Application Policies List
  • 20 Dec 2023
  • 1 Minute to read
  • Dark
    Light
  • PDF

Application Policies List

  • 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.).

    Security
    Http
    Type bearer
    For more details about Management API Authentication, check out the Management APIs Authentication Article
    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
    object

    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
    id
    string
    name
    string
    Max length100
    state
    string
    Valid values[ "\"active\"", "\"inactive\"" ]
    accessType
    string
    Valid values[ "\"allow\"", "\"restrict\"" ]
    total
    integer
    limit
    integer
    offset
    integer
    400

    appId is missing

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

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

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

    Was this article helpful?

    What's Next