Obtain User Information - GetUser
Overview
Obtain User Information
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is GetUser . | 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 |
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 |
User | User | User Information | Yes |
Data Model
User
Field Name | Type | Description Information | Required |
---|---|---|---|
string | Yes | ||
UserName | string | Username | Yes |
DisplayName | string | Nickname | No |
Status | string | Status (Active: Normal, Inactive: Not Activated, Frozen: Frozen, ConsoleInactive: Console Not Activated) | No |
CreatedAt | int | Create Timestamp | No |
Example
Request Example
https://api.surfercloud.com/?Action=GetUser
&UserName=zYVUcdtS
Response Example
{
"Action": "GetUserResponse",
"Message": "buBQXbcF",
"RetCode": 0,
"User": {}
}