PipeAuthenticator
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
Typically used when authenticating from a redirect including some kind of token since no end-user UI is available.
All HTTP parameters are passed on to the configured pipe.
Properties
| Name | Description | Default value | Mandatory |
|---|---|---|---|
| successURL | Where to redirect client after successful authentication | N/A | Yes |
| pipeID | ID of the pipe executef after approved login | N/A | Yes |
| includeQueryString | Should query string parameters be transferred fron initial request when sending client to success URL | false | No |
| alwaysRunPipe | Should the pipe be run even if there is a valid session? | false | No |
Example Configuration
{
"alias": "pipeAuth",
"name": "PipeAuthenticator",
"configuration": {
"successURL": "/config/",
"pipeID": "authPipe"
},
"id": "pipeAuth"
}