User lookup

Provides a single field of input for user to enter an identifier.

Configuration

Authenticator type: UserLookup

Common Authenticator configuration can be found here.

Name
Description
Default value
Mandatory

pipe_id

Name of pipe used for validation

N/A

allowed_retries

Allowed number of times a user is allowed to enter OTP before process is aborted.

2

webroot_dir

See common authenticator configuration

web/authenticator/user_lookup

custom_identifier

Tag used for event separation

N/A

Logging

Apart from system logging, event logging is done when completing and failing a transaction.

Event ids are:

  • WEB_100024("Performed user lookup")

    • IDENTIFIER (user trace id)

    • CUSTOMER_IDENTIFIER (if configured)

    • SOURCE_USER_NAME (username entered by the user)

    • SOURCE_ADDRESS (ip of the remote session)

  • WEB_100025("User lookup failed")

    • IDENTIFIER (user trace id)

    • CUSTOMER_IDENTIFIER (if configured)

    • SOURCE_ADDRESS (ip of the remote session)

    • SOURCE_USER_NAME (username entered by the user)

Data sent to validation pipe

On validation, data sent to the pipe is:

  • identifier - the username provided by the user

Data exposed to global state

After a user completes a transaction, the authenticator is marked as done. Data from the authentication response is then put into the global state replacing existing values:

  • username

API

Starting an authentication

Start by sending in a Ajax request containing identifier & password:

The response back will contain either a COMPLETED or ERROR:

Translation keys