OAuthProviderService

class OAuthProviderService

Methods

get_all	Get all OAuth providers connected to this instance.
get_oauth_token	Get an OAuth token for the specified provider.
put_oauth_token	Get or create an OAuth token for the specified provider.
callback	The method that is used by OAuth providers after they completed the login flow.

get_all(*, extra_parameters=None)

Get all OAuth providers connected to this instance.

Parameters:

extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

Returns:

All connected providers.

Return type:

Sequence[OAuthProvider]

get_oauth_token(*, provider_id, extra_parameters=None)

Get an OAuth token for the specified provider.

Parameters:

• provider_id (str) – The provider for which you want to get a token.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (OAuthProviderService[AuthenticatedClient]) –

Returns:

The token.

Return type:

OAuthToken

put_oauth_token(*, provider_id, extra_parameters=None)

Get or create an OAuth token for the specified provider.

Parameters:

• provider_id (str) – The provider for which you want to get/create a token.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (OAuthProviderService[AuthenticatedClient]) –

Returns:

The token.

Return type:

OAuthToken | SetupOAuthResult

callback(*, provider_id, state=Nothing, code=Nothing, error=Nothing, error_description=Nothing, extra_parameters=None)

The method that is used by OAuth providers after they completed the login flow.

For the precise meaning of the query parameters see RFC 6749.

Parameters:

• provider_id (str) – The id of the OAuthProvider that completed the flow.

• state (Union[Just[str], _Nothing[str]]) – The state.

• code (Union[Just[str], _Nothing[str]]) – The code.

• error (Union[Just[str], _Nothing[str]]) – The error.

• error_description (Union[Just[str], _Nothing[str]]) – The description of the error.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

Returns:

A response that is not in any defined format.

Return type:

bytes