Skip to content

Taipy.auth.login

Log in a user.

Available in Taipy Enterprise only

This function exists only in the Enterprise edition of Taipy.

This function creates Credentials using the default authenticator. Note that if there is no default authenticator when this function is called, a default authenticator is created, as described in Credentials.get_default().

Parameters:

Name Type Description Default
username str

The name of the user that needs to be authenticated.

required
password str

The expected password for that user.

required

Returns:

Name Type Description
Credentials Credentials

A valid Credentials instance.

Raises:

Type Description
InvalidCredentials

The username and password combination does not correspond to an authenticated user.

ValueError

The configuration for authentication is invalid.