Create third-party OAuth provider records to enable each of your instances to access the API endpoints you've created.

Before you begin

Complete the tasks in Create OAuth API endpoints for external clients.

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. Begin the steps below on the production instance.

Role required: admin

Procedure

  1. On your production instance, navigate to All > System OAuth > Application Registry.
    You must create three records here, one for each of the three instances (development, test, and production). If you have any additional non-production instances (staging, and the like), create a record for each of those following the method shown here.

  2. Select New.
  3. Select Connect to a third party OAuth Provider to create a record for your development instance.
  4. On the form, fill in the fields.
    Table 1. Application Registries form
    FieldAction
    Name Enter Dev Instance Connection.
    Client ID
    1. On your development instance, open the Application Registry list (All > System OAuth > Application Registry).
    2. Open the Pipeline Development Client record.
    3. Copy the Client ID.
    4. On your production instance, paste the Client ID from your development instance into the Client ID field.
    Client Secret
    1. On your development instance, open the Application Registry list (All > System OAuth > Application Registry).
    2. Open the Pipeline Development Client record.
    3. Unlock the Client Secret field and copy the text.
    4. On your production instance, paste the Client Secret from your development instance in the Client Secret field.
    Default Grant type Change to Authorization code.
    Authorization URL
    1. Unlock the field.
    2. Enter the URL for your development instance followed by oauth_auth.do.
    3. Lock the field.
    For example: https://<development instance name>.service-now.com/oauth_auth.do.
    Token URL
    1. Unlock the field.
    2. Enter the URL for your development instance followed by oauth_token.do.
    3. Lock the field.
    For example: https://<development instance name>.service-now.com/oauth_token.do.
  5. Select Submit.
  6. Select New.
  7. Select Connect to a third party OAuth Provider to create a record for your test instance.
  8. On the form, fill in the fields.
    Table 2. Application Registries form
    FieldAction
    Name Enter Test Instance Connection.
    Client ID
    1. On your test instance, open the Application Registry list (All > System OAuth > Application Registry).
    2. Open the Pipeline Test Client record.
    3. Copy the Client ID.
    4. On your production instance, paste the Client ID from your test instance into the Client ID field.
    Client Secret
    1. On your test instance, open the Application Registry list (All > System OAuth > Application Registry).
    2. Open the Pipeline Test Client record.
    3. Unlock the Client Secret field and copy the text.
    4. On your production instance, paste the Client Secret from your test instance in the Client Secret field.
    Default Grant type Change to Authorization code.
    Authorization URL
    1. Unlock the field.
    2. Enter the URL for your test instance followed by oauth_auth.do.
    3. Lock the field.
    For example: https://<test instance name>.service-now.com/oauth_auth.do.
    Token URL
    1. Unlock the field.
    2. Enter the URL for your test instance followed by oauth_token.do.
    3. Lock the field.
    For example: https://<test instance name>.service-now.com/oauth_token.do.
  9. Select Submit.
  10. On the Application Registry list, select the Pipeline Controller Client record.
  11. Copy the Client ID and paste it somewhere like a notes application.
  12. Unlock the Client Secret field, copy the text, and paste it in a note with the Client ID.
  13. Go back to the Application Registry list and select New.
  14. Select Connect to a third party OAuth Provider to create a record for your production instance.
  15. On the form, fill in the fields.
    Table 3. Application Registries form
    FieldAction
    Name Enter Prod Instance Connection.
    Client ID
    1. Copy the Client ID that you noted down.
    2. Paste the Client ID into the Client ID field.
    Client Secret
    1. Copy the Client Secret that you noted down.
    2. Unlock the Client Secret field, and paste the text in the field.
    Default Grant type Change to Authorization code.
    Authorization URL
    1. Unlock the field.
    2. Enter the URL for your production instance followed by oauth_auth.do.
    3. Lock the field.
    For example: https://<production instance name>.service-now.com/oauth_auth.do.
    Token URL
    1. Unlock the field.
    2. Enter the URL for your production instance followed by oauth_token.do.
    3. Lock the field.
    For example: https://<production instance name>.service-now.com/oauth_token.do.
  16. Select Submit.
    Important: Complete the next steps on your development instance.
  17. On your development instance, navigate to All > System OAuth > Application Registry.

  18. Select New.
  19. Select Connect to a third party OAuth Provider to create a record for your production instance.
  20. On the form, fill in the fields.
    Table 4. Application Registries form
    FieldAction
    Name Enter Prod Instance Connection.
    Client ID
    1. Copy the Client ID that you noted down.
    2. Paste the Client ID into the Client ID field.
    Client Secret
    1. Copy the Client Secret that you noted down.
    2. Unlock the Client Secret field, and paste the text in the field.
    Default Grant type Change to Authorization code.
    Authorization URL
    1. Unlock the field.
    2. Enter the URL for your production instance followed by oauth_auth.do.
    3. Lock the field.
    For example: https://<production instance name>.service-now.com/oauth_auth.do.
    Token URL
    1. Unlock the field.
    2. Enter the URL for your production instance followed by oauth_token.do.
    3. Lock the field.
    For example: https://<production instance name>.service-now.com/oauth_token.do.
  21. Select Submit.
    Important: Complete the next steps on your test instance.
  22. On your test instance, navigate to All > System OAuth > Application Registry.
  23. Select New.
  24. Select Connect to a third party OAuth Provider to create a record for your production instance.
  25. On the form, fill in the fields.
    Table 5. Application Registries form
    FieldAction
    Name Enter Prod Instance Connection.
    Client ID
    1. Copy the Client ID that you noted down.
    2. Paste the Client ID into the Client ID field.
    Client Secret
    1. Copy the Client Secret that you noted down.
    2. Unlock the Client Secret field, and paste the text in the field.
    Default Grant type Change to Authorization code.
    Authorization URL
    1. Unlock the field.
    2. Enter the URL for your production instance followed by oauth_auth.do
    3. Lock the field.
    For example: https://<production instance name>.service-now.com/oauth_auth.do.
    Token URL
    1. Unlock the field.
    2. Enter the URL for your production instance followed by oauth_token.do
    3. Lock the field.
    For example: https://<production instance name>.service-now.com/oauth_token.do.
  26. Select Submit.
  27. (Optional) Repeat steps 22–26 for any other non-production instances that you have (staging, and the like).

What to do next

Now that you’ve completed the pre-work for using OAuth, complete all the steps in Use OAuth to create pipeline credentials on the specified instances.