Pular para o conteúdo principal

Get User API Keys

GET 
/company/apikey/

Recupera todas as API Keys criadas pelo usuário autenticado, permitindo auditar e gerenciar as próprias credenciais de acesso programático.

Objetivo​

Fornecer ao usuário visibilidade sobre suas API Keys ativas, incluindo seus tipos e códigos temporais necessários para exclusão.

Casos de Uso​

  • Auditar quais API Keys estão ativas para o usuário
  • Obter o temp_code necessário para excluir uma key específica
  • Verificar o tipo de permissões de cada key
  • Identificar keys antigas que devem ser rotacionadas

Fluxo de Operação​

  1. Valida que o usuário existe e pertence a uma empresa
  2. Busca todas as chaves associadas ao ID do usuário
  3. Oculta parcialmente as chaves por segurança (mostra os primeiros 8 e os últimos 4 caracteres)
  4. Retorna a lista de chaves com seus metadados

Mecanismo de Ocultação​

As API Keys são mostradas parcialmente:

  • Formato: sk_live_*****5678 (primeiros 8 + asteriscos + últimos 4 caracteres)
  • As chaves completas só são mostradas no momento da criação
  • Não é possível recuperar a chave completa posteriormente

Considerações Importantes​

  • Retorna apenas chaves próprias do usuário (não de outros usuários da empresa)
  • As chaves excluídas (soft delete) não aparecem na lista
  • O campo temp_code é necessário para operações de exclusão

Request​

Responses​

Lista de chaves de API do usuário

Response Headers