Table of Contents

BasicAuthenticator

Warning

This authenticator is a legacy authenticator. It is recommended to plan for migrating the authenticator to the new protocol agnostic authenticator architecture. More information about the legacy authenticators can be found here.

Note

Allows for HTTP Basic authentication.

Properties

Name Description Default value Mandatory
successURL Where to send user agent after succesfull authentication N/A Yes
realm The name of the realm presented to the user PhenixID service No
pipeID Id of the pipe validating the user N/A Yes
includeQueryString On a successful authentication, should the data from the original query be added when redirecting the client false No

Example Configuration

{
    "alias": "basicauth",
    "name": "BasicAuthenticator",
    "configuration": {
        "successURL": "/config/",
        "realm": "Phenix ID test",
        "pipeID": "authPipe"
    },
    "id": "basicauth"
}