mirror of
https://github.com/BerriAI/litellm.git
synced 2025-04-24 18:24:20 +00:00
Litellm docs SCIM (#10174)
* docs scim * docs SCIM stash * docs litellm SCIM * docs fix * docs scim with LiteLLM
This commit is contained in:
parent
55a17730fb
commit
1be36be72e
8 changed files with 76 additions and 0 deletions
74
docs/my-website/docs/tutorials/scim_litellm.md
Normal file
74
docs/my-website/docs/tutorials/scim_litellm.md
Normal file
|
@ -0,0 +1,74 @@
|
|||
|
||||
import Image from '@theme/IdealImage';
|
||||
|
||||
# SCIM with LiteLLM
|
||||
|
||||
Enables identity providers (Okta, Azure AD, OneLogin, etc.) to automate user and team (group) provisioning, updates, and deprovisioning on LiteLLM.
|
||||
|
||||
|
||||
This tutorial will walk you through the steps to connect your IDP to LiteLLM SCIM Endpoints.
|
||||
|
||||
### Supported SSO Providers for SCIM
|
||||
Below is a list of supported SSO providers for connecting to LiteLLM SCIM Endpoints.
|
||||
- Microsoft Entra ID (Azure AD)
|
||||
- Okta
|
||||
- Google Workspace
|
||||
- OneLogin
|
||||
- Keycloak
|
||||
- Auth0
|
||||
|
||||
|
||||
## 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. Connect your IDP to LiteLLM SCIM Endpoints
|
||||
|
||||
On your IDP provider, navigate to your SSO application and select `Provisioning` > `New provisioning configuration`.
|
||||
|
||||
On this page, paste 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 step 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' }} />
|
||||
|
||||
|
||||
|
||||
|
BIN
docs/my-website/img/scim_0.png
Normal file
BIN
docs/my-website/img/scim_0.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 380 KiB |
BIN
docs/my-website/img/scim_1.png
Normal file
BIN
docs/my-website/img/scim_1.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 231 KiB |
BIN
docs/my-website/img/scim_2.png
Normal file
BIN
docs/my-website/img/scim_2.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 261 KiB |
BIN
docs/my-website/img/scim_3.png
Normal file
BIN
docs/my-website/img/scim_3.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 413 KiB |
BIN
docs/my-website/img/scim_4.png
Normal file
BIN
docs/my-website/img/scim_4.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 274 KiB |
|
@ -447,6 +447,7 @@ const sidebars = {
|
|||
items: [
|
||||
"tutorials/openweb_ui",
|
||||
"tutorials/openai_codex",
|
||||
"tutorials/scim_litellm",
|
||||
"tutorials/msft_sso",
|
||||
"tutorials/prompt_caching",
|
||||
"tutorials/tag_management",
|
||||
|
|
1
litellm/openai-responses-starter-app
Submodule
1
litellm/openai-responses-starter-app
Submodule
|
@ -0,0 +1 @@
|
|||
Subproject commit bf0485467c343957ba5c217db777f407b2e65453
|
Loading…
Add table
Add a link
Reference in a new issue