SCIM API

GitLab 15.5 で導入されました。

GitLabはRFC7644プロトコルを実装し、/Users エンドポイントを提供するSCIM APIを提供します。ベースURLは/api/scim/v2/groups/:group_path/Users/です。

このAPIを使うには、グループのSSOが有効になっていなければなりません。この API はSCIM for Group SSOが有効になっている場合にのみ使用されます。これは SCIM アイデンティティを作成するための前提条件です。

内部グループ SCIM API と混同しないでください。

グループのSCIM IDの取得

GitLab 15.5 で導入されました。

GET /groups/:id/scim/identities

サポートされる属性：

属性種類必須説明
id整数/文字列はい グループのIDまたはURLエンコードされたパス

成功した場合は、200 と以下のレスポンス属性を返します：

属性種類説明
extern_uid文字列です。ユーザーの外部UID
user_id整数。ユーザーのID
activebooleanIDのステータス

応答例

[
    {
        "extern_uid": "4",
        "user_id": 48,
        "active": true
    }
]

リクエストの例

curl --location --request GET "https://gitlab.example.com/api/v4/groups/33/scim/identities" \
--header "PRIVATE-TOKEN: <PRIVATE-TOKEN>"

単一の SCIM ID を取得

GitLab 16.1 で導入されました。

GET /groups/:id/scim/:uid

サポートされる属性：

属性種類必須説明
id整数。yes グループのIDまたはURLエンコードされたパス
uid文字列です。yesユーザーの外部UID。

リクエストの例

curl --location --request GET "https://gitlab.example.com/api/v4/groups/33/scim/sydney_jones" --header "PRIVATE-TOKEN: <PRIVATE TOKEN>"

応答例

{
    "extern_uid": "4",
    "user_id": 48,
    "active": true
}

SCIM ID のextern_uid フィールドの更新

GitLab 15.5 で導入されました。

更新可能なフィールド

SCIM/IDPフィールドGitLab フィールド
id/externalIdextern_uid
PATCH /groups/:groups_id/scim/:uid

パラメータを指定します：

属性種類必須説明
id整数/文字列yes グループのIDまたはURLエンコードされたパス
uid文字列です。yesユーザーの外部UID。

リクエストの例

curl --location --request PATCH "https://gitlab.example.com/api/v4/groups/33/scim/sydney_jones" \
--header "PRIVATE-TOKEN: <PRIVATE TOKEN>" \
--form "extern_uid=sydney_jones_new"