跳到主要内容
Sursa Developers

GET/v1/groups

列出组织的用户组

list_groups

不带 kind 时，返回普通用户组、“All members”（全体成员）和角色组。只有显式指定 kind=single_user 时才返回个人组（single_user）。all_members、role 和 single_user 用户组的成员及其 members_count 都根据组织的用户计算得出。

身份验证

在 Authorization 请求头中传入 API 密钥：Authorization: Bearer <密钥>。

查询参数

  • kindGroupKind
  • limitinteger

    每页数量。不传 limit 和 cursor 时返回整个列表；传入时最多返回 limit 项，下一页通过 Link（rel="next"）和 X-Next-Cursor 头给出。

    ≥ 1, ≤ 200

  • cursorstring

    下一页的游标，取自 X-Next-Cursor 或上一个响应（筛选条件相同）的 next_cursor；游标中包含每页数量。与 offset 同时使用时返回 422 validation.failed；属于其他列表、其他筛选条件或格式错误的游标返回 400 api.cursor_invalid。

    length ≤ 512

  • updated_sincestring (date-time)

    只返回 updated_at 不早于此时刻（带时区偏移的 RFC 3339）的对象，用于同步。使用该参数时，列表按 updated_at 升序排列，再按 id 排序，游标也按这个顺序继续。已删除的对象不会列出：删除以事件的形式通知。

    length ≤ 512

响应

200成功响应

响应头

  • Link

    下一页的地址，<…>; rel="next"。没有此头表示当前是最后一页。

  • X-Next-Cursor

    下一页的游标，用于 cursor 参数。没有此头表示当前是最后一页。

  • RateLimit-Policy

    当前生效的限制，格式遵循 IETF 草案 draft-ietf-httpapi-ratelimit-headers：以逗号分隔的项 "<name>";q=<quota>;w=<window in seconds>。key 是 API 密钥的请求速率（配额即突发量，时间窗口是配额完全恢复所需的时间；会话为 user，无凭据时为 ip）；minute、day 和 month 是组织按 UTC 计算的自然分钟、自然日和自然月的配额。

  • RateLimit

    RateLimit-Policy 中每项限制的剩余量："<name>";r=<remaining>;t=<seconds until reset>。

  • X-RateLimit-Limit

    RateLimit-Policy 中最严格一项（剩余请求数最少的一项）的限额。

  • X-RateLimit-Remaining

    最严格限制下的剩余请求数。

  • X-RateLimit-Reset

    距最严格限制重置的秒数。

application/json

对象：GroupList

array of Group
  • idinteger必填
  • org_idinteger必填
  • keystring必填

    稳定的键：all、role:<role>、user:<id> 或普通用户组的键。界面按键翻译内置用户组的名称。

  • titlestring必填
  • kindGroupKind必填
  • user_idinteger | null必填

    仅用于个人组。

  • role_keyRole | null必填

    仅用于角色组。

  • managed_byGroupManagedBy必填
  • members_countinteger必填

    活跃成员的数量。已停用的用户不是任何用户组的成员。

  • disabledboolean必填

    已停用用户的个人组：其授权会保留，但在用户处于停用状态期间不生效。其他所有用户组为 false。

  • created_atstring (date-time)必填
  • updated_atstring (date-time)必填
401未发送凭据（既没有会话 Cookie，也没有 API 密钥），或未找到该密钥。

响应头

  • RateLimit-Policy

    当前生效的限制，格式遵循 IETF 草案 draft-ietf-httpapi-ratelimit-headers：以逗号分隔的项 "<name>";q=<quota>;w=<window in seconds>。key 是 API 密钥的请求速率（配额即突发量，时间窗口是配额完全恢复所需的时间；会话为 user，无凭据时为 ip）；minute、day 和 month 是组织按 UTC 计算的自然分钟、自然日和自然月的配额。

  • RateLimit

    RateLimit-Policy 中每项限制的剩余量："<name>";r=<remaining>;t=<seconds until reset>。

  • X-RateLimit-Limit

    RateLimit-Policy 中最严格一项（剩余请求数最少的一项）的限额。

  • X-RateLimit-Remaining

    最严格限制下的剩余请求数。

  • X-RateLimit-Reset

    距最严格限制重置的秒数。

application/json

对象：Error

422校验错误：请求体或参数不符合定义的结构（`detail` 为校验错误列表），或参数值超出范围（`detail` 为消息）。

响应头

  • RateLimit-Policy

    当前生效的限制，格式遵循 IETF 草案 draft-ietf-httpapi-ratelimit-headers：以逗号分隔的项 "<name>";q=<quota>;w=<window in seconds>。key 是 API 密钥的请求速率（配额即突发量，时间窗口是配额完全恢复所需的时间；会话为 user，无凭据时为 ip）；minute、day 和 month 是组织按 UTC 计算的自然分钟、自然日和自然月的配额。

  • RateLimit

    RateLimit-Policy 中每项限制的剩余量："<name>";r=<remaining>;t=<seconds until reset>。

  • X-RateLimit-Limit

    RateLimit-Policy 中最严格一项（剩余请求数最少的一项）的限额。

  • X-RateLimit-Remaining

    最严格限制下的剩余请求数。

  • X-RateLimit-Reset

    距最严格限制重置的秒数。

application/json

对象：Error

429请求过多（`api.rate_limited`）、组织每分钟、每天或每月的配额已用完（`api.quota_exceeded`；`error.details` 中包含 `quota`、`limit` 和 `reset_at`）、已达到组织的限额，或回答服务繁忙（`answers.engine_busy`）。请等待 `Retry-After` 头中给出的时间。

响应头

  • Retry-After

    重试请求前需要等待的秒数。

  • RateLimit-Policy

    当前生效的限制，格式遵循 IETF 草案 draft-ietf-httpapi-ratelimit-headers：以逗号分隔的项 "<name>";q=<quota>;w=<window in seconds>。key 是 API 密钥的请求速率（配额即突发量，时间窗口是配额完全恢复所需的时间；会话为 user，无凭据时为 ip）；minute、day 和 month 是组织按 UTC 计算的自然分钟、自然日和自然月的配额。

  • RateLimit

    RateLimit-Policy 中每项限制的剩余量："<name>";r=<remaining>;t=<seconds until reset>。

  • X-RateLimit-Limit

    RateLimit-Policy 中最严格一项（剩余请求数最少的一项）的限额。

  • X-RateLimit-Remaining

    最严格限制下的剩余请求数。

  • X-RateLimit-Reset

    距最严格限制重置的秒数。

application/json

对象：Error

错误码

除所有请求通用的错误码外，此接口还可能在 error.code 中返回以下错误码。

速率限制

响应带有 RateLimit 和 RateLimit-Policy 头，以及旧版的 X-RateLimit-Limit、X-RateLimit-Remaining 和 X-RateLimit-Reset 头。429 响应带有以秒为单位的 Retry-After：等待后重试。

← groups · API 参考