1. Home
  2. Documentation
  3. AI Gateway
  4. General

General

Configure the gateway's Authorization Server and global integration.

The General module centralizes the global parameters that AI Gateway uses to validate access tokens and integrate with Sensedia Platform. Unlike the other features, General is not a listing page. It is a single page with an update form.

IMPORTANT

The values registered here affect all gateway routes. Changing the Authorization Server changes who issues the tokens the gateway accepts: tokens issued by the previous provider start being rejected as soon as the new configuration is saved.

Learn how to:

Editing

Step 1

In the side menu, access General. The form opens directly on the page. There is no listing or modal.

Step 2

Decide which Authorization Server the gateway should use to validate tokens: the platform default or your own OpenID provider.

Step 3

Fill in or update the remaining fields (see Form fields).

Step 4

Click Save to persist the changes. To discard unsaved changes, click Cancel. The form returns to the last loaded values.

Platform Authorization Server

With the Use a custom authorization server option unchecked, the gateway validates access tokens against the platform's own Authorization Server. This is the default mode and requires no additional configuration: the credentials issued in AI Agents and the scopes registered in Scopes work without you providing any URL.

Your own Authorization Server

Check Use a custom authorization server to validate tokens against your own OpenID Provider. When you check the option, the Well-Known URL field appears and becomes required.

Provide the URL of your provider's OpenID discovery document (usually ending in /.well-known/openid-configuration). On save, the gateway:

  1. Accesses the well-known document you provided.
  2. Extracts the issuer (issuer) and the address of the public key set (jwks_uri) from it.
  3. Accesses that key set and verifies that it contains at least one signing key.

Only after these three checks is the configuration accepted. From then on, the gateway accepts only tokens issued by the discovered issuer and signed by one of those keys.

THE URL MUST BE PUBLIC

The Well-Known URL is accessed by the gateway itself at the moment you save, so it must be a publicly reachable address. Internal, private, or loopback URLs are rejected.

VALIDATION ERRORS

If any of the three steps fails β€” unreachable document, missing jwks_uri, or an empty key set or one without a signing key β€” the form displays the corresponding message and the configuration is not saved. Check the URL and your provider's public availability before trying again.

To go back to the platform Authorization Server, uncheck the option β€” the Well-Known URL field is cleared β€” and click Save.

Sensedia Platform credentials

The Sensedia Platform Client ID / Sensedia Platform Client Secret pair is the client_credentials credential AI Gateway uses to query the Sensedia Platform APIs β€” in particular the multigateway catalog, the source of the APIs, revisions, and OpenAPI contract used by MCP Servers with the From an API origin.

The credential must be an M2M (Machine-to-Machine) credential, created on the Client Apps screen in Access Control. U2M credentials β€” the user ones β€” are not accepted by AI Gateway.

REQUIRED FOR THE FROM AN API ORIGIN

Although the form lets you save the global configuration without them, the credentials are required for every MCP Server with the From an API origin: without the registered pair, the operation returns an error. The M2M credential registered here must also hold the List MCP Servers (ai-gateway.mcp-servers.list) permission in Access Control β€” that permission is what authorizes reading the catalog's APIs, revisions, and contracts. Without it, those reads return 403. MCP Servers with the From an existing MCP Server origin do not depend on these credentials.

Editing the credentials

The General form never shows the already registered Sensedia Platform Client Secret β€” the field always opens blank, with the text Leave blank to keep the current secret. Client ID and Client Secret form an indivisible pair: they are provided together, or both left blank.

  • Keep the current credentials: leave Sensedia Platform Client ID and Sensedia Platform Client Secret as they are (the Client ID comes prefilled) and adjust only the other fields. The registered pair is preserved.
  • Replace the credentials: provide both fields β€” Client ID and Client Secret β€” together.
  • Remove the credentials: clear both fields and click Save. Providing only one of the two (for example, a new Client ID with a blank Client Secret) results in a validation error. Removing the pair prevents new MCP Servers with the From an API origin from being created and makes the existing ones fail as soon as they need to fetch the revision's contract again.

Form fields

The table below covers all fields visible in the form.

Field
Type
Required
Rules
Use a custom authorization serverCheckboxNoUnchecked, the gateway uses the platform Authorization Server. Checked, it displays the Well-Known URL field so you can connect your own OpenID Provider.
Well-Known URLText (URL)Yes β€” when Use a custom authorization server is checkedURL of the provider's OpenID discovery document (e.g., https://your-idp/.well-known/openid-configuration). It must be a valid, publicly accessible URL, and the provider must expose at least one signing key.
Sensedia Platform Client IDText (sensitive, password)Yes β€” for MCP Servers with the From an API originClient ID used to authenticate with Sensedia Platform APIs, including the multigateway catalog that feeds the From an API origin. Displayed as a password field. It must be an M2M credential, created under Client Apps in Access Control, holding the List MCP Servers (ai-gateway.mcp-servers.list) permission. Always provided together with the Sensedia Platform Client Secret β€” see Sensedia Platform credentials.
Sensedia Platform Client SecretText (sensitive, password)Yes β€” for MCP Servers with the From an API origin; optional on editClient Secret corresponding to the Sensedia Platform Client ID. Displayed as a password field. On edit, leaving it blank keeps the currently registered value; providing it without the matching Client ID results in a validation error.

How happy are you with this page?

We use cookies to enhance your experience on our site. By continuing to browse, you agree to our use of cookies.Learn more