Table of Contents

TokenHeadless

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 authentication based on User-Agent (web browser) data. No UI is available.

Properties

Name Description Default value Mandatory
successUrl Where to send user agent after succesfull authentication N/A Yes
itemUserNameProperty The name of the attribute of the username returend from the pipe. username Yes
pipeID ID of the validating pipe N/A Yes
requiredParameter If configured, an "is present" chck is done befor sending to pipe for validation N/A No

Example Configuration

{
    "alias": "tokenauth",
    "name": "TokenHeadless",
    "configuration": {
        "successUrl": "/config/",
        "requiredParameter": "access_token",
        "pipeID": "authPipe"
    },
    "id": "tokenauth"
}

Requirements

In order for this to be found by the system this needs to be added at the module com.phenixidentity~auth-http

config": {
  "v2_classes": {
    "TokenAuthenticator":"com.phenixidentity.authn.http.internal.headless.TokenHeadless"
  }
}