API SAML

{{< details >}}

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

{{< /details >}}

{{< history >}}

• Introduit dans GitLab 15.5.

{{< /history >}}

Utilisez cette API pour interagir avec les fonctionnalités SAML.

Points de terminaison GitLab.com {#gitlabcom-endpoints}

Lister toutes les identités SAML d'un groupe {#list-all-saml-identities-for-a-group}

GET /groups/:id/saml/identities

Liste toutes les identités SAML d'un groupe.

Attributs pris en charge :

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

Exemple de requête :

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

Exemple de réponse :

[
    {
        "extern_uid": "yrnZW46BrtBFqM7xDzE7dddd",
        "user_id": 48
    }
]

Récupérer une identité SAML unique {#retrieve-a-single-saml-identity}

{{< history >}}

• Introduit dans GitLab 16.1.

{{< /history >}}

Récupère une identité SAML unique.

GET /groups/:id/saml/:uid

Attributs pris en charge :

Exemple de requête :

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

Exemple de réponse :

{
    "extern_uid": "yrnZW46BrtBFqM7xDzE7dddd",
    "user_id": 48
}

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

Met à jour le champ extern_uid pour une identité SAML :

PATCH /groups/:id/saml/:uid

Attributs pris en charge :

Exemple de requête :

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

Supprimer une identité SAML unique {#delete-a-single-saml-identity}

{{< history >}}

• Introduite dans GitLab 16.5.

{{< /history >}}

DELETE /groups/:id/saml/:uid

Attributs pris en charge :

Exemple de requête :

curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.com/api/v4/groups/33/saml/be20d8dcc028677c931e04f387"

Exemple de réponse :

{
    "message" : "204 No Content"
}

Points de terminaison GitLab Self-Managed {#gitlab-self-managed-endpoints}

Récupérer une identité SAML unique {#retrieve-a-single-saml-identity-1}

Utilise l'API Users pour obtenir une identité SAML unique.

Mettre à jour le champ extern_uid pour une identité SAML {#update-extern_uid-field-for-a-saml-identity-1}

Utilise l'API Users pour mettre à jour le champ extern_uid d'un utilisateur.

Supprimer une identité SAML unique {#delete-a-single-saml-identity-1}

Utilise l'API Users pour supprimer une identité unique d'un utilisateur.

Liens de groupe SAML {#saml-group-links}

{{< history >}}

• Introduit dans GitLab 15.3.0.
• Le type access_level a été modifié de string à integer dans GitLab 15.3.3.
• Le type member_role_id a été introduit dans GitLab 16.7 avec un indicateur nommé custom_roles_for_saml_group_links. Désactivé par défaut.
• Le type member_role_id est généralement disponible dans GitLab 16.8. L'indicateur de fonctionnalité custom_roles_for_saml_group_links a été supprimé.
• Le paramètre provider a été introduit dans GitLab 18.2.

{{< /history >}}

Listez, récupérez, ajoutez et supprimez des liens de groupe SAML en utilisant l'API REST.

Lister tous les liens de groupe SAML {#list-all-saml-group-links}

Liste tous les liens de groupe SAML pour un groupe.

GET /groups/:id/saml_group_links

Attributs pris en charge :

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

Exemple de requête :

curl \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/1/saml_group_links"

Exemple de réponse :

[
  {
    "name": "saml-group-1",
    "access_level": 10,
    "member_role_id": 12,
    "provider": null
  },
  {
    "name": "saml-group-2",
    "access_level": 40,
    "member_role_id": 99,
    "provider": "saml_provider_1"
  }
]

Récupérer un lien de groupe SAML {#retrieve-a-saml-group-link}

Récupère un lien de groupe SAML pour un groupe.

GET /groups/:id/saml_group_links/:saml_group_name

Attributs pris en charge :

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

Si plusieurs liens de groupe SAML existent avec le même nom mais des fournisseurs différents, et qu'aucun paramètre provider n'est spécifié, renvoie 422 avec un message d'erreur indiquant que le paramètre provider est requis pour lever l'ambiguïté.

Exemple de requête :

curl \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/1/saml_group_links/saml-group-1"

Exemple de requête avec le paramètre provider :

curl \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/1/saml_group_links/saml-group-1?provider=saml_provider_1"

Exemple de réponse :

{
"name": "saml-group-1",
"access_level": 10,
"member_role_id": 12,
"provider": "saml_provider_1"
}

Ajouter un lien de groupe SAML {#add-a-saml-group-link}

Ajoute un lien de groupe SAML pour un groupe.

POST /groups/:id/saml_group_links

Attributs pris en charge :

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

Exemple de requête :

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --header "Content-Type: application/json" --data '{ "saml_group_name": "<your_saml_group_name`>", "access_level": <chosen_access_level>, "member_role_id": <chosen_member_role_id>, "provider": "<your_provider>" }' --url  "https://gitlab.example.com/api/v4/groups/1/saml_group_links"

Exemple de réponse :

{
"name": "saml-group-1",
"access_level": 10,
"member_role_id": 12,
"provider": "saml_provider_1"
}

Supprimer un lien de groupe SAML {#delete-a-saml-group-link}

Supprime un lien de groupe SAML pour un groupe.

DELETE /groups/:id/saml_group_links/:saml_group_name

Attributs pris en charge :

Exemple de requête :

curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/1/saml_group_links/saml-group-1"

Exemple de requête avec le paramètre provider :

curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/1/saml_group_links/saml-group-1?provider=saml_provider_1"

En cas de succès, renvoie le code de statut 204 sans corps de réponse.

Si plusieurs liens de groupe SAML existent avec le même nom mais des fournisseurs différents, et qu'aucun paramètre provider n'est spécifié, renvoie 422 avec un message d'erreur indiquant que le paramètre provider est requis pour lever l'ambiguïté.