ODBC Driver for PostgreSQL

Build 24.0.9060

GetOAuthAccessToken

Gets an authentication token from Azure Active Directory.

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://ossrdbms-aad.database.windows.net/.default.

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. If set to 'None', the user will not be prompted.
AccessType String Indicates if your application needs to access a Google API when the user is not present at the browser. This parameter defaults to OFFLINE. If your application needs to refresh access tokens when the user is not present at the browser, then use OFFLINE. This will result in your application obtaining a refresh token the first time your application exchanges an authorization code for a user.

The allowed values are ONLINE, OFFLINE.

The default value is OFFLINE.

Result Set Columns

Name Type Description
OAuthAccessToken String The authentication token returned from Azure Active Directory. This can be used in subsequent calls to other operations for this particular service.
OAuthRefreshToken String This is the same as the access token.
ExpiresIn String The remaining lifetime on the access token. -1 denotes that it will not expire.

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