ODBC Driver for SQL Server

Build 21.0.7958

GetOAuthAccessToken

Gets an authentication token from AzureAD.

Input

Name Type Description
AuthMode String

The allowed values are APP, WEB.

The default value is APP.

Verifier String A verifier returned by the service that must be input to return the access token. Needed only when using the Web auth mode. Obtained by navigating to the URL returned in GetOAuthAuthorizationUrl.
Scope String

The default value is https://database.windows.net/user_impersonation offline_access.

CallbackUrl String
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 AzureDataCatalog authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations.
Prompt String Defaults to 'select_account' which prompts the user to select account while authenticating. Set to 'None', for no prompt, 'login' to force user to enter their credentials or 'consent' to trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app.

Result Set Columns

Name Type Description
OAuthAccessToken String The access token used for communication with Azure AD.
OAuthRefreshToken String The OAuth refresh token. This is the same as the access token in the case of Azure AD.
ExpiresIn String The remaining lifetime on the access token. A -1 denotes that it will not expire.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7958