OAuthRefreshToken
Gets and refreshes the currently-active OAuth Access Token.
Data Type
string
Default Value
""
Remarks
When InitiateOAuth is set to REFRESH, the first time the token expires the connector uses the OAuthRefreshToken to get a new access and refresh tokens from the server. After the first refresh, the connector uses the access and refresh tokens stored in OAuthSettingsLocation instead of the tokens from the connection properties. The access token is used in place of the user's login ID and password, which stay on the server.
The OAuth access token has a server-dependent timeout, limiting user access, set using the OAuthExpiresIn property. When OAuthRefreshToken is called, it refreshes the OAuth access token so the user can keep working without needing to re-authenticate.