Skip to content

common_auth.contracts.authentication

HTTP request-authentication methods and API-key credential placement.

Classes

HttpAuthenticationMethod

Bases: StrEnum

Request-authentication implementation families, independent of providers.

API_KEY places supplied material; BASIC encodes username/password; BEARER attaches a supplied token. HMAC and SIGNED_JWT sign per request. OAuth grant selection and token-endpoint client authentication use separate vocabulary.

Fields and properties declared here; inherited members belong to the bases above.

API_KEY

API_KEY = 'api_key'

BASIC

BASIC = 'basic'

BEARER

BEARER = 'bearer'

HMAC

HMAC = 'hmac'

SIGNED_JWT

SIGNED_JWT = 'signed_jwt'

HttpCredentialLocation

Bases: StrEnum

API-key placement; the header or query-field name is configuration.

Fields and properties declared here; inherited members belong to the bases above.

HEADER = 'header'

QUERY

QUERY = 'query'