Excel Add-In for Airtable

Build 24.0.9060

GetOAuthAccessToken

Retrieve the OAuth access token to be used for authentication with Airtable using OAuth.

Input

Name Type Required Description
AuthMode String False The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app.

The allowed values are APP, WEB.

The default value is APP.

CallbackUrl String False The URI for the authorize response redirect. Must exactly match a redirect URI associated with your integration.
State String False This field indicates any state that 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 Airtable server and back. Possible uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery.
Scope String False The permissions required by your integration. A string that is a space delimited list of unique scopes. All scopes must be valid, Airtable defined scopes that have been selected for your integration in the integration management page. You must request at least one scope.
PKCEVerifier String False The PKCEVerifier returned by GetOAuthAuthorizationURL.
Verifier String False The grant code returned from Airtable after the user has authorized your app to have access to their data. This value will be returned as a code parameter to the callback URL.

Result Set Columns

Name Type Description
TokenType String The type of the generated token.
Scope String A string that is a space delimited list of scopes granted to this access token.
OAuthAccessToken String A token that is used to make requests to the Airtable API on behalf of the user.
ExpiresIn String Time in seconds until the access token expires.
OAuthRefreshToken String A token that may be used to obtain a new access token.
RefreshExpiresIn String Time in seconds until the refresh token expires.

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