Interface KeycloakAuthPlugin

The interface implemented by the Keycloak authentication plugin.

interface KeycloakAuthPlugin {
    "[DECLARE_SERVICE_INTERFACE]"?: "authentication-keycloak.KeycloakAuthPlugin";
    getAuthState(): AuthState;
    getLoginBehavior(): LoginBehavior;
    logout(options?: Partial<KeycloakLogoutOptions>): void;
}

Hierarchy (View Summary)

AuthPlugin
- KeycloakAuthPlugin

Index

Properties

[DECLARE_SERVICE_INTERFACE]?

Methods

getAuthState getLoginBehavior logout

Properties

`Optional` `Readonly`[DECLARE_SERVICE_INTERFACE]

"[DECLARE_SERVICE_INTERFACE]"?: "authentication-keycloak.KeycloakAuthPlugin"

Methods

getAuthState

getAuthState(): AuthState
Returns the current authentication state.

Objects returned by this method should not be mutated. Emit the changed event instead to communicate that there is a new state.

Returns AuthState
Inherited from AuthPlugin.getAuthState
- Defined in authentication/api.ts:156

getLoginBehavior

getLoginBehavior(): LoginBehavior
Returns the login behavior that should be performed if the user is not authenticated.

Returns LoginBehavior
Inherited from AuthPlugin.getLoginBehavior
- Defined in authentication/api.ts:161

logout

logout(options?: Partial<KeycloakLogoutOptions>): void
Explicitly triggers a logout.

options used here can override the package properties used by the plugin.
Parameters
- Optionaloptions: Partial<KeycloakLogoutOptions>
Returns void
Overrides AuthPlugin.logout
- Defined in authentication-keycloak/api.ts:103