Autentifikacija
Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu members.role.assign; ključ bez nje se odbija s kodom 403, a ne 404.
Gdje dolazi ID vaše organizacije
Ova krajnja točka prihvaća ID vaše organizacije u samom URL-u, kao orgId. Zamijenite ga u stazi — ne postoji zaglavlje ili parametar upita koji će umjesto toga poslužiti.
ID vaše organizacije nalazi se na zaslonu API ključeva u vašoj nadzornoj ploči, pored samog ključa. To je isti ID u svakom pozivu koji uputite.
Isprobajte
Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.
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> }'Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli
Pojedinosti
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
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
orgId (path) | Uuid | Da | Organization ID (UUIDv7). |
userId (path) | Uuid | Da | The user to remove from the organization. |
Tijelo zahtjeva
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
role | string | Da | A role key from `GET /v1/orgs/{orgId}/roles`. |
Odgovor
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
user_id | Uuid | Da | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
email | string | Da | — |
name | string | Da | Display name; may be empty for an account that never set one. |
roles | string[] | Da | Every role this person holds in this org, sorted. |
joined_at | string | Da | When their EARLIEST membership of this org was created. |
is_self | boolean | Da | Whether this row is the calling user. |
removable | boolean | Da | — |
not_removable_reason | OrgMemberRemovalBlock | null | Da | 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 | Da | 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… |
Pogreške koje ova krajnja točka može vratiti
401 · 403 · 404 · 409 · 422 · 429