Contents x
    Delete Policy
    • 04 Jul 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    Delete Policy

    • Updated on 04 Jul 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Article summary

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

    This API deletes a Policy from the Authorization Platform.

    Note - This version is going to be deprecated soon. See Delete Policy V2 for the latest documentation.

    *Once deleted, the Policy is removed permanently and would have to either be re-imported using the Import API or recreated within the Platform.**

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

    Responses
    204

    Policy Deleted

    Headers
    x-request-id
    string
    401

    Unauthorized

    Headers
    x-request-id
    string
    422

    Validation Failed - Invalid UUID

    Headers
    x-request-id
    string
    Invalid ID Format
    {
  "errors": [
    {
      "args": {
        "0": "ed252aa5-9d0c-4193-838-60bf20b13109",
        "1": "uuid"
      },
      "code": "V-032",
      "id": "EEJQMA",
      "message": "$: ed252aa5-9d0c-4193-838-60bf20b13109 is an invalid uuid",
      "name": "UnprocessableEntityError",
      "status": 422
    }
  ]
}
    Expand All
    object
    errors
    Array of object
    object
    args
    object
    0
    string
    1
    string
    code
    string
    id
    string
    message
    string
    name
    string
    status
    integer
    Was this article helpful?
    What's Next