Skip to content

users

FastAPI endpoint functions for managing user resources.

Attributes

RESOURCE_USERS module-attribute 

RESOURCE_USERS = 'Users'

users_router module-attribute 

users_router = APIRouter(
    prefix=format_path(RESOURCE_USERS),
    tags=[RESOURCE_USERS],
    responses=DEFAULT_HTTP_ERROR_RESPONSES,
)

Classes

Functions

create_user async 

create_user(
    fastapi_request: Request,
    request: UserCreateRequestV1,
    namespace: str = namespace_path_param,
    job_pool: ThreadPoolExecutor = Depends(
        job_pool_dependency
    ),
)

Create a new user resource

get_user async 

get_user(
    fastapi_request: Request,
    namespace: str = namespace_path_param,
    user: str = user_path_param,
    job_pool: ThreadPoolExecutor = Depends(
        job_pool_dependency
    ),
)

Get a user resource

hard_delete_user async 

hard_delete_user(
    fastapi_request: Request,
    namespace: str = namespace_path_param,
    user: str = user_path_param,
    dry_run: bool = dry_run_query_param,
    job_pool: ThreadPoolExecutor = Depends(
        job_pool_dependency
    ),
)

Hard delete an agent and associated resources

soft_delete_user async 

soft_delete_user(
    fastapi_request: Request,
    namespace: str = namespace_path_param,
    user: str = user_path_param,
    job_pool: ThreadPoolExecutor = Depends(
        job_pool_dependency
    ),
)

Soft delete a user resource

undelete_user async 

undelete_user(
    fastapi_request: Request,
    namespace: str = namespace_path_param,
    user: str = user_path_param,
    job_pool: ThreadPoolExecutor = Depends(
        job_pool_dependency
    ),
)

Undelete a user resource

update_user async 

update_user(
    fastapi_request: Request,
    request: UserUpdateRequestV1,
    namespace: str = namespace_path_param,
    user: str = user_path_param,
    job_pool: ThreadPoolExecutor = Depends(
        job_pool_dependency
    ),
)

Update a user resource