Passa al contenuto principale

Delete User API Key

DELETE 
/company/apikey/:tempCode

Elimina permanentemente una chiave API creata dall'utente autenticato, revocando l'accesso programmatico associato a quella credenziale.

Obiettivo​

Consentire agli utenti di revocare le proprie chiavi API quando non sono più necessarie o quando si sospetta che siano state compromesse.

Casi d'Uso​

  • Revocare l'accesso di un'integrazione dismessa
  • Eliminare una chiave compromessa o accidentalmente divulgata
  • Ruotare le credenziali eliminando quella vecchia e creandone una nuova
  • Pulire le chiavi di test che non vengono più utilizzate

Flusso operativo​

flowchart TD
  A[Ricevi Richiesta DELETE] --> B{Utente Autenticato?}
  B -->|No| C[401 Unauthorized]
  B -->|Sì| D{Utente Esiste?}
  D -->|No| E[404 USER_NOT_FOUND]
  D -->|Sì| F{temp_code Fornito?}
  F -->|No| G[400 TEMP_CODE_NOT_PROVIDED]
  F -->|Sì| H{Chiave API Esiste?}
  H -->|No| I[404 APIKEY_NOT_FOUND]
  H -->|Sì| J{Chiave Appartiene all'Utente?}
  J -->|No| K[401 CANT_DELETE]
  J -->|Sì| L[Soft Delete della Chiave]
  L --> M[200 APIKEY_DELETED]

Considerazioni importanti​

  • È possibile eliminare solo le chiavi proprie dell'utente
  • Utilizza il temp_code (non la chiave reale) per identificare la chiave API
  • L'eliminazione è un soft delete (plugin mongoose-delete)
  • La chiave eliminata non apparirà negli elenchi futuri
  • Non è possibile annullare l'eliminazione tramite l'API pubblica

Formato del temp_code​

  • Stringa alfanumerica di circa 25 caratteri
  • Esempio: 2c3srejxqa176128918935tzv
  • Si ottiene da

Request​

Responses​

Chiave API eliminata con successo

Response Headers