Client registration command register-as-tibco-cloud-client
To be able to use some functionality that integrates with TIBCO Cloud™ in Spotfire web clients, you need to register your Spotfire Web Player as a TIBCO Cloud OAuth2 client.
You do this by running the command
register-as-tibco-cloud-client
. The output returns
OAuth2 client registration information that you enter into the Web Player
service configurations as described in
Configuring Spotfire Web Clients for OAuth2 with TIBCO Cloud™.
Running the
register-as-tibco-cloud-client
command
Run the
register-as-tibco-cloud-client
command according to the
instructions in
Executing commands on the command line. For
more general information about when and how to use the command line for server
configurations, and related help topics, see
Configuration using the command line.
Refer to the EXAMPLES section of the help output below for examples of
how to correctly enter the
register-as-tibco-cloud-client
command and its required
parameters.
export-config
command before, and
export-config
after executing the
register-as-tibco-cloud-client
command.
config help register-as-tibco-cloud-client
This contains more information about the tool, all possible
parameters, as well as examples for different registration scenarios.
NAME
register-as-tibco-cloud-client -- Registers the TIBCO Spotfire Web Player
as a TIBCO Cloud API client.
SYNOPSIS
register-as-tibco-cloud-client [-b value | --bootstrap-config=value]
[-t value | --tool-password=value]
[-l value | --tibco-cloud-hostname=value] {-Cvalue}
[-p value | --public-address=value]
OVERVIEW
This command is used for registering the TIBCO Spotfire Web Player as a
TIBCO Cloud (OAuth2) API client - in order to access data from TIBCO
Cloud Services such as TIBCO Cloud Data Streams.
OPTIONS
The arguments are as follows:
-b value
--bootstrap-config=value
The path to the bootstrap configuration file. See the 'bootstrap.xml'
help topic for more information about this file. This argument is
optional.
-t value
--tool-password=value
The configuration tool password used to decrypt the database password
in the bootstrap.xml file. If the tool password is omitted, the
command will prompt the end-user for it on the console. See the
'bootstrap.xml' help topic for more information. This argument is
optional.
-l value
--tibco-cloud-hostname=value
The hostname of the TIBCO Cloud OAuth2 Authorization Server. The
hostname to use depends on the region that you want to access. This
argument is optional. The default value is 'account.cloud.tibco.com'.
-Cvalue
The email address of a contact person, to be included in the
registration request. This argument is mandatory but may be specified
multiple times with different values.
-p value
--public-address=value
The public address of the TIBCO Spotfire Server. See the
'set-public-address' command for more information. This argument is
optional.
EXAMPLES
Register towards the TIBCO Cloud United States (US) region:
register-as-tibco-cloud-client -Cinfo@example.com
Register towards the TIBCO Cloud Europe (EU) region:
register-as-tibco-cloud-client -Cinfo@example.com
--tibco-cloud-hostname=eu.account.cloud.tibco.com