docs
api
Access Control(IAM)
ListEntitiesForProject

List entities with specified project permissions - ListEntitiesForProject

Overview

List entities with specified project permissions

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is ListEntitiesForProject.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
ProjectIDstringProject IDYes
LimitstringThe number of user groups to be queriedNo
OffsetstringStart querying from which data entryNo

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
Entitiesarray[Entity]Entity authorized for project permissionsYes
TotalCountintNumber of Data SetsYes

Data Model

Entity

Field NameTypeDescription InformationRequired
EntityNamestringEntity Name.Yes
EntityKindstringEntity Type (User: User, Group)Yes
AttachedAtintQuotation TimeYes
DisplayNamestringSub-account Display NameYes
ScopestringEffective SpaceNo

Example

Request Example

https://api.surfercloud.com/?Action=ListEntitiesForProject
&ProjectID=LjAdemcs
&Limit=lmjPWkdl
&Offset=NMyWAVrU

Response Example

{
  "Action": "ListEntitiesForProjectResponse",
  "Entities": "dRCPbpgQ",
  "Message": "gNDOHVFF",
  "RetCode": 0,
  "TotalCount": "cJxZCbIZ"
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved