Describe a Permission

GET /workspace/permissions/{permission}

Describe a Permission

cURL

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

200

{
  "id": "<string>",
  "name": "<string>",
  "timestamp": {
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z"
  },
  "count": {
    "workspace_roles": 123
  },
  "included": {
    "workspace_roles": [
      {
        "id": "<string>",
        "name": "<string>",
        "default_grant": true
      }
    ]
  },
  "links": [
    "<string>"
  ]
}

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 · string

Available includes are roles, roles-count, roles-exists. You can include multiple options by separating them with a comma.

Response

200

application/json

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

Show child attributes

count · object · required

Counts of related resources

Show child attributes

included · object · required

Included related resources

Show child attributes

links · string[] · required

API hyperlinks related to the workspace permission record.

self: string workspace_roles: string }