Installing the OpenAPI connector

To use the OpenAPI connector, you first need to install it on your tenant. To configure the connector, you can use the URL-based schema or the Code Value schema. For more information on Code value schemas, refer to Code value schemas.

Perform the following to install the OpenAPI connector:

1. In the main left-hand menu, select Connectors.
2. Click New Connector.
3. Select OpenAPI from the Connector Type menu.
4. In Name field, enter a name.
5. Click Retrieve Connector Configuration Data.
6. Configure the required values. For information about the configuration values, refer to OpenAPI connector configuration values.
7. Click Configure OpenAPI to add the extensions into the schema.
8. Click Install.
9. Click Save Connector.

These steps install the OpenAPI connector and allow you to connect and communicate with the API by using your OpenAPI schema.

OpenAPI connector configuration values

The following configuration values can be defined during the installation of the OpenAPI connector.

Name	Type	Description
Schema URL	String	Complete path to a valid OpenAPI document written in YAML. Must be a valid HTTP or HTTPS URL. Note: The schema must always be available at the configured URL. Otherwise, you may encounter errors at design time and run time when using or configuring this connector.
Schema Value	Code	Similar to the schema URL configuration value, the code value should include a valid OpenAPI document written in YAML (up to 2MB in size).
API Key	String	API key for API key-based authentication.
OAuth2/OIDC: Client Id	String	Client ID for OAuth 2.0 or OIDC-based authentication.
OAuth2/OIDC: Client Secret	String	Client secret for OAuth 2.0 or OIDC-based authentication.
Authorization Groups	String	Collections of user accounts or roles that are assigned specific permissions or access rights.
Authorization Users	String	User accounts or roles that are assigned specific permissions or access rights.

Code value schemas

If you use a Code value schema, save the YAML schema in a Code value within Flow and supply it as a schema value. You can add YAML schemas up to 2 MB in size. This method simplifies the OpenAPI connector configuration by removing the need for a hosted schema file. During configuration, provide this value the same way as you would for a URL-based value. If you provide both a code value and a URL, the code value takes precedence. When using code values, you must take care of the special considerations given on this page.

Click Preview Actions & Types during installation to check that your OpenAPI schema configures correctly and creates the required types and actions.