docs litellm SCIM

This commit is contained in:
Ishaan Jaff 2025-04-19 18:24:28 -07:00
parent bc37873d2c
commit 0fa1ad2d9c
2 changed files with 44 additions and 32 deletions

View file

@ -3,49 +3,61 @@ import Image from '@theme/IdealImage';
# SCIM with Litellm
Using SCIM with LitELLM allows you to sync users, groups and group memberships on LiteLLM with your IDP (SSO) Provider.
Enables identity providers (Okta, Azure AD, OneLogin, etc.) to automate user and team (group) provisioning, updates, and deprovisioning on LiteLLM.
The key benefits of using SCIM with LiteLLM are:
- Users are automatically provisioned, deprovisioned, and updated on LiteLLM when they are added to a group in your IDP.
- Groups are automatically provisioned, deprovisioned, and updated on LiteLLM when they are created in your IDP.
- Group memberships are automatically provisioned, deprovisioned, and updated on LiteLLM when they are added to a group in your IDP.
# Usage
## 1. Create a SCIM Application in your IDP
## 1.1 Create a new Application in your IDP
On Azure Entra ID, search for `Enterprise Application` and click on `New Application`.
<Image img={require('../../img/scim_0.png')} style={{ width: '800px', height: 'auto' }} />
<br />
<br />
Now select `Create your own application`.
<Image img={require('../../img/scim_1.png')} style={{ width: '800px', height: 'auto' }} />
<br />
<br />
Enter any name for your application, for example `litellm-scim-app` and select the "Integrate any other application you don't find in the gallery (Non-gallery)" option.
<Image img={require('../../img/scim_3.png')} style={{ width: '800px', height: 'auto' }} />
## 2. Connect your app on your IDP to LiteLLM SCIM Endpoints
## 2.1 Get your SCIM Tenant URL and Bearer Token
## 1. Get your SCIM Tenant URL and Bearer Token
On LiteLLM, navigate to the Settings > Admin Settings > SCIM. On this page you will create a SCIM Token, this allows your IDP to authenticate to litellm `/scim` endpoints.
<Image img={require('../../img/scim_2.png')} style={{ width: '800px', height: 'auto' }} />
## 2.2 Paste your SCIM Tenant URL and Bearer Token into your IDP Provider
## 2. Connect your IDP to LiteLLM SCIM Endpoints
On your IDP provider, navigate your your SSO application and select `Provisioning` > `New provisioning configuration`.
On this page, pase in your litellm scim tenant url and bearer token.
Once this is pasted in, click on `Test Connection` to ensure your IDP can authenticate to the LiteLLM SCIM endpoints.
<Image img={require('../../img/scim_4.png')} style={{ width: '800px', height: 'auto' }} />
## 3. Test SCIM Connection
### 3.1 Assign the group to your LiteLLM Enterprise App
On your IDP Portal, navigate to `Enterprise Applications` > Select your litellm app
<Image img={require('../../img/msft_enterprise_app.png')} style={{ width: '800px', height: 'auto' }} />
<br />
<br />
Once you've selected your litellm app, click on `Users and Groups` > `Add user/group`
<Image img={require('../../img/msft_enterprise_assign_group.png')} style={{ width: '800px', height: 'auto' }} />
<br />
Now select the group you created in step 1.1. And add it to the LiteLLM Enterprise App. At this point we have added `Production LLM Evals Group` to the LiteLLM Enterprise App. The next steps is having LiteLLM automatically create the `Production LLM Evals Group` on the LiteLLM DB when a new user signs in.
<Image img={require('../../img/msft_enterprise_select_group.png')} style={{ width: '800px', height: 'auto' }} />
### 3.2 Sign in to LiteLLM UI via SSO
Sign into the LiteLLM UI via SSO. You should be redirected to the Entra ID SSO page. This SSO sign in flow will trigger LiteLLM to fetch the latest Groups and Members from Azure Entra ID.
<Image img={require('../../img/msft_sso_sign_in.png')} style={{ width: '800px', height: 'auto' }} />
### 3.3 Check the new team on LiteLLM UI
On the LiteLLM UI, Navigate to `Teams`, You should see the new team `Production LLM Evals Group` auto-created on LiteLLM.
<Image img={require('../../img/msft_auto_team.png')} style={{ width: '900px', height: 'auto' }} />

Binary file not shown.

After

Width:  |  Height:  |  Size: 274 KiB