Skip to main content
GET
Describe a Role

Authorizations

Authorization
string
header
required

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

Path Parameters

role
string
required

Workspace Role ID

Query Parameters

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

Response

WorkspaceRoleDetailedResponseData

id
string
required
Example:

"wsrol_01hq8xyzabc123def456ghi789"

name
string
required

The name of the role. All names are lowercase with only letters and periods. Periods are used for word or namespace separation. All custom roles are automatically prefixed with tenant.

Example:

"workspace.user.viewer"

default_grant
boolean
required

Whether this role is granted to all users by default when they authenticate

Example:

false

timestamp
TimestampBasicData · object
required

The timestamps for the workspace role record

count
object
required

Counts of related resources

included
object
required

Included related resources

API hyperlinks related to the workspace role record