This is an API to update a Policy Orchestration Point (POP).
Notice
Accessing the APIs is through a dedicated domain/URL, according to your PlainID Tenant LocationImportant 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 |
|---|---|---|
| Accept | `application/json` | `-H"Accept: application/json"` |
| Content Type | `application/json` | `-H"Content-Type: application/json"` |
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 in the Try It or Code Sample tabs. You can then copy the cURL sample from the Code Sample tab in the correct format.
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.
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
POP ID. You can find the POP ID using the GET List of POPs API or through the UI under your POP settings.
{
"orchestrationWorkspaceId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"identityWorkspaceId": "9ca7569f-5635-4cff-a335-74bcb3251ef0",
"authorizationWorkspaceId": "4988cfea-527e-4183-8f80-608b0540dc14",
"description": "description",
"mode": "LEARN",
"name": "pop connection name",
"vendorName": "PowerBI",
"popConnectionCredentials": {
"authenticationMethod": "method",
"credentials": {}
}
}{
"orchestrationWorkspaceId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"identityWorkspaceId": "9ca7569f-5635-4cff-a335-74bcb3251ef0",
"authorizationWorkspaceId": "4988cfea-527e-4183-8f80-608b0540dc14",
"description": "description",
"mode": "MANAGE",
"name": "pop connection name",
"vendorName": "PowerBI",
"popConnectionCredentials": {
"authenticationMethod": "method",
"credentials": {}
},
"settings": {
"defaultNewObjectsAccess": true
}
}POP update request
POP Name
The Orchestration Workspace ID is located in the Details Tab in the Orchestration Workspace Settings.
The Identity Workspace ID is located in the Details Tab in the Identity Workspace Settings.
The Authorization Workspace ID is located in the Details Tab in the Authorization Workspace Settings.
POP Description
POP Mode. Users are required to set this to MANAGE when using the defaultNewObjectsAccess parameter for Power BI only.
Vendor Name
Refer to the SaaS Management Vendors article for instructions and examples on how to configure your vendor credentials with your Policy Orchestration Points (POP).
This parameter is specific to Power BI. See the SaaS Management Vendors article for more information.
Setting for PowerBI to set new tables as public or private.
Successful response
{
"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": {}
}
}
}{
"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": {}
},
"settings": {
"defaultNewObjectsAccess": true
}
}
}Response object
POP Name
The Orchestration Workspace ID is located in the Details Tab in the Orchestration Workspace Settings.
The Identity Workspace ID is located in the Details Tab in the Identity Workspace Settings.
The Authorization Workspace ID is located in the Details Tab in the Authorization Workspace Settings.
POP Description
Vendor Name
Refer to the SaaS Management Vendors article for instructions and examples on how to configure your vendor credentials with your Policy Orchestration Points (POP).
This parameter is specific to Power BI. See the SaaS Management Vendors article for more information.
POP Mode.
Setting for PowerBI to set new tables as public or private.
Unauthorized
Internal Server Error