diff --git a/litellm/proxy/management_endpoints/internal_user_endpoints.py b/litellm/proxy/management_endpoints/internal_user_endpoints.py index 54a2d4062d2..03b528b6c03 100644 --- a/litellm/proxy/management_endpoints/internal_user_endpoints.py +++ b/litellm/proxy/management_endpoints/internal_user_endpoints.py @@ -101,6 +101,7 @@ from litellm.types.proxy.management_endpoints.common_daily_activity import ( from litellm.types.proxy.management_endpoints.internal_user_endpoints import ( BulkUpdateUserRequest, BulkUpdateUserResponse, + UserAliasWhere, UserListResponse, UserSearchWhere, UserUpdateResult, @@ -2241,6 +2242,14 @@ def _user_search_where(search: str | None) -> Mapping[str, object]: return search_where +def _user_alias_where(user_alias: str | None) -> Mapping[str, object]: + """Prisma predicate for `/user/list?user_alias=`; empty is no filter, since contains "" drops NULL aliases.""" + if not user_alias: + return _NO_SEARCH_WHERE + alias_where: Final[UserAliasWhere] = {"user_alias": {"contains": user_alias, "mode": "insensitive"}} + return alias_where + + @router.get( "/user/list", tags=["Internal User management"], @@ -2252,6 +2261,9 @@ async def get_users( user_ids: str | None = fastapi.Query(default=None, description="Get list of users by user_ids"), sso_user_ids: str | None = fastapi.Query(default=None, description="Get list of users by sso_user_id"), user_email: str | None = fastapi.Query(default=None, description="Filter users by partial email match"), + user_alias: str | None = fastapi.Query( + default=None, description="Filter users by partial alias match (case-insensitive)" + ), search: str | None = fastapi.Query( default=None, description="Combined search: matches users whose 'user_id' or 'user_email' contains the value (case-insensitive).", @@ -2286,6 +2298,8 @@ async def get_users( Get list of users by sso_ids. Comma separated list of sso_ids. user_email: Optional[str] Filter users by partial email match + user_alias: Optional[str] + Filter users by partial alias match (case-insensitive) search: Optional[str] Combined search: matches users whose user_id or user_email contains the value (case-insensitive) team: Optional[str] @@ -2366,7 +2380,11 @@ async def get_users( ## Filter any none fastapi.Query params - e.g. where_conditions: {'user_email': {'contains': Query(None), 'mode': 'insensitive'}, 'teams': {'has': Query(None)}} where: Final[Mapping[str, object]] = { key: value - for key, value in (*where_conditions.items(), *_user_search_where(search).items()) + for key, value in ( + *where_conditions.items(), + *_user_alias_where(user_alias).items(), + *_user_search_where(search).items(), + ) if value is not None } diff --git a/litellm/types/proxy/management_endpoints/internal_user_endpoints.py b/litellm/types/proxy/management_endpoints/internal_user_endpoints.py index fc0b73f77b6..d3c43ec3a06 100644 --- a/litellm/types/proxy/management_endpoints/internal_user_endpoints.py +++ b/litellm/types/proxy/management_endpoints/internal_user_endpoints.py @@ -29,6 +29,12 @@ class UserSearchWhere(TypedDict): OR: ReadOnly[tuple[Mapping[Literal["user_id", "user_email"], InsensitiveContains], ...]] +class UserAliasWhere(TypedDict): + """Prisma filter behind `/user/list?user_alias=`: user_alias contains the term, case-insensitive.""" + + user_alias: ReadOnly[InsensitiveContains] + + class UserListResponse(LiteLLMBaseModel): """ Response model for the user list endpoint diff --git a/tests/unit/proxy/management_endpoints/test_internal_user_endpoints.py b/tests/unit/proxy/management_endpoints/test_internal_user_endpoints.py index 39586a1a204..b56dadb7ad9 100644 --- a/tests/unit/proxy/management_endpoints/test_internal_user_endpoints.py +++ b/tests/unit/proxy/management_endpoints/test_internal_user_endpoints.py @@ -2204,6 +2204,59 @@ def test_get_users_search_matches_user_id_or_email(mocker): app.dependency_overrides.pop(user_api_key_auth, None) +def test_get_users_filters_by_partial_user_alias(mocker: MockerFixture) -> None: + """ + `user_alias` filters rows and the total by a case-insensitive contains match, composes with other + filters, and an empty value applies no alias filter (a contains-"" match would drop users without an alias). + """ + from litellm.proxy._types import UserAPIKeyAuth + from litellm.proxy.auth.user_api_key_auth import user_api_key_auth + + aliased_user_id: Final = "user-with-alias" + mock_user_row: Final = mocker.MagicMock() + mock_user_row.user_id = aliased_user_id + mock_user_row.model_dump.return_value = { + "user_id": aliased_user_id, + "user_alias": "Jane Doe (Platform Team)", + "user_role": "internal_user", + "created_at": datetime.now(timezone.utc), + "updated_at": datetime.now(timezone.utc), + } + mock_prisma_client: Final = mocker.MagicMock() + find_many: Final = mocker.AsyncMock(return_value=[mock_user_row]) + count: Final = mocker.AsyncMock(return_value=1) + mock_prisma_client.db.litellm_usertable.find_many = find_many + mock_prisma_client.db.litellm_usertable.count = count + mock_prisma_client.db.litellm_verificationtoken.count = mocker.AsyncMock(return_value=0) + mocker.patch( # test-quality-ok: /user/list reads prisma_client off proxy_server at call time + "litellm.proxy.proxy_server.prisma_client", mock_prisma_client + ) + app.dependency_overrides[user_api_key_auth] = lambda: UserAPIKeyAuth( + user_id="admin", user_role=LitellmUserRoles.PROXY_ADMIN + ) + try: + alias_response: Final = client.get("/user/list", params={"user_alias": "jane DOE"}) + assert alias_response.status_code == 200, alias_response.text + alias_where: Final = {"user_alias": {"contains": "jane DOE", "mode": "insensitive"}} + assert find_many.call_args.kwargs["where"] == alias_where + assert count.call_args.kwargs["where"] == alias_where + assert tuple(user["user_id"] for user in alias_response.json()["users"]) == (aliased_user_id,) + assert alias_response.json()["total"] == 1 + + combined_response: Final = client.get("/user/list", params={"user_alias": "jane", "role": "internal_user"}) + assert combined_response.status_code == 200, combined_response.text + assert find_many.call_args.kwargs["where"] == { + "user_role": "internal_user", + "user_alias": {"contains": "jane", "mode": "insensitive"}, + } + + empty_response: Final = client.get("/user/list", params={"user_alias": ""}) + assert empty_response.status_code == 200, empty_response.text + assert find_many.call_args.kwargs["where"] == {} + finally: + app.dependency_overrides.pop(user_api_key_auth, None) + + def test_update_internal_user_params_reset_max_budget_with_none(): """ Test that _update_internal_user_params allows setting max_budget to None. diff --git a/ui/litellm-dashboard/src/lib/http/schema.d.ts b/ui/litellm-dashboard/src/lib/http/schema.d.ts index 3aa7c888e98..efa61a37926 100644 --- a/ui/litellm-dashboard/src/lib/http/schema.d.ts +++ b/ui/litellm-dashboard/src/lib/http/schema.d.ts @@ -18905,6 +18905,8 @@ export interface paths { * Get list of users by sso_ids. Comma separated list of sso_ids. * user_email: Optional[str] * Filter users by partial email match + * user_alias: Optional[str] + * Filter users by partial alias match (case-insensitive) * search: Optional[str] * Combined search: matches users whose user_id or user_email contains the value (case-insensitive) * team: Optional[str] @@ -77504,6 +77506,8 @@ export interface operations { sso_user_ids?: string | null; /** @description Filter users by partial email match */ user_email?: string | null; + /** @description Filter users by partial alias match (case-insensitive) */ + user_alias?: string | null; /** @description Combined search: matches users whose 'user_id' or 'user_email' contains the value (case-insensitive). */ search?: string | null; /** @description Filter users by team id */