Skip to content

Return role assignments for Entitlement Operations global module permissions.

GET
/api/workspace/admin/entitlement-operations/permissions
curl --request GET \
--url https://example.com/api/workspace/admin/entitlement-operations/permissions
  • None
access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

OK

Media typeapplication/json
object
Data

Bounded permission scope with role assignments.

object
Permissions

Permissions that can be managed in this scope.

Array<object>
nullable

Defines a permission that can be assigned to roles.

object
Group

Group identifier used to categorize permissions.

string
nullable
Code

Permission code within the group.

string
nullable
Name

Optional display name or localization key.

string
nullable
Description

Optional description or localization key.

string
nullable
PresentationKind

Defines how a permission is presented when roles are configured.

integer format: int32
Allowed values: 0 1 2
Assignments

Role assignments inside this scope.

Array<object>
nullable

Role assignment for a bounded permission scope.

object
RoleId

Workspace role identifier.

string
nullable
RoleName

Workspace role display name.

string
nullable
IsLocked

Whether the role assignment is system-managed and cannot be edited here.

boolean
PermissionKeys

Normalized permission keys assigned or inherited inside this scope.

Array<string>
nullable
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"Permissions": [
{
"PresentationKind": 0
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}