Skip to main content
GET
Listar chaves KMS
Requer a ação IAM kms:ListKeys. Consulte permissões de KMS para obter a lista completa, o que cada uma abrange e um exemplo de política.

Autorizações

Authorization
string
header
obrigatório

Um token bearer OAuth 2.0, enviado como Authorization: Bearer <token>. Esta é a forma recomendada de autenticação.

Obtenha o token trocando o par de chaves de acesso de uma conta de serviço em POST /v1/oauth/token com grant_type=client_credentials. Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis com OAuth podem obter e renovar o token para você.

Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso também serve como credencial AWS SigV4 para o endpoint de objetos compatível com S3, que aceita somente esse método de autenticação.

Parâmetros de consulta

limit
integer
padrão:50
Intervalo obrigatório: 1 <= x <= 500
Exemplo:

50

marker
string<uuid>

Token de continuação — o último id de chave da página anterior.

Exemplo:

"7c9e2f4a-1d83-4b6e-9a2c-5f8b0d3e6a17"

state
enum<string>

Filtro de estado opcional (ativado / desativado / pending_deletion). Estado do ciclo de vida:

  • enabled: utilizável para operações de spec/usage
  • disabled: existe; recusa cripto operações; pode ser reativado
  • pending_deletion: agendado para exclusão em scheduled_purge_at; cancelável até então
Opções disponíveis:
enabled,
disabled,
pending_deletion
Exemplo:

"enabled"

name
string

Nome de chave de escopo de conta exato e sensível a maiúsculas e minúsculas. Combinado com outros filtros.

Exemplo:

"prod-master"

crn
string

CRN exato da chave KMS na conta autenticada e na região atual. CRNs mal formados ou vazios retornam 400; CRNs estrangeiros válidos ou não correspondidos retornam uma página vazia. Combinado com filtros de nome e estado.

Exemplo:

"crn:kms:sa-saopaulo-1:acme:key/prod-master"

Resposta

Lista de chaves

keys
object[]
meta
object