Configuring an imported app endpoint

You can configure a custom endpoint for apps that are imported by using OpenAPI specifications. This action replaces the current endpoint of your app to a new endpoint.

Configure custom endpoints for imported apps when you have multiple tenants to run the skills, but you need to manage the apps with their corresponding server URLs for each tenant. If your app endpoint changes and you don't want to delete and reimport all skills again. Or even if the developers disabled the default endpoint in the OpenAPI specifications.

Apps with the default endpoint disabled display a red symbol in the app tile on the catalog page.

To configure the app endpoint, access the prebuilt skill enhancement page. To do it:

  • Through the Apps tab on the Skills and apps page, click the vertical ellipsis button of the app that you want to configure the endpoint.
  • Through the skill catalog, click the app tile with the red exclamation mark and then click Configure app. This only works for apps with the default endpoint disabled.

Then, in the configure app page, follow the procedure to configure app endpoint:

  1. Click Configuration.

  2. Configure the app endpoint. The following table outlines the configuration for various fields related to setting up the app endpoint. Note that some fields might only apply to specific apps:

    Field Description
    Server URL The URL of your app endpoint. It is a mandatory field for all the authentication types.
    Token URL The URL used to validate the user connection. It is a mandatory field for OAuth2 password, OAuth2 client credentials and OAuth2 authorization code.
    Authentication type The method used by the users to connect to the app.
    Authorization URL The URL used to validate the user connection. It is a mandatory field for OAuth2 implicit and OAuth2 authorization Code.
    Client ID The ID you use to authenticate with the app. It is an optional field for all the OAuth2 credential types.
    Client secret The client secret you use to authenticate with the app. It is an optional field for OAuth2 password, OAuth2 client credentials and OAuth2 authorization code.

  3. Optional: Test the connection by clicking Test connection and set your connection credentials.

  4. Click Save.

After the app is updated to use the new endpoint and the status Configured is shown on the Skills and apps page.

Information:

  • When a builder incorporates the client ID and secret within the app, the connection process is simplified for the users. Instead of requiring users to manually enter the client ID and client secret, they can establish a connection by simply clicking the Connect app button.
  • When an admin configures the client ID and secret as team credentials, users can connect to the app without needing to manually enter the client ID and client secret. The values are automatically populated from the admin-configured data, simplifying the connection process for all team members.
  • When a builder includes only the client secret in the app, users only need to provide their client ID during connection, as the secret has already been set. If an admin configures the team credentials, the system prompts for the client ID alone, as the secret is pre-configured by the builder. Once the team credentials is set by the admin, users see the app as already connected.

A custom endpoint overwrites only the app endpoint on the current watsonx Orchestrate tenant. Therefore, if you export a skill from an app with a custom endpoint, the url property keeps the same value as when the skill was imported.

However, to import skills to an app with a custom endpoint, the custom endpoint need to be configured in the url property in the OpenAPI specifications. For more information about the url property, see Configuring the API server.

Every time that you configure a custom endpoint, the previous connection credentials are lost. Therefore, a new credential that corresponds to the new endpoint need to be configured to use the skills of the app.

To check the known issues and limitations of this feature, see Known issues and limitations: Building skills.