Skip to content

List all capabilities

GET
/auth/capabilities

Lists every capability defined on this instance, by code, with a short description of each. These are the codes you can grant to users or revoke from them.

Needs the caps.read capability.

Every capability on this instance.

Array<object>
object
code
required

The capability code, such as users.read.

string
Example
users.read
description
required
string

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
"error": "authentication required: sign in and retry with a valid session or API token"
}

Authenticated but missing required capabilities

object
error
required

Human-readable error summary

string
Example
the request could not be completed