GetOAuthAccessToken
Fetches the OAuth Access Token, which is used to authenticate and authorize API calls made to REST.
Input
| Name | Type | Description |
| Other_Options | String | Additional options to customize OAuth authentication behavior. |
| Cert | String | Path to a personal certificate (.pfx) file for authentication. Only applicable to OAuth 1.0. |
| Cert_Password | String | The password for the personal certificate file specified in 'Cert'. Only applicable to OAuth 1.0. |
| AuthToken | String | A temporary token returned by GetOAuthAuthorizationUrl, required for obtaining an access token. Only applicable to OAuth 1.0. |
| AuthKey | String | A secret key associated with the OAuth request token. Returned by GetOAuthAuthorizationUrl. Only applicable to OAuth 1.0. |
| AuthSecret | String | A legacy alias for 'AuthKey', included for backward compatibility. |
| Sign_Method | String | Specifies the method used to generate the signature for OAuth 1.0 authentication.
The allowed values are HMAC-SHA1, PLAINTEXT. The default value is HMAC-SHA1. |
| GrantType | String | Defines the OAuth 2.0 authorization grant type, such as 'authorization_code' or 'client_credentials'.
The allowed values are CODE, PASSWORD, CLIENT, REFRESH. |
| Post_Data | String | Data payload to be included in the HTTP POST request, if required. |
| AuthMode | String | Specifies the authentication mode. Common values include 'WEB' for browser-based authentication and 'APP' for application-based authentication.
The allowed values are APP, WEB. The default value is WEB. |
| Verifier | String | A one-time verifier code returned by the authorization server after the user grants permission. Required only for 'WEB' authentication mode. |
| Scope | String | Specifies the level of access to APIs. By default, all APIs supported by this data provider are included. |
| CallbackURL | String | Defines the URL where the OAuth authorization response is sent after authentication. |
| Prompt | String | Determines how the authentication prompt is displayed to the user. Options: 'NONE' (no prompt), 'CONSENT' (always display the consent screen), 'SELECT_ACCOUNT' (prompt user to choose an account). |
| AccessType | String | Indicates whether the application requires access when the user is offline. Options: 'ONLINE' (access only when user is present), 'OFFLINE' (allows token refresh when user is absent). |
| State | String | A custom value sent with the authorization request, which is returned in the response. Commonly used for session tracking, redirect handling, or security checks. |
| PKCEVerifier | String | A one-time cryptographic key used in the OAuth PKCE (Proof Key for Code Exchange) flow. Required when 'AuthScheme=OAuthPKCE'. |
Result Set Columns
| Name | Type | Description |
| OAuthAccessToken | String | The OAuth access token used for authenticating API requests. |
| OAuthAccessTokenSecret | String | The secret key associated with the OAuth access token. Used for OAuth 1.0 authentication. |
| OAuthRefreshToken | String | A token that can be used to request a new access token without requiring user reauthorization. |
| ExpiresIn | String | The duration (in seconds) before the access token expires. A value of -1 indicates that the token does not expire. |
| * | String | Captures any additional response parameters returned by the OAuth provider. |