List Policies¶
List the policies of an OU.
Operation Permissions¶
Applications assigned with the administrator policy in the OU.
Request Format¶
GET https://{apigw-address}/enos-iam-service/v2.3/policy/list
Request Parameters (URI)¶
Name | Location (Path/Query) | Mandatory/Optional | Data Type | Description |
---|---|---|---|---|
orgId | Query | Mandatory | String | The ID of the organization to which the policies belong to. How to get orgId>> |
Response Parameters¶
Name | Data Type | Description |
---|---|---|
data | PolicyResults Struct | Summary of the obtained results. For more information, see PolicyResults Struct. |
PolicyResults Struct ¶
Name | Data Type | Description |
---|---|---|
list | Array of Policy Structs | The list of policies. For more information, see Policy Struct. |
open | Integer | An unused parameter, usually 0. |
total | Integer | The total number of policies. |
offset | Integer | An unused parameter, usually 0. |
Policy Struct ¶
Name | Data Type | Description |
---|---|---|
id | String | The policy ID. |
code | String | The policy code. |
desc | String | The policy description. |
name | String | The policy name. |
type | Integer |
|
created_by | String | The username of the user who created the policy. |
permissions | Map | An unused parameter, usually blank. |
updated_at | String | An unused parameter, usually null. |
Samples¶
Request Sample¶
url: https://{apigw-address}/enos-iam-service/v2.3/policy/list?orgId=yourOrgId
method: GET
Return Sample¶
{
"fail": false,
"data": {
"list": [
{
"id": "1505",
"code": "",
"desc": "",
"name": "test_Policy",
"type": 2,
"created_by": "system",
"permissions": {},
"updated_at": null
},
{
"id": "4",
"code": "connectivity.admin",
"desc": "Device Management Administrator",
"name": "Device Management Administrator",
"type": 8,
"created_by": "",
"permissions": {},
"updated_at": null
}
],
"open": 0,
"total": 2,
"offset": 0
},
"success": true,
"status": 0
}