Skip to content

Get your capabilities

GET
/auth/me/capabilities

Returns the capabilities your account holds across the whole instance, with one of your global roles and the grants and revokes recorded on your account. Any signed-in account can call it.

role is one of your global roles, the first by name if you have several; it’s left out if you have none. capabilities includes what all your global roles give you, not only the one in role. Roles you hold within a team aren’t shown here, and neither are the capabilities they give you.

Your capabilities, role, grants and revokes.

object
user_ref
required
integer format: int64
role
object
id
required
string format: uuid
name
required
string
description
required
string
parent_id

The role this one inherits from. Left out if it has no parent.

string format: uuid
nullable
capabilities
required

Capability codes attached directly to this role. Capabilities it inherits through parent_id aren’t included.

Array<string>
capabilities
required

The capabilities your account holds across the instance: what all your global roles and the roles they inherit from give you, plus global grants, minus global revokes. Capabilities that apply only within a team aren’t included. system.admin counts as every other capability, except ones that need a license feature this instance doesn’t have.

If your capabilities can’t be loaded, this list comes back empty, so an empty list doesn’t always mean you have none.

Array<string>
grants

Capability codes granted to your account directly. Grants that apply within a team are included too, without the team.

Array<string>
revokes

Capability codes revoked from your account directly. Revokes that apply within a team are included too, without the team.

Array<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"
}