Deploy Policy to Vendor

New
  • Published on Jun 29, 2025
  • 2 minute(s) read
Prev Next
Post
/orchestrator/1.0/pop-operations/deploy/env/{envId}/pop/{popId}/policy/{vendorPolicyId}

Deploy Policy to Vendor by Environment ID, POPID, and Vendor Policy ID. You can find the Vendor Policy ID using the Get Vendor Policy IDs by POP API.

Notice

Accessing the 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.


    Important note about headers

    Refer to the headers below to modify your cURL sample. Check if the following headers are in the sample, if not, ensure you add it to your cURL sample before pasting into your API tool.

    Headers

    *Required
    Header Value cURL Line
    Accept`application/json` `-H"Accept: application/json"`
    Content Type`application/json` `-H"Content-Type: application/json"`

    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 in the Try It or Code Sample tabs. You can then copy the cURL sample from the Code Sample tab in the correct format.


    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.


    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

    Environment ID. You can find the Environment ID in your Environment Settings.

    popId
    stringRequired

    POP ID. You can find the POP ID using the GET List of POPs API or through the UI under your POP settings.

    Pattern^POP[0-9A-Z]{11,13}$
    vendorPolicyId
    stringRequired

    Vendor Policy ID. You can find the Vendor Policy ID using the Get Vendor Policy IDs by POP API or through the UI. To locate the Vendor Policy ID through the UI, refer to SaaS Management Vendors.

    Responses
    204

    POP Policy deployed successfully.

    400

    Bad Request

    {
  "errors": [
    {
      "code": "ORC-027",
      "id": "E880D0",
      "status": 400,
      "name": "PopDoesNotBelongToEnvironment",
      "message": "Pop [POP1P00XFYS0NVJ] does not belong to Environment [ec3ff4ee-81f9-4e7f-9037-6fa9fde62cc8]",
      "args": {
        "0": "POP1P00XFYS0NVJ",
        "1": "ec3ff4ee-81f9-4e7f-9037-6fa9fde62cc8"
      }
    }
  ]
}
    Expand All
    object

    Response object

    errors
    Array of object (Error)
    object
    code
    string
    id
    string
    status
    integer
    name
    string
    message
    string
    args
    object
    path
    string
    404

    Vendor Policy Not Found

    {
  "errors": [
    {
      "code": "ORC-25",
      "id": "ECD872",
      "status": 404,
      "name": "VendorPolicyNotFoundError",
      "message": "Vendor Policy by ID [role_0b9192e5-6b04-4350-a781-021878c04689_20432] was not found",
      "args": {
        "vendorPolicyId": "role_0b9192e5-6b04-4350-a781-021878c04689_20432"
      }
    }
  ]
}
    Expand All
    object

    Response object

    errors
    Array of object (Error)
    object
    code
    string
    id
    string
    status
    integer
    name
    string
    message
    string
    args
    object
    path
    string
    500

    Internal Server Error