summaryrefslogtreecommitdiff
path: root/doc/api/scim.md
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2020-05-20 14:34:42 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2020-05-20 14:34:42 +0000
commit9f46488805e86b1bc341ea1620b866016c2ce5ed (patch)
treef9748c7e287041e37d6da49e0a29c9511dc34768 /doc/api/scim.md
parentdfc92d081ea0332d69c8aca2f0e745cb48ae5e6d (diff)
downloadgitlab-ce-9f46488805e86b1bc341ea1620b866016c2ce5ed.tar.gz
Add latest changes from gitlab-org/gitlab@13-0-stable-ee
Diffstat (limited to 'doc/api/scim.md')
-rw-r--r--doc/api/scim.md27
1 files changed, 15 insertions, 12 deletions
diff --git a/doc/api/scim.md b/doc/api/scim.md
index eaa56b0d0dd..4300c9efa3d 100644
--- a/doc/api/scim.md
+++ b/doc/api/scim.md
@@ -4,6 +4,9 @@
The SCIM API implements the [the RFC7644 protocol](https://tools.ietf.org/html/rfc7644).
+CAUTION: **Caution:**
+This API is for internal system use for connecting with a SCIM provider. While it can be used directly, it is subject to change without notice.
+
NOTE: **Note:**
[Group SSO](../user/group/saml_sso/index.md) must be enabled for the group. For more information, see [SCIM setup documentation](../user/group/saml_sso/scim_setup.md#requirements).
@@ -13,7 +16,7 @@ NOTE: **Note:**
This endpoint is used as part of the SCIM syncing mechanism and it only returns
a single user based on a unique ID which should match the `extern_uid` of the user.
-```text
+```plaintext
GET /api/scim/v2/groups/:group_path/Users
```
@@ -69,7 +72,7 @@ Example response:
## Get a single SAML user
-```text
+```plaintext
GET /api/scim/v2/groups/:group_path/Users/:id
```
@@ -110,7 +113,7 @@ Example response:
## Create a SAML user
-```text
+```plaintext
POST /api/scim/v2/groups/:group_path/Users/
```
@@ -158,15 +161,15 @@ Returns a `201` status code if successful.
Fields that can be updated are:
-| SCIM/IdP field | GitLab field |
-|:----------|:--------|
-| id/externalId | extern_uid |
-| name.formatted | name |
-| emails\[type eq "work"\].value | email |
-| active | Identity removal if `active = false` |
-| userName | username |
+| SCIM/IdP field | GitLab field |
+|:---------------------------------|:---------------------------------------|
+| `id/externalId` | `extern_uid` |
+| `name.formatted` | `name` |
+| `emails\[type eq "work"\].value` | `email` |
+| `active` | Identity removal if `active` = `false` |
+| `userName` | `username` |
-```text
+```plaintext
PATCH /api/scim/v2/groups/:group_path/Users/:id
```
@@ -190,7 +193,7 @@ Returns an empty response with a `204` status code if successful.
Removes the user's SSO identity and group membership.
-```text
+```plaintext
DELETE /api/scim/v2/groups/:group_path/Users/:id
```