Trails Packages
    Preparing search index...

    Interface KeycloakOptions

    interface KeycloakOptions {
        keycloakConfig: KeycloakConfig;
        keycloakInitOptions?: Partial<KeycloakInitOptions>;
        keycloakLoginOptions?: Partial<KeycloakLoginOptions>;
        keycloakLogoutOptions?: Partial<KeycloakLogoutOptions>;
        refreshOptions?: RefreshOptions;
    }
    Index

    Properties

    keycloakConfig keycloakInitOptions? keycloakLoginOptions? keycloakLogoutOptions? refreshOptions?

    Properties

    keycloakConfig: KeycloakConfig

    The configuration details for connecting to Keycloak.

    • 'url': The URL of your Keycloak server.
    • 'realm': The realm within Keycloak.
    • 'clientId': The ID of the client application registered in Keycloak.
    keycloakInitOptions?: Partial<KeycloakInitOptions>

    Define how Keycloak initializes.

    These properties can be used:

    • 'onLoad': Specifies when Keycloak should initialize. Default: check-sso.
    • 'pkceMethod': The method used for PKCE for enhanced security. Default: S256.
    • 'scope': The scope of the authentication.
    keycloakLoginOptions?: Partial<KeycloakLoginOptions>

    Define behavior when the user logs in.

    keycloakLogoutOptions?: Partial<KeycloakLogoutOptions>

    Define behavior when the user logs out.

    refreshOptions?: RefreshOptions

    Control the automatic refreshing of authentication tokens.

    • 'autoRefresh': Whether token refreshing should happen automatically.
    • 'interval': The interval (in milliseconds) at which token refreshing should occur.
    • 'timeLeft': The remaining time (in milliseconds) before token expiration.

    Settings

    Member Visibility

    On This Page

    Properties