FireDAC Components for Excel Online

Build 21.0.7930

GetOAuthAccessToken

Gets the OAuth access token from Excel Online.

Input

Name Type Description
AuthMode String The type of authentication mode to use. The allowed values are APP, WEB.
Verifier String The verifier token returned by Excel Online after using the URL obtained with GetOAuthAuthorizationURL. Required for only the Web AuthMode.
CallbackUrl String The URL the user will be redirected to after authorizing your application.
Scope String A space-separated list of scopes to request from the user when OAuthGrantType='CODE'. Please check the Microsoft Graph API documentation for a list of available permissions. When OAuthGrantType='CLIENT', a scope of 'https://graph.microsoft.com/.default' is used. '/.default' picks up whatever permissions your app already has.

The default value is https://graph.microsoft.com/Sites.Read.All https://graph.microsoft.com/Sites.ReadWrite.All https://graph.microsoft.com/Files.Read https://graph.microsoft.com/Files.Read.All https://graph.microsoft.com/Files.Read.Selected https://graph.microsoft.com/Files.ReadWrite https://graph.microsoft.com/Files.ReadWrite.All https://graph.microsoft.com/Files.ReadWrite.AppFolder https://graph.microsoft.com/Files.ReadWrite.Selected offline_access.

State String A value included in the request that will also be returned in the token response. It can be a string of any content that you wish.
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 authentication token returned from Excel Online.
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) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7930