Crea inviti in blocco

POST /v1/invitations:batch · autorizzazione invitations:write

Crea da 1 a 100 inviti (items). Ogni elemento segue le regole di POST /v1/invitations ed è scritto in modo indipendente: un elemento che fallisce non blocca gli altri. La risposta è 200 OK e items mantiene l'ordine della richiesta; lo status di un elemento è 201 (nuovo invito), 200 (un invito in sospeso è stato reinviato) oppure lo stato HTTP del suo errore, e un elemento fallito contiene error con code, status e puntatori ai campi nella forma /items/<i>/…. L'accept_url degli elementi link_only viene restituito solo in questa risposta (Cache-Control: no-store); una risposta riprodotta con Idempotency-Key non contiene link e restituisce secret_redacted: true. Un elemento senza organization_id è un invito all'ambiente. Un elemento email viene inviato via e-mail; se l'invio delle e-mail di invito non è configurato per il deployment, si ottiene un errore dell'elemento 501 not_implemented, e un application_id che non esiste in questo ambiente produce un errore dell'elemento 404 not_found. Ogni invito scritto viene registrato nell'audit come invitation.created.

Richiesta

Campo Tipo Obbligatorio Descrizione
items object[] sì Da 1 a 100 inviti, ciascuno con i campi di POST /v1/invitations.
Idempotency-Key header no Fa sì che un nuovo tentativo restituisca il risultato memorizzato, senza link.

Risposta

200 OK con un risultato per ogni elemento.

{
  "items": [
    {
      "status": 201,
      "invitation": {
        "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>"
      }
    },
    {
      "status": 422,
      "error": {
        "code": "validation_failed",
        "status": 422,
        "errors": [
          {
            "pointer": "/items/1/email",
            "code": "invalid_value"
          }
        ]
      }
    }
  ]
}

Errori

HTTP code Quando
422 validation_failed items manca, è vuoto oppure contiene più di 100 elementi.
401 unauthenticated La credenziale manca, non è valida o è stata revocata.
403 insufficient_permissions La credenziale non ha l'autorizzazione richiesta. Un elemento con un ruolo privilegiato (is_privileged) fallisce con questo errore dell'elemento quando la credenziale non ha roles:write.
429 rate_limited È stato superato il limite di frequenza; 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:batch" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 0f6c1d2e3a4b5c6d7e8f9a0b" \
  -d '{"items":[{"organization_id":"org_01j9xk3m7q8r2s4t6v8w0y2z4a","email":"ada@example.com","delivery":"link_only"},{"organization_id":"org_01j9xk3m7q8r2s4t6v8w0y2z4a","email":"bob@example.com","delivery":"link_only"}]}'

Dati personali

Questo endpoint trasporta 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 categorie particolari di dati personali (salute, dati biometrici, religione, opinioni politiche, orientamento sessuale) in nessun campo.