Authentication and Authorization package for Taipy
Available in Taipy Enterprise only
This package exists only in the Enterprise edition of Taipy.
The taipy.auth
package provides features that make it possible
for a Taipy application to identify an end-user and provide different
capabilities depending on the user's identity.
Two steps have to be differentiated:
-
Authentication: is the process that verifies that a user is known by the system. This is performed by a login step (see
taipy.auth.login()
function for more details). It creates an instance of theCredentials
class that holds the relevant user information, whose identity has usually been verified using a password.
For more details, please refer to the authentication section of the user manual. -
Authorization: Authorization is the process of driving the application logic differently depending on the user using it. The
Authorize
context manager lets you create a block of code within which the functions and methods requiring authorization will find the relevant information (typically the user roles) in theCredentials
object passed to theAuthorize
context manager.
For more details, please refer to the authorization section of the user manual.
Functions¶
hash_taipy_password()
: Generate a hashed password for the Taipy authenticator.login()
: Log in.logout()
: Logout a user.
Classes¶
AllOf
: Select traits depending on whether all user roles belong to the filter or not.AnyOf
: Select traits depending on whether any of the user roles belongs to the filter or not.Authenticator
: User Authentication.Authorize
: Authorized Context Manager.Credentials
: Hold the information for a user, potentially authenticated.InvalidCredentials
: Raised if credentials are invalid.IsAuthenticated
: Select traits depending on whether the user is authenticated or not.NoneOf
: Select traits depending on whether none of the user roles belong to the filter or not.RoleTraits
: Base class for role management in Taipy Enterprise.RoleTraitsFilter
: Base class for all role traits filters.UnknownProtocolError
: Raised if and unknown Authentication protocol was provided.UserGroupsNotFound
: Raised if user groups could not be retrieve from the LDAP server.