JDBC Driver for Azure Synapse

Build 25.0.9434

GetOAuthAuthorizationUrl

Retrieves the OAuth Authorization URL, allowing the client to direct the user's browser to the authorization server and initiate the OAuth process.

Input

Name Type Description
CallbackURL String The URL where users are redirected after successfully authorizing your application must match the Reply URL set in the Azure Synapse application settings for proper redirection.
Scope String A list of space-separated permissions or scopes requested from users during authorization. For OAuthGrantType='CODE', these are the user-facing scopes. For OAuthGrantType='CLIENT', use 'https://graph.microsoft.com/.default' to utilize preconfigured application permissions.

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

State String A unique string value used to maintain the state between your authorization request and its response. This is useful for preventing cross-site request forgery (CSRF) attacks and identifying user sessions.
Prompt String Specifies the behavior of user authentication. The default setting is 'select_account', which prompts the user to choose an account. The 'none' option skips this prompt, while 'login' requires the user to re-enter their credentials. The 'consent' option displays a permissions consent screen.

Result Set Columns

Name Type Description
Url String The generated authorization URL enables users to authenticate and grant access to the application via their web browser.

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