diff options
Diffstat (limited to 'doc/api/scim.md')
| -rw-r--r-- | doc/api/scim.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/api/scim.md b/doc/api/scim.md index 8840935e646..f3be1a479a8 100644 --- a/doc/api/scim.md +++ b/doc/api/scim.md @@ -8,7 +8,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/98354) in GitLab 15.5. -The GitLab SCIM API manages SCIM identities within groups and provides the `/Users` endpoint. The base URL is `/api/scim/v2/groups/:group_path/Users/`. +The GitLab SCIM API manages SCIM identities within groups and provides the `/groups/:groups_id/scim/identities` and `/groups/:groups_id/scim/:uid` endpoints. The base URL is `<http|https>://<GitLab host>/api/v4`. To use this API, [Group SSO](../user/group/saml_sso/index.md) must be enabled for the group. This API is only in use where [SCIM for Group SSO](../user/group/saml_sso/scim_setup.md) is enabled. It's a prerequisite to the creation of SCIM identities. @@ -53,7 +53,7 @@ Example response: ```json [ { - "extern_uid": "4", + "extern_uid": "be20d8dcc028677c931e04f387", "user_id": 48, "active": true } @@ -85,14 +85,14 @@ Supported attributes: Example request: ```shell -curl --location --request GET "https://gitlab.example.com/api/v4/groups/33/scim/sydney_jones" --header "PRIVATE-TOKEN: <PRIVATE TOKEN>" +curl --location --request GET "https://gitlab.example.com/api/v4/groups/33/scim/be20d8dcc028677c931e04f387" --header "PRIVATE-TOKEN: <PRIVATE TOKEN>" ``` Example response: ```json { - "extern_uid": "4", + "extern_uid": "be20d8dcc028677c931e04f387", "user_id": 48, "active": true } @@ -122,9 +122,9 @@ Parameters: Example request: ```shell -curl --location --request PATCH "https://gitlab.example.com/api/v4/groups/33/scim/sydney_jones" \ +curl --location --request PATCH "https://gitlab.example.com/api/v4/groups/33/scim/be20d8dcc028677c931e04f387" \ --header "PRIVATE-TOKEN: <PRIVATE TOKEN>" \ ---form "extern_uid=sydney_jones_new" +--form "extern_uid=yrnZW46BrtBFqM7xDzE7dddd" ``` ## Delete a single SCIM identity @@ -145,7 +145,7 @@ Supported attributes: Example request: ```shell -curl --request DELETE --header "Content-Type: application/json" --header "Authorization: Bearer <your_access_token>" "https://gitlab.example.com/api/v4/groups/33/scim/sydney_jones" +curl --request DELETE --header "Content-Type: application/json" --header "Authorization: Bearer <your_access_token>" "https://gitlab.example.com/api/v4/groups/33/scim/yrnZW46BrtBFqM7xDzE7dddd" ``` |