litellm/proxy/management_endpoints/scim/README_SCIM.md
This module provides SCIM v2 (System for Cross-domain Identity Management) endpoints for LiteLLM Proxy, allowing identity providers to manage users and teams (groups) within the LiteLLM ecosystem.
SCIM is an open standard designed to simplify user management across different systems. This implementation allows compatible identity providers (like Okta, Azure AD, OneLogin, etc.) to automatically provision and deprovision users and groups in LiteLLM Proxy.
The SCIM v2 API follows the standard specification with the following base URL:
/scim/v2
| Endpoint | Method | Description |
|---|---|---|
/Users | GET | List all users with pagination support |
/Users/{user_id} | GET | Get a specific user by ID |
/Users | POST | Create a new user |
/Users/{user_id} | PUT | Update an existing user |
/Users/{user_id} | DELETE | Delete a user |
| Endpoint | Method | Description |
|---|---|---|
/Groups | GET | List all groups with pagination support |
/Groups/{group_id} | GET | Get a specific group by ID |
/Groups | POST | Create a new group |
/Groups/{group_id} | PUT | Update an existing group |
/Groups/{group_id} | DELETE | Delete a group |
This implementation follows the standard SCIM v2 schema with the following mappings:
user_iduser_emailteam_idteam_aliasTo enable SCIM in your identity provider, use the full URL to the SCIM endpoint:
https://your-litellm-proxy-url/scim/v2
Most identity providers will require authentication. You should use a valid LiteLLM API key with administrative privileges.
GET /scim/v2/Users?startIndex=1&count=10
POST /scim/v2/Users
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"userName": "[email protected]",
"active": true,
"emails": [
{
"value": "[email protected]",
"primary": true
}
]
}
PUT /scim/v2/Users/{user_id}
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"userName": "[email protected]",
"active": true,
"emails": [
{
"value": "[email protected]",
"primary": true
}
],
"groups": [
{
"value": "team-123",
"display": "Engineering Team"
}
]
}