access
GET /v1/orgs/{orgId}/roles
List the roles the caller may grant in an organization.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز 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