auth_authenticate_user¶
Authenticates a local user.
Functions
- async pydelfini.delfini_core.api.auth.auth_authenticate_user.asyncio(*, client, body)[source]¶
Authenticates a local user.
- Parameters:
client (AuthenticatedClient | Client)
- Raises:
errors.UnexpectedStatus – If the server returns a status code greater than or equal to 300.
httpx.TimeoutException – If the request takes longer than Client.timeout.
- Returns:
Union[AuthAuthenticateUserResponse200]
- Return type:
- async pydelfini.delfini_core.api.auth.auth_authenticate_user.asyncio_detailed(*, client, body)[source]¶
Authenticates a local user.
- Parameters:
client (AuthenticatedClient | Client)
- 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[Union[AuthAuthenticateUserResponse200, ServerError]]
- Return type:
- pydelfini.delfini_core.api.auth.auth_authenticate_user.sync(*, client, body)[source]¶
Authenticates a local user.
- Parameters:
client (AuthenticatedClient | Client)
- Raises:
errors.UnexpectedStatus – If the server returns a status code greater than or equal to 300.
httpx.TimeoutException – If the request takes longer than Client.timeout.
- Returns:
Union[AuthAuthenticateUserResponse200]
- Return type:
- pydelfini.delfini_core.api.auth.auth_authenticate_user.sync_detailed(*, client, body)[source]¶
Authenticates a local user.
- Parameters:
client (AuthenticatedClient | Client)
- 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[Union[AuthAuthenticateUserResponse200, ServerError]]
- Return type: