Platform UI Readme

acrValues

string

True

acr stands for “Authentication Context Class Reference”. It’s a parameter used in the authentication process to define or request a certain level or type of authentication. Essentially, it gives the client a way to specify the desired level of assurance about the authentication process when a user logs in.

authProvider

‘auth0’ or ‘keycloak’

True

For choosing between Auth0 or Keycloak for authentication provider.

clientId

string

True if authProvider=‘keycloak’

Your client application’s identifier as registered with the OIDC provider.

mgmtUiUrl

string

True if authProvider=‘keycloak’

The URL of the UI. Used for redirect_uri and post_logout_redirect_uri for the OIDC provider.

oidcEndpoint

string

True if authProvider=‘keycloak’

The URL of the OIDC provider (currently Keycloak). For example: https://platform.local. We will append to this URL: /auth/realms/${localStorageRealmFinal}.

oidcScopes

string, default value ‘openid profile’

True if authProvider=‘keycloak’

Common value: ‘openid profile metrics-exposer’ If we want to enable metrics-exposer.

responseTypes

string, default ‘code’

True if authProvider=‘keycloak’

In OpenID Connect (OIDC), the response_type parameter dictates how the authentication and authorization will be handled, and what kind of tokens or authorization codes the client can expect to receive in response from the OpenID Provider. By default the value is ‘code’ - this is used for the Authorization Code flow. The client will receive an authorization code from the authorization endpoint. This code can then be exchanged for an ID token and/or an access token at the token endpoint.

auth0Audience

string

True if authProvider=‘auth0’

The audience (presented as the aud claim in the access token) defines the intended consumer of the token. This is typically the resource server (API, in the dashboard) that a client (Application) would like to access. You will see the audience is in the token as aud.

auth0ClientId

string

True if authProvider=‘auth0’

The unique identifier for your application using Auth0. You will use this when configuring authentication with Auth0.

auth0Domain

string

True if authProvider=‘auth0’

Auth0 domain name for your application using Auth0.

auth0MachineToMachineAudience

string

True if authProvider=‘auth0’

Client credentials grant flow auth0 Machine to Machine Audience.

organizationManagerUrl

string

True if authProvider=‘auth0’

The URL for Axual Organization Manager Component. In Axual Architecture, Organization Manager (OM) is a user-facing component behind API Gateway that will be responsible for handling public user signups, sending user invitations, registering organizations for signing up users and configuring SSO for organizations to enable a dedicated URL for SSO users to login directly without signing up.

dataClassificationEnabled

boolean, default False

False

Enables data classification.

docsVersion

string, ie ‘2023.2’

True

Latest Axual docs version from here: https://docs.axual.io/axual/2023.2/index.html.

docsUrl

string, default ‘https://docs.axual.io’;

False

The location for Axual docs.

domain

string, ie ‘axual.io’

True

The domain name. Required for domain inside the XSRF-TOKEN in the cookie.

connectEnabled

boolean, default False

False

True if we want to have Connect functionalities on the UI visible.

connectorLoggingEnabled

boolean, default False

False

True if we want to enable Connect logging functionalities on the UI.

insightsEnabled

boolean, default False

False

Enables insights.

enabledKafkaProviders

Array of strings, Default []

False

Non-axual operator does not need this since its only used in the onboarding wizard. For example: [‘aiven’, ‘confluent_cloud’, ‘apache_kafka:coming’], ending a provider with ‘:coming’ will make the provider visible but not selectable in the wizard.

ksmlEnabled

boolean, default False

False

True if we want to have KSML functionalities on the UI visible.

metricsExposerUrl

string

Required if insightsEnabled=true

The URL where Metrics Exposer is located. Make sure oidcScopes includes metricsExposer.

mgmtApiUrl

string

True

The URL of the API.

organizationShortNameEditEnabled

boolean, default False

False

Enables editing Organization short name in Axual Governance wizard

subscriptionEnabled

boolean, default False

False

Enables subscription.

streamBrowseEnabled

boolean, default False

False

Enables Stream browse. This is deprecated, to be removed in the future, replaced by topicBrowseEnabled.

streamBrowseUrl

string

False

The URL where Stream Browse is located. This is deprecated, to be removed in the future, replaced by topicBrowseUrl.

topicBrowseEnabled

boolean, default False

False

Enables Topic browse.

topicBrowseUrl

string

False

The URL where Topic Browse is located

uiFeedBackUrl

string

False

URL where to offer feedback, for example ‘https://axualio.atlassian.net/servicedesk/customer/portal/1/group/1/create/1’;.

userFlowToken

string

False

The token required to record user’s product tour using UserFlow.