symphony.bdk.core.auth.obo_authenticator.OboAuthenticator#

class symphony.bdk.core.auth.obo_authenticator.OboAuthenticator#

Bases: abc.ABC

Obo authentication service.

__init__()#

Methods

__init__()

authenticate_by_user_id(user_id)

Authenticate On-Behalf-Of user by user id.

authenticate_by_username(username)

Authenticate On-Behalf-Of user by username.

retrieve_obo_session_token_by_user_id(user_id)

Retrieve the OBO session token by username.

retrieve_obo_session_token_by_username(username)

Retrieve the OBO session token by username.

Attributes

unauthorized_message

authenticate_by_user_id(user_id: int) symphony.bdk.core.auth.auth_session.OboAuthSession#

Authenticate On-Behalf-Of user by user id.

Parameters

user_id – User Id

Returns

the OBO authentication session.

authenticate_by_username(username: str) symphony.bdk.core.auth.auth_session.OboAuthSession#

Authenticate On-Behalf-Of user by username.

Parameters

username – Username

Returns

the OBO authentication session.

abstract async retrieve_obo_session_token_by_user_id(user_id: int) str#

Retrieve the OBO session token by username.

Parameters

user_id – User Id.

Returns

The obo session token.

Raises

AuthUnauthorizedError – if session token cannot be retrieved

abstract async retrieve_obo_session_token_by_username(username: str) str#

Retrieve the OBO session token by username.

Parameters

username – Username

Returns

The obo session token.

Raises

AuthUnauthorizedError – if session token cannot be retrieved