Platform UI

acrValues

string

Yes

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

Yes

For choosing between Auth0 or Keycloak for authentication provider.

clientId

string

Yes (if authProvider=keycloak)

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

mgmtUiUrl

string

Yes (if authProvider=keycloak)

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

oidcEndpoint

string

Yes (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 email

Yes (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}.

responseTypes

string, default code

Yes (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, default code

Yes (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, default code

Yes (if authProvider=auth0)

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

auth0Domain

string, default code

Yes (if authProvider=auth0)

Auth0 domain name for your application using Auth0.

auth0MachineToMachineAudience

string, default code

Yes (if authProvider=auth0)

Client credentials grant flow auth0 Machine to Machine Audience.

organizationManagerUrl

string, default code

Yes (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

No

Enables data classification.

docsVersion

string, ie 2024.1

Yes

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

docsUrl

string, default https://docs.axual.io

No

The location for Axual docs.

domain

string, ie axual.io

Yes

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

connectEnabled

boolean, default false

No

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

connectorLoggingEnabled

boolean, default false

No

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

insightsEnabled

boolean, default false

No

Enables insights.

enabledKafkaProviders

Array of strings, default []

No

Non-Axual operator does not need this since it’s 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

No

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

notificationsEnabled

boolean, default false

No

True if we want to have Notification functionalities enabled on the UI.

metricsExposerUrl

string

Yes (if insightsEnabled=true)

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

mgmtApiUrl

string

Yes

The URL of the API.

subscriptionEnabled

boolean, default false

No

Enables subscription.

streamBrowseEnabled

boolean, default false

No

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

streamBrowseUrl

string

No

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

topicBrowseEnabled

boolean, default false

No

Enables Topic browse.

topicBrowseUrl

string

No

The URL where Topic Browse is located

singleEnvironmentEnabled

boolean, default false

Yes

Enables a mode where environment switcher and environment menu are hidden - used for Bring Your Own Kafka project in Axual deployment.

uiFeedBackUrl

string

No

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

userFlowToken

string

No

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

viewerGroupsEnabled

boolean, default false

No

When enabled allows configuring viewer groups that defines which Groups are authorized to View all Resource Configurations, regardless of ownership and visibility.