Skip to content

Commit 7143974

Browse files
committed
Refactor SCIM docs
1 parent 115a729 commit 7143974

7 files changed

Lines changed: 24 additions & 117 deletions

File tree

src/content/authentication/scim-with-google.mdx

Lines changed: 0 additions & 28 deletions
This file was deleted.

src/content/authentication/scim-with-jumpcloud.mdx

Lines changed: 0 additions & 21 deletions
This file was deleted.

src/content/authentication/scim-with-microsoft-entra-id.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@ import img_scim_steps from './images/scim-with-microsoft-entra-id/ef96dfb04a805a
55

66
SCIM, or System for Cross-domain Identity Management, is an open standard designed to manage user identity information. Cloudsmith is SCIM 2.0-compliant. With Cloudsmith's support for SCIM, you can automatically provision new users, de-provision existing users, and update existing users' profile information based on changes within your Identity Provider (IdP).
77

8-
<Note variant="warning" headline="Early Access">
9-
SCIM integration with Entra is available in early access.
10-
</Note>
11-
128
To begin using SCIM, you need to enable the SCIM functionality in the [Cloudsmith Workspace Settings](/workspaces/workspace-settings)
139

1410
Follow these steps:

src/content/authentication/scim-with-okta.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,6 @@ import img93fc9ed_To_app from './images/scim-with-okta/93fc9ed-To_app.png'
88

99
SCIM, or System for Cross-domain Identity Management, is an open standard designed to manage user identity information. Cloudsmith is SCIM 2.0-compliant. With Cloudsmith's support for SCIM, you can automatically provision new users, de-provision existing users, and update existing users' profile information based on changes within your Identity Provider (IdP).
1010

11-
<Note variant="warning" headline="Early Access">
12-
SCIM integration with Okta is available in early access.
13-
</Note>
14-
1511
To begin using SCIM, you need to enable the SCIM functionality in the [Cloudsmith Workspace Settings](/workspaces/workspace-settings)
1612

1713
Follow these steps:

src/content/authentication/scim-with-onelogin.mdx

Lines changed: 0 additions & 21 deletions
This file was deleted.

src/content/authentication/scim-with-pingfederate.mdx

Lines changed: 0 additions & 21 deletions
This file was deleted.

src/content/authentication/scim.mdx

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,34 +4,40 @@ import { Note } from '@/components'
44

55
## Overview
66

7-
SCIM, or System for Cross-domain Identity Management, is an open standard designed to manage user identity information. Cloudsmith is SCIM 2.0-compliant. With Cloudsmith's support for SCIM, you can automatically provision new users, de-provision existing users and update existing users profile information based on changes within your Identity Provider (IdP).
7+
SCIM, or **System for Crossdomain Identity Management**, is an open standard designed to manage user identity information. Cloudsmith is SCIM2.0compliant. With Cloudsmiths support for SCIM, you can automatically provision new users, deprovision existing users and update user profile information based on changes within your IdP.
88

99
<Note variant="warning" headline="Early Access">
10-
SCIM Groups provisioning integration is currently available in early access. Please contact us if you need this feature enabled for your organization.
10+
SCIM Groups provisioning integration is currently available in early access. Please contact us if you need this feature enabled for your organization.
1111
</Note>
1212

13-
<Note>
14-
📘 To provision users via SCIM, you need to setup the workspace as the primary workspace. Users from other workspaces can not be managed via SCIM.
15-
If you have any question, reach out to [support](https://cloudsmith.com/company/contact-us).
16-
</Note>
13+
## Prerequisites for enabling SCIM on Cloudsmith
14+
15+
To configure SCIM for your organization you must meet the following requirements:
16+
17+
1. **Cloudsmith plan** – Your account must be on a plan that includes **Ultra** or **Enterprise**.
18+
2. **Administrator access** – You must be the owner of a Cloudsmith organization.
19+
3. **Domain registry** – At least one domain must be claimed in Cloudsmith - please reach out to our [support team](https://cloudsmith.com/company/contact-us).
20+
4. **Identity provider (IdP)** – You need an IdP that supports SCIM 2.0 to use with Cloudsmith.
21+
22+
---
1723

1824
## Configuration
1925

20-
When configuring your Identity Provider, you'll need the following details which apply to all SCIM integrations with Cloudsmith:
26+
When configuring your IdP, you’ll need the following details that apply to all SCIM integrations with Cloudsmith:
27+
28+
- **Base URL**: `https://api.cloudsmith.io/scim/v2`
29+
- **Authentication**: Basic Auth, using a SCIM token generated from Cloudsmith.
30+
- **Supported Features**: User provisioning and de‑provisioning.
2131

22-
- **Base URL**: `https://api.cloudsmith.io/scim/v2`
23-
- **Authentication**: Basic Auth, using a SCIM token generated from Cloudsmith.
24-
- **Supported Features**: User provisioning and de-provisioning.
32+
<Note variant="warning" headline="Unique User Identifier">
33+
Make sure to use the user’s e‑mail address as the unique identifier.
34+
</Note>
2535

26-
## Supported Providers
36+
## Supported IdP Providers
2737

28-
Whilst Cloudsmith should work with any generic SCIM IdP, we officially support and provide documentation for a number of the most common providers. Please see below for the guides for each officially supported provider:
38+
Cloudsmith works with any generic SCIM 2.0‑compliant IdP, but we provide detailed documentation for the most common providers below as an example configuration:
2939

30-
- [Okta](/authentication/scim-with-okta)
40+
- [Okta](/authentication/scim-with-okta)
3141
- [Microsoft Entra ID](/authentication/scim-with-microsoft-entra-id)
32-
- [PingFederate](/authentication/scim-with-pingfederate)
33-
- [Google](/authentication/scim-with-google)
34-
- [JumpCloud](/authentication/single-sign-on-with-jumpcloud)
35-
- [OneLogin](/authentication/single-sign-on-with-onelogin)
3642

37-
Other providers may be supported. If you need help with an unlisted integration, you can still [contact us](https://cloudsmith.com/company/contact-us).
43+
If you need help with an IdP not listed above, feel free to [contact us](https://cloudsmith.com/company/contact-us).

0 commit comments

Comments
 (0)