Contents x
    Get a List of POPs
    • 26 Aug 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    Get a List of POPs

    • Updated on 26 Aug 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Get
    /orchestrator/1.0/pops

    This is an API that fetches a list of Policy Orchestration Points (POP) with query parameters.

    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

    Query parameters
    filter[orchestrationWorkspaceId]
    stringRequired

    Filter by the Orchestration Workspace ID. This ID is located in the Details Tab in the Orchestration Workspace Settings.

    offset
    integer

    Offset for pagination.

    Default0
    limit
    integer

    Limit for pagination.

    Default10
    sort[name]
    string

    Sort by name in ascending order (ASC) or descending order (DESC).

    Valid values[ "ASC", "DESC" ]
    Responses
    200

    Successful response

    list_example
    {
  "data": [
    {
      "id": "POPS269J5C16H8N4",
      "orchestrationWorkspaceId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "identityWorkspaceId": "9ca7569f-5635-4cff-a335-74bcb3251ef0",
      "authorizationWorkspaceId": "4988cfea-527e-4183-8f80-608b0540dc14",
      "description": "description",
      "name": "pop connection name",
      "mode": "LEARN",
      "state": "DISCOVERY_DONE",
      "vendorName": "PowerBI",
      "popConnectionCredentials": {
        "authenticationMethod": "method",
        "credentials": {}
      }
    }
  ],
  "meta": {
    "total": 1,
    "limit": 50,
    "offset": 0
  }
}
    Expand All
    object

    Response object

    data
    Array of object (pop)
    object
    id
    string
    name
    string

    POP Name

    Max length50
    orchestrationWorkspaceId
    string (uuid)

    The Orchestration Workspace ID is located in the Details Tab in the Orchestration Workspace Settings.

    identityWorkspaceId
    string (uuid)

    The Identity Workspace ID is located in the Details Tab in the Identity Workspace Settings.

    authorizationWorkspaceId
    string (uuid)

    The Authorization Workspace ID is located in the Details Tab in the Authorization Workspace Settings.

    description
    string

    POP Description

    Max length200
    vendorName
    string

    Vendor Name

    Valid values[ "PowerBI", "ZScaler" ]
    popConnectionCredentials
    object (PopConnectionCredentials)

    Refer to the SaaS Management Vendors article for instructions and examples on how to configure your vendor credentials with your Policy Orchestration Points (POP).

    Example{ "authenticationMethod": "method", "credentials": {} }
    authenticationMethod
    string
    credentials
    object
    discoveryScopeRule
    object
    mode
    string

    POP Mode.

    Valid values[ "LEARN", "MANAGE" ]
    state
    string
    Valid values[ "DISCOVERY_FAILED", "DISCOVERY_DONE", "DISCOVERY_IN_PROGRESS" ]
    settings
    object
    defaultNewObjectsAccess
    boolean

    Setting for PowerBI to set new tables as public or private.

    meta
    object (meta)

    Response Meta

    total
    integer

    Total number of records

    limit
    integer

    Limit the number of records returned

    offset
    integer

    The starting point for return of records

    401

    Unauthorized

    500

    Internal Server Error

    Was this article helpful?
    What's Next