diff options
Diffstat (limited to 'doc/api/scim.md')
| -rw-r--r-- | doc/api/scim.md | 34 |
1 files changed, 33 insertions, 1 deletions
diff --git a/doc/api/scim.md b/doc/api/scim.md index 6e022afb2f5..df0d90756d2 100644 --- a/doc/api/scim.md +++ b/doc/api/scim.md @@ -28,7 +28,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:------------------|:--------|:---------|:----------------------| -| `id` | integer | Yes | Return SCIM identities for the given group ID. | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | If successful, returns [`200`](rest/index.md#status-codes) and the following response attributes: @@ -58,6 +58,37 @@ curl --location --request GET "https://gitlab.example.com/api/v4/groups/33/scim/ --header "PRIVATE-TOKEN: <PRIVATE-TOKEN>" ``` +## Get a single SCIM identity + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/123591) in GitLab 16.1. + +```plaintext +GET /groups/:id/scim/: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 --location --request GET "https://gitlab.example.com/api/v4/groups/33/scim/sydney_jones" --header "<PRIVATE TOKEN>" +``` + +Example response: + +```json +{ + "extern_uid": "4", + "user_id": 48, + "active": true +} +``` + ## Update `extern_uid` field for a SCIM identity > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/227841) in GitLab 15.5. @@ -76,6 +107,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ------ | -------- | ------------------------- | +| `id` | integer/string | 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: |