Skip to content

Get roles.

GET
/backend/v1/auth/roles

Retrieves a list of available roles associated with a given resource,
with the option to adjust the limit for more results.

Authorizations

HTTPBearer
TypeHTTP (bearer)

Parameters

Query Parameters

projectId

Returns roles associated with the specified project. If not provided, organization roles are returned

limit

Max number of items to be returned.

Typeinteger
default10
maximum100
minimum1
cursor

Pass cursor from response to get next or prev page.

Responses

Successful Response
application/json
JSON
{
"next": "string",
"prev": "string",
"roles": [
{
"id": "string",
"memberCount": 0,
"name": "string",
"permissions": [
[
]
],
"projectId": "string",
"system": true
}
]
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

Updated at: