JDBC Driver for Vault CRM

Build 25.0.9434

GetOAuthAccessToken

Fetches the OAuth Access Token, which is used to authenticate and authorize API calls made to Veeva Vault.

Input

Name Type Required Description
AuthMode String False Specifies the OAuth authentication mode to initiate. Valid values are APP for application-based authentication and WEB for user-delegated authentication through browser redirect flow.
Verifier String False The verifier token issued by the Veeva Vault Authentication Provider after the user completes the authorization step using the URL generated by the GetOAuthAuthorizationURL function. This field is required only when AuthMode is set to WEB.
CallbackUrl String False The redirect URI to which the user is sent after completing authorization. This URL must exactly match one of the redirect URIs registered with the Veeva Vault application.
State String False A developer-defined opaque value included in the OAuth flow for maintaining state between the request and callback. It can be used to prevent cross-site request forgery or to encode additional information needed during the callback.
Prompt String False Controls how the Veeva Vault login page is displayed. Valid values include 'select_account' (default, prompts the user to choose an account), 'None' (silent login if already authenticated), 'login' (forces re-authentication), and 'consent' (prompts the user to re-consent to requested permissions).

Result Set Columns

Name Type Description
OAuthAccessToken String The short-lived access token issued by Veeva Vault that authorizes API requests on behalf of the authenticated application or user.
OAuthRefreshToken String A long-lived token used to silently acquire a new OAuth access token without requiring user interaction. This is typically applicable when AuthMode is WEB.
ExpiresIn String The number of seconds until the OAuth access token expires. Applications should track this value to know when to refresh the token using the refresh token.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434