Aggiorna un ruolo dell'organizzazione

PATCH /fapi/v1/organizations/{org_id}/roles/{role_id} · chiamato dall'host di accesso dell'ambiente

Modifica il nome o la descrizione di un ruolo dell'organizzazione (JSON merge patch, RFC 7396). I ruoli di ambiente non possono essere modificati qui. Richiede il cookie __Host-idp_session dell'utente autenticato; se il cookie manca, è scaduto o è stato revocato, restituisce 401 unauthenticated. Un'applicazione first-party su un'altra origine può invece inviare il proprio token di accesso Front API (Authorization: DPoP <token> con una prova DPoP; vedi Token di accesso Front API). L'utente deve essere un membro attivo dell'organizzazione con l'autorizzazione idp_roles:manage. Un utente che non è membro riceve 404 not_found, così l'esistenza dell'organizzazione non viene rivelata; un membro senza l'autorizzazione riceve 403 insufficient_permissions. I ruoli dell'organizzazione devono essere abilitati per l'ambiente e inclusi nel suo piano.

Richiesta

Header:

Header Obbligatorio Descrizione
Idp-Client sì Identificatore dell'SDK.
Origin sì Deve essere esattamente https://<sign-in host>.
Content-Type con un body application/json oppure application/merge-patch+json.
If-Match no "<version>" del ruolo come letto l'ultima volta; se il ruolo è cambiato nel frattempo, restituisce 412 precondition_failed e non cambia nulla.

org_id: l'identificatore dell'organizzazione (org_…). role_id: l'identificatore del ruolo (rol_…).

Body (almeno un campo):

Campo Obbligatorio Descrizione
name no Nuovo nome visualizzato.
description no Nuova descrizione.

Risposta

200 OK con un nuovo ETag; il body è il ruolo (vedi Ottieni un ruolo dell'organizzazione).

Errori

Stato Codice Quando
401 unauthenticated Nessun cookie di sessione valido.
403 origin_not_allowed Origin manca o è errato.
403 insufficient_permissions L'utente non ha idp_roles:manage nell'organizzazione.
403 plan_feature_unavailable Il piano dell'ambiente non include i ruoli dell'organizzazione (feature, required_plan).
403 org_custom_roles_disabled I ruoli dell'organizzazione sono disattivati per l'ambiente.
403 role_not_assignable Il ruolo concede un'autorizzazione che l'utente non possiede, oppure l'appartenenza dell'utente la include.
404 not_found Nessuna organizzazione o nessun ruolo dell'organizzazione per questo utente; un ruolo di ambiente, un identificatore inesistente, malformato o di un'altra organizzazione ricevono la stessa risposta.
409 organization_pending_deletion L'organizzazione è programmata per l'eliminazione.
412 precondition_failed If-Match non indica la versione attuale, oppure il ruolo è cambiato durante l'elaborazione della richiesta.
422 validation_failed Un campo non è valido, oppure la patch è vuota (empty_patch).
503 service_unavailable Temporaneamente non disponibile; riprova dopo Retry-After.

Esempio

curl -X PATCH https://example.keenauth.app/fapi/v1/organizations/org_01jbz6x8kq3m2n4p5r6s7t8v9a/roles/rol_01jbz6x8kq3m2n4p5r6s7t8v9w \
  -H "Idp-Client: my-app/1.0.0 (node/22.0.0)" \
  -H "Origin: https://example.keenauth.app" \
  -H "Content-Type: application/merge-patch+json" \
  -H 'If-Match: "1"' \
  -b cookies.txt \
  -d '{"name":"Auditors"}'