Describes the authentication method and permissions required to configure a TIBCO Spotfire Server connection in Data Integrity Suite.
API Access
TIBCO Spotfire Server uses WebService API combined with OAuth 2.0 authentication for secure metadata access.
OAuth 2.0 API Client Registration
You must register an OAuth 2.0 API client using the Spotfire Server command-line configuration tool. Follow these steps:
- On the computer running Spotfire Server, open a command line as an administrator and change the directory to the command-line configuration tool (
config.baton Windows orconfig.shon Linux). The default location isserver_installation_dir/tomcat/bin. - Export the active server configuration from the Spotfire database into a local
configuration.xmlfile using theexport-configcommand. For example:config export-config --tool-password=mypassword - Register a new OAuth 2.0 API client using the
register-api-clientcommand. For example:config register-api-client -n OAuthClient1 -Sapi.soap.library-service -Sapi.library.read - Note the client credentials for use in Data Integrity Suite.
Required API Scopes
The registered API client must have access to the following scopes:
api.soap.library-service: Allows access to library metadataapi.library.read: Allows read-only access to library content
Optional DXP Download Credentials
If you plan to download Spotfire DXP files, an Enterprise Player license may be required. Optional download user credentials can be configured for this purpose.