docs
api
Access Control(IAM)
GetIAMPolicy

Get Policy Details - GetIAMPolicy

Overview

Get Policy Details

Definition

Public Parameters

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

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

Data Model

IAMPolicy

Field NameTypeDescription InformationRequired
PolicyNamestringPolicy NameNo
PolicyURNstringIAM Policy URNNo
DescriptionstringIAM Policy DescriptionNo
DocumentstringIAM Policy TextNo
ScopeTypestringIAM Permission Policy Application Scope (ScopeRequired: Project Level, ScopeEmpty: Global Level, ScopeUnrestricted: Project Level/Global Level)No
CreatedAtintIAM Policy Creation TimeNo
UpdatedAtintIAM Policy Update TimeNo

Example

Request Example

https://api.surfercloud.com/?Action=GetIAMPolicy
&PolicyURN=iAVnENEZ

Response Example

{
  "Action": "GetIAMPolicyResponse",
  "Message": "MJEfQQTC",
  "Policy": {},
  "RetCode": 0
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved