Skip to content

Credentials class

Hold the information for a user, potentially authenticated.

Available in Taipy Enterprise only

This class exists only in the Enterprise edition of Taipy.

Credentials are created by an Authenticator instance.

Methods

get_roles()

get_roles() -> Set[str]

Return the roles for this Credentials object.

If no roles are assigned, the returned value is an empty set.

Returns:

Type Description
Set[str]

The roles as a set of strings.

validate()

validate() -> None

Validate these credentials.

This function does nothing if the credentials are valid (the user is properly authenticated, and the credentials have not expired).

Raises:

Type Description
InvalidCredentials

if these credentials are invalid.