Get Policy¶
Get the policy information.
Operation Permissions¶
Applications assigned with the administrator policy in the OU.
Request Format¶
GET https://{apigw-address}/enos-iam-service/v2.3/policy/info
Request Parameters (URI)¶
Name |
Location (Path/Query) |
Mandatory/Optional |
Data Type |
Description |
---|---|---|---|---|
orgId |
Query |
Mandatory |
String |
The ID of the organization to which the policy belongs to. How to get orgId>> |
id |
Query |
Mandatory |
String |
The policy ID. |
Response Parameters¶
Name |
Data Type |
Description |
---|---|---|
data |
Policy Struct |
The policy details. For more information, see Policy Struct. |
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/info?orgId=yourOrgId&id=yourRequestedPolicyId
method: GET
Return Sample¶
{
"fail": false,
"data": {
"id": "yourRequestedPolicyId",
"code": "connectivity.admin",
"desc": "Device Management Administrator",
"name": "Device Management Administrator",
"type": 8,
"created_by": "",
"permissions": {},
"updated_at": null
},
"success": true,
"status": 0
}