Update Policy State.
Note - for the older version, see Policy State V1.
Notice
Accessing the Policy Management APIs is through a dedicated domain/URL, according to your PlainID Tenant Locationhttps://api.us1.plainid.io
https://api.ca1.plainid.io
https://api.eu1.plainid.io
Using HTML Encoded Special Characters
Use HTML encoded patterns when working with values that contain special characters like spaces, dashes, etc. Refer to this HTML URL Encoding Reference for a full list.
cURL Sample Guidelines
In order for the relevant parameters to appear in the cURL sample, you can input the values in the interactive API console on the right. They will then appear in the cURL sample on the bottom of the page in the correct format.
For more details about Administration API Authentication, check out the Authentication APIs documentation. Provide your bearer token in the Authorization header when making requests to protected resources. Example: Authorization: Bearer 123
The Environment ID can be found under the Details tab in the Environment Settings.
Authorization Workspace ID. This can be found in your Authorization Workspace Settings under Workspace ID.
Policy ID Filter
[
{
"op": "replace",
"path": "/state",
"value": true
}
]
Success - No Content
bad request
{
"errors": [
{
"code": "PAC-001",
"args": {
"0": "ceef5853-1491-4d1c-ae52-2f2a1729b3a4"
},
"id": "EWWOTR",
"status": 400,
"name": "AuthorizationWsNotFound",
"message": "AuthorizationWs: [ceef5853-1491-4d1c-ae52-2f2a1729b3a4] not found"
}
]
}
Unauthorized
not found
{
"errors": [
{
"code": "PUA-033",
"args": {
"0": "a0a455bb-7dc3-4cd3-b0d2-86631ac75379",
"1": "ceef5853-1491-4d1c-ae52-2f2a1729b3a4"
},
"id": "E7WJBB",
"status": 404,
"name": "PolicyNotFoundError",
"message": "Policy Id doesn't exist in the environment"
}
]
}
Validation Failed - Invalid UUID
{
"errors": [
{
"code": "V-032",
"args": {
"0": "ed252aa5-9d0c-4193-838-60bf20b13109",
"1": "uuid"
},
"id": "EEJQMA",
"status": 422,
"name": "UnprocessableEntityError",
"message": "$: test is an invalid uuid"
}
]
}