Uses of Package
pl.edu.icm.unity.engine.api.authn
Package
Description
The main entry point to engine's functionality.
Authentication related API and utilities
Local authentication API and general purpose support classes
Remote authentication API
Endpoint API
Events processing
Identity API
IdP-type endpoints support
Unity login session API
Output translation API
API of the user import subsystem.
-
ClassDescriptionDescribes authenticator configuration.Describes an available authenticator type.Thrown when there is authorization problem
-
ClassDescriptionStores information about authenticated entity during the authentication.Thrown on authentication problem.Stores information about a authentication flow, as configured by administrator and selectable by a user or client.Base contract of authentication result - have remote and local authn variants.Describes context of authentication: in which realm it happens (or happened), what flow is used, which option was used and which factor it was which can be 1 or 2 (at least until we start support 3rd factor authn).DTO containing information about a user being authenticated.Representation of an authenticator instance, which is a composition of
CredentialRetrieval
andCredentialVerificator
, configured.Describes a configured authenticator instance in implementation agnostic way.Describes authenticator context of authentication: in which realm it happens (or happened), what flow is used, which factor it was which can be 1 or 2 (at least until we start support 3rd factor authn).Describes an available authenticator type.Marker interface.Retrieves credential, using a some binding specific method.Implementations allows for creatingCredentialRetrieval
s of a particular type.Implementations allow for verification of the provided credential.ProducesCredentialVerificator
s of a particular type.Implemented by an IdP endpoint and registered withIdPLoginController
to inform it about authentications against the IdP.Thrown when credential definition is invalid.Used to prevent from session fixation attack.Stores thread-local information about the current request metadata in thread local variable.This class object is returned by local authenticator with information about authentication result.Represents login session.Performs a logout, including logout of additional session participants, in case of logout initiated directly in Unity.Provides information about partial state of authentication.Contains information used by remember me functionalityThis class object is returned by authenticator with information about authentication result.Signals an error of too many attempts, e.g.Counts unsuccessful authentication attempts per client's IP address.Counts unsuccessful access attempts per client's IP address. -
ClassDescriptionHelper to easily create credential factories.Abstract
CredentialVerificator
with a common boilerplate code.Marker interface.Implementations allow for verification of the provided credential.ProducesCredentialVerificator
s of a particular type.Thrown when credential definition is invalid. -
ClassDescriptionAbstract
CredentialVerificator
with a common boilerplate code.Thrown on authentication problem.Base contract of authentication result - have remote and local authn variants.Describes context of authentication: in which realm it happens (or happened), what flow is used, which option was used and which factor it was which can be 1 or 2 (at least until we start support 3rd factor authn).Marker interface.Implementations allow for verification of the provided credential.Used to prevent from session fixation attack.Provides information about partial state of authentication.Thrown on authentication problem.This class object is returned by authenticator with information about authentication result. -
ClassDescriptionStores information about authenticated entity during the authentication.Base contract of authentication result - have remote and local authn variants.This class object is returned by authenticator with information about authentication result.
-
ClassDescriptionStores information about a authentication flow, as configured by administrator and selectable by a user or client.
-
-
ClassDescriptionDTO containing information about a user being authenticated.Entity and a value of (one of) its credential attribute
-
-
ClassDescriptionRepresents login session.
-
-
ClassDescriptionBase contract of authentication result - have remote and local authn variants.