Link the OAuth entity with an auth scope to manage the token to access the REST APIs that are linked with the auth scope.

Before you begin

Install the following plugins:

  • OAuth 2.0
  • REST API Provider
  • Authentication scope
  • REST API Auth Scope
Note: The REST API Auth Scope plugin is added as part of the Tokyo release.

Role required: admin

Procedure

  1. Navigate to All > API Auth Scopes > REST API Auth Scope.
    The REST API Auth Scopes page is displayed.
  2. To configure a new REST API Auth Scope, click New.
  3. On the form, fill in the fields.
  4. Click Submit.
    Based on the selected REST API and Auth Scope, the APIs retrieves information that is particular to the scope.

Example: Consider creating three REST API Auth Scope for Table API

The first auth scope is mapped to the Table API with all the http methods, versions, and resources enabled.

REST API Auth Scope3

The second auth scope is mapped to the Table API with all the versions and resources enabled. But, you choose the HTTP Method, in this example, the GET method.

REST API Auth Scope2

The third auth scope is mapped to the Table API without the http methods, versions, and resources enabled. But, you choose the HTTP Method, Version, and Resource manually. In this example, HTTP Method is GET, REST API Version is latest, and Resource is /now/table/{tableName}.

REST API Auth Scope1

If all these auth scopes are created, you can use GET method with all the three scopes, but for POST, PUT, DELETE, or PATCH methods only scope3 can be used.