KeycloakInstance

Signature

1
{
2
authenticated?: boolean;
3
subject?: string;
4
realmAccess?: { roles: string[] };
5
resourceAccess?: string[];
6
token?: string;
7
tokenParsed?: {
8
exp?: number;
9
email?: string,
10
name?: string,
11
iat?: number;
12
nonce?: string;
13
sub?: string;
14
session_state?: string;
15
realm_access?: { roles: string[] };
16
resource_access?: string[];
17
};
18
refreshToken?: string;
19
refreshTokenParsed?: { nonce?: string };
20
idToken?: string;
21
idTokenParsed?: { nonce?: string };
22
timeSkew?: number;
23
}
Copied!

Parameters

Parameter
Description
authenticated
Is true if the user is authenticated, false otherwise.
subject
The user id.
realmAccess
The realm roles associated with the token.
resourceAccess
The resource roles associated with the token.
token
The base64 encoded token that can be sent in the Authorization header in requests to services.
tokenParsed
The parsed JWT token as a JavaScript object.
refreshToken
The base64 encoded refresh token that can be used to retrieve a new token.
refreshTokenParsed
The parsed refresh token as a JavaScript object.
idToken
The base64 encoded ID token.
idTokenParsed
The parsed id token as a JavaScript object.
timeSkew
The estimated time difference between the browser time and the authentication server in seconds. This value is just an estimation but is accurate enough when determining if a token is expired or not.
Copy link