From 330cd4f2a9f3202743b49193cb0bd9ee5a4a7072 Mon Sep 17 00:00:00 2001 From: Krrish Dholakia Date: Tue, 24 Jun 2025 09:31:33 -0700 Subject: [PATCH] docs(self_serve.md): update self serve docs to include default team / member budget information --- docs/my-website/docs/proxy/self_serve.md | 59 ++++++++++++++++++++++++ 1 file changed, 59 insertions(+) diff --git a/docs/my-website/docs/proxy/self_serve.md b/docs/my-website/docs/proxy/self_serve.md index 39db0fffdb..30c46cfb0a 100644 --- a/docs/my-website/docs/proxy/self_serve.md +++ b/docs/my-website/docs/proxy/self_serve.md @@ -161,6 +161,11 @@ Here's the available UI roles for a LiteLLM Internal User: - `internal_user`: can login, view/create/delete their own keys, view their spend. **Cannot** add new users. - `internal_user_viewer`: can login, view their own keys, view their own spend. **Cannot** create/delete keys, add new users. +**Team Roles:** + - `admin`: can add new members to the team, can control Team Permissions, can add team-only models (useful for onboarding a team's finetuned models). + - `user`: can login, view their own keys, view their own spend. **Cannot** create/delete keys (controllable via Team Permissions), add new users. + + ## Auto-add SSO users to teams This walks through setting up sso auto-add for **Okta, Google SSO** @@ -273,6 +278,60 @@ This budget does not apply to keys created under non-default teams. [**Go Here**](./team_budgets.md) +### Default Team + + + + +Go to `Internal Users` -> `Default User Settings` and set the default team to the team you just created. + +Let's also set the default models to `no-default-models`. This means a user can only create keys within a team. + + + + + + +```yaml +default_internal_user_params: # Default Params used when a new user signs in Via SSO + user_role: "internal_user" # one of "internal_user", "internal_user_viewer", + models: ["no-default-models"] # Optional[List[str]], optional): models to be used by the user + teams: # Optional[List[NewUserRequestTeam]], optional): teams to be used by the user + - team_id: "team_id_1" # Required[str]: team_id to be used by the user + user_role: "user" # Optional[str], optional): Default role in the team. Values: "user" or "admin". Defaults to "user" +``` + + + + +### Team Member Budgets + +Set a max budget for a team member. + +You can do this when creating a new team, or by updating an existing team. + + + + + + + + + +```bash +curl -X POST '/team/new' \ +-H 'Authorization: Bearer ' \ +-H 'Content-Type: application/json' \ +-D '{ + "team_alias": "team_1", + "budget_duration": "10d", + "team_member_budget": 10 +}' +``` + + + + ### Set default params for new teams When you connect litellm to your SSO provider, litellm can auto-create teams. Use this to set the default `models`, `max_budget`, `budget_duration` for these auto-created teams.