List the permission policies associated with the user group - ListPoliciesForGroup
Overview
List the permission policies associated with the user group
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is ListPoliciesForGroup . | Yes |
PublicKey | string | The user’s public key can be obtained from Console | 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 |
---|---|---|---|
GroupName | string | User Group Name | Yes |
Scope | string | Application Scope | No |
ProjectID | string | Project ID | No |
Limit | string | The number of user groups to be queried | No |
Offset | string | Start querying from which data entry | 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 |
Policies | array[Policy] | User Information Array | Yes |
TotalCount | int | Total | Yes |
Data Model
Policy
Field Name | Type | Description Information | Required |
---|---|---|---|
PolicyName | string | Permission Policy Name | Yes |
PolicyURN | string | Strategy URN | Yes |
Description | string | Description | No |
CreatedAt | int | Creation Time | No |
Scope | string | Application Scope (ScopeRequired: Project Level, ScopeEmpty: Global Level, ScopeUnrestricted: Project Level/Global Level) | No |
ProjectID | string | Project ID | No |
AttachedAt | int | The timestamp when the policy was added to the user group | No |
Example
Request Example
https://api.dezai.com/?Action=ListPoliciesForGroup
&GroupName=VHldJkYs
&Scope=tbLpJnNP
&ProjectID=zDsUSYuA
&Limit=mEGbXyIu
&Offset=ZFxUpmzZ
Response Example
{
"Action": "ListPoliciesForGroupResponse",
"Message": "ltpagPiP",
"Policies": [
{
"AttachedAt": 3,
"CreatedAt": 6,
"Description": "BRMFCakF",
"PolicyName": "piAGjTUK",
"PolicyURN": "HLSbhbvw",
"ProjectID": "JbJFDksq",
"Scope": "yes"
}
],
"RetCode": 0,
"TotalCount": 7
}