From 7143974206b47762aabe8b6f8e61106e92d3e50f Mon Sep 17 00:00:00 2001 From: Rose Pomykala Date: Thu, 22 Jan 2026 15:40:39 +0000 Subject: [PATCH] Refactor SCIM docs --- .../authentication/scim-with-google.mdx | 28 ------------- .../authentication/scim-with-jumpcloud.mdx | 21 ---------- .../scim-with-microsoft-entra-id.mdx | 4 -- src/content/authentication/scim-with-okta.mdx | 4 -- .../authentication/scim-with-onelogin.mdx | 21 ---------- .../authentication/scim-with-pingfederate.mdx | 21 ---------- src/content/authentication/scim.mdx | 42 +++++++++++-------- 7 files changed, 24 insertions(+), 117 deletions(-) delete mode 100644 src/content/authentication/scim-with-google.mdx delete mode 100644 src/content/authentication/scim-with-jumpcloud.mdx delete mode 100644 src/content/authentication/scim-with-onelogin.mdx delete mode 100644 src/content/authentication/scim-with-pingfederate.mdx diff --git a/src/content/authentication/scim-with-google.mdx b/src/content/authentication/scim-with-google.mdx deleted file mode 100644 index 0dab5789..00000000 --- a/src/content/authentication/scim-with-google.mdx +++ /dev/null @@ -1,28 +0,0 @@ -import { Note, BlockImage } from '@/components' -import img_app_cloudsmith_com_demo_examples_repo_settingsiPad_Pro_4 from './images/scim-with-google/cf166e95d48f2069f263ad8e318d5257155954738c98136eda1f581b83d01db3-app.cloudsmith.com_demo_examples-repo_settingsiPad_Pro_4.png' -import img_app_cloudsmith_com_demo_examples_repo_settingsiPad_Pro_5 from './images/scim-with-google/c2370ff90f8533154dc129aa4094c6c2a609c6c915382adb9d3e645610cfa826-app.cloudsmith.com_demo_examples-repo_settingsiPad_Pro_5.png' - - - -# SCIM with Google - -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). - - - SCIM integration with Google is available in early access - - -To begin using SCIM, you need to enable the SCIM functionality in the [Cloudsmith Workspace Settings](/workspaces/workspace-settings) - -Follow these steps: - -1. Navigate to the Cloudsmith Workspace Settings. -2. Navigate to Authentication >> SCIM and enable the SCIM functionality by selecting "Allow SCIM." - - - -After enabling SCIM, proceed to Google's Getting Started Guide to complete the setup process. - - - -Follow the detailed instructions on their support page for Identity Management Connectors: [Set up SSO with Google as your identity provider](https://support.google.com/a/topic/7556794?hl=en&ref_topic=7556686&sjid=825024795023446732-EU). diff --git a/src/content/authentication/scim-with-jumpcloud.mdx b/src/content/authentication/scim-with-jumpcloud.mdx deleted file mode 100644 index f6f7cc42..00000000 --- a/src/content/authentication/scim-with-jumpcloud.mdx +++ /dev/null @@ -1,21 +0,0 @@ -import { Note, BlockImage } from '@/components' -import img_scim_steps from './images/scim-with-jumpcloud/33a9e7ca325096db9b79c309c47d0ee3fd2741eeac422518b5790d964051833a-scim-steps.png' - -# SCIM with JumpCloud - -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). - - - SCIM integration with JumpCloud is available in early access - - -To begin using SCIM, you need to enable the SCIM functionality in the [Cloudsmith Workspace Settings](/workspaces/workspace-settings) - -Follow these steps: - -1. Navigate to the Cloudsmith Workspace Settings. -2. Navigate to Authentication >> SCIM and enable the SCIM functionality by selecting "Allow SCIM." - - - -After enabling SCIM, proceed to JumpCloud's Getting Started Guide to complete the setup process. Follow the detailed instructions on their support page for Identity Management Connectors: [JumpCloud Getting Started Guide](https://jumpcloud.com/support/get-started-identity-management-connectors). diff --git a/src/content/authentication/scim-with-microsoft-entra-id.mdx b/src/content/authentication/scim-with-microsoft-entra-id.mdx index 5cf8a7e1..eedc541f 100644 --- a/src/content/authentication/scim-with-microsoft-entra-id.mdx +++ b/src/content/authentication/scim-with-microsoft-entra-id.mdx @@ -5,10 +5,6 @@ import img_scim_steps from './images/scim-with-microsoft-entra-id/ef96dfb04a805a 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). - - SCIM integration with Entra is available in early access. - - To begin using SCIM, you need to enable the SCIM functionality in the [Cloudsmith Workspace Settings](/workspaces/workspace-settings) Follow these steps: diff --git a/src/content/authentication/scim-with-okta.mdx b/src/content/authentication/scim-with-okta.mdx index 884a8ca2..cb7698ec 100644 --- a/src/content/authentication/scim-with-okta.mdx +++ b/src/content/authentication/scim-with-okta.mdx @@ -8,10 +8,6 @@ import img93fc9ed_To_app from './images/scim-with-okta/93fc9ed-To_app.png' 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). - - SCIM integration with Okta is available in early access. - - To begin using SCIM, you need to enable the SCIM functionality in the [Cloudsmith Workspace Settings](/workspaces/workspace-settings) Follow these steps: diff --git a/src/content/authentication/scim-with-onelogin.mdx b/src/content/authentication/scim-with-onelogin.mdx deleted file mode 100644 index 8d722fba..00000000 --- a/src/content/authentication/scim-with-onelogin.mdx +++ /dev/null @@ -1,21 +0,0 @@ -import { Note, BlockImage } from '@/components' -import img_scim_steps from './images/scim-with-onelogin/821b638351f176305f092a4ab1f6c763359b7c5c5808155d2150217305b559db-scim-steps.png' - -# SCIM with OneLogin - -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 OneLogin. - - - SCIM integration with OneLogin is available in early access. - - -To begin using SCIM, you need to enable the SCIM functionality in the [Cloudsmith Workspace Settings](/workspaces/workspace-settings) - -Follow these steps: - -1. Navigate to the Cloudsmith Workspace Settings. -2. Navigate to Authentication >> SCIM and enable the SCIM functionality by selecting "Allow SCIM" - - - -After enabling SCIM, proceed to OneLogin's Getting Started Guide to complete the setup process. Follow the detailed instructions on their support page for Identity Management Connectors: [JumpCloud Getting Started Guide](https://jumpcloud.com/support/get-started-identity-management-connectors). diff --git a/src/content/authentication/scim-with-pingfederate.mdx b/src/content/authentication/scim-with-pingfederate.mdx deleted file mode 100644 index 8edca71f..00000000 --- a/src/content/authentication/scim-with-pingfederate.mdx +++ /dev/null @@ -1,21 +0,0 @@ -import { Note, BlockImage } from '@/components' -import img_scim_steps from './images/scim-with-pingfederate/d09aad44bccec4d78046752b2e2c223729431e2f5075cf2cefb78c8310bc9fa3-scim-steps.png' - -# SCIM with PingFederate - -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). - - - SCIM integration with PingFederate is available in early access. - - -To begin using SCIM, you need to enable the SCIM functionality in the [Cloudsmith Workspace Settings](/workspaces/workspace-settings) - -Follow these steps: - -1. Navigate to the Cloudsmith Workspace Settings. -2. Navigate to Authentication >> SCIM and enable the SCIM functionality by selecting "Allow SCIM." - - - -After enabling SCIM, proceed to PingFederate's Getting Started Guide to complete the setup process. Follow the detailed instructions on their support page for SCIM Connectors: [Ping Federate SCIM Connector Documentation](https://docs.pingidentity.com/integrations/scim/setup/pf_scim_connector_creating_a_provisioning_connection.html). diff --git a/src/content/authentication/scim.mdx b/src/content/authentication/scim.mdx index f77cafae..646ebd68 100644 --- a/src/content/authentication/scim.mdx +++ b/src/content/authentication/scim.mdx @@ -4,34 +4,40 @@ import { Note } from '@/components' ## Overview -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). +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 user profile information based on changes within your IdP. - SCIM Groups provisioning integration is currently available in early access. Please contact us if you need this feature enabled for your organization. +SCIM Groups provisioning integration is currently available in early access. Please contact us if you need this feature enabled for your organization. - -📘 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. -If you have any question, reach out to [support](https://cloudsmith.com/company/contact-us). - +## Prerequisites for enabling SCIM on Cloudsmith + +To configure SCIM for your organization you must meet the following requirements: + +1. **Cloudsmith plan** – Your account must be on a plan that includes **Ultra** or **Enterprise**. +2. **Administrator access** – You must be the owner of a Cloudsmith organization. +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). +4. **Identity provider (IdP)** – You need an IdP that supports SCIM 2.0 to use with Cloudsmith. + +--- ## Configuration -When configuring your Identity Provider, you'll need the following details which apply to all SCIM integrations with Cloudsmith: +When configuring your IdP, you’ll need the following details that apply to all SCIM integrations with Cloudsmith: + +- **Base URL**: `https://api.cloudsmith.io/scim/v2` +- **Authentication**: Basic Auth, using a SCIM token generated from Cloudsmith. +- **Supported Features**: User provisioning and de‑provisioning. -- **Base URL**: `https://api.cloudsmith.io/scim/v2` -- **Authentication**: Basic Auth, using a SCIM token generated from Cloudsmith. -- **Supported Features**: User provisioning and de-provisioning. + +Make sure to use the user’s e‑mail address as the unique identifier. + -## Supported Providers +## Supported IdP Providers -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: +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: -- [Okta](/authentication/scim-with-okta) +- [Okta](/authentication/scim-with-okta) - [Microsoft Entra ID](/authentication/scim-with-microsoft-entra-id) -- [PingFederate](/authentication/scim-with-pingfederate) -- [Google](/authentication/scim-with-google) -- [JumpCloud](/authentication/single-sign-on-with-jumpcloud) -- [OneLogin](/authentication/single-sign-on-with-onelogin) -Other providers may be supported. If you need help with an unlisted integration, you can still [contact us](https://cloudsmith.com/company/contact-us). +If you need help with an IdP not listed above, feel free to [contact us](https://cloudsmith.com/company/contact-us).