Autenticazione
Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione members.role.assign; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.
L'ID della tua organizzazione va qui
Questo endpoint accetta l'ID della tua organizzazione direttamente nell'URL come orgId. Sostituiscilo nel percorso: non sono presenti intestazioni o parametri di query alternativi.
L'identificativo della tua organizzazione si trova nella schermata delle chiavi API nella tua dashboard, accanto alla chiave stessa. È lo stesso identificativo in ogni chiamata che effettui.
Provalo
Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.
curl -X PATCH https://api.zinndigital.com/v1/orgs/{orgId}/members/{userId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "role": <string> }'Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API
Dettagli
Sets this member's role in the organization. Requires `members.role.assign` **on that org**. ⛔ **Replaces** the member's roles with the one given rather than adding to them — a person may hold several `Membership` rows, and collapsing them can only ever reduce what they hold, so no path through this endpoint escalates by accident. Three refusals, and they are the same rules an invitation is held to: **403** if the member holds a permission the caller does not (`more_privileged`), **403** if the *role being granted* holds one (`role_not_grantable` — this is what stops any holder of the key promoting themselves to `owner`), and **409** for the org's last owner (`last_owner`). An unknown role is a **422**, never a 403, so a typo is distinguishable from a permission you lack.
Parametri
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
orgId (path) | Uuid | Sì | Organization ID (UUIDv7). |
userId (path) | Uuid | Sì | The user to remove from the organization. |
Corpo della richiesta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
role | string | Sì | A role key from `GET /v1/orgs/{orgId}/roles`. |
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
user_id | Uuid | Sì | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
email | string | Sì | — |
name | string | Sì | Display name; may be empty for an account that never set one. |
roles | string[] | Sì | Every role this person holds in this org, sorted. |
joined_at | string | Sì | When their EARLIEST membership of this org was created. |
is_self | boolean | Sì | Whether this row is the calling user. |
removable | boolean | Sì | — |
not_removable_reason | OrgMemberRemovalBlock | null | Sì | Why not, when `removable` is false. Null when removable — and also null for a caller lacking `members.remove`, because "you cannot remove anyone here" is a fact about the caller… |
role_assignable | boolean | Sì | Whether `PATCH` on this member would be accepted — the caller holds `members.role.assign` here, does not outrank themselves, and this is not the last owner. ⛔ *Which* role may t… |
Errori che questo endpoint può restituire
401 · 403 · 404 · 409 · 422 · 429