nat.authentication.api_key.api_key_auth_provider_config

Attributes

logger
HEADER_NAME_REGEX

Classes

APIKeyAuthProviderConfig

API Key authentication configuration model.

Module Contents

logger

HEADER_NAME_REGEX

class APIKeyAuthProviderConfig(/, **data: Any)

Bases: nat.data_models.authentication.AuthProviderBaseConfig

API Key authentication configuration model.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

raw_key: str = None

auth_scheme: nat.data_models.authentication.HeaderAuthScheme = None

custom_header_name: str | None = None

custom_header_prefix: str | None = None

classmethod validate_raw_key(value: str) → str

classmethod validate_custom_header_name(value: str) → str

classmethod validate_custom_header_prefix(value: str) → str

classmethod validate_raw_key_after(value: str) → str