...
The OAS tab allows you to select an OAS document, an API server and configure security settings if applicable. Configure the following required properties:
| Name | Description |
|---|---|
| OAS document |
...
| Upload and select the OAS document. To upload an OpenAPI 3.0 document, ensure the file is in either JSON or YAML format | |
| Download OAS Document |
...
| The Download button redownloads the uploaded OAS document. | |
| Select API Server |
...
| Select the API server from the drop-down list. | |
| Select Authentication Method |
...
| Select an authentication method specified by the OAS document. |
Depending on the Authentication Method selected, configure the following properties:
- Grant Type: Select the method the application uses to obtain an access token.
- Scopes:
- View allowance templates.
- Create and update allowance templates.
- Delete allowance templates.
- Client ID: The Client ID provisioned by the OpenID provider when the client was registered.
...
- Configuration Method:
- OpenID Connect Discovery
- Custom
- Authorization Code:
- OpenID Connect Directory
- Get Authorization Code
- Custom:
- Issuer
- JSON Web Key Set
- Authorization Token Endpoint
- Token Endpoint
- Scopes
- Client Authentication: Select the client authentication type.
- Send as Basic Auth Header
- Send credentials in body
- Headers:
- NAME
- VALUE
| Name | Description |
|---|---|
| Grant Type |
|
| Scopes |
|
| Client ID |
|
Design
In the Design tab, all available API endpoints are listed in the API Connector Builder palette. After dragging and dropping an endpoint to the canvas, that canvas can be configured depending on the method that endpoint uses. Refer to API Endpoints for more information.
...