access

GET `/v1/orgs/{orgId}/roles`

List the roles the caller may grant in an organization.

Pengesahan

Hantar kunci API sebagai token pembawa. Kunci tersebut mesti membawa kebenaran members.read; kunci yang tidak mempunyainya akan ditolak dengan 403, bukan 404.

Tempat ID organisasi anda diletakkan

Titik akhir ini mengambil ID organisasi anda dalam URL itu sendiri, sebagai orgId. Gantikannya ke dalam laluan — tiada pengepala atau parameter pertanyaan yang akan melakukan sebaliknya.

ID organisasi anda terletak pada skrin kekunci API dalam papan pemuka anda, di sebelah kekunci itu sendiri. Ia adalah ID yang sama dalam setiap panggilan yang anda buat.

Cuba

Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.

curl -X GET https://api.zinndigital.com/v1/orgs/{orgId}/roles \
  -H "Authorization: Bearer zdk_live_…"

Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API

Butiran

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.

Parameter

Nama	Jenis	Diperlukan	Apakah ia
`orgId (path)`	`Uuid`	Ya	Organization ID (UUIDv7).

Respons

Nama	Jenis	Diperlukan	Apakah ia
`data`	`AssignableRole[]`	Ya	—

Ralat yang boleh dikembalikan oleh titik akhir ini

401 · 403 · 404 · 429