Pular para o conteúdo principal

Delete User API Key

DELETE 
/company/apikey/:tempCode

Elimina permanentemente uma API Key criada pelo usuário autenticado, revogando o acesso programático associado a essa credencial.

Objetivo​

Permitir que os usuários revoguem suas próprias API Keys quando não são mais necessárias ou quando há suspeita de que foram comprometidas.

Casos de Uso​

  • Revogar o acesso de uma integração descontinuada
  • Eliminar uma chave comprometida ou vazada acidentalmente
  • Rotacionar credenciais eliminando a antiga e criando uma nova
  • Limpar chaves de teste que não são mais utilizadas

Fluxo de operação​

flowchart TD
  A[Receber Requisição DELETE] --> B{Usuário Autenticado?}
  B -->|Não| C[401 Unauthorized]
  B -->|Sim| D{Usuário Existe?}
  D -->|Não| E[404 USER_NOT_FOUND]
  D -->|Sim| F{temp_code Fornecido?}
  F -->|Não| G[400 TEMP_CODE_NOT_PROVIDED]
  F -->|Sim| H{API Key Existe?}
  H -->|Não| I[404 APIKEY_NOT_FOUND]
  H -->|Sim| J{Key Pertence ao Usuário?}
  J -->|Não| K[401 CANT_DELETE]
  J -->|Sim| L[Soft Delete Key]
  L --> M[200 APIKEY_DELETED]

Considerações importantes​

  • Apenas chaves pertencentes ao usuário podem ser eliminadas
  • Usa o temp_code (não a chave real) para identificar a API Key
  • A eliminação é um soft delete (plugin mongoose-delete)
  • A chave eliminada não aparecerá em listagens futuras
  • A eliminação não pode ser desfeita através da API pública

Formato do temp_code​

  • String alfanumérica de aproximadamente 25 caracteres
  • Exemplo: 2c3srejxqa176128918935tzv
  • Obtido em GET /company/apikey/ ou ao criar a chave

Notas de Segurança​

  • Verificar que todas as integrações

Request​

Responses​

Chave da API removida com sucesso

Response Headers