flip_api.user_services.get_users

Attributes

router

Functions

get_users(, token_id)

Get a list of users with pagination.

Module Contents

flip_api.user_services.get_users.router
flip_api.user_services.get_users.get_users(request: fastapi.Request, db: sqlmodel.Session = Depends(get_session), token_id: uuid.UUID = Depends(verify_token)) → flip_api.utils.paging_utils.IPagedData[flip_api.domain.schemas.users.IUser]

Get a list of users with pagination.

Requires CAN_MANAGE_USERS permission

Parameters:

  • request (Request) – FastAPI request object

  • db (Session) – Database session

  • token_id (UUID) – ID of the authenticated user

Returns:

Paginated list of Cognito users

Return type:

IPagedData[IUser]

Raises:

HTTPException – If user does not have permission or if an error occurs