ODBC Driver for Azure Cosmos DB

Build 24.0.9060

GetOAuthAccessToken

Gets the OAuth access token from CosmosDB.

Input

Name Type Description
AuthMode String The type of authentication you are attempting. Use App for a Windows application, or Web for Web-based applications.

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.
CallbackUrl String The URL the user will be redirected to after authorizing your application.
Scope String The scope or permissions you are requesting.
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 CosmosDB.
OAuthRefreshToken String A token that may be used to obtain a new access token.
ExpiresIn String The remaining lifetime for the access token in seconds.

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