Common configuration

All authenticators are configured in the same way and share some common configuration properties.

Authenticator

An authenticator represent an authentication scenario like "username and password" or "username, password and one-time password".

Authenticator may have specific configuration properties, below are properties that applies to all authenticators.

Properties

Name	Description	Default value	Mandatory
id	Configuration unique identifier.	N/A
type	Authenticator type. (Name of authenticator)	N/A
config	Authenticator configuration object. See below for details.	{}

Example

{
    "id": "auth01",
    "type": "UsernamePassword",
    "config": {
        "custom_identifier": "Company_name",
        "pipe": "uid_pwd_pipe_id",
        "accept_response_attrs": [
            {
                "type": 18,
                "name": "Reply-Message",
                "value": "Have a nice day! (This message was generated at {{{now}}} [{{{request.name}}}#{{{request.id}}}])"
            }
        ]
    }
}

Config

Properties

Name	Description	Default value	Mandatory
selector	Authenticator selector. See Selector.
accept_response_attrs	Response attribute configuration for Access-Accept responses. See Response attributes.
challenge_response_attrs	Response attribute configuration for Access-Challenge responses. See Response attributes.
reject_response_attrs	Response attribute configuration for Access-Reject responses. See Response attributes.
custom_identifier	Custom event identifier. (Part of the event data)

Example

{
    "id": "auth01",
    "type": "UsernamePassword",
    "config": {
        "custom_identifier": "Company_name",
        "pipe": "uid_pwd_pipe_id",
        "accept_response_attrs": [
            {
                "type": 18,
                "name": "Reply-Message",
                "value": "Have a nice day! (This message was generated at {{{now}}} [{{{request.name}}}#{{{request.id}}}])"
            }
        ]
    }
}