Get single policy
- Print
- PDF
Get single policy
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get a single policy.
API
- GET /policies/{policyId}
Request
Request parameter
| Parameter | Location | Required | Type | Restrictions | Description |
|---|---|---|---|---|---|
| policyId | path | Y | String | Policy Id | |
| withPermissions | query string | N | boolean | Get permissions of the policy together (default: false) |
Response
{
"policyId": "string",
"policyName": "string",
"policyType": "string",
"nrn": "string",
"permissions": [
{
"effect": "string",
"targets": [
{
"product": "string",
"actions": [
"string"
],
"resourceNrns": [
"string"
]
}
],
"condition": {
"operator": {
"key": "value"
}
}
}
]
}
| Items | Type | Description | Remarks |
|---|---|---|---|
| policyId | string | Policy ID | |
| policyName | string | Policy Name | |
| policyType | string | Policy type (SYSTEM_MANAGED, USER_CREATED) | |
| nrn | string | policy nrn | |
| permissions | array | Permission list | |
| permissions.effect | string | Permission status (currently only supports Allow) | |
| permissions.targets | array | Permission target | |
| permissions.targets.product | string | Target product code | |
| permissions.targets.actions | array | Target action | |
| permissions.targets.resourceNrns | array | Target resource nrns | |
| permissions.condition | object | Policy condition | |
| permissions.condition.operator | string | Policy condition operator | |
| permissions.condition.operator.key | string | Policy condition key | |
| permissions.condition.operator.value | any | Policy condition value |
Was this article helpful?