Update User - UpdateUser
Overview
Update User
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is UpdateUser . | Yes |
PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
UserName | string | Username | Yes |
DisplayName | string | Username (Username and user status cannot be empty at the same time) | No |
Status | string | User Status (User name and user status cannot be empty at the same time, enumeration values: Active: Unfreeze, Frozen: Freeze) | No |
NewUserName | string | New Username | No |
Response Field
Field Name | Type | Description Information | Required |
---|---|---|---|
RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
Action | string | Operation command name. | Yes |
Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
Example
Request Example
https://api.surfercloud.com/?Action=UpdateUser
&UserName=wevTzLLr
&DisplayName=ilbhUdoq
&Status=iVtHJZUP
&NewUserName=jBHjgupX
Response Example
{
"Action": "UpdateUserResponse",
"Message": "LJztAcqM",
"RetCode": 0
}