Global Resource Properties (OAuth 2.0)

Connection Settings

Connection settings for a Global Resource can be managed in the property setting dialog for each adapter, in the "Global Resource Settings" in Control Panel.

Basic settings

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter the name of the setting for the connecting destination.

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
Client ID	Required	Only environment variables are available	Enter the client ID.
Client secret	Required	Only environment variables are available	Enter the client secret.
Redirect URI	Required	Only environment variables are available	Enter the redirect URI.	Specify the redirect URI registered to the service provider. To redirect to DataSpider, register the following URI to the service provider. http://<The host name or IP address of the OS on which DataSpiderServer runs>:<Port number>/dataspider/oauth_2_0
Authorization endpoint	Required	Only environment variables are available	Enter the authorization endpoint.
Token endpoint	Required	Only environment variables are available	Enter the token endpoint.
Scope	Optional	-	Specify scopes. Each column can be operated with the following buttons. [Add]: Adds a column. [Up]: Moves up the order of selected column by one. [Down]: Moves down the order of selected column by one. [Delete]: Deletes a column.
Scope/Value	Required	Only environment variables are available	Enter a Scope.
Refresh token	Required	Not available	The refresh token set in [Issue token] will be shown.
Valid period of access token	Optional	Only environment variables are available	Enter the valid period of access token by seconds.	When entered, refreshes the token if the entered seconds passed over from the point of time when token was issued. If omitted, refreshes the token when 401 error occurred.

Property action

Item name	Description	Remarks
Issue token	Connects to the token endpoint, then issues a refresh token and gets the access token valid period.	If the following property items are not specified, it is disabled. [Client ID] [Client secret] [Redirect URI] [Authorization endpoint] [Token endpoint]

Detail settings

Item name	Required/Optional	Use of variables	Description
Additional parameters	Optional	-	Specify parameters to add in authorization request. Each column can be operated with the following buttons. [Add]: Adds a column. [Up]: Moves up the order of selected column by one. [Down]: Moves down the order of selected column by one. [Delete]: Deletes a column.
Additional parameters/Key	Required	Only environment variables are available	Enter the parameter key.
Additional parameters/Value	Required	Only environment variables are available	Enter the parameter value.

Component Pool Setting

Component pool is not supported.

Security

Security setting is available from "Global Resource Settings" in control panel.

Specification Limits

Supported authorization grant is Authorization Code grant.

Supported access token type is Bearer.

In Studio for Web, [Additional parameters] is not supported.

In Studio for Web, state parameter verification in authorization request is not supported.

Main Exceptions

Exception name	Cause	Solution
InvalidPropertyConfigurationException <Property name> is not specified.	[<Property name>] is not specified.	Specify [<Property name>].
java.net.URISyntaxException	The URL is in invalid form.	Check the URL setting.
java.net.UnknownHostException <host name>	Host name is invalid.	Check the host name specified in URL setting.
AuthorizationException <Detailed information...>	Failed in authentication/authorization.	Check the detailed information of the exception. Check [Client ID], [Client secret], [Redirect URI], [Authorization endpoint], [Token endpoint], or [Scope]. Allow the appropriate authority in the authorization screen.
TokenException Token could not be gotten.<Detailed information...>	Failed to do Token Request.	Check the detailed information of the exception. Check [Token endpoint] or [Scope].
TokenException Token could not be updated.<Detailed information...>	Failed to do Refresh Request.	Check the detailed information of the exception. Re-execute [Issue token].