docs
api
Access Control(IAM)
GetUser

Obtain User Information - GetUser

Overview

Obtain User Information

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is GetUser.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
UserNamestringUsernameYes

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
UserUserUser InformationYes

Data Model

User

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=GetUser
&UserName=zYVUcdtS

Response Example

{
  "Action": "GetUserResponse",
  "Message": "buBQXbcF",
  "RetCode": 0,
  "User": {}
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved