diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-11-19 08:27:35 +0000 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-11-19 08:27:35 +0000 |
| commit | 7e9c479f7de77702622631cff2628a9c8dcbc627 (patch) | |
| tree | c8f718a08e110ad7e1894510980d2155a6549197 /doc/api/scim.md | |
| parent | e852b0ae16db4052c1c567d9efa4facc81146e88 (diff) | |
| download | gitlab-ce-7e9c479f7de77702622631cff2628a9c8dcbc627.tar.gz | |
Add latest changes from gitlab-org/gitlab@13-6-stable-eev13.6.0-rc42
Diffstat (limited to 'doc/api/scim.md')
| -rw-r--r-- | doc/api/scim.md | 22 |
1 files changed, 13 insertions, 9 deletions
diff --git a/doc/api/scim.md b/doc/api/scim.md index 350f992779e..653d56f3e06 100644 --- a/doc/api/scim.md +++ b/doc/api/scim.md @@ -1,19 +1,23 @@ -# SCIM API **(SILVER ONLY)** +--- +type: reference, howto +stage: Manage +group: Access +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +--- -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/9388) in [GitLab Silver](https://about.gitlab.com/pricing/) 11.10. +# SCIM API (SYSTEM ONLY) **(SILVER ONLY)** -The SCIM API implements the [RFC7644 protocol](https://tools.ietf.org/html/rfc7644). +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/9388) in [GitLab.com Silver](https://about.gitlab.com/pricing/) 11.10. -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. +The SCIM API implements the [RFC7644 protocol](https://tools.ietf.org/html/rfc7644). As this API is for +**system** use for SCIM provider integration, 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). +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. ## Get a list of SAML users -NOTE: **Note:** -This endpoint is used as part of the SCIM syncing mechanism and it only returns +This endpoint is used as part of the SCIM syncing mechanism. It only returns a single user based on a unique ID which should match the `extern_uid` of the user. ```plaintext |