List of Roles

GET /workspace/roles

List of Roles

cURL

curl --request GET \
  --url https://wks-a1b2c3d4.provisionr.io/api/v1/workspace/roles \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "id": "<string>",
    "name": "<string>",
    "default_grant": true,
    "timestamp": {
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    },
    "count": {
      "workspace_permissions": 123,
      "workspace_logs_parent": 123,
      "workspace_logs_record": 123,
      "workspace_logs_related": 123,
      "workspace_users": 123
    },
    "included": {
      "workspace_permissions": [
        "<unknown>"
      ],
      "workspace_users": [
        "<unknown>"
      ]
    },
    "links": {
      "permissions": "<string>",
      "self": "<string>",
      "workspace_logs_parent": "<string>",
      "workspace_logs_record": "<string>",
      "workspace_logs_related": "<string>",
      "workspace_users": "<string>"
    }
  }
]

Authorizations

Authorization · string · header · required

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

Query Parameters

include · string

Include related resources (permissions, users)

filter[id] · string

Filter by Role ID

filter[name] · string

Filter by role name

filter[name_search] · string

Partial search by role name

filter[default_granted] · string

Filter by default granted status

filter[created_before] · string

Filter by created before date

filter[created_after] · string

Filter by created after date

filter[updated_before] · string

Filter by updated before date

filter[updated_after] · string

Filter by updated after date

Response

200

application/json

The collection of 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

Show child attributes

count · object · required

Counts of related resources

Show child attributes

included · object · required

Included related resources

Show child attributes

links · object · required

API hyperlinks related to the workspace role record

Show child attributes