All Products
Search
Document Center

Bastionhost:ModifyUser

Last Updated:Mar 01, 2024

Modifies the information about a Bastionhost user.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-bastionhost:ModifyUserWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

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****
RegionIdstringNo

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
UserIdstringYes

The ID of the user whose information you want to modify.

1
PasswordstringNo

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****
DisplayNamestringNo

The new display name of the user. This display name can be up to 128 characters in length.

Bob
CommentstringNo

The new description of the user. The description can be up to 500 characters in length.

comment
EmailstringNo

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
MobilestringNo

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****
MobileCountryCodestringNo

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
EffectiveStartTimelongNo

The beginning of the validity period of the user. The value is a UNIX timestamp. Unit: seconds.

1669630029
EffectiveEndTimelongNo

The end of the validity period of the user. The value is a UNIX timestamp. Unit: seconds.

1672502400
NeedResetPasswordbooleanNo

Specifies whether password reset is required upon the next logon. Valid values:

  • true: yes
  • false: no
true
TwoFactorStatusstringNo

The two-factor authentication status of the user. Valid values:

  • Global: follows the global settings
  • Disable: disables two-factor authentication
  • Enable: enable two-factor authentication and follows settings of the single user
Enable
TwoFactorMethodsstringNo

The two-factor authentication method. You can select only one method. Valid values:

  • sms: text message
  • email: email
  • dingtalk: DingTalk
  • totp OTP: time-based one-time password (TOTP) app
Note
  • When the TwoFactorStatus parameter is set to Enable, you must specify one of the preceding values.
  • sms

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response data.

    RequestIdstring

    The ID of the request, which is used to locate and troubleshoot issues.

    EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

    Examples

    Sample success responses

    JSONformat

    {
      "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE"
    }

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidParameterThe argument is invalid.The argument is invalid.
    404UserNotFoundThe user is not found.The user is not found.
    500InternalErrorAn unknown error occurred.An unknown error occurred.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-02-28The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 404
      delete Error Codes: 500
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: LanguageStatus
      Added Input Parameters: Language