Interface KeycloakRegisterOptions

Construct a type with the properties of T except for those in type K.

interface KeycloakRegisterOptions {
    acr?: Acr;
    acrValues?: string;
    cordovaOptions?: { [optionName: string]: string };
    idpHint?: string;
    locale?: string;
    loginHint?: string;
    maxAge?: number;
    prompt?: "none" | "login" | "consent";
    redirectUri?: string;
    scope?: string;
}

Hierarchy (View Summary)

Properties

acr? acrValues? cordovaOptions? idpHint? locale? loginHint? maxAge? prompt? redirectUri? scope?

Properties

Optionalacr

acr?: Acr

Sets the acr claim of the ID token sent inside the claims parameter. See section 5.5.1 of the OIDC 1.0 specification.

OptionalacrValues

acrValues?: string

Configures the 'acr_values' query param in compliance with section 3.1.2.1 of the OIDC 1.0 specification. Used to tell Keycloak what level of authentication the user needs.

OptionalcordovaOptions

cordovaOptions?: { [optionName: string]: string }

Specifies arguments that are passed to the Cordova in-app-browser (if applicable). Options 'hidden' and 'location' are not affected by these arguments. All available options are defined at https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-inappbrowser/. Example of use: { zoom: "no", hardwareback: "yes" }

OptionalidpHint

idpHint?: string

Used to tell Keycloak which IDP the user wants to authenticate with.

Optionallocale

locale?: string

Sets the 'ui_locales' query param in compliance with section 3.1.2.1 * of the OIDC 1.0 specification.

OptionalloginHint

loginHint?: string

Used to pre-fill the username/email field on the login form.

OptionalmaxAge

maxAge?: number

Used just if user is already authenticated. Specifies maximum time since the authentication of user happened. If user is already authenticated for longer time than 'maxAge', the SSO is ignored and he will need to authenticate again.

Optionalprompt

prompt?: "none" | "login" | "consent"

By default the login screen is displayed if the user is not logged into Keycloak. To only authenticate to the application if the user is already logged in and not display the login page if the user is not logged in, set this option to 'none'. To always require re-authentication and ignore SSO, set this option to 'login'. To always prompt the user for consent, set this option to 'consent'. This ensures that consent is requested, even if it has been given previously.

OptionalredirectUri

redirectUri?: string

Specifies the uri to redirect to after login.

Optionalscope

scope?: string

Specifies the scope parameter for the login url The scope 'openid' will be added to the scope if it is missing or undefined.

Settings

Member Visibility

On This Page

Properties