Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) members.read jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.
A szervezet azonosítójának helye
Ez a végpont magában az URL-ben várja a szervezeted azonosítóját, mégpedig orgId formában. Helyettesítsd be az útvonalba – nincs olyan fejléc vagy lekérdezési paraméter, amely ezt helyettesítené.
A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
curl -X GET https://api.zinndigital.com/v1/orgs/{orgId}/members \
-H "Authorization: Bearer zdk_live_…"Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
The org's members with their roles, paged over **users** (a person holding two roles is one row, not two). Each row carries `removable` and, when false, `not_removable_reason` — the engine's own answer, so a client never re-derives the removal policy and offers a button that will be refused. Requires `members.read`; a caller without `members.remove` sees `removable: false` on everyone.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
orgId (path) | Uuid | Igen | Organization ID (UUIDv7). |
cursor (query) | string | Nem | Opaque cursor from a previous page's `page.next_cursor`. |
limit (query) | integer | Nem | Maximum items to return (page size). |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
data | OrgMember[] | Igen | — |
page | PageMeta | Igen | — |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 404 · 429