技术速查官方文档2 分钟阅读技术速查

FastGPT获取团队成员列表的标准接口使用说明

FastGPT提供标准接口用于获取团队成员列表,适配SSO集成场景。调用该接口可同步获取团队成员的账号、显示名、联系方式等结构化信息。 1. 构造GET请求,目标地址为https://example.com/user/list。 2.

结论

FastGPT提供标准接口用于获取团队成员列表,适配SSO集成场景。调用该接口可同步获取团队成员的账号、显示名、联系方式等结构化信息。

具体怎么做

  1. 构造GET请求,目标地址为https://example.com/user/list
  2. 添加以下请求头:
    • Authorization: Bearer your_token_here:替换your_token_here为实际有效的访问令牌
    • Content-Type: application/json
  3. 发起请求的完整curl示例如下:
curl -X GET "https://example.com/user/list" \
-H "Authorization: Bearer your_token_here" \
-H "Content-Type: application/json"

请求响应将遵循UserListResponseListType格式,包含success布尔值、可选报错信息message和成员列表userList

注意事项

  1. 成员的username为唯一标识,必须与SSO接口返回的username完全一致,且需携带指定前缀,前缀需与SSO接口返回的前缀保持匹配,例如fastgpt-xxxxsync-aaaaa
  2. orgs字段为成员所属组织ID数组,若成员无所属组织,需传入空数组[]
  3. 部分字段为可选:memberName为成员显示名,avatar为成员头像地址,contact可填写邮箱或手机号码,message仅在请求失败时返回报错信息。

来源:FastGPT 官方文档