register-oidc-client

register-oidc-client 
[-c value | --configuration=value] 
[-b value | --bootstrap-config=value] 
<-d value | --discovery-document-url=value> 
<-n value | --provider-name=value> 
[-l value | --client-name=value] 
{-Cvalue} 
[--available-to-data-sources=<true|false>]
[-a value | --access-token=value] 
[-v value | --authorization-header-value=value] 
<-p value | --public-address=value> 
[-r <true|false> | --replace-existing=<true|false>]

Overview

Use this command to register the Spotfire Server as a client with a given OpenID Provider. The provider must support OpenID Connect Dynamic Client Registration. The metadata included in the registration request depends on the OpenID Connect configuration, so before running this command, first run the config-oidc command.

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. For more information, see Bootstrap.xml file.
`-d value \| --discovery-document-url=value`	Required	none	The URL to the provider's OpenID Connect Discovery document.
`-n value \| --provider-name=value`	Required	none	The name to give the provider when adding it to the Spotfire Server configuration.
`-l value \| --client-name=value`	Optional	Spotfire Server <`version`>	The name of the client to include in the registration request.
`--available-to-data-sources=<true\|false>`	Optional	`true`	Specifies whether tokens from the provider should be available to data sources (besides being used for authentication). Affects the registered redirect URIs.
`-Cvalue`	Optional	none	The email address of a contact person to include in the registration request. Can be specified multiple times with different values. Note: If you run this command from PowerShell, then you must put the option in single quotation marks. (For example, `'-Cinfo@example.com'`.)
`-a value \| --access-token=value`	Optional	none	An initial access token to include with the registration request. The `--access-token` and `--authorization-header-value` arguments are mutually exclusive.
`-v value \| --authorization-header-value=value`	Optional	none	An Authorization header value to include with the registration request. The `--access-token` and `--authorization-header-value` arguments are mutually exclusive.
`-p value \| --public-address=value`	Required	none	The public address of the Spotfire Server. See set-public-address for more information.
`-r <true\|false> \| --replace-existing=<true\|false>`	Optional	`false`	Indicates that any existing OpenID Provider with the same name should be replaced.

Examples

Register (using an Initial Access Token)

register-oidc-client 
--discovery-document-url=https://example.com/.well-known/openid-configuration 
--provider-name="Demo 1" 
--access-token="<token>" 
--public-address="https://spotfire.example.com/"

Register (using a custom client name and a contact email address)

register-oidc-client 
--discovery-document-url=https://example.com/.well-known/openid-configuration 
--provider-name="Demo 2" 
--client-name="Spotfire" 
-Cjohn.doe@example.com 
--public-address="https://spotfire.example.com/"

Register with Okta (using an API token)

register-oidc-client 
--discovery-document-url=https://example.com/.well-known/openid-configuration 
--provider-name="Okta" 
--authorization-header-value="SSWS <api_token>" 
--public-address="https://spotfire.example.com/"