Table of Contents

HeaderBasedAuthenticator

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

Authenticate based on a HTTP header

Properties

Name Description Default value Mandatory
successURL Where to send user agent after successfull authentication N/A Yes
header The name of the header used when authenticating N/A No
pipeID Id of the pipe validating the user N/A Yes

Example Configuration

{
    "alias": "headerauth",
    "name": "HeaderBasedAuthenticator",
    "configuration": {
        "successURL": "/config/",
        "header": "remote_user",
        "pipeID": "authPipe"
    },
    "id": "headerauth"
}