For the complete documentation index, see llms.txt. This page is also available as Markdown.

Role Grants

List Role Grants

get
Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Query parameters
sort_bystring[]OptionalDefault: []
limitinteger · max: 200OptionalDefault: 50
continuation_tokenanyOptional
statusstring · enum · nullableOptionalPossible values:
Responses
200

Successful Response

application/json
has_morebooleanRequired
continuation_tokenanyOptional
get/v1/{workspace_id}/role-grants

Create Role Grant

post
Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Body
role_idstring · uuidRequired
resource_typestring · enumRequiredPossible values:
resource_keystring · min: 1 · max: 512Required
accessstring · enumRequiredPossible values:
param_bindingstring · max: 256 · nullableOptional
Responses
201

Successful Response

application/json
idstring · uuidRequired
role_idstring · uuidRequired
resource_typestring · enumRequiredPossible values:
resource_keystringRequired
accessstring · enumRequiredPossible values:
param_bindingstring · nullableOptional
statusstring · enumRequiredPossible values:
changed_bystring · uuid · nullableOptional
created_atstring · date-timeRequired
post/v1/{workspace_id}/role-grants

Get Role Grant

get
Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
grant_idstring · uuidRequired
Responses
200

Successful Response

application/json
idstring · uuidRequired
role_idstring · uuidRequired
resource_typestring · enumRequiredPossible values:
resource_keystringRequired
accessstring · enumRequiredPossible values:
param_bindingstring · nullableOptional
statusstring · enumRequiredPossible values:
changed_bystring · uuid · nullableOptional
created_atstring · date-timeRequired
get/v1/{workspace_id}/role-grants/{grant_id}

Delete Role Grant

delete

Supersede an active grant (immutable history) — never a physical delete.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
grant_idstring · uuidRequired
Responses
204

Successful Response

No content

delete/v1/{workspace_id}/role-grants/{grant_id}

No content

Last updated

Was this helpful?