access
GET /v1/orgs/{orgId}/roles
List the roles the caller may grant in an organization.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл members.read; ключ без нього відхиляється з кодом 403, а не 404.
Де вказується ідентифікатор вашої організації
Ця кінцева точка приймає ідентифікатор вашої організації безпосередньо в URL як orgId. Підставте його в шлях — немає заголовка чи параметра запиту, які б замінили це.
Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X GET https://api.zinndigital.com/v1/orgs/{orgId}/roles \
-H "Authorization: Bearer zdk_live_…"Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
Filtered by the same escalation rule the invite flow enforces (a role holding a permission the caller lacks is not grantable, register #31), so every role returned is one an invitation will accept. Requires `members.read`. Unpaged — the role catalogue is a fixed, small set.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
orgId (path) | Uuid | Так | Organization ID (UUIDv7). |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
data | AssignableRole[] | Так | — |
Помилки, які може повертати ця кінцева точка
401 · 403 · 404 · 429