kavita_client.api.plugin.post_api_plugin_authenticate

Module Contents

Functions

asyncio	Authenticate with the Server given an auth key. This will log you in by returning the user object and the JWT token.
asyncio_detailed	Authenticate with the Server given an auth key. This will log you in by returning the user object and the JWT token.
sync	Authenticate with the Server given an auth key. This will log you in by returning the user object and the JWT token.
sync_detailed	Authenticate with the Server given an auth key. This will log you in by returning the user object and the JWT token.

API

async kavita_client.api.plugin.post_api_plugin_authenticate.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, api_key: str, plugin_name: str) → kavita_client.models.user_dto.UserDto | None

Authenticate with the Server given an auth key. This will log you in by returning the user object and the JWT token.

This API is not fully built out and may require more information in later releases

Args:

api_key (str): plugin_name (str):

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:

UserDto

async kavita_client.api.plugin.post_api_plugin_authenticate.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, api_key: str, plugin_name: str) → kavita_client.types.Response[kavita_client.models.user_dto.UserDto]

Authenticate with the Server given an auth key. This will log you in by returning the user object and the JWT token.

This API is not fully built out and may require more information in later releases

Args:

api_key (str): plugin_name (str):

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[UserDto]

kavita_client.api.plugin.post_api_plugin_authenticate.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, api_key: str, plugin_name: str) → kavita_client.models.user_dto.UserDto | None

Authenticate with the Server given an auth key. This will log you in by returning the user object and the JWT token.

This API is not fully built out and may require more information in later releases

Args:

api_key (str): plugin_name (str):

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:

UserDto

kavita_client.api.plugin.post_api_plugin_authenticate.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, api_key: str, plugin_name: str) → kavita_client.types.Response[kavita_client.models.user_dto.UserDto]

Authenticate with the Server given an auth key. This will log you in by returning the user object and the JWT token.

This API is not fully built out and may require more information in later releases

Args:

api_key (str): plugin_name (str):

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[UserDto]