Skip to content

Product documentation

Roles

RBAC roles and role-permission bindings (SSO-1891).

Roles

RBAC roles and role-permission bindings (SSO-1891).

Base URL: https://api.stg.thoryn.org

Operations

MethodPathSummaryScopes
GET/api/v1/rolesRoles Listtenant:roles.read
POST/api/v1/rolesRoles Createtenant:roles.write
GET/api/v1/roles/{id}Roles Gettenant:roles.read
PATCH/api/v1/roles/{id}Roles Patchtenant:roles.write
DELETE/api/v1/roles/{id}Roles Deletetenant:roles.write
GET/api/v1/roles/{id}/assignmentsRoles List Assignmentstenant:roles.read
GET/api/v1/roles/{id}/permissionsRoles List Permissionstenant:roles.read
PUT/api/v1/roles/{id}/permissionsRoles Set Permissionstenant:roles.write

Operation details

GET /api/v1/roles

Roles List

  • Operation ID: rolesList
  • Required scopes: tenant:roles.read

Parameters:

NameInRequiredTypeDescription
limitquerynointeger
cursorquerynostring

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.Problem (problem+json)

POST /api/v1/roles

Roles Create

  • Operation ID: rolesCreate
  • Required scopes: tenant:roles.write

Request body (required): application/jsonCreateRoleRequest

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.Problem (problem+json)

GET /api/v1/roles/{id}

Roles Get

  • Operation ID: rolesGet
  • Required scopes: tenant:roles.read

Parameters:

NameInRequiredTypeDescription
idpathyesstring

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.Problem (problem+json)

PATCH /api/v1/roles/{id}

Roles Patch

  • Operation ID: rolesPatch
  • Required scopes: tenant:roles.write

Parameters:

NameInRequiredTypeDescription
idpathyesstring

Request body (required): application/jsonUpdateRoleRequest

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.Problem (problem+json)

DELETE /api/v1/roles/{id}

Roles Delete

  • Operation ID: rolesDelete
  • Required scopes: tenant:roles.write

Parameters:

NameInRequiredTypeDescription
idpathyesstring

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.Problem (problem+json)

GET /api/v1/roles/{id}/assignments

Roles List Assignments

  • Operation ID: rolesListAssignments
  • Required scopes: tenant:roles.read

Parameters:

NameInRequiredTypeDescription
idpathyesstring
limitquerynointeger
cursorquerynostring

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.Problem (problem+json)

GET /api/v1/roles/{id}/permissions

Roles List Permissions

  • Operation ID: rolesListPermissions
  • Required scopes: tenant:roles.read

Parameters:

NameInRequiredTypeDescription
idpathyesstring
limitquerynointeger
cursorquerynostring

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.Problem (problem+json)

PUT /api/v1/roles/{id}/permissions

Roles Set Permissions

  • Operation ID: rolesSetPermissions
  • Required scopes: tenant:roles.write

Parameters:

NameInRequiredTypeDescription
idpathyesstring

Request body (required): application/jsonSetRolePermissionsRequest

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.Problem (problem+json)