GetOAuthAccessToken
Gets an authentication token from Blackbaud Financial Edge NXT.
Input
Name | Type | Required | Description |
AuthMode | String | False | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app.
The allowed values are APP, WEB. The default value is APP. |
CallbackURL | String | False | Determines where the response is sent. The value of this parameter must exactly match one of the values registered in the settings for the app (including the HTTP or HTTPS schemes, capitalization, and trailing '/'). |
Verifier | String | False | The verifier returned from Blackbaud Financial Edge NXT after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL in GetOAuthAuthorizationURL. |
State | String | False | This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Blackbaud Financial Edge NXT authorization server and back. Possible uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
Result Set Columns
Name | Type | Description |
OAuthAccessToken | String | The access token used for communication with Blackbaud Financial Edge NXT. |
OAuthRefreshToken | String | The refresh token used for RefreshOAuthAccessToken procedure. |