Contents x
    Environment Applications List
    • 23 Jul 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    Environment Applications List

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

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

    This API allows users to retrieve a list of Applications based on the Environment ID.

    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 (US) - https://api.ca1.plainid.io
    Europe (US) - 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
    detailed
    boolean

    If false, only the ID and name are returned.
    If true, a detailed response is returned.

    Defaultfalse
    limit
    number
    Minimum1
    Maximum50
    Default50
    offset
    number
    Minimum0
    Default0
    Responses
    200

    List of applications

    Expand All
    data
    Array of object (application)
    object
    Example{ "id": "APPS269J5C16H8N4", "name": "application name", "description": "description", "clientId": [ "P6VFQUXJ4FDTGPZKLY0C" ], "authWsId": "119e0a29-f4fe-429a-9ac6-7e413353f044", "authWsName": "authorization workspace name" }
    id
    string
    name
    string
    Max length100
    description
    string
    Max length200
    clientId
    Array of string
    string
    Max length100
    authWsId
    string (uuid)
    authWsName
    string
    Max length100
    total
    integer
    limit
    integer
    offset
    integer
    400

    Max page size is 50

    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