Contents x
    Update Policy State
    • 18 Nov 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    Update Policy State

    • Updated on 18 Nov 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Patch
    /api/2.0/policies/{envId}

    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 Location
  • United States (US) - https://api.us1.plainid.io
  • Canada (CA) - https://api.ca1.plainid.io
  • Europe (EU) - 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.

    Security
    HTTP
    Type bearer

    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

    Path parameters
    envId
    string (uuid) Required

    The Environment ID can be found under the Details tab in the Environment Settings.

    Query parameters
    filter[authWsId]
    string (uuid) Required

    Authorization Workspace ID. This can be found in your Authorization Workspace Settings under Workspace ID.

    filter[id]
    stringRequired

    Policy ID Filter

    Body parameters
    Switch Policy State
    [
  {
    "op": "replace",
    "path": "/state",
    "value": true
  }
]
    Array of object
    object
    op
    string Required
    Valid values[ "replace" ]
    path
    string Required
    Valid values[ "/state" ]
    value
    boolean Required
    Defaulttrue
    Responses
    204

    Success - No Content

    Headers
    x-request-id
    string
    400

    bad request

    Headers
    x-request-id
    string
    Authorization WS not found
    {
  "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"
    }
  ]
}
    Expand All
    object
    errors
    Array of object (Error)
    object
    code
    string
    id
    string
    status
    integer
    name
    string
    message
    string
    args
    object
    path
    string
    401

    Unauthorized

    Headers
    x-request-id
    string
    404

    not found

    Headers
    x-request-id
    string
    Policy 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"
    }
  ]
}
    Expand All
    object
    errors
    Array of object (Error)
    object
    code
    string
    id
    string
    status
    integer
    name
    string
    message
    string
    args
    object
    path
    string
    422

    Validation Failed - Invalid UUID

    Headers
    x-request-id
    string
    Invalid ID Format
    {
  "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"
    }
  ]
}
    Expand All
    object
    errors
    Array of object (Error)
    object
    code
    string
    id
    string
    status
    integer
    name
    string
    message
    string
    args
    object
    path
    string
    Was this article helpful?
    What's Next