access
GET /v1/orgs/{orgId}/roles
List the roles the caller may grant in an organization.
Pagpapatotoo
Magpadala ng API key bilang isang bearer token. Kailangang taglayin ng key ang pahintulot na members.read; ang key na wala nito ay tatanggihan gamit ang 403, hindi 404.
Kung saan mapupunta ang id ng iyong organisasyon
Kinukuha ng endpoint na ito ang id ng iyong organisasyon sa mismong URL bilang orgId. Palitan ito sa path — walang header o query parameter na gagawa nito sa halip.
Ang id ng iyong organisasyon ay nasa screen ng mga API key sa iyong dashboard, sa tabi mismo ng key. Ito ang parehong id sa bawat tawag na gagawin mo.
Subukan ito
Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.
curl -X GET https://api.zinndigital.com/v1/orgs/{orgId}/roles \
-H "Authorization: Bearer zdk_live_…"Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API
Mga Detalye
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.
Mga Parameter
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
orgId (path) | Uuid | Oo | Organization ID (UUIDv7). |
Tugon
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
data | AssignableRole[] | Oo | — |
Mga error na maibabalik ng endpoint na ito
401 · 403 · 404 · 429