Class default

Represents an SessionAuthorization class that handles authorization using JWT tokens.

Index

Constructors

Accessors

isAdmin isAgency isBrand isCreator isUser

Methods

checkTokenValidAndExpiration getAgencyIds getBrandIds getClaims getIDMGroups getParam getRawToken getUserEmail getUserID hasClaim isTokenValid

Constructors

constructor

new default(token: string, jwtAPIMode: boolean): default
Constructs a new instance of the TokenDecoder class.
Parameters
- token: string
  The token to be decoded.
- jwtAPIMode: boolean
  A boolean indicating whether the token is in JWT API mode.
Returns default
None
- Defined in src/lib/SessionAuthorization.ts:29

Accessors

isAdmin

get isAdmin(): boolean
Returns boolean
- Defined in src/lib/SessionAuthorization.ts:44

isAgency

get isAgency(): boolean
Returns boolean
- Defined in src/lib/SessionAuthorization.ts:52

isBrand

get isBrand(): boolean
Returns boolean
- Defined in src/lib/SessionAuthorization.ts:36

isCreator

get isCreator(): boolean
Returns boolean
- Defined in src/lib/SessionAuthorization.ts:40

isUser

get isUser(): boolean
Returns boolean
- Defined in src/lib/SessionAuthorization.ts:48

Methods

checkTokenValidAndExpiration

checkTokenValidAndExpiration(): { expired: boolean; valid: boolean }
Check if the token is valid and if it has expired.

Returns { expired: boolean; valid: boolean }
- An object with two boolean properties, valid and expired.
- Defined in src/lib/SessionAuthorization.ts:83

getAgencyIds

getAgencyIds(): string[]
Retrieves the agency IDs from the decoded token payload.

Returns string[]
The agency IDs if present in the decoded token payload, otherwise null.
- Defined in src/lib/SessionAuthorization.ts:139

getBrandIds

getBrandIds(): string[]
Retrieves the brand IDs from the decoded token payload.

Returns string[]
The brand IDs if available, otherwise null.
- Defined in src/lib/SessionAuthorization.ts:131

getClaims

getClaims(): null | string[]
Retrieves the claims from the decoded token, specifically the 'cognito:groups' claim.

Returns null | string[]
An array of strings representing the groups the user belongs to, or null if the claim is not present.
- Defined in src/lib/SessionAuthorization.ts:115

getIDMGroups

getIDMGroups(): string[]
Retrieves the IDM groups from the decoded token payload.

Returns string[]
The IDM groups if available, otherwise null.
- Defined in src/lib/SessionAuthorization.ts:123

getParam

getParam(param: string): any
Retrieves a specific parameter from the decoded token payload.
Parameters
- param: string
  The parameter to retrieve from the decoded token payload.
Returns any
The value of the specified parameter, or undefined if the parameter does not exist.
- Defined in src/lib/SessionAuthorization.ts:107

getRawToken

getRawToken(): string
Get the raw token value.

Returns string
The raw token value.
- Defined in src/lib/SessionAuthorization.ts:167

getUserEmail

getUserEmail(): null | string
Retrieves the user's email from the decoded token.

Returns null | string
The user's email if available, otherwise null.
- Defined in src/lib/SessionAuthorization.ts:155

getUserID

getUserID(): null | string
Retrieves the user ID from the decoded token payload.

Returns null | string
The user ID if present in the decoded token payload, otherwise null.
- Defined in src/lib/SessionAuthorization.ts:147

hasClaim

hasClaim(claimName: AccessLevelJWTRoles): boolean
Checks if the user has a specific claim based on the claim name.
Parameters
- claimName: AccessLevelJWTRoles
  The name of the claim to check.
Returns boolean
True if the user has the claim, false otherwise.
- Defined in src/lib/SessionAuthorization.ts:177

isTokenValid

isTokenValid(): boolean
Checks if the token is valid by verifying if it exists, has a decoded token payload, and if the expiration time is greater than the current time.

Returns boolean
true if the token is valid, false otherwise
- Defined in src/lib/SessionAuthorization.ts:61