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 |
| Cert | String | Path to a personal certificate (.pfx) file used 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. |
| Sign_Method | String | Specifies the method used to generate the digital signature for OAuth 1.0 authentication.
The allowed values are HMAC-SHA1, PLAINTEXT. The default value is HMAC-SHA1. |
| Scope | String | Defines the level of access granted to APIs. By default, access is provided to all APIs supported by this data provider. |
| CallbackURL | String | The URL to which the user is redirected after completing the OAuth authorization process. |
| Prompt | String | Controls the type of authentication prompt displayed to the user. Options: 'NONE' (no prompt), 'CONSENT' (always display the consent screen), 'SELECT_ACCOUNT' (prompt the 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 and returned in the response. Commonly used for session tracking, redirect handling, or security checks. |
| Other_Options | String | Additional options for customizing OAuth authentication behavior. |
Result Set Columns
| Name | Type | Description |
| AuthToken | String | A temporary authorization token that must be passed into the GetOAuthAccessToken stored procedure to obtain an access token. |
| AuthKey | String | A secret token associated with the authorization request, required for OAuth 1.0 authentication. |
| AuthSecret | String | A legacy alias for 'AuthKey', included for backward compatibility. |
| URL | String | The OAuth authorization URL that users must visit to authenticate and grant access to the application. |
| PKCEVerifier | String | A randomly generated key used in the OAuth PKCE (Proof Key for Code Exchange) flow. Required when 'AuthScheme=OAuthPKCE'. |