ngx-keycloak

Appearance

SpecificKeycloakConfig ​

ts
type SpecificKeycloakConfig = object;

Defined in: types/config.type.ts:13

Keycloak-related configuration

Properties ​

expirationOffset? ​

ts
optional expirationOffset: number;

Defined in: types/config.type.ts:90

This property allows to add offset (in milliseconds) to the expiration of the Access Token.\

Since ​

1.0.0

Author ​

Simon Kovtyk

guardFallbackCallback? ​

ts
optional guardFallbackCallback: GuardFallbackFn;

Defined in: types/config.type.ts:48

Guard-URL the user gets redirected to, when securing router with keycloakGuard and missing authentication.

Since ​

1.0.0

Author ​

Simon Kovtyk

guardFallbackUrl? ​

ts
optional guardFallbackUrl: string;

Defined in: types/config.type.ts:34

Fallback-URL the user gets redirected to, when securing router with keycloakGuard and missing authentication.

Since ​

1.0.0

Author ​

Simon Kovtyk

realm ​

ts
realm: string;

Defined in: types/config.type.ts:27

The realm from Keycloak specification.

Since ​

1.0.0

Author ​

Simon Kovtyk

resource ​

ts
resource: string;

Defined in: types/config.type.ts:20

The resource our client is accessing. This option will be appended into the requests' body as form data with the key "client_id"

Since ​

1.0.0

Author ​

Simon Kovtyk

reverseGuardFallbackCallback? ​

ts
optional reverseGuardFallbackCallback: GuardFallbackFn;

Defined in: types/config.type.ts:55

Guard-URL the user gets redirected to, when securing router with keycloakGuard and existing authentication.

Since ​

1.0.0

Author ​

Simon Kovtyk

reverseGuardFallbackUrl? ​

ts
optional reverseGuardFallbackUrl: string;

Defined in: types/config.type.ts:41

Fallback-URL the user gets redirected to, when securing router with keycloakGuard and existing authentication.

Since ​

1.0.0

Author ​

Simon Kovtyk

storageKey ​

ts
storageKey: string;

Defined in: types/config.type.ts:69

This property enables the customization of the key, where the storage (if enabled) should store the values.

Since ​

1.0.0

Author ​

Simon Kovtyk

storageType ​

ts
storageType: Storage;

Defined in: types/config.type.ts:62

This property allows to specify, which storage should be used to store value.

Since ​

1.0.0

Author ​

Simon Kovtyk

timeout? ​

ts
optional timeout: number;

Defined in: types/config.type.ts:83

This property is for controlling the HTTP request timeout (in milliseconds).\

Since ​

1.0.0

Author ​

Simon Kovtyk

updateStrategy ​

ts
updateStrategy: UpdateStrategy;

Defined in: types/config.type.ts:97

Update strategy for handling token updates

Since ​

1.0.0

Author ​

Simon Kovtyk

useEmailAsCurrentUser? ​

ts
optional useEmailAsCurrentUser: boolean;

Defined in: types/config.type.ts:76

With this property set to true, the email given by KeycloakService.login() will be used as currentUser HTTP requests header field as long as the KeycloakInterceptor is used.

Since ​

1.0.0

Author ​

Simon Kovtyk