List User List - ListUsers

Overview

List User List

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `ListUsers`.	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
Limit	string	Pagination Limit (default: 10, maximum: 100)	No
Offset	string	Pagination offset	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
Users	array[Users]	User Information	Yes
TotalCount	int	Number of Users	No

Data Model

Users

Field Name	Type	Description Information	Required
Email	string	Email	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=ListUsers
&Limit=MQsgTdfa
&Offset=WicWKMBK
&Limit=YTQvTMtp
&Offset=xAbIncHa

Response Example

{
  "Action": "ListUsersResponse",
  "Message": "PoepGvmk",
  "RetCode": 0,
  "TotalCount": 1,
  "Users": [
    {
      "CreateAt": 3,
      "DisplayName": "WZQCLnPj",
      "Email": "QlrwqAoa",
      "JoinedAt": "ObCrmEvV",
      "Status": "Activate",
      "UserName": "TFYdQsyN"
    }
  ]
}

ListProjects ListUsersForGroup