orionis.auth.contracts.IAuthenticatable

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

class IAuthenticatable(ABC): (source)

Define the minimum surface an application identity must expose.

Authentication never depends on a concrete User class. Any object able to answer these three questions can be authenticated by Orionis.

Method	`getAuthIdentifier`	Return the value uniquely identifying this identity.
Method	`getAuthIdentifierName`	Return the attribute holding the unique identifier.
Method	`getAuthPassword`	Return the stored password hash of this identity.
Class Variable	`__slots__`	Undocumented

@abstractmethod

def getAuthIdentifier(self) -> object: (source) ¶

Return the value uniquely identifying this identity.

Returns
`object`	Value persisted in the session or in an access token so the identity can be restored on a later request.

@abstractmethod

def getAuthIdentifierName(self) -> str: (source) ¶

Return the attribute holding the unique identifier.

Returns
`str`	Name of the attribute that uniquely identifies the identity.

@abstractmethod

Return the stored password hash of this identity.

Returns
`str`	Encoded hash produced by the hashing module. Never a plain text password.

Undocumented