Create OAuth API endpoints to enable your controller instance to have two-way communication with your non-production instances. Follow and complete each step carefully on the specified instances before moving on to create your third-party OAuth provider records.
Before you begin
In the top right corner of your instance, make sure you set the application scope to Global.
Open all of your instances (development, test, production, and the like) in separate browser tabs.
Role required: admin
About this task
To create OAuth API endpoints for external clients and use OAuth in your pipelines, you must create several records, each on different instances in your pipeline. Begin on your production instance, which should be your controller instance.
Procedure
On your production instance, navigate to All > System OAuth > Application Registry.
Select New.
Select Create an OAuth API endpoint for external clients.
On the form, fill in the fields.
Field
Action
Name
Enter `Pipeline Controller Client`.
Redirect URLs
1. Unlock the field. 2. Enter the URL for your production, development, and test instances, each with `oauth_redirect.do` after the backslash. 3. Lock the field. Separate each of the three URLs with a comma and a space. For example: `https://.service-now.com/oauth_redirect.do, https://.service-now.com/oauth_redirect.do, https://.service-now.com/oauth_redirect.do`.
Select Submit.
Important: Complete the next steps on your development instance.
On your development instance, navigate to All > System OAuth > Application Registry.
Select New.
Select Create an OAuth API endpoint for external clients.
On the form, fill in the fields.
Field
Action
Name
Enter `Pipeline Development Client`.
Redirect URLs
1. Unlock the field. 2. Enter the URL for your production and development instances, each with `oauth_redirect.do` after the backslash. 3. Lock the field. Separate the two URLs with a comma and a space. For example: `https://.service-now.com/oauth_redirect.do, https://.service-now.com/oauth_redirect.do`.
Select Submit.
Important: Complete the next steps on your test instance.
On your test instance, navigate to All > System OAuth > Application Registry.
Select New.
Select Create an OAuth API endpoint for external clients.
On the form, fill in the fields.
Field
Action
Name
Enter `Pipeline Test Client`.
Redirect URLs
1. Unlock the field. 2. Enter the URL for your production and test instances, each with `oauth_redirect.do` after the backslash. 3. Lock the field. Separate the two URLs with a comma and a space. For example: `https://.service-now.com/oauth_redirect.do, https://.service-now.com/oauth_redirect.do`.
Select Submit.
Repeat this process from steps 11–15 for any other non-production instances (staging, and the like) you have.