Skip to content

List all permission scopes grouped by resource

GET
/v1/permissions
curl --request GET \
--url https://example.com/v1/permissions \
--header 'Authorization: Bearer <token>' \
--header 'X-Tenant-ID: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'
X-Tenant-ID
required
string format: uuid

Tenant identifier. Must match the tenant associated with the credential. Returns 403 tenant_mismatch if the credential and header belong to different tenants.

OK

Media type application/json
object
data
required
Array<object>
object
resource
required
string
scopes
required
Array<object>
object
scope
required
string
resource
required
string
action
required
string
name
required
string
description
string
nullable
Example generated
{
"data": [
{
"resource": "example",
"scopes": [
{
"scope": "example",
"resource": "example",
"action": "example",
"name": "example",
"description": "example"
}
]
}
]
}

Unauthenticated

Media type application/json
object
code
required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string
message
required

Human-readable description of the error.

string
details

Optional additional context about the error.

object
key
additional properties
any
notices

Policy notices from determining Cedar rules, if applicable.

Array<string>
Example generated
{
"code": "example",
"message": "example",
"details": {},
"notices": [
"example"
]
}