JDBC Driver for Xero WorkflowMax

Build 23.0.8839

GetOAuthAccessToken

Gets an authentication token from Xero WorkflowMax.

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.

Scope String A comma-separated list of permissions to request from the user. Please check the Xero WorkflowMax API for a list of available permissions.
CallbackUrl String The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL you have specified in the Xero WorkflowMax app settings. Only needed when the Authmode parameter is Web.
Verifier String The verifier returned from Xero WorkflowMax after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL.
State String Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Xero WorkflowMax authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations.

Result Set Columns

Name Type Description
OAuthAccessToken String The access token used for communication with Xero WorkflowMax.
OAuthRefreshToken String The OAuth refresh token. This is the same as the access token in the case of Xero WorkflowMax.
ExpiresIn String The remaining lifetime on the access token. A -1 denotes that it will not expire.
TenantId String The ID associated with a Xero WorkflowMax tenant, which is needed, alongside an OAuthAccessToken, to authenticate an OAuth app to Xero WorkflowMax.

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