All Products
Search
Document Center

CloudSSO:ResetUserPassword

Last Updated:Jan 14, 2025

Resets the password of a user.

Operation description

If a user forgets the password, the password expires, or the password poses security risks, a CloudSSO administrator can reset the password for the user.

Note After you enable single sign-on (SSO) logon, the password of a user cannot be reset.

This topic provides an example on how to reset the password of the user u-00q8wbq42wiltcrk****. The new password is automatically generated by the system.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
cloudsso:ResetUserPasswordupdate
*User
acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/user/{#UserId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DirectoryIdstringYes

The ID of the directory.

d-00fc2p61****
UserIdstringYes

The ID of the user.

u-00q8wbq42wiltcrk****
PasswordstringNo

The new password.

The password must contain the following types of characters: uppercase letters, lowercase letters, digits, and special characters.

The password must be 8 to 32 characters in length.

Note If you set GenerateRandomPassword to False, you must specify Password.
uc)XK$?ictf72CKFDy9vtWaFmISl****
GenerateRandomPasswordbooleanNo

Specifies whether to enable the system to automatically generate a new password. Valid values:

  • True: The new password is automatically generated by the system.
  • False: The new password must be manually specified. This is the default value.
True
RequirePasswordResetForNextLoginbooleanNo

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

  • True: Password reset is required upon the next logon.
  • False: Password reset is not required upon the next logon. This is the default value.
False

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

NewPasswordstring

The new password.

Note This parameter is returned only when the new password is automatically generated by the system.
W2koInFIm0Wy2wVZ$oB)MzD$nY!G****
RequestIdstring

The request ID.

F44F02EC-70D1-5E51-8E8E-FA9AC4EF952A

Examples

Sample success responses

JSONformat

{
  "NewPassword": "W2koInFIm0Wy2wVZ$oB)MzD$nY!G****",
  "RequestId": "F44F02EC-70D1-5E51-8E8E-FA9AC4EF952A"
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history