SSO Authenticator

Introduction

The SSO authenticator is responsible for checking that a user is logged in and then redirect the user. It must NOT be placed in a chain. Used in a SSO scenario.

Configuration

Note

Authenticator type: SSOAuthenticator

Common Authenticator configuration can be found here.

Properties

Name	Description	Default	Mandatory
pipe_id	The pipe reference. The pipe is commonly used to extract data needed for the redirect.	N/A	true
redirect_url	The url to redirect to after the pipe is finished. Expandable.	N/A	true
identifier	Used to find the authenticated user. Expandable.	${session.identifier}	false
failure_location	The target location to where the user agent will be redirected when user is not authenticated.	N/A	false

Example

{
    "id": "tsplus",
    "type": "SSOAuthenticator",
    "config": {
        "pipe_id": "tsplus",
        "identifier": "${session.identifier}",
        "redirect_url": "https://www.app.com/?server=${exports.server_name}&ticket=${exports.ticket}",
        "base_path": "/access/authn",
        "failure_location": "http://www.mycompany.com/errorpage"
    }
}