This guide walks through how to use Outbound requests that require OAuth.

Definitions

• Authentications – These are used to create an authentication name, assign authentication requests to authentication attributes (e.g. client id/secret), and tie to outbound requests.
• Authentication Requests - These requests make the authorization API call to generate/retrieve a token.
• Authentication Attributes - These attributes can be created and stored in one place but has values that are used throughout the system for a specific authentication.

Create Outbound requests that use OAuth

1. Open the Authentication subsection under Requests in the left panel.
2. Click + Create New Request.
3. A new page will open. Enter in the Request Name and Request Description.
   • Note: Think about building this as you would for an Outbound Request.
4. Select POST as the request method. 
5. Enter the request endpoint.
   • Note: Click the <…> button in order to view the Token Library.
6. Set the Headers.
   • Note: Note for application/x-www-form-urlencoded requests, be sure the header is set appropriately and choose XML for the payload type.
7. Add the Payload.
8. Map the Response to Paradox Attributes.
   • Notes: 
     • Map the access_token value from the response to the <AuthName>.access_token attribute
     • Map the expires_in value from the response to the <AuthName>.expires_in attribute.
       • We take this value (in seconds) to set [expiration of the auth token == (time of auth request) + expires_in].
9. Click Save.
   • Note: You also have the option to Save and Preview if you also want to view this request.
10. Open the Authentications section from the left panel.
11. Click the + Create New Authentication button.
12. In the drawer that opens, enter the Authentication Name and Description.
13. Add your authentication attributes/values.
14. Add your newly-created Authentication Request to this Authentication.
15. Click Save.
16. Open the Requests section from the left panel.
17. The Outbound Requests list will open by default. Click + Create New Request.
18. Create your outbound request. As you create this request, ensure to complete the following:
    1. Select your new Authentication as your Authentication Type.
    2. Add your Authorization header to pass in the Bearer token.
19. Click Save.
    • Note: You also have the option to Save and Preview if you also want to view this request.
20. Click the Run button within the new Outbound Request row.
    • If the request's run time is greater than the expiration time on the authentication, the authentication will run the authentication request to generate a new access token and update the authentication attribute, then run the outbound request.
    • If the request's runtime is less than expiration time on the authentication, the outbound request runs without calling the authentication request first, no need to generate a new access token.