SDKs
Opal API
- GETGet resources
- PUTPut resources
- POSTPost resources
- GETGet resource by ID
- DELDelete resources
- GETGet resources message channels
- PUTPut resources message channels
- GETGet resources visibility
- PUTPut resources visibility
- GETGet resources reviewers
- PUTPut resources reviewers
- GETGet resources reviewer stages
- PUTPut resources reviewer stages
- GETGet resources non human identities
- GETGet resource users
- POSTPost resources non human identities
- DELDelete resources non human identities
- GETGet resource user
- PUTPut resources users
- POSTPost resources users
- DELDelete resources users
- GETGet resource user access statusdeprecated
- GETGet resources tags
- GETGet resources scoped role permissions
- PUTPut resources scoped role permissions
- GETGet resourcesusers
- GET
curl --request PUT \
--url https://api.opal.dev/v1/resources/{resource_id}/scoped-role-permissions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"permissions": [
{
"target_ids": [
"a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1",
"8294e9c9-deb6-48e9-9c99-da2a1e04a87f"
],
"target_type": "RESOURCE",
"permission_name": "READ"
}
]
}
'{
"permissions": [
{
"target_ids": [
"a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1",
"8294e9c9-deb6-48e9-9c99-da2a1e04a87f"
],
"target_type": "RESOURCE",
"permission_name": "READ"
}
]
}Sets all the scoped role permissions on an OPAL_SCOPED_ROLE resource.
curl --request PUT \
--url https://api.opal.dev/v1/resources/{resource_id}/scoped-role-permissions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"permissions": [
{
"target_ids": [
"a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1",
"8294e9c9-deb6-48e9-9c99-da2a1e04a87f"
],
"target_type": "RESOURCE",
"permission_name": "READ"
}
]
}
'{
"permissions": [
{
"target_ids": [
"a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1",
"8294e9c9-deb6-48e9-9c99-da2a1e04a87f"
],
"target_type": "RESOURCE",
"permission_name": "READ"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the resource whose scoped role permissions belong to. Must be of OPAL_SCOPED_ROLE resource type.
Body
Show child attributes
Show child attributes
The type of the target for the role permission.
RESOURCE, CONNECTION, GROUP, BUNDLE, USER, ACCESS_REVIEW, OWNER "RESOURCE"
The name of the role permission.
READ, READ_ASSIGNMENTS, CREATE, IMPORT, EXPORT, SYNC, DELETE, READ_SETTINGS, EDIT_TAGS, EDIT_SETTINGS, EDIT_SYNC_SETTINGS, EDIT_ASSIGNMENTS, EDIT_REQUEST_CONFIGURATIONS, EDIT_EVENT_STREAM, ASSIGN_UAR_REVIEWERS, SEND_REMINDERS, STOP, REQUEST_ON_BEHALF, RESET_MFA "READ"
The IDs of the entities that this permission applies to. If empty of missing, the permission will have untargeted scope.
[
"a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1",
"8294e9c9-deb6-48e9-9c99-da2a1e04a87f"
]Response
The role permissions that this Opal Scoped Role has.
Show child attributes
Show child attributes
The type of the target for the role permission.
RESOURCE, CONNECTION, GROUP, BUNDLE, USER, ACCESS_REVIEW, OWNER "RESOURCE"
The name of the role permission.
READ, READ_ASSIGNMENTS, CREATE, IMPORT, EXPORT, SYNC, DELETE, READ_SETTINGS, EDIT_TAGS, EDIT_SETTINGS, EDIT_SYNC_SETTINGS, EDIT_ASSIGNMENTS, EDIT_REQUEST_CONFIGURATIONS, EDIT_EVENT_STREAM, ASSIGN_UAR_REVIEWERS, SEND_REMINDERS, STOP, REQUEST_ON_BEHALF, RESET_MFA "READ"
The IDs of the entities that this permission applies to. If empty of missing, the permission will have untargeted scope.
[
"a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1",
"8294e9c9-deb6-48e9-9c99-da2a1e04a87f"
]Was this page helpful?