TIBCO Spotfire® Server and Environment - Installation and Administration

config-custom-web-auth

Configures custom web authentication.

config-custom-web-auth 
[-c value | --configuration=value] 
[-b value | --bootstrap-config=value] 
[-e <true|false> | --enabled=<true|false>] 
[-a value | --authenticator-class=value] 
{-Ikey=value}

Overview

This command is used for configuring a custom web authenticator that implements a web-based authentication flow (for example, based on OAuth2).

Options

Option Optional or Required Default Value Description
-c value
--configuration=value
Optional configuration.xml The path to the server configuration file.
-b value
--bootstrap-config=value
Optional none The path to the bootstrap configuration file. See Bootstrap.xml file for more information about this file.
-e <true|false>
--enabled=<true|false>
Optional true Specifies whether custom web authentication should be enabled.
-a value
--authenticator-class=value
Optional none The fully qualified name of a class implementing the com.spotfire.server.security.CustomWebAuthenticator interface.
-Ikey=value
Optional none Initialization parameters that will be provided to the custom web authenticator when the init(CustomWebAuthenticatorContext) method is called. If the name of the parameter ends with [SENSITIVE] it will be stored encrypted in the configuration. This argument may be specified multiple times with different keys.

Examples

To set the initialization parameter 'debug' to 'true': -Idebug=true

To set a sensitive parameter where the value should be stored encrypted: -Iclient.secret[SENSITIVE]=secret123