← Back to plugin index

Lookup and Accept Authenticator

Description
This authenticator expects credentials of type UserCredential (or subtypes) and responds with "authentication successful" if a corresponding user was found and is valid. The authentee object returned in the response contains the user's roles and context-data retrieved from the persistency layer. This authenticator is stateless (i.e. does not support multiple authentication steps), therefore the use of a session is not expected.

An example usage of this plugin is setting it up as the first authenticator of the MetaAuthenticator which allows to merge user roles and context-data with the results of the second authenticator.

The plugin writes the canonical class name description of this plugin to the context data container. The class name is stored under the key authPluginClassName. A short description of this authentication method is stored under the key authMethodShortDesc. This information may be used by callers.

Type name
LookupAndAcceptAuthenticator
Class
com.airlock.iam.core.misc.impl.authen.LookupAndAcceptAuthenticator
May be used by
Properties
User Persister (userPersister)
Description
The user persister plugin used to load and store user information.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Do Not Update User Statistics (doNotUpdateUserStatistics)
Description
If this property is set to TRUE, then this authenticator will not update the number of failed logins and the login dates on the persistency layer. This makes it suitable for use as a part in a bigger authentication scheme (e.g. as first part with the MetaAuthenticator)
Attributes
Boolean
Optional
Default value
true
YAML Template (with default values)

type: LookupAndAcceptAuthenticator
id: LookupAndAcceptAuthenticator-xxxxxx
displayName: 
comment: 
properties:
  doNotUpdateUserStatistics: true
  userPersister: