ngx-keycloak

Appearance

ParsedKeycloakToken ​

ts
type ParsedKeycloakToken = object;

Defined in: types/token.type.ts:7

Type definition for a parsed Keycloak token.

Since ​

1.0.0

Author ​

Simon Kovtyk

Properties ​

acr ​

ts
acr: string;

Defined in: types/token.type.ts:91

Authentication Context Class Reference

Since ​

1.0.0

Author ​

Simon Kovtyk

allowed-origins? ​

ts
optional allowed-origins: string[] | null;

Defined in: types/token.type.ts:98

Allowed origins for CORS

Since ​

1.0.0

Author ​

Simon Kovtyk

aud ​

ts
aud: string[];

Defined in: types/token.type.ts:161

Audiences of token

Since ​

1.0.0

Author ​

Simon Kovtyk

auth_time ​

ts
auth_time: number;

Defined in: types/token.type.ts:84

Timestamp of most reent authentication in seconds

Since ​

1.0.0

Author ​

Simon Kovtyk

azp ​

ts
azp: string;

Defined in: types/token.type.ts:56

Client ID

Since ​

1.0.0

Author ​

Simon Kovtyk

email ​

ts
email: string;

Defined in: types/token.type.ts:154

User’s email address

Since ​

1.0.0

Author ​

Simon Kovtyk

email_verified ​

ts
email_verified: boolean;

Defined in: types/token.type.ts:112

Indicator if email is verified

Since ​

1.0.0

Author ​

Simon Kovtyk

exp ​

ts
exp: number;

Defined in: types/token.type.ts:14

Expiration timestamp of token in seconds

Since ​

1.0.0

Author ​

Simon Kovtyk

family_name ​

ts
family_name: string;

Defined in: types/token.type.ts:147

User’s surname

Since ​

1.0.0

Author ​

Simon Kovtyk

given_name ​

ts
given_name: string;

Defined in: types/token.type.ts:140

User’s first name

Since ​

1.0.0

Author ​

Simon Kovtyk

iat ​

ts
iat: number;

Defined in: types/token.type.ts:21

Issued at timestamp of token in seconds

Since ​

1.0.0

Author ​

Simon Kovtyk

iss ​

ts
iss: string;

Defined in: types/token.type.ts:77

Issuer ID

Since ​

1.0.0

Author ​

Simon Kovtyk

jss ​

ts
jss: string;

Defined in: types/token.type.ts:35

Token ID

Since ​

1.0.0

Author ​

Simon Kovtyk

jti ​

ts
jti: string;

Defined in: types/token.type.ts:28

Token ID

Since ​

1.0.0

Author ​

Simon Kovtyk

name ​

ts
name: string;

Defined in: types/token.type.ts:119

User's full name

Since ​

1.0.0

Author ​

Simon Kovtyk

nbf ​

ts
nbf: number;

Defined in: types/token.type.ts:70

Not valid before timestamp of token in seconds

Since ​

1.0.0

Author ​

Simon Kovtyk

preferred_username ​

ts
preferred_username: string;

Defined in: types/token.type.ts:133

Preferred username of authenicated user

Since ​

1.0.0

Author ​

Simon Kovtyk

realm_access ​

ts
realm_access: object;

Defined in: types/token.type.ts:168

Role assignments granted at the realm

roles ​

ts
roles: string[];

Roles assigned at the realm level

Since ​

1.0.0

Author ​

Simon Kovtyk

Since ​

1.0.0

Author ​

Simon Kovtyk

resource_access ​

ts
resource_access: Record<string, {
  roles: string[];
}>;

Defined in: types/token.type.ts:183

Role assignments granted per client/application

Since ​

1.0.0

Author ​

Simon Kovtyk

scope ​

ts
scope: string;

Defined in: types/token.type.ts:105

Delegated authorization scopes

Since ​

1.0.0

Author ​

Simon Kovtyk

session_state ​

ts
session_state: string;

Defined in: types/token.type.ts:63

Server-side session ID

Since ​

1.0.0

Author ​

Simon Kovtyk

sid ​

ts
sid: string;

Defined in: types/token.type.ts:126

Session ID

Since ​

1.0.0

Author ​

Simon Kovtyk

sub ​

ts
sub: string;

Defined in: types/token.type.ts:42

Subject ID

Since ​

1.0.0

Author ​

Simon Kovtyk

typ ​

ts
typ: string;

Defined in: types/token.type.ts:49

Token type

Since ​

1.0.0

Author ​

Simon Kovtyk