JDBC Driver for Certinia

Build 23.0.8839

GetOAuthAccessToken

If using a Windows application, set Authmode to App. If using a Web app, set Authmode to Web and specify the Verifier obtained by GetOAuthAuthorizationUrl.

Input

Name Type Description
Authmode String The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app.

The allowed values are APP, WEB.

The default value is APP.

Verifier String The verifier token returned by Salesforce after using the URL obtained with GetOAuthAuthorizationUrl.
Scope String A space-separated scope of permissions you need the app to have access to. The available values are api, chatter_api, full, id, refresh_token, visualforce, and web. For details, refer to: http://help.salesforce.com/help/doc/en/remoteaccess_oauth_scopes.htm.
CallbackUrl String The page to return the Salesforce app after authentication has been completed.
Api_Version String The API version you would like to authenticate to.

The default value is 50.0.

State String Any value that you wish to be sent with the callback.
GrantType String Authorization grant type. Only available for OAuth 2.0. If left unspecified, the default value is the value of the OAuthGrantType connection property.

The allowed values are CODE, PASSWORD.

PKCEVerifier String Specifies 128 bytes of random data with high entropy to make guessing the code value difficult. Used when AuthScheme=OAuthPKCE.

Result Set Columns

Name Type Description
Scope String The scope of permissions for the app.
Instance_Url String The instance URL being used by the app.
Id String The Id associated with the OAuth token.
Issued_At String When the token was issued at.
Signature String A signature for the OAuth token.
OAuthServerUrl String The OAuth server URL.
OAuthRefreshToken String A token that may be used to obtain a new access token.
OAuthAccessToken String The OAuth access token.
ExpiresIn String The remaining lifetime on the access token. A -1 denotes that it will not expire.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839