GetOAuthAccessToken

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


Name	Type	Description
AuthMode	String	Specifies the type of authentication mode to use when obtaining an OAuth token. The options include 'App' for desktop applications and 'Web' for web applications. The allowed values are APP, WEB. The default value is APP.
Verifier	String	Azure Synapse provides the code verifier after user authorization. This value is sent as a query parameter to the callback URL.
Scope	String	Defines the permissions to request during authentication. For 'OAuthGrantType=CODE,' provide a space-separated list of desired scopes. For 'OAuthGrantType=CLIENT,' the default scope is 'https://graph.microsoft.com/.default,' which uses the permissions that are already assigned to your application. The default value is https://database.windows.net//.default offline_access.
CallbackUrl	String	The URL to which the authentication service redirects the user's browser after authorization is complete. This must match the Reply URL configured in the Azure Synapse Directory application settings.
State	String	A optional string that the client application can use to maintain state between the request and callback. This value is returned after the authentication roundtrip and helps verify the integrity of the request.
Prompt	String	Determines how the user is prompted during authentication. Options include 'select_account' (default), 'none' (no prompt), 'login' (force the user to log in), and 'consent' (request the user to grant permissions).


Name	Type	Description
OAuthAccessToken	String	The OAuth Access Token used to authenticate API requests with Azure Synapse.
OAuthRefreshToken	String	The OAuth Refresh Token is used to obtain a new access token when the current one expires.
ExpiresIn	String	Indicates the remaining lifetime of the access token in seconds. A value of -1 indicates the token does not expire.

ODBC Driver for Azure Synapse