Pular para o conteúdo principal
GET
List management keys
Guia relacionado: guia de Chaves de gerenciamento. Consulte o guia de Chaves de gerenciamento para um passo a passo com exemplos.

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de consulta

limit
integer<int32>

Page size, 1–200. Unset uses the server default (25).

starting_after
string

Cursor for forward pagination. Set to the management_key_id of the last item from the previous page.

ending_before
string

Cursor for backward pagination. Set to the management_key_id of the first item from the previous page.

status
enum<string>

Optional filter: only return keys with this status.

Opções disponíveis:
MANAGEMENT_KEY_STATUS_ACTIVE,
MANAGEMENT_KEY_STATUS_DISABLED,
MANAGEMENT_KEY_STATUS_REVOKED

Optional case-insensitive substring match against the management-key name. Empty means no name filter.

permission_mode
enum<string>[]

Optional filter: only return keys whose permission mode is one of the listed presets. Empty means no permission-mode filter.

Opções disponíveis:
MANAGEMENT_PERMISSION_MODE_ALL,
MANAGEMENT_PERMISSION_MODE_RESTRICTED,
MANAGEMENT_PERMISSION_MODE_READ_ONLY

Resposta

OK

object
string
obrigatório

Object discriminator for list responses; always list.

data
object[]
obrigatório

Page of management-keys, ordered newest first. token_hash and api_key are always elided in list responses.

has_more
boolean
obrigatório

Whether more management-keys are available in the selected pagination direction.