AI Auth Adapter: Functions and Operations

This adapter provides access tokens generated by Keycloak to the AI backend. Users configure an X4 server (host/port/protocol) and provide a valid Keycloak ID and a Keycloak client secret for integration.

Properties

Operation

Defines the operation executed by the adapter.

Possible values:

GetAccessToken: Retrieves access tokens.

Parameters

`Repository`	The virtual repository of the adapter project Possible values: `b6b3e80f-d1d6-4efd-a050-fe3463efc5de`
`protocol`	Used Keycloak protocol (HTTP or HTTPS) Possible values: `http`: Use HTTP (no encryption) (default) `https`: Use HTTPS (SSL-encrypted)
`host`	Name of the Keycloak host Possible values: Any valid character string without protocol specification (e.g. `localhost`)
`port`	Number of the Keycloak port Possible values: Any integer (e.g. `9999`)
`path`	Name of the Keycloak path preceded by a backslash Possible values: Any valid string (e.g. `/auth`)
`realm`	Keycloak realm Possible values: Any valid Keycloak realm (e.g. `X4Realm`)
`ClientID`	Keycloak client ID Possible values: Any valid Keycloak client ID (e,g. `X4`)
`ClientSecret`	Keycloak client secret Possible values: Any valid client secret from Keycloak that can be retrieved in the realm under Client > [Client ID] > Credentials

Status values

`1 (successful)`	The operation was executed successfully.
`0`	The operation was executed successfully, but without result.
`-1 (failed)`	The operation failed due to a technical error.

Input

The adapter does not expect any input.

Output

The adapter generates an XML document as output:

<accessToken>token_here</accessToken>

The following element is included in the output:

Element	Description
`accessToken`	Contains the access token generated by the adapter.