diff options
Diffstat (limited to 'doc/api/saml.md')
-rw-r--r-- | doc/api/saml.md | 32 |
1 files changed, 31 insertions, 1 deletions
diff --git a/doc/api/saml.md b/doc/api/saml.md index 60fd549f84f..911586933fa 100644 --- a/doc/api/saml.md +++ b/doc/api/saml.md @@ -1,6 +1,6 @@ --- stage: Govern -group: Authentication and Authorization +group: Authentication info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- @@ -105,3 +105,33 @@ curl --location --request PATCH "https://gitlab.example.com/api/v4/groups/33/sam --header "PRIVATE-TOKEN: <PRIVATE TOKEN>" \ --form "extern_uid=sydney_jones_new" ``` + +## Delete a single SAML identity + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/423592) in GitLab 16.5. + +```plaintext +DELETE /groups/:id/saml/:uid +``` + +Supported attributes: + +| Attribute | Type | Required | Description | +| --------- | ------- | -------- | ------------------------- | +| `id` | integer | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `uid` | string | yes | External UID of the user. | + +Example request: + +```shell +curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/33/saml/sydney_jones" + +``` + +Example response: + +```json +{ + "message" : "204 No Content" +} +``` |