DevOps Edition for Continuous Integration 10.4 | Service Development Help | Working with REST API Descriptors | Working with Security Definitions | Adding a Security Definition
 
Adding a Security Definition
You can add security definition in the REST API descriptor.
* To add a security definition
1. In the Package Navigator view, lock and open the REST API descriptor to which you want to add a security definition.
2. Click the Security Definitions tab.
3. Click on the REST API descriptor editor toolbar or on the REST API descriptor toolbar, right-click in the Security Definitions tab and select Add a Security Definition.
4. In the Add Security Definition dialog box, choose any one of the following security definition type.
*Basic Auth
*OAuth
Choosing Basic Auth
a. Enter a name for the security definition.
b. Click Finish.
Designer adds the security definition to the REST API descriptor.
c. Click File > Save.
Choosing OAuth
a. Enter a name for the security definition.
b. Click Next.
c. In the OAuth Security Definition wizard, select any one of the following OAuth flow type and click Next.
*implicit
*password
*application
*accessCode
d. In the OAuth Security Definition wizard, specify the details for the OAuth security definition type.
In this field...
Specify...
Authorization URL
The authorization URL to be used for this flow type. This must be in the form of a URL.
Token URL
The token URL to be used for this flow type. This must be in the form of a URL.
Scopes
Scopes for the selected OAuth flow type.
Click to add a scope.
Click to insert a scope.
Click to remove a scope.
e. Click Finish.
Designer adds the security definition to the REST API descriptor.
f. Click File > Save.
Note: Integration Server does not support to invoke REST APIs for OAuth security definition type.

Copyright © 2017-2019 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release