Updates the basic information about an Employee Identity and Access Management (EIAM) account of Identity as a Service (IDaaS).
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| eiam:UpdateUser | update | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| InstanceId | string | Yes | The instance ID. | idaas_ue2jvisn35ea5lmthk267xxxxx |
| UserId | string | Yes | The account ID. | user_d6sbsuumeta4h66ec3il7yxxxx |
| Username | string | No | The name of the account. The name can be up to 64 characters in length. It can contain letters, digits, and the following special characters: _ . @ - | username_test |
| DisplayName | string | No | The display name of the account. The display name can be up to 64 characters in length. | test_name |
| PhoneRegion | string | No | The area code of the mobile number. For example, the area code of a mobile number in the Chinese mainland is 86 without 00 or the plus sign (+). This parameter must be specified if you specify PhoneNumber. | 86 |
| PhoneNumber | string | No | The mobile number. The mobile number must be 6 to 15 digits in length. | 156xxxxxxxxx |
| PhoneNumberVerified | boolean | No | Specifies whether the mobile number is verified. This parameter must be specified if you specify PhoneNumber. You can set this parameter to true if you have no special business requirements. | true |
| string | No | The email address. The prefix of the email address can contain letters, digits, periods (.), underscores (_), and hyphens (-). | example@example.com | |
| EmailVerified | boolean | No | Specifies whether the email address is verified. This parameter must be specified if you specify Email. You can set this parameter to true if you have no special business requirements. | true |
| CustomFields | array<object> | No | The custom extended fields. | |
| object | No | The information about the array object. | ||
| FieldName | string | No | The name of the extended field. You must create an extended field before you specify this parameter. To create an extended field, go to the Extended Fields page of the specified EIAM instance in the IDaaS console. | nick_name |
| FieldValue | string | No | The value of the extended field. The value follows the limits on the properties of the extended field. | test_value |
| Operation | string | No | The operation type of the extended field. Valid values:
| add |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-04-04 | The internal configuration of the API is changed, but the call is not affected | View Change Details |