Skip to main content
GET
Describe a Permission

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

permission
string
required

The permission ID

Query Parameters

include
enum<string>[]
Available options:
roles,
roles-count,
roles-exists

Response

WorkspacePermissionDetailedResponseData

id
string
required
Example:

"wsprm_01hq8xyzabc123def456ghi789"

name
string
required

The name of the permission. All names are lowercase with only letters and periods. Permissions are hard coded into the application based on the UI pages or API endpoints that the user can access. You can create custom roles and assign one or more existing permissions

Example:

"workspace.user.view"

timestamp
TimestampBasicData · object
required

The timestamps for the workspace permission record

count
object
required

Counts of related resources

included
object
required

Included related resources

API hyperlinks related to the workspace permission record.

self: string workspace_roles: string }

Minimum array length: 1