Skip to Content
API ReferenceInterfacesInterface: AuthgearClaims

@authgear/nestjs


@authgear/nestjs / AuthgearClaims

Interface: AuthgearClaims

Defined in: src/authgear.interfaces.ts:38 

Typed view over a verified Authgear JWT access token.

Properties

aud

aud: string | string[]

Defined in: src/authgear.interfaces.ts:44 

Audience (the Authgear endpoint).


canReauthenticate?

optional canReauthenticate: boolean

Defined in: src/authgear.interfaces.ts:52 

https://authgear.com/claims/user/can_reauthenticate 


clientID?

optional clientID: string

Defined in: src/authgear.interfaces.ts:46 

The client_id claim, if present.


isAnonymous?

optional isAnonymous: boolean

Defined in: src/authgear.interfaces.ts:50 

https://authgear.com/claims/user/is_anonymous 


iss

iss: string

Defined in: src/authgear.interfaces.ts:42 

Issuer (the Authgear endpoint).


isVerified?

optional isVerified: boolean

Defined in: src/authgear.interfaces.ts:48 

https://authgear.com/claims/user/is_verified 


raw

raw: JWTPayload

Defined in: src/authgear.interfaces.ts:54 

The full raw JWT payload, for custom claims.


sub

sub: string

Defined in: src/authgear.interfaces.ts:40 

Authgear user id (OIDC sub).