Skip to content
Open Console →

Grants

3 endpoints under /api/v1/grants.

GET /api/v1/grants #

List the organization's grants

Responses

200 Every Grant in the acting organization.
Response body
  • grantsGrant[]required
    Show fields
    • idstringrequired
    • subjectTypestring · enumrequired

      membermachine_user

    • subjectIdstringrequired
    • subjectLabelstringrequired
    • rolestringrequired
    • roleNamestringrequired
    • resourcesGrantResource[]required
      Show fields
      • idstringrequired
      • namestringrequired
    • createdBystringrequired
    • createdAtstring · date-timerequired
400 Unknown role/subject, or an invalid resource selector.
Response body
  • errorstringrequired
401 Unauthenticated.
Response body
  • errorstringrequired
403 Requires grant management (owner/admin in v1).
Response body
  • errorstringrequired
POST /api/v1/grants #

Grant a role to a member or machine user

Request body

  • subjectIdstringrequired
  • rolestringrequired
  • resourceIdsstring[]

Responses

201 The created Grant.
Response body
  • idstringrequired
  • subjectTypestring · enumrequired

    membermachine_user

  • subjectIdstringrequired
  • subjectLabelstringrequired
  • rolestringrequired
  • roleNamestringrequired
  • resourcesGrantResource[]required
    Show fields
    • idstringrequired
    • namestringrequired
  • createdBystringrequired
  • createdAtstring · date-timerequired
400 Unknown role/subject, or an invalid resource selector.
Response body
  • errorstringrequired
401 Unauthenticated.
Response body
  • errorstringrequired
403 Requires grant management (owner/admin in v1).
Response body
  • errorstringrequired
DELETE /api/v1/grants/{id} #

Revoke a grant

Parameters

  • id path string required

Responses

204 Revoked.
400 Unknown role/subject, or an invalid resource selector.
Response body
  • errorstringrequired
401 Unauthenticated.
Response body
  • errorstringrequired
403 Requires grant management (owner/admin in v1).
Response body
  • errorstringrequired
404 Unknown grant.
Response body
  • errorstringrequired