Overview

This guide will walk you through the required OAuth scopes for your use case. You have two options:

1. Fully inherit the permissions of the authenticated user

2. Configure a custom read-only or read+create scope

Inheriting the permissions of the authenticating user

If you want your integration to inherit the permissions of the authenticating user, use the default useraccount scope. This scope simply allows an application to act on behalf of that user to retrieve/access data that the user already has access to.

Configuring a custom scope

By configuring a custom REST API Auth Scope, you'll be able to set up read-only or read+create scope. Permissions will still inherit from the authenticated user (they won't be able to interact with tables they are not able to interact with in the UI), but this will allow you to limit the operations available.

Steps to configure a custom REST API Auth Scope

1. Navigate to System Web Services > API Auth Scopes > REST API Auth Scope

   

2. Begin creating a new REST API Auth Scope by selecting New in the top right of the page.

3. Uncheck the Apply auth scope to all http methods in this API and Apply auth scope to all resources in this API checkboxes

4. Fill in the below fields

   1. Name: any name to remember the scope

   2. REST API: Table API

   3. HTTP Method:

      1. for read-only: GET

      2. for create-only: POST

      3. for update-only: PATCH (also create another Scope for PUT)

      4. for delete-only: DELETE

   4. Resource: /now/table/{tableName}

      

5. Select the search icon next to Auth Scope

6. A pop-up will upon. Select New in the pop-up.

   

7. Give your scope a name that you'll remember (i.e. table_read_access) and click Submit

8. After all the information is entered, click Submit.

Repeat the above steps for any other operation (i.e. create). You can then use these scopes when creating your OAuth application! See the below example.