Update a POP by ID

06 Aug 2024
2 Minutes to read

Print
Dark
Light
PDF

Update a POP by ID

Updated on 06 Aug 2024
2 Minutes to read

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Put

/orchestrator/1.0/pops/{popId}

This is an API to update a 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

Header	Value	cURL Line
Content-Type	`application/json`	`-H "Content-Type :application/json"`

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

popId

stringRequired

ID of the POP to update

Body parameters

PowerBI_learn

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

PowerBI_manage

{
  "authorizationWorkspaceId": "4988cfea-527e-4183-8f80-608b0540dc14",
  "description": "description",
  "identityWorkspaceId": "9ca7569f-5635-4cff-a335-74bcb3251ef0",
  "mode": "MANAGE",
  "name": "pop connection name",
  "orchestrationWorkspaceId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "popConnectionCredentials": {
    "authenticationMethod": "method",
    "credentials": {}
  },
  "settings": {
    "defaultNewObjectsAccess": true
  },
  "vendorName": "PowerBI"
}

Expand All

object

POP update request

authorizationWorkspaceId

string (uuid) Required

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

description

string

POP Description

Max length200

identityWorkspaceId

string (uuid) Required

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

mode

string Required

POP Mode. Users are required to set this to MANAGE when using the defaultNewObjectsAccess parameter for Power BI only.

Valid values[ "\"LEARN\"", "\"MANAGE\"" ]

name

string Required

POP Name

Max length50

orchestrationWorkspaceId

string (uuid) Required

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

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

settings

object

defaultNewObjectsAccess

boolean

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

vendorName

string Required

Vendor Name

Valid values[ "\"PowerBI\"", "\"ZScaler\"" ]

Responses

200

Successful response

PowerBI_learn

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

PowerBI_manage

{
  "data": {
    "authorizationWorkspaceId": "4988cfea-527e-4183-8f80-608b0540dc14",
    "description": "description",
    "id": "POPS269J5C16H8N4",
    "identityWorkspaceId": "9ca7569f-5635-4cff-a335-74bcb3251ef0",
    "mode": "LEARN",
    "name": "pop connection name",
    "orchestrationWorkspaceId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "popConnectionCredentials": {
      "authenticationMethod": "method",
      "credentials": {}
    },
    "settings": {
      "defaultNewObjectsAccess": true
    },
    "state": "DISCOVERY_DONE",
    "vendorName": "PowerBI"
  }
}

Expand All

object

Response object

data

object (pop)

authorizationWorkspaceId

string (uuid)

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

description

string

POP Description

Max length200

string

identityWorkspaceId

string (uuid)

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

mode

string

POP Mode.

Valid values[ "\"LEARN\"", "\"MANAGE\"" ]

name

string

POP Name

Max length50

orchestrationWorkspaceId

string (uuid)

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

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

settings

object

defaultNewObjectsAccess

boolean

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

state

string

Valid values[ "\"DISCOVERY_FAILED\"", "\"DISCOVERY_DONE\"", "\"DISCOVERY_IN_PROGRESS\"" ]

vendorName

string

Vendor Name

Valid values[ "\"PowerBI\"", "\"ZScaler\"" ]

401

Unauthorized

500

Internal Server Error

Was this article helpful?

What's Next

SaaS Management Vendors