SAML API
GitLab 15.5 で導入されました。
SAML 機能にアクセスするための API。
グループの SAML ID の取得
GET /groups/:id/saml/identities
グループの SAML ID を取得します。
サポートされる属性：
| 属性 | 種類 | 必須 | 説明 |
|---|---|---|---|
id | 整数/文字列 | yes | グループのIDまたはURLエンコードされたパス |
成功した場合は、200 と以下のレスポンス属性を返します：
| 属性 | 種類 | 説明 |
|---|---|---|
extern_uid | 文字列です。 | ユーザーの外部UID |
user_id | 文字列です。 | ユーザーのID |
リクエストの例
curl --location --request GET "https://gitlab.example.com/api/v4/groups/33/saml/identities" --header "PRIVATE-TOKEN: <PRIVATE-TOKEN>"
応答例
[
{
"extern_uid": "4",
"user_id": 48
}
]
単一の SAML ID の取得
GitLab 16.1 で導入されました。
GET /groups/:id/saml/:uid
サポートされる属性：
| 属性 | 種類 | 必須 | 説明 |
|---|---|---|---|
id | 整数/文字列 | yes | グループのIDまたはURLエンコードされたパス |
uid | 文字列です。 | yes | ユーザーの外部UID。 |
リクエストの例
curl --location --request GET "https://gitlab.example.com/api/v4/groups/33/saml/sydney_jones" --header "PRIVATE-TOKEN: <PRIVATE TOKEN>"
応答例
{
"extern_uid": "4",
"user_id": 48
}
SAML ID のextern_uid フィールドの更新
SAML ID のextern_uid フィールドを更新します：
| SAML IdP 属性。 | GitLab フィールド |
|---|---|
id/externalId | extern_uid |
PATCH /groups/:id/saml/:uid
サポートされる属性：
| 属性 | 種類 | 必須 | 説明 |
|---|---|---|---|
id | 整数/文字列 | yes | グループのIDまたはURLエンコードされたパス |
uid | 文字列です。 | yes | ユーザーの外部UID。 |
リクエストの例
curl --location --request PATCH "https://gitlab.example.com/api/v4/groups/33/saml/sydney_jones" \
--header "PRIVATE-TOKEN: <PRIVATE TOKEN>" \
--form "extern_uid=sydney_jones_new"