正式なドキュメントは英語版であり、この日本語訳はAI支援翻訳により作成された参考用のものです。日本語訳の一部の内容は人間によるレビューがまだ行われていないため、翻訳のタイミングにより英語版との間に差異が生じることがあります。最新かつ正確な情報については、英語版をご参照ください。

SCIM

  • プラン: Premium、Ultimate
  • 提供形態: GitLab.com、GitLab Dedicated

このを使用して、グループ内のSCIM IDを管理します。

前提要件:

このは、SCIMトークンを必要とする内部グループSCIMおよび内部インスタンスSCIMとは異なります。

  • この:

    • RFC7644プロトコルを実装していません。
    • グループ内のSCIM IDを取得、チェック、更新、削除します。

  • 内部グループおよびインスタンスSCIM :

    • SCIMプロバイダーインテグレーションのシステム用です。
    • RFC7644プロトコルを実装します。
    • グループまたはインスタンス用にSCIMプロビジョニングされたユーザーのリストを取得します。
    • グループまたはインスタンス用にSCIMプロビジョニングされたユーザーを作成、削除、更新します。

グループのSCIM IDを取得

GET /groups/:id/scim/identities

サポートされている属性は以下のとおりです:

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

成功した場合、200と次のレスポンス属性を返します:

属性型説明
extern_uid文字列ユーザーの外部
user_id整数ユーザーの
activeブール値IDのステータス

レスポンス例:

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

リクエスト例:

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

単一のSCIM IDを取得

GET /groups/:id/scim/:uid

サポートされている属性は以下のとおりです:

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

リクエスト例:

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

レスポンス例:

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

SCIM IDのextern_uidフィールドを更新する

更新できるフィールドは次のとおりです:

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

パラメータ:

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

リクエスト例:

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

単一のSCIM IDを削除

DELETE /groups/:id/scim/:uid

サポートされている属性は以下のとおりです:

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

リクエスト例:

curl --location --request DELETE \
  --url "https://gitlab.example.com/api/v4/groups/33/scim/yrnZW46BrtBFqM7xDzE7dddd" \
  --header "PRIVATE-TOKEN: <your_access_token>"

レスポンス例:

{
    "message" : "204 No Content"
}