ds_stoa.authentication._oauth2¶

This module provides an interface for OAuth2 authentication with the Stoa API. It encapsulates the process of obtaining an access token using the client credentials flow, suitable for server-to-server authentication where an application acts on its own behalf.

The module abstracts the complexities involved in the HTTP request and response handling, error management, and environment-specific configuration. It leverages the requests library for making HTTP requests and uses basic authentication to securely transmit the client credentials.

The oauth2 function within this module is designed to be used by applications that require an access token to authenticate against the Stoa API’s protected endpoints. This token is obtained by presenting valid client credentials (client ID and client secret) to the Stoa API’s OAuth2 token endpoint.

Usage of this module requires setting up the appropriate environment variable BUILDING_MODE to toggle between development and production configurations. This allows for flexible deployment and testing without code changes.

Dependencies: - requests: For making HTTP requests to the OAuth2 token endpoint. - utils.exceptions: For enriching HTTP exceptions with more context. - utils.logger: For logging information about the authentication process and errors.

Example usage:

from ds_stoa.authentication import oauth2

# Obtain an access token using client credentials
access_token = oauth2('your_client_id', 'your_client_secret')
print(access_token)

Attributes¶

`LOGGER`
`BUILDING_MODE`

Functions¶

`enrich_http_exception`(→ None)	Enriches an HTTP exception with additional context without re-raising it.
`oauth2`(→ str)	Authenticates an application and retrieves an access token.

Module Contents¶

ds_stoa.authentication._oauth2.enrich_http_exception(exc: requests.exceptions.HTTPError) → None¶

Enriches an HTTP exception with additional context without re-raising it.

Parameters:: exc – Exception
Returns:: None

ds_stoa.authentication._oauth2.LOGGER¶

ds_stoa.authentication._oauth2.BUILDING_MODE¶

ds_stoa.authentication._oauth2.oauth2(client_id: str, client_secret: str) → str[source]¶

Authenticates an application and retrieves an access token.

Parameters:

client_id (str) – The Client ID.
client_secret (str) – The Client Secret.

Returns:

An access token indicating successful authentication.

Return type:

str

Example:

>>> oauth2('client_id', 'client_secret')
'access_token_value'