Creating an API Scope

Edit online

About this task

Scopes enable you to group a set of REST resources, methods, or both, and SOAP operations for an API.

A scope consists of a name, description, and zero or more resources, methods, or operations. An API can have zero or more scopes.

You can define a set of policies and configure its properties for each individual scope. These policies apply to each of the resources, methods, or operations that are associated to the scope.

Instructions throughout the remainder of this guide use the term scope-level policy when referring to a set of policies configured for an individual scope of the API.

Note: Ensure that you have a unique set of resources, methods, or operations in every scope in the API.

To create a scope

Procedure

  1. Click APIs in the title navigation bar.
    A list of APIs available in API Gateway appears.
  2. Click the name of the required API.
    This opens the API details page.
  3. Click Edit.
    If the API is active, API Gateway prompts you to deactivate it.
  4. Click the Scopes tab.
    This displays a list of scopes available in the API.
  5. In the List of scopes section, click Add scope.
  6. In the Basic information section, provide the required information for each data field that appears:
    Field Description
    Name Name of the scope. A scope name must be unique within an API.
    Note: API Gateway automatically adds the name New Scope to the Name field. You can change the name of the scope to suit your needs. But you cannot leave this field empty.
    Description Description of the scope.
  7. Applicable only for REST APIs. In the Resources and methods section, select the resources, methods, or both, you want to associate to this scope.
    When selecting a resource or method for the scope definition, you can select whether you want some or all of the methods within that resource to be selected as well.
  8. Applicable only for SOAP APIs. In the Operations section, select the operations you want to associate to this scope.
  9. Click Save.
    The scope is created and listed in the List of scopes section.

What to do next

Post-requisites:

  • Activate the API when you are ready to put it into effect.
  • To apply and configure policies for this API scope, see Creating a Scope-level Policy.