ModifyUser - Bastionhost - Alibaba Cloud Documentation Center

Modifies the information about a user of a bastion host.

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

yundun-bastionhost:ModifyUser

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the bastion host on which you want to modify the information about the user. Note You can call the DescribeInstances operation to query the bastion host ID.	bastionhost-cn-st220aw****
RegionId	string	No	The region ID of the bastion host on which you want to modify the information about the user. 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. Note You can call the ListUsers operation to query the user ID.	1
Password	string	No	The new password of the user. The password must be 8 to 128 characters in length. It must contain uppercase letters, lowercase letters, digits, and special characters. Note Leave this parameter empty if you do not want to change the password of the user.	321****
DisplayName	string	No	The new display name of the user. The display name can be up to 128 characters in length. Note Leave this parameter empty if you do not want to change the display name of the user.	Bob
Comment	string	No	The new remarks of the user. The remarks can be up to 500 characters in length. Note Leave this parameter empty if you do not want to change the remarks of the user.	comment
Email	string	No	The new email address of the user. Note This parameter is required if TwoFactorStatus is set to Enable and TwoFactorMethods is set to email, or if TwoFactorStatus is set to Global and TwoFactorMethods is set to email in the global two-factor authentication settings. You can call the GetInstanceTwoFactor operation to query the global two-factor authentication settings. Leave this parameter empty if you do not want to change the email address of the user.	username@example.com
Mobile	string	No	The new mobile phone number of the user. Note This parameter is required if TwoFactorStatus is set to Enable and TwoFactorMethods is set to sms or dingtalk, or if TwoFactorStatus is set to Global and TwoFactorMethods is set to sms or dingtalk in the global two-factor authentication settings. You can call the GetInstanceTwoFactor operation to query the global two-factor authentication settings. Leave this parameter empty if you do not want to change the mobile phone number of the user.	1358888****
MobileCountryCode	string	No	The country where the new mobile number of the user is registered. Valid values: CN: the Chinese mainland, whose country calling code is +86 HK: Hong Kong (China), whose country calling code is +852 MO: Macao (China), whose country calling code is +853 TW: Taiwan (China), whose country calling code is +886 RU: Russia, whose country calling code is +7 SG: Singapore, whose country calling code is +65 MY: Malaysia, whose country calling code is +60 ID: Indonesia, whose country calling code is +62 DE: Germany, whose country calling code is +49 AU: Australia, whose country calling code is +61 US: US, whose country calling code is +1 AE: United Arab Emirates, whose country calling code is +971 JP: Japan, whose country calling code is +81 GB: UK, whose country calling code is +44 IN: India, whose country calling code is +91 KR: Republic of Korea, whose country calling code is +82 PH: Philippines, whose country calling code is +63 CH: Switzerland, whose country calling code is +41 SE: Sweden, whose country calling code is +46 SA: Saudi Arabia, whose country calling code is +966	CN
EffectiveStartTime	integer	No	The start time of the validity period of the user. Specify a UNIX timestamp. Unit: seconds. Note Leave this parameter empty if you do not want to change the start time of the validity period.	1669630029
EffectiveEndTime	integer	No	The end time of the validity period of the user. Specify a UNIX timestamp. Unit: seconds. Note Leave this parameter empty if you do not want to change the end time of the validity period.	1672502400
NeedResetPassword	boolean	No	Specifies whether password reset is required upon the next logon. Valid values: true false Note Leave this parameter empty if you do not want to change the password reset settings for the user.	true
TwoFactorStatus	string	No	Specifies whether two-factor authentication is enabled for the user. Valid values: Global: The global settings apply. Disable: Two-factor authentication is disabled. Enable: Two-factor authentication is enabled and user-specific settings apply. Note Leave this parameter empty if you do not want to change the two-factory authentication settings for the user.	Enable
TwoFactorMethods	string	No	The two-factor authentication method. You can select only one method. Valid values: sms: text message-based two-factor authentication. email: email-based two-factor authentication. dingtalk: DingTalk-based two-factor authentication. totp OTP: one-time password (OTP) token-based two-factor authentication. Note If TwoFactorStatus is set to Enable, you must specify one of the valid values as TwoFactorMethods.	[ "sms" ]
LanguageStatus	string	No	Specifies whether to send notifications in the language specified in the global settings or a custom language. Global Custom Note Leave this parameter empty if you do not want to change the natural language used to notify the user.	Custom
Language	string	No	This parameter is required if LanguageStatus is set to Custom. zh-cn: simplified Chinese en: English	en

Response elements

Element	Type	Description	Example
	object	The response data.
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

Examples

Success response

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.
500	InternalError	An unknown error occurred.	An unknown error occurred.
404	UserNotFound	The user is not found.	The user is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.