Revoca un invito

POST /v1/invitations/{invitation_id}:revoke · autorizzazione invitations:write

Revoca un invito in attesa: il suo link smette di funzionare e la sua e-mail viene cancellata. La scrittura viene registrata nel log di audit come invitation.revoked.

Richiesta

Campo Tipo Obbligatorio Descrizione
invitation_id path sì ID dell'invito (inv_…).

Nessun corpo della richiesta.

Risposta

200 OK con l'invito revocato.

{
  "id": "inv_01j9xt9v3w4y8z0a2b4c6d8e0g",
  "organization_id": "org_01j9xk3m7q8r2s4t6v8w0y2z4a",
  "email": null,
  "role_ids": [
    "rol_01j9xr7s1t2w6x8y0z2a4b6c8e"
  ],
  "application_id": null,
  "delivery": "link_only",
  "delivery_status": "not_sent",
  "status": "revoked",
  "send_count": 1,
  "last_sent_at": "2026-10-12T09:31:00.123456Z",
  "expires_at": "2026-10-19T09:31:00.123456Z",
  "accepted_user_id": null,
  "accepted_at": null,
  "revoked_at": "2026-10-12T10:00:00Z",
  "created_at": "2026-10-12T09:31:00.123456Z",
  "updated_at": "2026-10-12T09:31:00.123456Z",
  "version": 2
}

Errori

HTTP code Quando
404 not_found L'invito non esiste in questo ambiente.
409 conflict L'invito non è in attesa.
401 unauthenticated La credenziale è mancante, non valida o revocata.
403 insufficient_permissions La credenziale non ha l'autorizzazione richiesta.
429 rate_limited È stato superato il limite di richieste; riprova dopo il periodo indicato in Retry-After.
503 service_unavailable Una dipendenza è temporaneamente non disponibile; riprova dopo il periodo indicato in Retry-After.

Esempio

curl -i -X POST "https://api.eu.keenauth.com/v1/invitations/inv_01j9xt9v3w4y8z0a2b4c6d8e0g:revoke" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"

Dati personali

Questo endpoint contiene dati personali: appartenenze alle organizzazioni e inviti. Dati personali nelle API di KeenAuth descrive cosa viene memorizzato, per quanto tempo viene conservato e come viene cancellato. Non inviare in nessun campo categorie particolari di dati personali (salute, dati biometrici, religione, opinioni politiche, orientamento sessuale).