queenbee.config.auth module

class queenbee.config.auth.BaseAuth(*, type: ~typing.Literal['BaseAuth'] = 'BaseAuth', annotations: ~typing.Dict[str, ~typing.Any] = <factory>, domain: str, access_token: ~pydantic.types.SecretStr | None = None)[source]

Bases: BaseModel

access_token: SecretStr | None
property auth_header: Dict[str, str]

the auth header string for this auth model

Returns:

a bearer token auth header string

Return type:

Dict[str, str]

domain: str
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

refresh_token()[source]
type: Literal['BaseAuth']
class queenbee.config.auth.HeaderAuth(*, type: ~typing.Literal['HeaderAuth'] = 'HeaderAuth', annotations: ~typing.Dict[str, ~typing.Any] = <factory>, domain: str, access_token: ~pydantic.types.SecretStr | None = None, header_name: str)[source]

Bases: BaseAuth

property auth_header: Dict[str, str]

the auth header string for this auth model

Returns:

a header with an API token

Return type:

Dict[str, str]

header_name: str
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['HeaderAuth']
class queenbee.config.auth.JWTAuth(*, type: ~typing.Literal['JWTAuth'] = 'JWTAuth', annotations: ~typing.Dict[str, ~typing.Any] = <factory>, domain: str, access_token: ~pydantic.types.SecretStr | None = None)[source]

Bases: BaseAuth

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['JWTAuth']