SCIM API (SYSTEM ONLY)
引入于极狐GitLab 15.5。
要使用此 API,必须为群组启用群组 SSO。 此 API 仅在启用群组 SSO 的 SCIM 的情况下使用。这是创建 SCIM 身份的先决条件。
获取群组的 SCIM 身份
引入于极狐GitLab 15.5。
GET /groups/:id/scim/identities
支持的参数:
参数 | 类型 | 是否必需 | 描述 |
---|---|---|---|
id
| integer | Yes | 返回拥有特定 ID 的群组的 SAML 身份 |
如果成功,则返回 200
和以下响应参数:
参数 | 类型 | 描述 |
---|---|---|
extern_uid
| string | 用户的外部 UID |
user_id
| string | 用户 ID |
响应示例:
[
{
"extern_uid": "4",
"user_id": 48
}
]
请求示例:
curl --location --request GET "https://gdk.test:3443/api/v4/groups/33/scim/identities" \
--header "<PRIVATE-TOKEN>" \
--form "extern_uid=<ID_TO_BE_UPDATED>" \
更新 SCIM 身份的 extern_uid 字段
引入于极狐GitLab 15.5。
可以更新的字段为:
SCIM/IdP 字段 | 极狐GitLab 字段 |
---|---|
id/externalId
| extern_uid
|
PATCH groups/:groups_id/scim/:uid
参数:
参数 | 类型 | 是否必需 | 描述 |
---|---|---|---|
uid
| string | yes | 用户的外部 UID |
请求示例:
curl --location --request PATCH "https://gdk.test:3443/api/v4/groups/33/scim/sydney_jones" \
--header "<PRIVATE TOKEN>" \
--form "extern_uid=sydney_jones_new" \