Software AG Products 10.11 | Administering Integration Server | Configuring OAuth | Configuring Integration Server for OAuth | Defining Scopes | Adding a Scope
 
Adding a Scope
Complete the following steps to add a scope. The scope defines the services and folders that the clients are authorized to access.
*To add a scope
1. Open the Integration Server Administrator if it is not already open.
2. Go to Security > OAuth.
3. Click Scope Management.
4. Click Add Scope.
5. Under Scope Configuration, specify the following information:
Field
Description
Name
Specifies a unique name for the scope. The scope name must consist of ASCII character codes in the range of 33 - 126, and cannot contain any of the following characters:
\ , "
Description
A description of the scope.
Note:
If Integration Server generates the scopes automatically while creating the REST API descriptor based on the Swagger document, then Integration Server adds a default scope description as XX. You can modify this description; however, when Integration Server re-generates the RAD using the same Swagger document, Integration Server overrides the description as XX.
Folders and services
Specifies the list of folders and individual services that the client can access on behalf of the resource owner.
You can add more than one folder or service at a time by specifying multiple lines, one folder or service to a line. Press Enter to separate lines.
URL templates
Specifies a URL template for a REST V2 resource that you want to secure using the scope.
Note:
If Integration Server generates the URLs automatically while creating the REST API descriptor based on the Swagger document, then Integration Server adds a default URL template as <HTTP method>_<REST API descriptor namespace>/<URL template of resource>. For example,
GET_RadNamesSpace/employee.
You can modify this template; however, when Integration Server re-generates the RAD using the same Swagger document, then it overrides the template as the default URL template.
6. Click Save Changes.