OAuth
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
Property | Description |
InitiateOAuth | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. |
OAuthVersion | The version of OAuth being used. |
OAuthClientId | Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. |
OAuthClientSecret | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server. |
OAuthAccessToken | A token received after authentication to the OAuth network, granting the user access. The access token is used in place of the user's login ID and password, which stay on the server. |
OAuthAccessTokenSecret | The OAuth access token secret for connecting using OAuth. |
SubjectId | The user subject for which the application is requesting delegated access. |
SubjectType | The Subject Type for the Client Credentials authentication. |
OAuthSettingsLocation | Specifies the location of the settings file where OAuth values are saved. Storing OAuth settings in a central location avoids the need for users to enter OAuth connection properties manually each time they log in. It also enables credentials to be shared across connections or processes. |
CallbackURL | The URL users return to after authenticating to Microsoft Access via OAuth. |
Scope | Specifies the scope of the authenticating user's access to the application. Generally specified at the time the custom OAuth application is created (if necessary), so that the authenticating user can obtain the the level of access appropriate to their credentials. |
OAuthPasswordGrantMode | Specifies how the OAuth Client Id and Client Secret should be passed. Supported options: BASIC and POST. |
OAuthIncludeCallbackURL | Whether to include the callback URL in an access token request. |
OAuthAuthorizationURL | The authorization URL for the OAuth service. |
OAuthAccessTokenURL | The URL to retrieve the OAuth access token from. |
OAuthRefreshTokenURL | The URL to refresh the OAuth token from. |
OAuthRequestTokenURL | The URL the service provides to retrieve request tokens from. This is required in OAuth 1.0. |
OAuthVerifier | Specifies a verifier code returned from the OAuthAuthorizationURL . Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set. |
AuthToken | The authentication token used to request and obtain the OAuth Access Token. |
AuthKey | The authentication secret used to request and obtain the OAuth Access Token. |
OAuthParams | A comma-separated list of other parameters to submit in the request for the OAuth access token in the format paramname=value. |
OAuthRefreshToken | Gets and refreshes the currently-active OAuth Access Token. |
OAuthExpiresIn | Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working. |
OAuthTokenTimestamp | Displays a Unix epoch timestamp in milliseconds that shows how long ago the current Access Token was created. |