LogoLogo
AboutSupport
3.1
3.1
  • Unifi User Documentation
  • Release
    • Release Notes
      • Unifi 3.1 Release Notes
      • Unifi 3.0 Release Notes
      • Unifi 2.2 Release Notes
      • Unifi 2.1 Release Notes
      • Unifi 2.0 Release Notes
    • Installation
    • Global Utility
    • Hotfix
  • Overview
    • Quick Tour
    • Supported Features
    • Application Modules
    • Data Model
  • Integration Guides
    • Outbound Incident Guide
      • Getting Started
      • Process
      • Integration
      • Connection
      • Create Scenario
        • CreateIncidentResponse Message
        • CreateIncidentResponse Fields
        • CreateIncident Message
        • CreateIncident Fields
        • Trigger
        • Test CreateIncident
      • Update Scenario
        • Response Message
        • UpdateIncident Message
        • UpdateIncident Fields
        • Test UpdateIncident
      • Resolve Scenario
        • ResolveIncident Message
        • ResolveIncident Fields
        • Test ResolveIncident
      • Build - Integration Level
      • Conclusion
    • Bidirectional Asynchronous Incident Guide
      • Getting Started
      • Process
      • Web Service
      • Integration
      • Connection
      • Create Scenario
        • Response Message
        • CreateIncidentReceipt Message
        • CreateIncidentReceipt Fields
        • CreateIncident Message
        • CreateIncident Fields
        • Trigger
        • Test CreateIncident
      • Update Scenario
        • Receipt Message
        • UpdateIncident Message
        • UpdateIncident Fields
        • Test UpdateIncident
      • Resolve Scenario
        • ResolveIncident Message
        • ResolveIncident Fields
        • Test ResolveIncident
      • Build - Integration Level
      • Build the Other Half
        • Move the Integration
        • Reconfigure the Connections
      • Conclusion
    • Incident Update Poller Guide
      • Polling
        • Poll Processor
        • Poller
      • Inbound Message
        • UpdateIncidentInbound Message
        • UpdateIncidentInbound Fields
      • Message Identification
      • Bond Identification
        • Edit Incident Form
        • Edit CreateIncident Message
      • Test Update Poll
      • Conclusion
    • Incident Multiple Message Poller Guide
      • Polling
        • Poll Processor
        • Poller
      • Inbound Messages
        • ResolveIncidentInbound Message
        • ResolveIncidentInbound Fields
      • Testing
        • Test UpdateIncidentInbound
        • Test ResolveIncidentInbound
      • Conclusion
    • Incident Create Poller Guide
      • Polling
        • Connection Variables
        • Poll Processor
        • Poller
      • Messages
        • CreateIncidentInboundReceipt Message
        • CreateIncidentInboundReceipt Fields
        • CreateIncidentInbound Message
        • CreateIncidentInbound Fields
      • Build - Integration Level
      • Test Create Poll
      • Conclusion
    • Incident Parent and Child Poller Guide
      • Polling
        • Connection Variables
        • Child Poll Processor
        • Child Poller
        • Parent Poll Processor
        • Parent Poller
      • Inbound Messages
      • Testing
        • Test UpdateIncidentInbound
        • Test ResolveIncidentInbound
      • Conclusion
    • Incident Attachment Poller Guide
      • Polling
        • Connection Variables
        • Edit Endpoint URLs
        • Get Attachment Poll Processor
        • Get Attachment Poller
        • Select Attachments Poll Processor
        • Select Attachments Poller
        • Edit Child Poll Processor
        • Edit Child Update Poller
      • Messages
        • AddAttachmentInbound Message
      • Testing
        • Test Outbound Scenarios
        • Test CreateIncidentInbound
        • Test UpdateIncidentInbound
        • Test ResolveIncidentInbound
        • Test AddAttachmentInbound
      • Conclusion
  • Feature Guides
    • Packager Feature Guide
      • Instructions
    • Error Handling Tools Feature Guide
      • Retry
      • Replay
      • Ignore
      • Repair
      • Pause and Resume
    • Unifi Test Assistant Feature Guide
      • Generating Tests
      • Running Tests
      • Exploring Results
  • HOW TO GUIDES
    • How to Handle Attachments
      • Message
      • Scripted REST Resource
      • Test AddAttachment
    • How to Setup an OAuth Connection
      • Identity Provider Instance
      • Identity Consumer Instance
  • Bonding
    • Bonds
    • Bonded Attachments
  • Transport
    • Transport Data Flow
    • Snapshots
    • Transactions
    • Stages
    • HTTP Requests
  • Configuration
    • Processes
    • Integrations
    • Connections
    • Messages
    • Message Scripts
    • Fields
    • Field Maps
    • Response Actions
    • Event Actions
  • Polling
    • Pollers
    • Poll Processors
    • Poll Requests
    • Large Response Payloads
  • Testing
    • Integration Tests
    • Test Scenarios
    • Test Scenario Data
    • Test Results
    • Test Scenario Results
  • Administration
    • Activity Logs
    • Data Stores
    • Properties
    • Scheduled Scripts
    • System Logs
    • Self-test
  • Scripting
    • Variables
    • Snippets
  • Troubleshooting
    • Attachments
      • New record attachments are not sent from Portal
      • Embedded attachments not being sent
      • Special characters in attachment file names
    • Development
      • Bonding to existing records
      • Copying an existing Unifi trigger rule doesn't work
      • Duplicate messages being sent
      • Deleted records are not packaged
      • Multipart Form Data
      • Undefined error when building an integration
    • Installation
      • Latest version of Unifi not accessible
    • Integration Responses
      • Transaction has been processed already
      • Initiating transaction not found for inbound receipt
      • Message has already been processed
      • Message ID not found
      • Message is not valid for this bond
      • Message name not recognised
      • Unable to identify message name from request
    • Other
      • Dynamic stage does not render
Powered by GitBook
On this page
  • Create Application Registry
  • Configure Connection
  • Outbound Connectivity
  • Connection Details
  • Get OAuth Token
  • Test Integration

Was this helpful?

Export as PDF
  1. HOW TO GUIDES
  2. How to Setup an OAuth Connection

Identity Consumer Instance

These are the configuration changes to be made in the identity consumer instance when setting up an OAuth Connection.

PreviousIdentity Provider InstanceNextBonds

Last updated 3 years ago

Was this helpful?

Create Application Registry

In native ServiceNow, navigate to System OAuth > Application Registry and click New.

img

On the interceptor page, click Connect to a third party OAuth Provider.

The fields to be configured for the Application Registry record are as follows:

Field
Description
Value

Name

Name of the OAuth app

<Your Unique Name>

Client ID

The client id of the OAuth app

The Client ID from the Identity Provider Instance

Client Secret

The client secret of the OAuth app

The Client Secret from the Identity Provider Instance

Default Grant type

The Default Grant Type used to establish the OAuth token

'Resource Owner Password Credentials'

Refresh Token Lifespan*

The number of seconds a refresh token issued will be good for

8,640,000 (default value - automatically populated)

Token URL

OAuth token endpoint to retrieve access and refresh tokens

'https://<your-provider-instance>.service-now.com/oauth_token.do'

Comments

Comments about the OAuth app

<Your description of the purpose of the OAuth entity>

*This value is to be left as-is.

Token URL: Replace the <your-provider-instance> element of the URL with that of the Identity Provider Instance.

Your Application Registries New Record should look like this:

Right-click and Save to remain on the record.

Validate that the OAuth Entity Profiles related list has been populated with the following values:

Name: <Your Unique Name> default_profile

Is default: true

Grant type: Resource Owner Password Credentials

This is the profile which will be selected when configuring the Connection.

Configure Connection

In Unifi Integration Designer, navigate to Connections and click New.

We are going to configure a Connection for the Pre-Production environment because we have already configured connections for both the Development and Test environments. Choose whichever environment is appropriate for your requirements.

The fields to be configured for the New Connection modal are as follows:

Field
Description
Value

Environment

The environment this connection applies to.

'Pre-Production'

Endpoint URL

The external system's access URL.

<External system Endpoint URL>

Active

Use this connection for the integration when true.

<true>

Outbound Connectivity

The format of the Endpoint URL is as follows:

https://<your_provider_instance>.service-now.com/<your_provider_process_api>

The entire Endpoint URL can be easily obtained from the automatically created Message Resource on the Unifi Scripted REST API (displayed in the widget at the top of the Connections page in the other instance).

Your New Connection modal should look like this:

Submit and view to further configure the Connection.

Connection Details

The fields to be configured for the Details form are as follows:

Field
Description
Value

Authentication

The authentication method to use for this connection.

'OAuth 2.0'

OAuth Profile

The OAuth Entity Profile to authenticate with.

'<Your Unique Name> default_profile' (as created/validated above)

Inbound user

The user profile used by the external system for authentication. An active connection must be found for the user to gain access.

lookup: <Your Inbound User>

Your Details form should look like this:

Save the Connection.

Get OAuth Token

Once you have saved the Connection, the 'Get OAuth Token' button is available.

Click Get OAuth Token.

On the modal that pops up, enter the Username & Password (for the Inbound user of the Identity Provider Instance).

Click Get OAuth Token.

The 'OAuth token flow completed successfully' info message is displayed. Close the modal.

Test Integration

Congratulations. You have successfully configured both halves of the OAuth Connection.

Now all that remains is to test each of the Scenarios in turn. See the following pages of the Bidirectional Asynchronous Incident Guide for examples:

img
img
img
img
img
img
img
Create Scenario
Update Scenario
Resolve Scenario