Updating a User

Function

This API is used to update the attributes of an IAM Identity Center user based on the user ID.

URI

PUT /v1/identity-stores/{identity_store_id}/users/{user_id}

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
identity_store_id	Yes	String	Globally unique ID of the identity source Minimum length: 12 Maximum length: 12
user_id	Yes	String	Globally unique ID of an IAM Identity Center user in the identity source Minimum length: 1 Maximum length: 64

Request Parameters

**Table 2** Parameters in the request header
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required. Maximum length: 2048

**Table 3** Parameters in the request body
Parameter	Mandatory	Type	Description
operations	Yes	Array of objects	List of updated user attributes Array length: 1-100

**Table 4** operations
Parameter	Mandatory	Type	Description
attribute_path	Yes	String	Path of the attribute to be updated Minimum length: 1 Maximum length: 255
attribute_value	No	String	Attribute value to be updated. If the attribute is an object, set this parameter to the JSON string of the object. If the attribute is null, that attribute will be deleted.

Response Parameters

Status code: 400

**Table 5** Parameters in the response body
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message
request_id	String	Request ID
encoded_authorization_message	String	Authentication information

Status code: 403

**Table 6** Parameters in the response body
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message
request_id	String	Request ID
encoded_authorization_message	String	Authentication information

Status code: 404

**Table 7** Parameters in the response body
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message
request_id	String	Request ID
encoded_authorization_message	String	Authentication information

Example Request

Updating the attributes of an IAM Identity Center user based on the user ID

PUT https://{hostname}/v1/identity-stores/{identity_store_id}/users/{user_id}

{
  "operations" : [ {
    "attribute_path" : "emails",
    "attribute_value" : "[{\"primary\":true,\"type\":\"Work\",\"value\":\"new-email@example.com\"}]"
  }, {
    "attribute_path" : "name",
     "attribute_value": "{\"family_name\":\" Last name\",\"given_name\":\"Given name-new\"}"
  }, {
    "attribute_path" : "display_name",
    "attribute_value": "Display name of the user-new"
  } ]
}