Spotfire® Server and Environment - Installation and Administration

issue-access-token

Issues an access token to an API client.

issue-access-token 
[-b value | --bootstrap-config=value] 
[-t value | --tool-password=value] 
<-i value | --client-id=value> 
{-Svalue} 
[-v value | --validity=value]

Overview

Use this command to issue an access token to an OAuth2 client. The client must be authorized to use the client_credentials grant. The issued access token can be revoked using the revoke-token command.

Options

Option Optional or Required Default Value Description
-b value
--bootstrap-config=value
Optional none The path to the bootstrap configuration file. See Bootstrap.xml file for more information about this file.
-t value
--tool-password=value
Optional none The configuration tool password used to decrypt the database password in the file bootstrap.xml. If the tool password is omitted, the command prompts the user for it in the console. Refer to Bootstrap.xml file.
-i value 
--client-id=value
Required none The ID of the client for which to issue an access token. Use the list-oauth2-clients command to find the IDs of all clients.
Svalue
Required none The scope for which to issue an access token. The client must be authorized to use the given scope. This argument can be specified multiple times with different values.
-v value
--validity=value
Optional 17520 (two years) The amount of time, in hours, for which the issued access token should be valid. Must be a positive integer.