SCIM API

{{< details >}}

• Tier: Premium, Ultimate
• Offering: GitLab.com, GitLab Dedicated

{{< /details >}}

{{< history >}}

• Introduced in GitLab 15.5.

{{< /history >}}

Use this API to manage SCIM identities in groups.

Prerequisites:

• You must enable Group SSO.
• You must enable SCIM for Group SSO.
• You must authenticate with a Personal Access Token or Group Access Token that has the correct scope.

This API differs from the internal group SCIM API and the internal instance SCIM API which both require a SCIM token.

• This API:
  • Does not implement the RFC7644 protocol.
  • Gets, checks, updates, and deletes SCIM identities within groups.
• The internal group and instance SCIM APIs:
  • Are for system use for SCIM provider integration.
  • Implement the RFC7644 protocol.
  • Get a list of SCIM provisioned users for the group or instance.
  • Create, delete and update SCIM provisioned users for the group or instance.

Retrieve SCIM identities for a group

{{< history >}}

• Introduced in GitLab 15.5.

{{< /history >}}

Retrieves SCIM identities for a group.

GET /groups/:id/scim/identities

Supported attributes:

If successful, returns 200 and the following response attributes:

Example response:

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

Example request:

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

Retrieve a single SCIM identity

{{< history >}}

• Introduced in GitLab 16.1.

{{< /history >}}

Retrieves a single SCIM identity.

GET /groups/:id/scim/:uid

Supported attributes:

Example request:

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

Example response:

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

Update extern_uid field for a SCIM identity

{{< history >}}

• Introduced in GitLab 15.5.

{{< /history >}}

Updates extern_uid field for a SCIM identity.

Fields that can be updated are:

PATCH /groups/:groups_id/scim/:uid

Parameters:

Example request:

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

Delete a single SCIM identity

{{< history >}}

• Introduced in GitLab 16.5.

{{< /history >}}

Deletes a single SCIM identity.

DELETE /groups/:id/scim/:uid

Supported attributes:

Example request:

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

Example response:

{
    "message" : "204 No Content"
}