Skip to main content
GET
List your credential's own grants
Every credential may read its own grants, so this operation needs no permission, and it takes only limit and cursor. It lists the role grants behind the calling credential at every scope (a compatibility role’s grant is left out, as listGrants leaves it out), each with its role and the role’s name, its scope in words and its dates:
  • a Personal key lists its active owner’s grants. The key’s scopes narrow what they allow, not which exist; getMyAuthority answers what is effective at one place;
  • a platform key lists its own grants;
  • an External App, or its companion key, lists the app’s grants, never its owner’s.
Who gave a grant and why are never returned. The list pages at the database, so meta.partial is always false.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Query Parameters

limit
integer
default:100

Items per page, 1 to 100 (default 100); a larger value is a 400 too_big. A page may hold fewer items than limit while meta.hasMore is true; continue with meta.nextCursor.

Required range: 1 <= x <= 100
cursor
string

The previous page's meta.nextCursor; any other value is 400.

Minimum string length: 1

Response

The credential's grants

data
object[]
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.