InitiateOAuth
Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.
Possible Values
OFF, REFRESH, GETANDREFRESHData Type
string
Default Value
"OFF"
Remarks
OAuth is an authorization framework that enables applications to obtain limited access to user accounts on an HTTP service. The OAuth flow defines the method to be used for:
- Logging in users.
- Exchanging user credentials for an OAuth access token to be used for authentication.
- Providing limited access to applications.
The options for initiating and maintaining OAuth access are named for the parts of that flow that the connector handles:
| OFF | The connector provides no automatic OAuth flow initiation. The OAuth flow is handled entirely by the user. This means that the user must refresh the token manually, and reconnect with an updated OAuthAccessToken property when the current token expires. |
| GETANDREFRESH | The connector handles the entire OAuth flow (both GET and REFRESH). This means that if a token already exists, the connector refreshes it when necessary; if no token currently exists, the connector obtains it by prompting the user to login. |
| REFRESH | The user obtains the OAuth Access Token and sets up the sequence for refreshing the OAuth Access Token. (The user is never prompted to log in to authenticate.) After the user logs in, the connector handles the refresh of the OAuth Access Token. |
For more information on how to set up OAuth and use this property when configuring a connection, see Establishing a Connection.