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