Modifies the information about a user of a bastion host.
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 Resources
is 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 |
---|---|---|---|---|
yundun-bastionhost:ModifyUser | Write |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
InstanceId | string | Yes | The ID of the bastion host where you want to modify user information. Note
You can call the DescribeInstances operation to query the ID of the bastion host.
| bastionhost-cn-st220aw**** |
RegionId | string | No | The region ID of the bastion host where you want to modify user information. Note
For more information about the mapping between region IDs and region names, see Regions and zones.
| cn-hangzhou |
UserId | string | Yes | The ID of the user whose information you want to modify. | 1 |
Password | string | No | The new password of the user. The password must be 8 to 128 characters in length and must contain lowercase letters, uppercase letters, digits, and special characters. | 321**** |
DisplayName | string | No | The new display name of the user. This display name can be up to 128 characters in length. | Bob |
Comment | string | No | The new description of the user. The description can be up to 500 characters in length. | comment |
string | No | The new email address of the user. Note
This parameter is required when the TwoFactorStatus parameter is set to Enable and the TwoFactorMethods parameter is set to email.
| username@example.com | |
Mobile | string | No | The new mobile number of the user. Note
This parameter is required when the TwoFactorStatus parameter is set to Enable and the TwoFactorMethods parameter is set to sms or dingtalk.
| 1358888**** |
MobileCountryCode | string | No | The country where the new mobile number of the user is registered. Valid values:
| CN |
EffectiveStartTime | long | No | The beginning of the validity period of the user. The value is a UNIX timestamp. Unit: seconds. | 1669630029 |
EffectiveEndTime | long | No | The end of the validity period of the user. The value is a UNIX timestamp. Unit: seconds. | 1672502400 |
NeedResetPassword | boolean | No | Specifies whether password reset is required upon the next logon. Valid values:
| true |
TwoFactorStatus | string | No | The two-factor authentication status of the user. Valid values:
| Enable |
TwoFactorMethods | string | No | The two-factor authentication method. You can select only one method. Valid values:
Note
| sms |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidParameter | The argument is invalid. | The argument is invalid. |
404 | UserNotFound | The user is not found. | The user is not found. |
500 | InternalError | An unknown error occurred. | An unknown error occurred. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2024-02-28 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||||||
|