Contents x
    Create a POP
    • 26 Aug 2024
    • 2 Minutes to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    Create a POP

    • Updated on 26 Aug 2024
    • 2 Minutes to read
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Post
    /orchestrator/1.0/pops

    This is an API to create a new Policy Orchestration Point (POP).

    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
    HeaderValuecURL Line
    Content-Typeapplication/json-H "Content-Type :application/json"

    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

    Body parameters
    create_example
    {
  "name": "pop connection name",
  "orchestrationWorkspaceId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "identityWorkspaceId": "9ca7569f-5635-4cff-a335-74bcb3251ef0",
  "authorizationWorkspaceId": "4988cfea-527e-4183-8f80-608b0540dc14",
  "mode": "LEARN",
  "vendorName": "PowerBI",
  "popConnectionCredentials": {
    "authenticationMethod": "method",
    "credentials": {},
    "discoveryScopeRule": {}
  }
}
    Expand All
    object

    POP create request

    name
    string Required

    POP Name

    orchestrationWorkspaceId
    string Required

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

    identityWorkspaceId
    string Required

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

    authorizationWorkspaceId
    string Required

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

    mode
    string Required

    POP Mode

    Valid values[ "LEARN", "MANAGE" ]
    popConnectionCredentials
    object (PopConnectionCredentials) Required

    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 Required
    credentials
    object Required
    discoveryScopeRule
    object
    vendorName
    string Required

    Vendor Name

    Valid values[ "PowerBI", "ZScaler" ]
    Responses
    201

    Successful response

    create_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": {},
      "discoveryScopeRule": {}
    }
  }
}
    Expand All
    object

    Response object

    data
    object (pop)
    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.

    401

    Unauthorized

    500

    Internal Server Error

    Was this article helpful?
    What's Next