ResetUserPassword - Cloud Phone - Alibaba Cloud Documentation Center

Resets the password for a convenience user. If you call this operation, a token that is used to reset the password is generated, and the system sends a password reset email that includes the token to the email address of the convenience user.

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.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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
ecd:ResetUserPassword	update	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Users	array	Yes	The names of the convenience users whose passwords you want to reset.
	string	Yes	The name of the convenience user whose password you want to reset.	test1
NotifyType	integer	No	The method to notify the user after the password is reset. Note Alibaba Cloud accounts of the international site do not support sending notification through text messages. Enumeration Value: 1: email. 2: text message. 3: both.	1

Response parameters

Parameter	Type	Description	Example
	object	The information that is returned.
RequestId	string	The ID of the request.	32D05B39-E6EE-4D7A-9FD0-762A26859D0D
ResetUsersResult	object	The result of resetting the password of the convenience user.
ResetUsers	array	The convenience users to which the system sent a password reset email.
ResetUsers	string	The convenience user to which the system sent a password reset email.	test1
FailedUsers	array<object>	The information about the convenience users whose passwords failed to be reset.
failedUsers	object	The information about the convenience user whose password failed to be reset.
EndUserId	string	The ID of the convenience user whose password failed to be reset.	test123
ErrorCode	string	The error code.	InvalidUsername
ErrorMessage	string	The error message.	test123 is an invalid username.

Examples

Sample success responses

JSONformat

{
  "RequestId": "32D05B39-E6EE-4D7A-9FD0-762A26859D0D",
  "ResetUsersResult": {
    "ResetUsers": [
      "test1"
    ],
    "FailedUsers": [
      {
        "EndUserId": "test123",
        "ErrorCode": "InvalidUsername",
        "ErrorMessage": "test123 is an invalid username."
      }
    ]
  }
}

Error codes

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