Scopes help you to group a set of REST resources, methods, or both, and SOAP operations
for an API.
About this task
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.
In the following sections, the term scope-level policy is used when you refer 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.
Procedure
- Open the menu options and select APIs. A list of available APIs
appears.
- Click the name of the required API.
The API details
page appears.
- Click Edit.
If the API is active, webMethods API Gateway prompts
you to deactivate it.
- Click Scopes.
This displays a list of scopes available
in the API.
- In the List of scopes section, click Add scope.
- In the Basic information section, provide the following
information.
| Field |
Description |
| Name |
Name of the scope. A scope name must be unique within an API. webMethods 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. |
- This step is 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 you select a
resource or method for the scope definition, you can select whether you want some or all the methods
within that resource to be selected as well.
Note: You cannot create empty API scopes. You must
associate methods or resources with the API scope.
- This step is applicable only for SOAP APIs. In the Operations section, select the
operations that you want to associate to this scope.
- Click Save.
The scope is created and listed in the
List of scopes section.