docs
api
Access Control(IAM)
ListUsers

List User List - ListUsers

Overview

List User List

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is ListUsers.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
LimitstringPagination Limit (default: 10, maximum: 100)No
OffsetstringPagination offsetNo

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
Usersarray[Users]User InformationYes
TotalCountintNumber of UsersNo

Data Model

Users

Field NameTypeDescription InformationRequired
EmailstringEmailYes
UserNamestringUsernameYes
DisplayNamestringNicknameNo
StatusstringStatus (Active: Normal, Inactive: Not Activated, Frozen: Frozen, ConsoleInactive: Console Not Activated)No
CreatedAtintCreate TimestampNo

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"
    }
  ]
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved
  • Contact our sales to help your business.
  • Contact our sales to help your business.