SAML API
Introduced in GitLab 15.5.
API for accessing SAML features.
Get SAML identities for a group
GET /groups/:id/saml/identities
Fetch SAML identities for a group.
Supported attributes:
| Attribute | Type | Required | Description |
|---|---|---|---|
id
| integer | Yes | Group ID for the group to return SAML identities. |
If successful, returns 200 and the following
response attributes:
| Attribute | Type | Description |
|---|---|---|
extern_uid
| string | External UID for the user |
user_id
| string | ID for the user |
Example request:
curl --location --request GET "https://gitlab.example.com/api/v4/groups/33/saml/identities" --header "<PRIVATE-TOKEN>"
Example response:
[
{
"extern_uid": "4",
"user_id": 48
}
]
Update extern_uid field for a SAML identity
Update extern_uid field for a SAML identity:
| SAML IdP attribute | GitLab field |
|---|---|
id/externalId
| extern_uid
|
PATCH groups/:groups_id/saml/:uid
Parameters:
| Attribute | Type | Required | Description |
|---|---|---|---|
uid
| string | yes | External UID of the user. |
Example request:
curl --location --request PATCH "https://gitlab.example.com/api/v4/groups/33/saml/sydney_jones" \
--header "<PRIVATE TOKEN>" \
--form "extern_uid=sydney_jones_new" \