kavita_client.api.users.get_api_users

Module Contents

Functions

asyncio	Returns all users of this server
asyncio_detailed	Returns all users of this server
sync	Returns all users of this server
sync_detailed	Returns all users of this server

API

async kavita_client.api.users.get_api_users.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, include_pending: bool | kavita_client.types.Unset = False) → list[kavita_client.models.member_dto.MemberDto] | None

Returns all users of this server

Args:

include_pending (bool | Unset): Default: False.

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

list[MemberDto]

async kavita_client.api.users.get_api_users.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, include_pending: bool | kavita_client.types.Unset = False) → kavita_client.types.Response[list[kavita_client.models.member_dto.MemberDto]]

Returns all users of this server

Args:

include_pending (bool | Unset): Default: False.

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[list[MemberDto]]

kavita_client.api.users.get_api_users.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, include_pending: bool | kavita_client.types.Unset = False) → list[kavita_client.models.member_dto.MemberDto] | None

Returns all users of this server

Args:

include_pending (bool | Unset): Default: False.

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

list[MemberDto]

kavita_client.api.users.get_api_users.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, include_pending: bool | kavita_client.types.Unset = False) → kavita_client.types.Response[list[kavita_client.models.member_dto.MemberDto]]

Returns all users of this server

Args:

include_pending (bool | Unset): Default: False.

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[list[MemberDto]]