Contents x
    Application Policies List
    • 04 Jul 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    Application Policies List

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

    Get
    /policy-mgmt/1.0/policies/{envId}

    This API enables users to obtain a list of Policies associated with a particular Application in a specific Environment.

    Notice

    Accessing the Policy Management APIs is through a dedicated domain/URL according to your PlainID Tenant Location:
    https://api.{REGION}.plainid.io

  • United States (US) - `https://api.us1.plainid.io`
  • Canada (CA) - `https://api.ca1.plainid.io`
  • Europe (EU) - `https://api.eu1.plainid.io`
    • Replace`{REGION}` with your PlainID Tenant region (e.g. us1, eu1, ca1, etc.).

    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[appId]
    string (uuid)

    Application External ID. This can be found under the Details tab of the Application.

    limit
    number
    Maximum1000
    Minimum1
    Default"50"
    offset
    number
    Minimum0
    Default"0"
    Responses
    200

    List of policies

    Expand All
    data
    Array of object (policy)
    object
    Example{ "accessType": "Allow", "id": "POLS269J5C16H8N4", "name": "policy name", "state": "Active" }
    accessType
    string
    Valid values[ "Allow", "Restrict" ]
    id
    string
    name
    string
    Max length100
    state
    string
    Valid values[ "Active", "Inactive" ]
    meta
    object
    limit
    integer
    offset
    integer
    total
    integer
    400

    appId is missing

    Expand All
    object
    args
    object
    path
    string
    code
    string
    id
    string
    message
    string
    name
    string
    status
    integer
    403

    operation get for resource Application isn't allowed because the current user does not have the appropriate permissions

    Expand All
    object
    args
    object
    path
    string
    code
    string
    id
    string
    message
    string
    name
    string
    status
    integer
    Was this article helpful?
    What's Next