User name & password

Used to verify user credentials against one or more user stores. Requires modules AuthN & Pipes to be deployed.

Configuration

Authenticator type: UserNameAndPassword

Common Authenticator configuration can be found here.

Name
Description
Default value
Mandatory

pipe_id

Pipe to use for validation.

N/A

allowed_retries

Numer of allowed faulty tries before system resets the state.

2

webroot_dir

See common authenticator configuration

web/authenticator/username_password

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_100017("Authenticated using User-name & password")

    • IDENTIFIER (user trace id)

    • CUSTOMER_IDENTIFIER (if configured)

    • SOURCE_USER_NAME (username entered by the user)

    • SOURCE_ADDRESS (ip of the remote session)

    • AUTHENTICATOR_IDENTIFIER (id and display name)

  • WEB_100018("Failed authentication using User-name & password")

    • IDENTIFIER (user trace id)

    • CUSTOMER_IDENTIFIER (if configured)

    • SOURCE_ADDRESS (ip of the remote session)

    • SOURCE_USER_NAME (username entered by the user)

    • AUTHENTICATOR_IDENTIFIER (id and display name)

Data sent to validation pipe

On validation, data sent to the pipe is:

  • identifier - the username provided by the user

  • password - the password 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