Invita una persona a un'organizzazione

POST /v1/invitations · autorizzazione invitations:write

Crea un invito per un indirizzo email che deve entrare nell'organizzazione. Senza organization_id l'invito è un invito di ambiente: è il link di iscrizione per la modalità di iscrizione solo su invito, non apre alcuna appartenenza e non può includere ruoli (role_ids restituisce 422 validation_failed), e la risposta ha organization_id: null. delivery è obbligatorio: email invia l'email di invito con il template di invito dell'ambiente (delivery_status: queued), il link si trova solo nell'email e la risposta non contiene accept_url; link_only non invia alcuna email e restituisce il link da condividere. Il link di accettazione (accept_url) viene restituito solo in questa risposta, una volta sola; nessun endpoint lo restituisce in seguito. La risposta contiene Cache-Control: no-store, e una risposta riprodotta per lo stesso Idempotency-Key omette il link e contiene secret_redacted: true. Se l'email di invito non è configurata per il deployment (solo in configurazioni non di produzione), la consegna email restituisce 501 not_implemented e non viene scritto nulla. Se per l'organizzazione e l'email esiste già un invito in sospeso con gli stessi ruoli, viene rinviato con un nuovo link e la risposta è 200. Un invito in sospeso scaduto ma non ancora elaborato viene contrassegnato come expired nella stessa richiesta e ne viene creato uno nuovo (registrato nell'audit come invitation.expired). Un invito email in sospeso con gli stessi ruoli viene rinviato via email: la risposta è 200 con delivery: email e senza accept_url. La scrittura viene registrata nell'audit come invitation.created.

Richiesta

Campo Tipo Obbligatorio Descrizione
organization_id string no ID dell'organizzazione (org_…); omettilo per un invito di ambiente (senza ruoli).
email string sì Indirizzo email dell'invitato, fino a 320 caratteri.
delivery string sì email (link solo nell'email) oppure link_only (link solo in questa risposta).
role_ids string[] no Ruoli concessi all'accettazione (rol_…), massimo 10; se vuoto, viene assegnato il ruolo membro predefinito.
application_id string no Applicazione in cui atterra l'invitato (app_…); deve esistere in questo ambiente.
ttl_days integer no Da 1 a 30; il valore predefinito è invitation_ttl_days dell'ambiente (7).

Risposta

201 Created con l'invito e il relativo link di accettazione (200 OK quando è stato rinviato un invito in sospeso).

{
  "id": "inv_01j9xt9v3w4y8z0a2b4c6d8e0g",
  "organization_id": "org_01j9xk3m7q8r2s4t6v8w0y2z4a",
  "email": "ada@example.com",
  "role_ids": [
    "rol_01j9xr7s1t2w6x8y0z2a4b6c8e"
  ],
  "application_id": null,
  "delivery": "link_only",
  "delivery_status": "not_sent",
  "status": "pending",
  "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": null,
  "created_at": "2026-10-12T09:31:00.123456Z",
  "updated_at": "2026-10-12T09:31:00.123456Z",
  "version": 1,
  "accept_url": "https://acme.eu.keenauth.app/u/login?invitation=<token>"
}

Errori

HTTP codice Quando
404 not_found L'organizzazione o l'applicazione non esiste in questo ambiente.
409 invitation_already_pending Per questa email esiste un invito in sospeso con ruoli diversi.
409 membership_already_exists L'email appartiene già a un membro.
409 organization_disabled L'organizzazione è disabilitata.
422 invitation_invalid L'invito non può essere creato con questi valori.
422 validation_failed Un campo manca o non è valido.
429 invite_rate_limited L'invito è stato rinviato meno di 10 minuti fa oppure già 5 volte.
501 not_implemented delivery è email e l'email di invito non è configurata per il deployment.
401 unauthenticated La credenziale manca, non è valida o è stata revocata.
403 insufficient_permissions La credenziale non ha l'autorizzazione richiesta. Assegnare un ruolo privilegiato (is_privileged) richiede anche roles:write; senza di essa non viene scritto nulla e required_permissions elenca entrambe le autorizzazioni.
429 rate_limited È stato superato il limite di richieste; riprova dopo il periodo indicato in Retry-After.
503 service_unavailable Una dipendenza non è temporaneamente disponibile; riprova dopo il periodo indicato in Retry-After.

Esempio

curl -i -X POST "https://api.eu.keenauth.com/v1/invitations" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"organization_id":"org_01j9xk3m7q8r2s4t6v8w0y2z4a","email":"ada@example.com","delivery":"link_only","role_ids":["rol_01j9xr7s1t2w6x8y0z2a4b6c8e"]}'

Dati personali

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