Authentication service#

Keycloak is used for identity and access management. This open source solution provides a variety of options for authentication and authorization. Users authenticate with Keycloak rather than with the application, allowing flexibility in how the sign-in experience is delivered.

The Keycloak API is exposed at https://hostname:port/hps/auth/api, which is what the ansys.hps.client.auth module wraps around.

Auth API#

AuthApi(client)

Provides a minimal wrapper around the Keycloak API to query user information.

Resources#

User([id, username, password, first_name, ...])

Provides the user resource.