Skip to content
Open Console →

Roles

3 endpoints under /api/v1/roles.

GET /api/v1/roles #

List the organization's custom roles

Responses

200 Org-authored roles.
Response body
  • rolesCustomRole[]required
    Show fields
    • idstringrequired
    • rawIdstringrequired
    • namestringrequired
    • descriptionstringrequired
    • permissionsstring[]required
    • scopablebooleanrequired
    • createdBystringrequired
    • createdAtstring · date-timerequired
400 Invalid role (bad name or unknown permissions).
Response body
  • errorstringrequired
401 Unauthenticated.
Response body
  • errorstringrequired
403 Requires role management (owner/admin in v1).
Response body
  • errorstringrequired
POST /api/v1/roles #

Author a custom role

Request body

  • namestringrequired
  • descriptionstring
  • permissionsstring[]required

Responses

201 The created custom role.
Response body
  • idstringrequired
  • rawIdstringrequired
  • namestringrequired
  • descriptionstringrequired
  • permissionsstring[]required
  • scopablebooleanrequired
  • createdBystringrequired
  • createdAtstring · date-timerequired
400 Invalid role (bad name or unknown permissions).
Response body
  • errorstringrequired
401 Unauthenticated.
Response body
  • errorstringrequired
403 Requires role management (owner/admin in v1).
Response body
  • errorstringrequired
DELETE /api/v1/roles/{id} #

Delete a custom role

Parameters

  • id path string required

Responses

204 Deleted.
400 Invalid role (bad name or unknown permissions).
Response body
  • errorstringrequired
401 Unauthenticated.
Response body
  • errorstringrequired
403 Requires role management (owner/admin in v1).
Response body
  • errorstringrequired
404 Unknown custom role.
Response body
  • errorstringrequired