Skip to content

/AWS1/IF_IDS=>UPDATEUSER()

About UpdateUser

Updates the specified user metadata and attributes in the specified identity store.

Method Signature

METHODS /AWS1/IF_IDS~UPDATEUSER
  IMPORTING
    !IV_IDENTITYSTOREID TYPE /AWS1/IDSIDENTITYSTOREID OPTIONAL
    !IV_USERID TYPE /AWS1/IDSRESOURCEID OPTIONAL
    !IT_OPERATIONS TYPE /AWS1/CL_IDSATTRIBUTEOPERATION=>TT_ATTRIBUTEOPERATIONS OPTIONAL
    !IV_REVISION TYPE /AWS1/IDSRESOURCEREVISION OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_idsupdateuserresponse
  RAISING
    /AWS1/CX_IDSACCESSDENIEDEX
    /AWS1/CX_IDSINTERNALSERVEREX
    /AWS1/CX_IDSTHROTTLINGEX
    /AWS1/CX_IDSCONFLICTEXCEPTION
    /AWS1/CX_IDSRESOURCENOTFOUNDEX
    /AWS1/CX_IDSSERVICEQUOTAEXCDEX
    /AWS1/CX_IDSVALIDATIONEX
    /AWS1/CX_IDSCLIENTEXC
    /AWS1/CX_IDSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_identitystoreid TYPE /AWS1/IDSIDENTITYSTOREID /AWS1/IDSIDENTITYSTOREID

The globally unique identifier for the identity store.

You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.

iv_userid TYPE /AWS1/IDSRESOURCEID /AWS1/IDSRESOURCEID

The identifier for a user in the identity store.

You can specify the user by ID or by Amazon Resource Name (ARN). For example, user ID a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 or user ARN arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

it_operations TYPE /AWS1/CL_IDSATTRIBUTEOPERATION=>TT_ATTRIBUTEOPERATIONS TT_ATTRIBUTEOPERATIONS

A list of AttributeOperation objects to apply to the requested user. These operations might add, replace, or remove an attribute. For more information on the attributes that can be added, replaced, or removed, see User.

Optional arguments:

iv_revision TYPE /AWS1/IDSRESOURCEREVISION /AWS1/IDSRESOURCEREVISION

The expected current revision of the user. When you provide this value, the update is applied only if it matches the current revision of the user in the identity store, which prevents you from overwriting concurrent changes. If the value doesn't match, the operation fails with a ConflictException. If you don't provide this value, the update is applied unconditionally.

RETURNING

oo_output TYPE REF TO /aws1/cl_idsupdateuserresponse /AWS1/CL_IDSUPDATEUSERRESPONSE

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->updateuser(
  it_operations = VALUE /aws1/cl_idsattributeoperation=>tt_attributeoperations(
    (
      new /aws1/cl_idsattributeoperation(
        io_attributevalue = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
        iv_attributepath = |string|
      )
    )
  )
  iv_identitystoreid = |string|
  iv_revision = |string|
  iv_userid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_identitystoreid = lo_result->get_identitystoreid( ).
  lv_resourceid = lo_result->get_userid( ).
  lv_resourcearn = lo_result->get_userarn( ).
  lv_resourcerevision = lo_result->get_revision( ).
ENDIF.