Retrieve User Login Information - GetLoginProfile
Overview
Retrieve User Login Information
Definition
Public Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Action | string | Corresponding API command name, the current API is GetLoginProfile. | Yes |
| PublicKey | string | The user’s public key can be obtained from Console  | 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 |
| LoginProfile | LoginProfile | Login Information | No |
Data Model
LoginProfile
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| Status | string | Login Information Status | Yes |
Example
Request Example
https://api.surfercloud.com/?Action=GetLoginProfile
&UserName=qPkVyDtFResponse Example
{
"Action": "GetLoginProfileResponse",
"LoginProfile": "WmREDoMJ",
"RetCode": 0
}