access
GET /v1/sites/{siteId}/collaborator-roles
The per-site roles that may be granted here.
身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限,因此请为您的密钥赋予所需的最小权限,并通过检查响应来确认,而不是盲目假设。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/collaborator-roles \
-H "Authorization: Bearer zdk_live_…"已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
The roles a collaborator may be given on this site, so a form offers only choices the engine will accept. Fixed today; it exists because the first time a plan tier or a reseller policy limits which per-site roles may be conferred, every screen that hardcoded three choices is silently wrong and one that asked is not. collaborator_role_seeded reports whether the underlying organisation role exists in this deployment. It distinguishes "nobody has been granted anything yet" from "the role catalogue was never seeded, so every grant will fail to narrow" — two states that otherwise look identical from an empty list.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
siteId (path) | Uuid | 是 | Site ID (UUIDv7). |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
items | object[] | 是 | — |
collaborator_role_seeded | boolean | 是 | Whether the site_collaborator organisation role exists in this deployment. See the endpoint description: it separates an empty answer from a blind one. |
此端点可能返回的错误
401 · 403 · 404 · 429