GetOAuthAccessToken
Gets an authentication token from Outreach.
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. |
| Scope | String | False | The scope or permissions you are requesting.
The default value is audits.read accounts.read callDispositions.read callPurposes.read calls.read customDuties.read complianceRequests.read contentCategories.read contentCategoryMemberships.read contentCategoryOwnerships.read duties.read emailAddresses.read events.read favorites.read mailAliases.read mailboxes.read mailings.read opportunities.read opportunityProspectRoles.read opportunityStages.read personas.read phoneNumbers.read profiles.read prospects.read recipients.read roles.read rulesets.read sequenceStates.read sequenceSteps.read sequenceTemplates.read sequences.read snippets.read stages.read taskPriorities.read tasks.read teams.read templates.read users.read. |
| CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL you have specified in the Outreach app settings. Only needed when the Authmode parameter is Web. |
| Verifier | String | False | The verifier returned from Outreach 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. |
| State | String | False | Indicates any state which 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 Outreach authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations. |
Result Set Columns
| Name | Type | Description |
| OAuthAccessToken | String | The access token used for communication with Outreach. |
| OAuthRefreshToken | String | The OAuth refresh token. This is the same as the access token in the case of Outreach. |
| ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |