API SCIM

{{< details >}}

• Édition : Premium, Ultimate
• Offre : GitLab.com, GitLab Dedicated

{{< /details >}}

{{< history >}}

• Introduit dans GitLab 15.5.

{{< /history >}}

Utilisez cette API pour gérer les identités SCIM dans les groupes.

Prérequis :

• Vous devez activer Group SSO.
• Vous devez activer SCIM for Group SSO.
• Vous devez vous authentifier avec un Personal Access Token ou un Group Access Token disposant de la portée appropriée.

Cette API diffère de l'API SCIM de groupe interne et de l'API SCIM d'instance interne, qui nécessitent toutes deux un jeton SCIM.

• Cette API :
  • N'implémente pas le protocole RFC7644.
  • Récupère, vérifie, met à jour et supprime les identités SCIM au sein des groupes.
• Les API SCIM de groupe et d'instance internes :
  • Sont destinées à l'utilisation système pour l'intégration des fournisseurs SCIM.
  • Implémentent le protocole RFC7644.
  • Récupèrent une liste d'utilisateurs provisionnés par SCIM pour le groupe ou l'instance.
  • Créent, suppriment et mettent à jour les utilisateurs provisionnés par SCIM pour le groupe ou l'instance.

Récupérer les identités SCIM pour un groupe {#retrieve-scim-identities-for-a-group}

{{< history >}}

• Introduit dans GitLab 15.5.

{{< /history >}}

Récupère les identités SCIM pour un groupe.

GET /groups/:id/scim/identities

Attributs pris en charge :

En cas de succès, renvoie 200 et les attributs de réponse suivants :

Exemple de réponse :

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

Exemple de requête :

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

Récupérer une identité SCIM unique {#retrieve-a-single-scim-identity}

{{< history >}}

• Introduit dans GitLab 16.1.

{{< /history >}}

Récupère une identité SCIM unique.

GET /groups/:id/scim/:uid

Attributs pris en charge :

Exemple de requête :

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

Exemple de réponse :

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

Mettre à jour le champ extern_uid pour une identité SCIM {#update-extern_uid-field-for-a-scim-identity}

{{< history >}}

• Introduit dans GitLab 15.5.

{{< /history >}}

Met à jour le champ extern_uid pour une identité SCIM.

Les champs pouvant être mis à jour sont :

PATCH /groups/:groups_id/scim/:uid

Paramètres :

Exemple de requête :

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

Supprimer une identité SCIM unique {#delete-a-single-scim-identity}

{{< history >}}

• Introduite dans GitLab 16.5.

{{< /history >}}

Supprime une identité SCIM unique.

DELETE /groups/:id/scim/:uid

Attributs pris en charge :

Exemple de requête :

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

Exemple de réponse :

{
    "message" : "204 No Content"
}