implementations.authentication Namespace Reference

Classes
class	AuthMethod
	Defines authentication methods. More...
class	TokenData
	Holds token data. More...

Functions
TokenData|None	get_token (OAuth o_auth_configuration)
	Get token based on the provided OAuth configuration.
TokenData|None	get_token_by_basic_auth (str endpoint, str username, str password, timeout=200)
	Get token from a specific authentication service provider by basic authentication.
TokenData|None	get_token_by_password (str endpoint, str username, str password, timeout=200)
	Get token from a specific authentication service provider by username and password.
TokenData|None	_get_token_from_endpoint (str endpoint, dict[str, str] data, HTTPBasicAuth|None auth=None, int timeout=200)
	Get token from a specific authentication service provider.

Variables
	_logger

Function Documentation

_get_token_from_endpoint()

TokenData | None implementations.authentication._get_token_from_endpoint ( str  endpoint, dict[str, str]  data, HTTPBasicAuth | None   auth = None, int   timeout = 200  )

protected

Get token from a specific authentication service provider.

Parameters

endpoint	Get token endpoint for the authentication service provider
data	Data for the authentication service provider
timeout	Timeout for the API calls, defaults to 200

Returns

Access token or None if an error occurred

Definition at line 108 of file authentication.py.

Here is the caller graph for this function:

get_token()

TokenData | None implementations.authentication.get_token

(

OAuth

o_auth_configuration

)

Get token based on the provided OAuth configuration.

Parameters

auth_configuration

Authentication configuration

Returns

Access token or None if an error occurred

Definition at line 47 of file authentication.py.

Here is the call graph for this function:

get_token_by_basic_auth()

TokenData | None implementations.authentication.get_token_by_basic_auth	(	str	endpoint,
		str	username,
		str	password,
			timeout = 200
	)

Get token from a specific authentication service provider by basic authentication.

Parameters

endpoint	Get token endpoint for the authentication service provider
username	Username for the authentication service provider
password	Password for the authentication service provider
timeout	Timeout for the API calls, defaults to 200

Returns

Access token or None if an error occurred

Definition at line 77 of file authentication.py.

Here is the call graph for this function:

Here is the caller graph for this function:

get_token_by_password()

TokenData | None implementations.authentication.get_token_by_password	(	str	endpoint,
		str	username,
		str	password,
			timeout = 200
	)

Get token from a specific authentication service provider by username and password.

Parameters

endpoint	Get token endpoint for the authentication service provider
username	Username for the authentication service provider
password	Password for the authentication service provider
timeout	Timeout for the API calls, defaults to 200

Returns

Access token or None if an error occurred

Definition at line 93 of file authentication.py.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

_logger

implementations.authentication._logger

protected

Definition at line 17 of file authentication.py.