Update the basic information of an EIAM account by using UpdateUser - Identity as a Service - Alibaba Cloud - Identity as a Service

Updates the basic information of an EIAM user.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eiam:UpdateUser

update

*User

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
UserId	string	Yes	The user ID.	user_d6sbsuumeta4h66ec3il7yxxxx
Username	string	No	The username. It can be up to 256 characters long and can contain letters, digits, and the special characters: `_`, `.`, `@`, and `-`.	username_test
DisplayName	string	No	The display name. The maximum length is 128 characters.	test_name
PhoneRegion	string	No	The phone region. For example, the code for Chinese mainland is `86`. Do not prefix the code with `00` or `+`. This parameter is required if you specify `PhoneNumber`.	86
PhoneNumber	string	No	The phone number, which must be 6 to 15 digits long.	156xxxxxxxxx
PhoneNumberVerified	boolean	No	Indicates if the phone number is verified. A verified phone number is considered trusted. This parameter is required if you specify `PhoneNumber`. For most use cases, set this parameter to `true`.	true
Email	string	No	The email address. The local-part of the email can contain letters, digits, periods (`.`), underscores (`_`), and hyphens (`-`).	example@example.com
EmailVerified	boolean	No	Indicates if the email is verified. This parameter is required if you specify `Email`. For most use cases, set this parameter to `true`.	true
CustomFields	array<object>	No	The list of custom field objects.
	object	No	A custom field object.
FieldName	string	No	The name of the custom field. You must first create the custom field in the EIAM console. For more information, see the Custom Fields section in the console.	nick_name
FieldValue	string	No	The value of the custom field. The value must conform to the constraints defined for the field.	test_value
Operation	string	No	The operation to perform on the custom field. Valid values: `add`: Adds a value for the custom field. `replace`: Replaces the existing value of the custom field. If the field does not have a value, this operation functions as `add`. `remove`: Removes the value of the custom field.	add

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A"
}

Error codes

HTTP status code	Error code	Error message	Description
403	ResourceDuplicated.Username	The specified resource: Username already exist.	Duplicate user name

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.