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

    Policy State

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

    Patch
    /api/1.0/policies/{envId}/{policyId}



    Note: This version is going to be deprecated in June 2025.
    See Import Policy V2 for the latest documentation.

    Active Policies are factored into the authorization decision returned by the Authorization Platform. Similarly, an Inactive Policy is not considered when calculating the authorization decision. The setting for Policy State is per Environment.

    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
  • Local PAA - https://api.plainid.local

    • 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
    stringRequired

    The Environment that the Policy is located in.
    The Environment ID can be found under the Details tab in the Environment Settings.

    policyId
    stringRequired

    The Policy ID can be found on the Policy Details tab

    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

    400

    Bad Request

    Headers
    x-request-id
    string
    Expand All
    object
    errors
    Array of object
    object
    code
    string
    args
    object
    0
    string
    1
    string
    id
    string
    status
    integer
    name
    string
    message
    string
    401

    Unauthorized

    Headers
    x-request-id
    string
    Expand All
    object
    errors
    Array of object
    object
    code
    string
    args
    object
    0
    string
    1
    string
    id
    string
    status
    integer
    name
    string
    message
    string
    404

    Policy Not Found

    Headers
    x-request-id
    string
    Expand All
    object
    errors
    Array of object
    object
    code
    string
    args
    object
    0
    string
    1
    string
    id
    string
    status
    integer
    name
    string
    message
    string
    Was this article helpful?
    What's Next