| Table of Contents |
|---|
Introduction
In the OAS document, security schemes describe the type of authenticator being used and how This section describes all the tabs available in the API Connector Builder using the OAS document must authenticate itself., which are the OAS, Design, Settings, and Preview tabs.
Properties configuration
OAS3
OAS
The OAS tab allows you to select an Depending on the authentication method defined in the OAS document, an API server and configure security settings if applicable. Configure the following possible 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:
...
| Name | Description |
|---|---|
| Grant Type |
Select the method the application uses to obtain an access token. |
| Scopes |
...
| |
| Client ID |
...
The Client ID provisioned by the OpenID provider when the client was registered. | |
| Client Secret |
...
The Client Secret (password) provisioned by the OpenID provider when the client is registered. | |
Code Challenge Method |
...
Select the code challenge method used to authorize the client. | |
Callback URL | URL |
...
to which Auth0 redirects users after they authenticate.
| |||||
Configuration Method |
...
| |
Authorization Code |
...
| |
Custom |
...
| |
Client Authentication |
...
Select the client authentication type.
| |
Headers |
...
|
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.
Settings
The Settings tab allows you to modify the API ID, name and description if required.
| Name | Description |
|---|---|
| ID |
...
| The API connector ID. | |
| Name |
...
| The name of the API connector. | |
| Description |
...
| The description of the API connector. | |
| Logo |
...
| Assign a logo for the API connector. | |
| Debug Mode |
...
| Show relevant debug in the server log for debugging purposes. |
...
Preview
The Preview tab allows you to view the API endpoint before publishing it.
| Name | Description |
|---|---|
| Select Operation |
...
Select an |
...
API endpoint |
...
. Depending on the operation selected, you will preview:
|
...
|
...
|
...
| Description | The API endpoint description. |