ResetSmartAccessGatewayClientUserPassword - Smart Access Gateway

Resets the password that a client account uses to log on to the Smart Access Gateway (SAG) app.

Debugging

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

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:
- 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
smartag:ResetSmartAccessGatewayClientUserPassword	Write	SmartAccessGateway acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the SAG app instance is deployed.	cn-shanghai
SmartAGId	string	Yes	The ID of the SAG app instance.	sag-kzo5dvms3dqii3****
UserName	string	Yes	The username of the client account for which you want to reset the password.	username
Password	string	No	The new password. If you do not specify a new password, the system generates a random password. If you specify a new password, the password is reset to the specified new password. The password must be 8 to 32 characters in length, and can contain letters, digits, underscores (_), at signs (@), periods (.), and hyphens (-). It must start with a letter or a digit. After the password is reset, an email that contains the new password is sent to the email address of the client account.	Password****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	BE1F7E80-4558-4021-B6D2-B94DA8AAAF81

Examples

Sample success responses

JSONformat

{
  "RequestId": "BE1F7E80-4558-4021-B6D2-B94DA8AAAF81"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ClientUser.NameEmpty	You must specify UserName.	You must enter a username.
400	ClientUser.NameInvalid	The specified UserName is invalid.	The format of the username is invalid.
400	SAG.InstanceIdEmpty	You must specify the SAG instance ID.	You must specify the SAG instance ID.
400	SAG.InstanceNoFound	The specified SAG instance does not exist.	The specified SAG instance does not exist.
400	ClientUser.PasswordInvalid	The specified password format is invalid.	The specified password format is invalid.

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