orionis.foundation.config.auth.Auth

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

class documentation

Represent the authentication and authorization configuration.

Method	`__normalizeSection`	Coerce a configuration section into its typed entity.
Method	`__post_init__`	Validate and normalize the authentication configuration.
Instance Variable	`default`	Guard used when a middleware or a facade call does not name one. Accepts a `Guards` member or a plain string.
Instance Variable	`identity`	Where the application identity lives and how it is verified.
Instance Variable	`passwords`	Trusted reset URL, token table, lifetime and resend delay.
Instance Variable	`remember`	Optional persistent login cookie name, lifetime and HTTPS requirement.
Instance Variable	`session`	Options of the session guard used by web routes.
Instance Variable	`tokens`	Options of the personal access token guard used by API routes.

Inherited from BaseEntity:

Class Method	`_cachedFieldMetadata`	Retrieve field definitions and normalized types cached by class.
Method	`getFields`	Describe field names, normalized types, defaults, and metadata.
Method	`toDict`	Convert the dataclass instance to a recursively copied dictionary.
Class Variable	`__slots__`	Undocumented

def __normalizeSection(self, name: str, entity: type): (source) ¶

Coerce a configuration section into its typed entity.

Parameters
name:`str`	Name of the attribute holding the section.
entity:`type`	Entity class the section must end up being an instance of.

Returns
`None`	The attribute is replaced in place when a dictionary is given.

Raises
`TypeError`	If the section is neither the entity nor a dictionary.

overrides orionis.support.entities.BaseEntity.__post_init__

Validate and normalize the authentication configuration.

Returns
`None`	This method validates and normalizes attributes in place.

Raises
`TypeError`	If an option has an unexpected type.
`ValueError`	If the default guard is not one of the supported guards.

Guard used when a middleware or a facade call does not name one. Accepts a Guards member or a plain string.

Where the application identity lives and how it is verified.

passwords: PasswordReset | dict = (source) ¶

Trusted reset URL, token table, lifetime and resend delay.

remember: RememberAuth | dict = (source) ¶

Optional persistent login cookie name, lifetime and HTTPS requirement.

Options of the session guard used by web routes.

Options of the personal access token guard used by API routes.