hf dZddlZddlZddlZddlZddlmZmZddlmZm Z m Z m Z m Z m Z ddlZddlmZmZmZmZmZmZddlZddlmZddlddlmZdd lmZdd lmZdd lm Z dd l!m"Z"m#Z#dd l$m%Z%ddl&m'Z'ddl(m)Z)m*Z*m+Z+m,Z,m-Z-m.Z.m/Z/ddl0m1Z1m2Z2m3Z3m4Z4e5rddl6m7Z7eZ8de9de:de9fdZ;de e<deddfdZ=defdZ? ddede e<de e@d eAd!f d"ZBde e e e<e eCffd#ZDded$e e e<e eCfddf d%ZEe8jd&d'geegeG(e%eefde:de>fd)ZHe8jd*d'gd+eeg,eefde>fd-ZJd.e e e eKe eLfdefd6ZQd7ZRd8e e eSd9e e e eKe eLffd:ZTde9de eUeVfde9fd;ZW ddd=e e<de eZXe8jd?d'geeg3e%eefdeUde>fd@ZY ddAe eUde>d=e e<de2fdBZZe8jdCd'geege2(e%eeeddDEfde1de>d=e e<fdFZ[ ddGe e e<fdHZ\dIe e<dJed=e e<fdcZadef doZedpe/dqe,de/fdrZfdse)dqe,dte ede.fdZhy)z Internal User Management Endpoints These are members of a Team on LiteLLM /user/new /user/update /user/delete /user/info /user/list N)datetimetimezone)AnyDictListOptionalUnioncast) APIRouterDependsHeader HTTPExceptionRequeststatus)verbose_proxy_logger)*)user_api_key_auth)UserManagementEventHooks)get_daily_activity)_user_has_admin_view)generate_key_helper_fnprepare_metadata_fields)management_endpoint_wrapper)handle_exception_on_proxy)BreakdownMetrics KeyMetadataKeyMetricWithMetadataLiteLLM_DailyUserSpendMetricWithMetadataSpendAnalyticsPaginatedResponse SpendMetrics)BulkUpdateUserRequestBulkUpdateUserResponseUserListResponseUserUpdateResult) PrismaClient data_jsondatareturnchd|vr%|d ttj|d<|jdd}|durd|d<tj r|j tjjk7r|j tjk7rltj jD]K\}}|dk(r ||vs|||||<|dk(s!t||ts5t||d k(sG|||<M|j |j tjjk(rhtj$|j!d tj|d <tj"$|j!d tj"|d <|jd d|S) Nuser_idauto_create_keyTFuser table_nameavailable_teamsmodelsr max_budgetbudget_durationteams)struuiduuid4poplitellmdefault_internal_user_params user_roleLitellmUserRoles PROXY_ADMINvalueitems isinstancelistlen INTERNAL_USERmax_internal_user_budgetgetinternal_user_budget_duration)r'r(r,keyr=s v/var/www/Befach/backend/env/lib/python3.12/site-packages/litellm/proxy/management_endpoints/internal_user_endpoints.py _update_internal_new_user_paramsrH;sI)I"6">"4::<0 )mm$5t>DDFJC''I%3)?!& #xy~t4 #'1,!& #G " NN.<<BB B  , , 8 l+3&-&F&FIl #  1 1 = /08+2+P+PI' ( MM'4  user_email prisma_clientcK|rn| td|jjjd|j ddid{}|t ddd |j d i yy7%w) a< Helper function to check if a user email already exists in the database. Args: user_email (Optional[str]): Email to check prisma_client (Any): Database client instance Raises: Exception: If database is not connected HTTPException: If user with email already exists NDatabase not connectedrJ insensitive)equalsmodewhereerrorzUser with email z already exists status_codedetail) Exceptiondblitellm_usertable find_firststriprrJ)rJrK existing_users rG_check_duplicate_user_emailr^ks  45 5+..@@KKJ,<,<,> !VWL    $/ 0H0H/IY  % sA A6A4&A6r+ organizationsr&user_api_key_dictc Kddlm}g}|D]N}|j|t|t |t j gtddd| Ptj|d d id {y 7w) z% Add a user to organizations r)organization_member_add)r+role)organization_idmemberhttp /user/newtypepathscope)r( http_requestr`return_exceptionsTN) 9litellm.proxy.management_endpoints.organization_endpointsrbappendOrganizationMemberAddRequest OrgMemberr;rBrasynciogather)r+r_rKr`rbtasksrds rG_add_user_to_organizationsrvs E( #1$3!$+!1!?!?%#);?#4  )$ ..% 84 888sA4A>6A<7A>team_idmax_budget_in_teamr:)r-adminc $Kddlm} |t|t|||||d{y7#t$r}|j dk(rHdt |vs dt |vr.tjd jt |n2tjd jt |Yd}~yYd}~yd}~wt$r}dt |vs dt |vr.tjd jt |nat|trJtj|jvr.tjd jt |n|Yd}~yYd}~yd}~wwxYww) Nr)team_member_add)r+rcrJ)rwrerx)r(r`rSzalready existsz doesn't existzglitellm.proxy.management_endpoints.internal_user_endpoints.new_user(): User already exists in team - {}z]litellm.proxy.management_endpoints.internal_user_endpoints.new_user(): Exception occured - {})1litellm.proxy.management_endpoints.team_endpointsr{TeamMemberAddRequestMemberrrVr4rdebugformatrXr?ProxyExceptionProxyErrorTypesteam_member_already_in_teamri)r+rwr`rJrxr:r{es rG_add_user_to_teamrsxR-%#") $60    ==C  A &/SV*C & &yAAF  ! & &ovvF      s1v %CF)B & &yAAF  q. );;qvvE & &yAAF  G   sKF%757F7 F BC F F B$F> FF  Fc ~tjytjjd}|td|Dr|Std|DrJ|Dcgc]>}t |jd|jd|jdd@c}St j d |ycc}w) Nr3c3<K|]}t|tywN)r?r4.0teams rG z,check_if_default_team_set..s7z$$7c3<K|]}t|tywr)r?dictrs rGrz,check_if_default_team_set..s:DD$':rrwrxr:r-)rwrxr:z5Invalid team type in default internal user params: %s)r8r9rDallNewUserRequestTeamrrT)r3rs rGcheck_if_default_team_setrs++3  0 0 4 4W =E  77 7L :E: :"   # HHY/'+xx0D'E"hh{F;  ! & &G  sAB:r3c DKg}|D]v}d}t|tr|}n@t|tr|j}|j}nt dt ||jt|||||xtj|ddid{y7w)Nr-zInvalid team type: )r+rwrJr`r:rnT) r?r4rrwr: ValueErrorrirprrsrt) r+rJr`r3rKrurr:rws rGadd_new_user_to_default_teamrs E.4 dC G 0 1llGI24:,?@ @ %"3#   & ..% 84 888sBB BB rgzInternal User management)tags dependenciesresponse_modelc K ddlm}m}|%tdtj j |%tdtj j t|j|d{|jjjd{}|r|j|r tdd |j}t||}|j}| t!}t#t$t&t(|j+d d}t-dd d i|d{}|j/d d} | At1t#t(|j/d| ||jdd d{nA|?t3t#t(|j/d|j|||d{t#t$t(|j/dd} || t5| |||d{ddg} i} |j7D]0\} }| t8j:j=vs'| | vs,|| | <2|j/dd| d<t9di| }t?j@tCjD||||S7777y7(77#tF$r=}tIjJdjMt)|tO|d}~wwxYww)a Use this to create a new INTERNAL user with a budget. Internal Users can access LiteLLM Admin UI to make keys, request access to models. This creates a new user and generates a new api key for the new user. The new api key is returned. Returns user id, budget + new key. Parameters: - user_id: Optional[str] - Specify a user id. If not set, a unique id will be generated. - user_alias: Optional[str] - A descriptive name for you to know who this user id refers to. - teams: Optional[list] - specify a list of team id's a user belongs to. - user_email: Optional[str] - Specify a user email. - send_invite_email: Optional[bool] - Specify if an invite email should be sent. - user_role: Optional[str] - Specify a user role - "proxy_admin", "proxy_admin_viewer", "internal_user", "internal_user_viewer", "team", "customer". Info about each role here: `https://github.com/BerriAI/litellm/litellm/proxy/_types.py#L20` - max_budget: Optional[float] - Specify max budget for a given user. - budget_duration: Optional[str] - Budget is reset at the end of specified duration. If not set, budget is never reset. You can set duration as seconds ("30s"), minutes ("30m"), hours ("30h"), days ("30d"), months ("1mo"). - models: Optional[list] - Model_name's a user is allowed to call. (if empty, key is allowed to call all models). Set to ['no-default-models'] to block all model access. Restricting user to only team-based model access. - tpm_limit: Optional[int] - Specify tpm limit for a given user (Tokens per minute) - rpm_limit: Optional[int] - Specify rpm limit for a given user (Requests per minute) - auto_create_key: bool - Default=True. Flag used for returning a key as part of the /user/new response - aliases: Optional[dict] - Model aliases for the user - [Docs](https://litellm.vercel.app/docs/proxy/virtual_keys#model-aliases) - config: Optional[dict] - [DEPRECATED PARAM] User-specific config. - allowed_cache_controls: Optional[list] - List of allowed cache control values. Example - ["no-cache", "no-store"]. See all values - https://docs.litellm.ai/docs/proxy/caching#turn-on--off-caching-per-request- - blocked: Optional[bool] - [Not Implemented Yet] Whether the user is blocked. - guardrails: Optional[List[str]] - [Not Implemented Yet] List of active guardrails for the user - permissions: Optional[dict] - [Not Implemented Yet] User-specific permissions, eg. turning off pii masking. - metadata: Optional[dict] - Metadata for user, store information for user. Example metadata = {"team": "core-infra", "app": "app2", "email": "ishaan@berri.ai" } - max_parallel_requests: Optional[int] - Rate limit a user based on the number of parallel requests. Raises 429 error, if user's parallel requests > x. - soft_budget: Optional[float] - Get alerts when user crosses given budget, doesn't block requests. - model_max_budget: Optional[dict] - Model-specific max budget for user. [Docs](https://docs.litellm.ai/docs/proxy/users#add-model-specific-budgets-to-keys) - model_rpm_limit: Optional[float] - Model-specific rpm limit for user. [Docs](https://docs.litellm.ai/docs/proxy/users#add-model-specific-limits-to-keys) - model_tpm_limit: Optional[float] - Model-specific tpm limit for user. [Docs](https://docs.litellm.ai/docs/proxy/users#add-model-specific-limits-to-keys) - spend: Optional[float] - Amount spent by user. Default is 0. Will be updated by proxy whenever user is used. You can set duration as seconds ("30s"), minutes ("30m"), hours ("30h"), days ("30d"), months ("1mo"). - team_id: Optional[str] - [DEPRECATED PARAM] The team id of the user. Default is None. - duration: Optional[str] - Duration for the key auto-created on `/user/new`. Default is None. - key_alias: Optional[str] - Alias for the key auto-created on `/user/new`. Default is None. - sso_user_id: Optional[str] - The id of the user in the SSO provider. - object_permission: Optional[LiteLLM_ObjectPermissionBase] - internal user-specific object permission. Example - {"vector_stores": ["vector_store_1", "vector_store_2"]}. IF null or {} then no object permission. - organizations: List[str] - List of organization id's the user is a member of Returns: - key: (str) The generated api key for the user - expires: (datetime) Datetime object for when key expires. - user_id: (str) Unique user id - used for tracking spend across multiple keys for same user id. - max_budget: (float|None) Max budget for given user. Usage Example ```shell curl -X POST "http://localhost:4000/user/new" -H "Content-Type: application/json" -H "Authorization: Bearer sk-1234" -d '{ "username": "new_user", "email": "new_user@example.com" }' ``` r)_license_checkrKNrSrU) total_usersizOLicense is over limit. Please contact support@berri.ai to upgrade your license.r_ request_typer-rwr+)r+rwr`rJrxr:)r+rJr`r3rK)r+r_rKr`tokentoken_idrF)r(responser`z!/user/new: Exception occured - {})(litellm.proxy.proxy_serverrrKrCommonProxyErrorsdb_not_connected_errorr=r^rJrYrZcount is_over_limitjsonrHr3rr rrr4r7rrDrrrvr>NewUserResponse model_fieldskeysrs create_taskrasync_user_created_hookrXr exceptionrr)r(r`rrKrr'r3organization_idsr_team_idr+ special_keys response_dictrFr=new_user_responsers rGnew_userrsH_+L  (9(P(P(V(V   (??EE  *$//=III*,,>>DDFF >77K7Ph  IIK 4YE   =-/E T#Y !E 0QVQyQQ==D1  #S(,,y"9: "3??#'    .S(,,y"9:??"3+   x}hll9d&CD  'G,?,.+"3    ,  "..*JCo227799c>U%* c"+ (||GR8 e+ (** +sLA/J:3J*4+J:J- BJ:7J08AJ: J3 AJ: J6AJ:J8AJ:J:AJ:)L*J:-J:0J:3J:6J:8J:: L8K;;LLz/user/available_rolesF)rinclude_in_schemarcKi}tD]i}|tjtjtjtjfvsD|j |j d||j<k|Sw)z Endpoint used by Admin UI to show all available roles to assign a user return { "proxy_admin": { "description": "Proxy Admin role", "ui_label": "Admin" } } ) descriptionui_label)r;r<PROXY_ADMIN_VIEW_ONLYrBINTERNAL_USER_VIEW_ONLYrrr=)r`_data_to_returnrcs rGui_get_available_rolersr&O    ( (  2 2  * *  4 4    $// MM+ODJJ '! s A A9*A9 team_listc>|y|D]}|j|k(s|cSyr)rw)rrwrs rGget_team_from_listrs- <<7 "K rIrequestcd}t|jj}d|vr7ddl}ddlm}|j d|}|r||jd}|}|S)z* Get the user id from the request Nzuser_id=r)unquotezuser_id=([^&]*))r4urlqueryre urllib.parsersearchgroup)rr+ query_stringrrmatch raw_user_ids rGget_user_id_from_requestrs[ "Gw{{(()L\!( ,l; !%++a.1K!G NrI /user/info)rrz!User ID in the request parameters)defaultrcKddlm} |d|vr t|}| td|/|jt j k(rtd{S| |j}||j|d{}nd}g}g}ddl m }|td d d  || d{}|4t|tr$|}|D]} |j| j d} |||j|j"ddd{} | t| tr| D]=} | j |vs|j| |j| j ?n|j||j|jd{} | &|j| j"ddd{} | Rt| trB| D]=} | j |vs|j| |j| j ?|j|ddd{} || d} | D]}| t%|ddz } d| i}t'| |}|j)dt|t*r|j-n|}t/||||}|S7P7)77777#t$r=}t1j2dj5t7|t9|d}~wwxYww)aA [10/07/2024] Note: To get all users (+pagination), use `/user/list` endpoint. Use this to get user information. (user row + all user key info) Example request ``` curl -X GET 'http://localhost:4000/user/info?user_id=krrish7%40berri.ai' --header 'Authorization: Bearer sk-1234' ``` rrKN )rDatabase not connected. Connect a database to your proxy - https://docs.litellm.ai/docs/simple_proxy#managing-auth---virtual-keys)r+) list_teamrfrrhrk)rmr+r`rfind_all) team_id_listr. query_typerF)r+r.rspendr all_teamsc$t|ddxsdSN team_aliasrgetattrxs rGzuser_info..sgar&B&Hb&HrIrFr+ user_inforr3z>litellm.proxy.proxy_server.user_info(): Exception occured - {})rrKrrXr:r;r<_get_user_info_for_proxy_adminr+get_datar|rrr?r@rprwr3r_process_keys_for_user_infosort BaseModel model_dumpUserInfoResponserrrr4r)rr+r`rKrrrrteams_1rteams_2caller_user_inforrk returned_keys _user_info response_datars rGrrsL69k+  C7N.w?G  T  O!++/?/K/KK799 9 _'//G  +44W4EEII  O! %|</     :gt#<I##DLL1 "&  )22&__J3G"z'4'@#D||<7!((.$++DLL9$  % % 1go%2%;%;)11&<&   + - 6 6!1!7!7%)!7! "z'4'@#D||<7!((.$++DLL9$ #++!,    !1EGQ// %(I4Q IJ&0I&FI "I )z Y k: F    0 +&& L S SA  (** +sLA J8J%J8L%J8?J(,J8,J+-AJ8 J. *J88AJ8J1'J8<J4=)J8'AJ8,J6-A7J8$L%J8(J8+J8.J81J84J86J88 K>8K99K>>LcKddlm}d}| td|jj |d{}t j d||ddxsg}g}|D]2}|jdg|d<|jtdi|4|dd xsg}|Dcgc] }tdi|}}|jd t|| }tdd|| S7cc}ww)a1 Admin UI Endpoint - Returns All Teams and Keys when Proxy Admin is querying - get all teams in LiteLLM_TeamTable - get all keys in LiteLLM_VerificationToken table Why separate helper for proxy admin ? - To get Faster UI load times, get all teams and virtual keys in 1 query rrz SELECT (SELECT json_agg(t.*) FROM "LiteLLM_TeamTable" t) as teams, (SELECT json_agg(k.*) FROM "LiteLLM_VerificationToken" k WHERE k.team_id != 'litellm-dashboard' OR k.team_id IS NULL) as keys Nrzresults_keys: %srr0r3c$t|ddxsdSrrrs rGrz0_get_user_info_for_proxy_admin..sWQ b%A%GR%GrIrrrr)rrKrXrY query_rawrrrDrpLiteLLM_VerificationTokenLiteLLM_TeamTablerrr) rK sql_queryresults _keys_in_db keys_in_dbrF _teams_in_dbrrs rGrrs9I  P  "$$..y99G17; 6*0bKJ 778  $CM3:c:; !G,2L:FG$%--GLGHI/Z<XM    #:Hs"4C0C)A/C0&C+82C0+C0rrc~ddlm}m}g}| |S|D]}|j|k(r|j dddur' |j }d|vr8|d3|ddk7r+t||d}|t|d d}||d <n d|d <nd |d <|j||S#t $r|j}YqwxYw) Nr)general_settingslitellm_master_key_hashdisable_master_key_returnFTrwzlitellm-dashboard)rrwrNone) rrrrrDrrXrrrrp) rrrrrrF_key team_infors rGrrsUM | > ;C 44$(()DeL " ^^- T!O/O'::.'i (!(L$!GJ)3D&)-D&%+\"   &9: ' "xxz "sB  B<;B<ci}|jD]\}}| |gifvs|tvs|||<d}|jtjk(rd}d|vrddlm}||d|d<d|vr%|r#tjtj|d<d|vr:|r8tj(tj|d<ddlm}||d|d<|S) NFTr2r)get_budget_reset_time)r2budget_reset_atr1) r>)LiteLLM_ManagementEndpoint_MetadataFieldsr:r;rB)litellm.proxy.common_utils.timezone_utilsrr8rCrE)r'r(non_default_valuesrvis_internal_userrs rG_update_internal_user_paramsr s!1 M BB$% q !" ~~)777..S0E./@A1 ,--- !A!A!M/6/O/O | , !33  E E Q55 0 1 X4I 23D E5 0 1 rI user_requestlitellm_changed_byc 2Kddlm}m}| td|js|j s t d|jd}t||}d}|jr;|jjjd |ji d{}nF|j r:|jjjd |j i d{}|tdi|jd }|ttt|d ixsini}t!|||xsi}d} |jrNt#|jdkDr6|j|d <|j%|j|dd{} n|j r|j'd |j iddd{} | r\t)| t*rLt#| dkDr>| D]8} | j|d <|j%| j|dd{} nLnJt-t/j0|d <|j |d <|j3|dd{} | |jjjd | d i d{} | rtdi| jd } t5j6t9j:| jd|xs |j|||r|j=d nd| j=d | tEdddi| S77c777077#t$r4}t?j@d| jCd d|Yd}~^d}~wwxYww)z Helper function to update a single user. Used by both user_update and bulk_user_update endpoints. Returns the updated user data or raises an exception on failure. rlitellm_proxy_admin_namerKNzNot connected to DB!z-Either user_id or user_email must be providedT exclude_unsetr'r(r+rQrJ exclude_nonemetadata)r(r existing_metadatar-)r+r(r.r)key_valr.r)r(r.updatedr+actionrr`r before_value after_valuez$Failed to create audit log for user : rSrTzFailed to update userrUr)#rrrKrXr+rJrrr rYrZr[LiteLLM_UserTabler rrrrA update_datarr?r@r4r5r6 insert_datarsrrcreate_internal_user_audit_logmodel_dump_jsonrwarningrDr)rr`rrrKr'r existing_user_rowrrexisting_user_rowsr]updated_user_rowuser_row_typed audit_errors rG_update_single_user_helperr,sS.//    (?(?HII#--D-AI6, .2"/"2"2"D"D"O"Ol223#P#    "/"2"2"D"D"O"O!8!89#P#  $- ***=   ( T7,j"=CD  1 -+1r*.HL$8$8 9A =(4(<(<9%&22 ((#3    #0#9#9!<#:#:;!$:$   -t4&'!+!3 0=0E0E"9-!.!:!:)11+%";" "4-0 ,= y )/;/F/F | ,*66'F7H  %2%5%5%G%G%R%R (9"56&S&   !2"&11t1D" ##,KK . 6 6(+=,5,44*;1I 1.==4=P!%$2$B$BPT$B$U *45   OO  4   4  ( (6x||I7N6OrR]Q^_   sBNMAN$M%B,NM 4NM AN M!A N.M/N6.M$M%B M1NN N NNNM N *N NNNz /user/updatec K tjd|t||d{}|S7#t$r}tjdj t |tjtjt|trYtt|ddt |dtjt|dd t|d tj  t|tr|td t |ztjt|dd tj d}~wwxYww) a Example curl ``` curl --location 'http://0.0.0.0:4000/user/update' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{ "user_id": "test-litellm-user-4", "user_role": "proxy_admin_viewer" }' ``` Parameters: - user_id: Optional[str] - Specify a user id. If not set, a unique id will be generated. - user_email: Optional[str] - Specify a user email. - password: Optional[str] - Specify a user password. - user_alias: Optional[str] - A descriptive name for you to know who this user id refers to. - teams: Optional[list] - specify a list of team id's a user belongs to. - send_invite_email: Optional[bool] - Specify if an invite email should be sent. - user_role: Optional[str] - Specify a user role - "proxy_admin", "proxy_admin_viewer", "internal_user", "internal_user_viewer", "team", "customer". Info about each role here: `https://github.com/BerriAI/litellm/litellm/proxy/_types.py#L20` - max_budget: Optional[float] - Specify max budget for a given user. - budget_duration: Optional[str] - Budget is reset at the end of specified duration. If not set, budget is never reset. You can set duration as seconds ("30s"), minutes ("30m"), hours ("30h"), days ("30d"), months ("1mo"). - models: Optional[list] - Model_name's a user is allowed to call. (if empty, key is allowed to call all models) - tpm_limit: Optional[int] - Specify tpm limit for a given user (Tokens per minute) - rpm_limit: Optional[int] - Specify rpm limit for a given user (Requests per minute) - auto_create_key: bool - Default=True. Flag used for returning a key as part of the /user/new response - aliases: Optional[dict] - Model aliases for the user - [Docs](https://litellm.vercel.app/docs/proxy/virtual_keys#model-aliases) - config: Optional[dict] - [DEPRECATED PARAM] User-specific config. - allowed_cache_controls: Optional[list] - List of allowed cache control values. Example - ["no-cache", "no-store"]. See all values - https://docs.litellm.ai/docs/proxy/caching#turn-on--off-caching-per-request- - blocked: Optional[bool] - [Not Implemented Yet] Whether the user is blocked. - guardrails: Optional[List[str]] - [Not Implemented Yet] List of active guardrails for the user - permissions: Optional[dict] - [Not Implemented Yet] User-specific permissions, eg. turning off pii masking. - metadata: Optional[dict] - Metadata for user, store information for user. Example metadata = {"team": "core-infra", "app": "app2", "email": "ishaan@berri.ai" } - max_parallel_requests: Optional[int] - Rate limit a user based on the number of parallel requests. Raises 429 error, if user's parallel requests > x. - soft_budget: Optional[float] - Get alerts when user crosses given budget, doesn't block requests. - model_max_budget: Optional[dict] - Model-specific max budget for user. [Docs](https://docs.litellm.ai/docs/proxy/users#add-model-specific-budgets-to-keys) - model_rpm_limit: Optional[float] - Model-specific rpm limit for user. [Docs](https://docs.litellm.ai/docs/proxy/users#add-model-specific-limits-to-keys) - model_tpm_limit: Optional[float] - Model-specific tpm limit for user. [Docs](https://docs.litellm.ai/docs/proxy/users#add-model-specific-limits-to-keys) - spend: Optional[float] - Amount spent by user. Default is 0. Will be updated by proxy whenever user is used. You can set duration as seconds ("30s"), minutes ("30m"), hours ("30h"), days ("30d"), months ("1mo"). - team_id: Optional[str] - [DEPRECATED PARAM] The team id of the user. Default is None. - duration: Optional[str] - [NOT IMPLEMENTED]. - key_alias: Optional[str] - [NOT IMPLEMENTED]. - object_permission: Optional[LiteLLM_ObjectPermissionBase] - internal user-specific object permission. Example - {"vector_stores": ["vector_store_1", "vector_store_2"]}. IF null or {} then no object permission. z /user/update: Received data = %s)rr`Nz@litellm.proxy.proxy_server.user_update(): Exception occured - {}rWzAuthentication Error()paramrrV)messagerir/codezAuthentication Error, )rrr,rXrrr4 traceback format_excr?rrrr auth_errorrHTTP_400_BAD_REQUEST)r(r`rrs rG user_updater6s+p ""#EtL3/     && N U UA  ""9#7#7#9: a ' 8/DSVHA-NO$//a&1Q v/J/JK   > *G,s1v5 ++!Wf-,,   ! s1E&313E3 EDEEEusers_to_updatec Kg}d}d} |D]c} t|||d{}|jt|r|jdn |j|j d||dz }et|t||| S7h#t $r}tjd|jxs |j d|t|} tjd|jxs |j d| |jt|j|j d | |dz }Yd}~7d}~wwxYw#t $r5}tjd |td dt|id}~wwxYww)Nr)rr`rr+Tr+rJsuccess updated_userrzFailed to update user r F)r+rJr:rTrtotal_requestedsuccessful_updatesfailed_updateszFailed to update users: rrTrU)r,rpr%rDr+rJrXrrr4rTr#rAr) r7r`rrr>r?rrr error_messages rGbulk_update_processed_usersrAs ')GN2G+L& $!;!-&7'9" $ (%LL3!-!5!5#/#:#: $%-  #a'"),R&01)   O& $$..,\-A-A-\\E\E\,]]_`a_bc!$A $**,\-A-A-\\E\E\,]]_`m_no$ , 4 4#/#:#: %+ !#% $4 G&&)A!'EFWc!f4EFFGscF E B B AB 0E F  B  EB(E=E EE F 0FF  F z/user/bulk_updatezThe litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability)rc Kddlm}m}|tdddig}|jr|j r|j jjdd i d{}|std dd id}t||kDrtd dd |dt|di|j jd}t||j } | jdd| jddd} d} g} |j jji| d{|D]G} | jt| j | j"dd| j i| | dz } I t%j&t)j*|j xsdd|xs |j ||dt|dt-j.| | dkDr@t;| t|| | S|j<r |j<}ntd dd i|std dd id}t||kDrtd dd |dt|dit?tAtBtD|||!d{S7:7p#t0$r"}t3j4d|Yd}~d}~wwxYw#t0$rf}t3j6d||D]>} |j j9}| j |_|j|@Yd}~Nd}~wwxYw7w)"a Bulk update multiple users at once. This endpoint allows updating multiple users in a single request. Each user update is processed independently - if some updates fail, others will still succeed. Parameters: - users: Optional[List[UpdateUserRequest]] - List of specific user update requests - all_users: Optional[bool] - Set to true to update all users in the system - user_updates: Optional[UpdateUserRequest] - Updates to apply when all_users=True Returns: - results: List of individual update results - total_requested: Total number of users requested for update - successful_updates: Number of successful updates - failed_updates: Number of failed updates Example request for specific users: ```bash curl --location 'http://0.0.0.0:4000/user/bulk_update' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{ "users": [ { "user_id": "user1", "user_role": "internal_user", "max_budget": 100.0 }, { "user_email": "user2@example.com", "user_role": "internal_user_viewer", "max_budget": 50.0 } ] }' ``` Example request for all users: ```bash curl --location 'http://0.0.0.0:4000/user/bulk_update' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{ "all_users": true, "user_updates": { "user_role": "internal_user", "max_budget": 50.0 } }' ``` rrNrrTrMrU created_atdesc)orderrSzNo users found to updatezMaximum z% users can be updated at once. Found z users.Trrr+rJrRr(r9rrrzUpdated z usersrz!Failed to create bulk audit log: zFailed to perform bulk update: r<zkMust specify either 'users' for individual updates or 'all_users=True' with 'user_updates' for bulk updates)r7r`r)#rrrKr all_users user_updatesrYrZ find_manyrArr r7 update_manyrpr%r+rJrsrrr$rdumpsrXrr&r model_copyr#usersrAr rUpdateUserRequest)r(r`rrrKr7all_users_in_dbMAX_BATCH_SIZEr'r r>r?rr-r+ruser_update_requests rGbulk_user_updaterR<sFS56    ~~$++ - 0 0 B B L L(!M!  !;<    . 0x'77\]`ap]q\rryz ++66T6J 9d&7&7  y$/|T2*,+ <""44@@1A   ($ $ #'?? $&/%TAS%T #a'"( ##,KK 1 9 9 ?R(+=,5,44*;1I'/O0D/EV%L$(JJ/A$B  2  !) #O 4#5-   **G   78  N ?n,8N#33XY\]lYmXnnuv  -T"34oF+- c H < $,,7 }E   < * *-LQC+P Q'&*&7&7&B&B&D#.2ll#+&&':;( rerYrZrIrr[r+rrrpLiteLLM_UserTableWithKeyCountrrD)rcrSrjrJrrkrlr\r]rKruwhere_conditionsuid user_id_listsid sso_id_listrr rcrM total_countr-user_key_countsry user_lists rG get_usersrOsz9>}oNO  1H !D(* (,%Jx-/7~~c/BRciik R R ,' #*Z"="!* &  JtS1 4% !J|S$A.:.@.@.EUssyy{U U ++ ' *:)?)?)ASAQ]1SS  :gs#; gz2   ""44>>   H|V&< ? E&((::@@GW@XXK  3 U;TDLL;!  !7 }EF!LI-.K68I D   -oo'3B3F3Ft||UV3W  "  MS"V T Y < s{AI?I$)I$;A!I?I)2I)I? I.+I.0AI?I4-I?3I64I?I8  I?!I="BI?6I?8I?z /user/deletecKddlm}ddlm}m}m}|t dddi|jt d dd i|jD]+}|jjjd |i d{}|t d dd|itjdur|jd} tj|t!t#t%j&t)j*t,j.|xs|j0xs||j2t4j6|dd|  |jj8j;dd|j<ii d{} g} | D]} |t?di| jAtC| jD|j0|jF\} }| sT|Dcgc]}|jA}}tjH|| _%| jM| | D]I} |jj8jOd| jDid| jJid{K.|jjPjSd d|jii d{|jjTjSd d|jii d{|jjVjSd d|jii d{|jjXjSd d|jii d{|jjjSd d|jii d{}|S7.7)cc}w7C7777W7w)a{ delete user and associated user keys ``` curl --location 'http://0.0.0.0:4000/user/delete' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data-raw '{ "user_ids": ["45e3e396-ee08-4a61-a88e-16b3ce7e0849"] }' ``` Parameters: - user_ids: List[str] - The list of user id's to be deleted. r)_cleanup_members_with_roles)create_audit_log_for_updaterrKNrrTNo db connectedrUrSzNo user id passed inr+rQizUser not found, passed user_id=Trdeletedz{}) id updated_at changed_bychanged_by_api_keyr. object_idrupdated_valuesr) request_datarwro)rwr+rJ)existing_team_rowr(members_with_rolesrFr)-r|rrrrrKrrSrYrZ find_uniquer8store_audit_logsrrsrLiteLLM_AuditLogsr4r5r6rnowrutcr+api_keyLitellmTableNamesUSER_TABLE_NAMElitellm_teamtablerIr3rrTeamMemberDeleteRequestrwrJrKrrpupdaterY delete_manylitellm_invitationlinklitellm_organizationmembershiplitellm_teammembership)r(r`rrrrrKr+user_row _user_rowfetch_all_teamsteams_to_updateris_member_in_teamnew_team_membersm_db_new_team_members deleted_userss rG delete_userrs@ W>O4PQQ }}W>T4UVV==&));;GGg&H    #B7)!LM ''4/$MMtM< ##/%6"4::<0'/||HLL'A'9(8088(87/@/H/H'8'H'H&-#,+/)2 &&!. 0 0 B B L LtX^^45!M!  #D2M"3"Hdoo6G"H, LL$,,'223 / /!,<4'(ALLN4$4+/**5I*J'&&t,$$$D""44;; $,,/*D,C,CD<  $u!D    4 4 @ @4/0 A     1 1 = =4/0 >     9 9 E E4/0 F     1 1 = =4/0 >  (**<<HH4/0IM s F 4     sA8O:N(;DON+AOO#N.:A6O0N31AO1N62;O-N9.;O)N;*;O%N=&;O!N?"O+O.O6O9O;O=O?OrdcrKddlm}| td |jjj d|id{}|td||jj j|||d d{}|S7H7#t$r}td t|d}~wwxYww) a Helper function to add an internal user to an organization Adds the user to LiteLLM_OrganizationMembership table - Checks if organization_id exists Raises: - Exception if database not connected - Exception if user_id or organization_id not found rrNrMrdrQz/Organization not found, passed organization_id=)r+rdr:)r(z$Failed to add user to organization: ) rrKrXrYlitellm_organizationtablerrcreater4)r+rdr:rKorganization_rownew_membershiprs rG!add_internal_user_to_organizationrzs 9011I!.!1!1!K!K!W!W$o6"X"    #A/ARS  -//NNUU"#2& V  %   I>s1vhGHHIsMB7+BB ABB B B7 B B B4B//B44B7z/user/filter/uimodel)rrr responsesz$User email in the request parameterszPage number for pagination)rrrf2)rrrfric Kddlm}|tdddi |dz |z}i}|r|d d |d <|r|d d |d <|jjj |||d did{}|sgS|D cgc]} t di| jc} S7/cc} w#t$r?} tjdt| tddt| d} ~ wwxYww)a  [PROXY-ADMIN ONLY]Filter users based on partial match of user_id or email with pagination. Args: user_id (Optional[str]): Partial user ID to search for user_email (Optional[str]): Partial email to search for page (int): Page number for pagination (starts at 1) page_size (int): Number of items per page (max 100) user_api_key_dict (UserAPIKeyAuth): User authentication information Returns: List[LiteLLM_SpendLogs]: Paginated list of matching user records rrNrrTrrUrrNrpr+rJrCrDrtzError searching users: r) rrKrrYrZrILiteLLM_UserTableFilteredrrXrrr4) r+rJrkrlr`rKrur|rMr-rs rG ui_view_usersrs&J9W>O4PQQ$XqI% #%+ Y ' &%. \ * ""44>>&#V, ?  IKPQ4)>DOO,=>QQ R X&&)@Q'IJ6McRSfX4VWWXsYC)A B'B(B/C)0B4 BBC)BB C&':C!!C&&C) group_metricsrecordcN|xj|jz c_|xj|jz c_|xj|jz c_|xj|jz c_|xj|jz c_|xj |j|jzz c_|xj |j z c_|xj|jz c_|xj|jz c_|Sr) r prompt_tokenscompletion_tokenscache_read_input_tokenscache_creation_input_tokens total_tokens api_requestssuccessful_requestsfailed_requests)rrs rGupdate_metricsrs6<<'6#7#77##v'?'??#))V-K-KK)--1S1SS-&"6"69Q9Q"QQ&"5"55%%)C)CC%!!V%;%;;! rI breakdownmodel_metadataprovider_metadataapi_key_metadatac |jr|j|jvrFtt|j |ji|j|j<t |j|jj ||j|j_|jxsd}||jvr2tt|j |i|j|<t |j|j ||j|_|j|jvr`ttt|j |jij dd|j|j<t |j|jj ||j|j_|S)zXUpdates breakdown metrics for a single record using the existing update_metrics function)metricsrunknown key_aliasN)r) rr0rr!rDrrcustom_llm_provider providersrapi_keysrr)rrrrrproviders rGupdate_breakdown_metricsrs|| <>*2@6>>*22F2Iv~~&. rIz/user/daily/activityzBudget & Spend TrackingzStart date in YYYY-MM-DD formatzEnd date in YYYY-MM-DD formatzFilter by specific modelzFilter by specific API keyzItems per pagei start_dateend_daterc Kddlm}|'tddtjj i||tt jddi d}t|s |j}t|dd |d|||||| d{S7#t$r[} tjd jt| tt j dd t| id} ~ wwxYww) ad [BETA] This is a beta endpoint. It will change. Meant to optimize querying spend data for analytics for a user. Returns: (by date) - spend - prompt_tokens - completion_tokens - cache_read_input_tokens - cache_creation_input_tokens - total_tokens - api_requests - breakdown by model, api_key, provider rrNrrTrUz&Please provide start_date and end_datelitellm_dailyuserspendr+) rKr.entity_id_field entity_identity_metadata_fieldrrrrrkrlz./spend/daily/analytics: Exception occured - {}zFailed to fetch analytics: )rrKrrrr=rr5rr+rrXrrrr4HTTP_500_INTERNAL_SERVER_ERROR) rrrrrkrlr`rKrrs rGget_user_daily_activityr<s^9.EEKKL  X-33EF   #' #$56)11I''/%"&!      && < C CCF K ==:3q6(CD   s=AC42B B B C4 B C1AC,,C11C4)NNr-r)i__doc__rsrr2r5rrtypingrrrrr r fastapir r r rrrr8litellm._loggingrlitellm.proxy._types$litellm.proxy.auth.user_api_key_authr/litellm.proxy.hooks.user_management_event_hooksr8litellm.proxy.management_endpoints.common_daily_activityr/litellm.proxy.management_endpoints.common_utilsr;litellm.proxy.management_endpoints.key_management_endpointsrr&litellm.proxy.management_helpers.utilsrlitellm.proxy.utilsr>litellm.types.proxy.management_endpoints.common_daily_activityrrrrrr r!@litellm.types.proxy.management_endpoints.internal_user_endpointsr"r#r$r% TYPE_CHECKINGrr&routerrNewUserRequestrHr4r^UserAPIKeyAuthrvfloatLiteralrrrrpostrrrDrrTeamListResponseObjectLiteLLM_TeamMembershiprrQueryrrrrrN UpdateUserRequestNoUserIDorEmailr r,r6rArRr[reintrDeleteUserRequestrr;rrrrrrrrIrGrsC    '99NN1"BTWPO97 --N-t-` .1 > 9  99 9" 9& 9N!%*.*0 7 7 7&7 7 ! 7 ' 7t8E$s)TBT=U2U,V#W09 9 9&9 cD!344 5 9 " 9< $ %+,-"   )00A(B\+ \+%\+ \+~ $ %+,-  )00A(B%  : d#45t? g(3-( $ %+,-  +W]]"E)00A(B A+ A+ c]A+ & A+ A+H-`' 412 3'd#45t