IAdminForthAuth

Methods

getClientIp()

getClientIp(headers): string

Parameters

Parameter	Type
headers	any

Returns

string

---

getCustomCookie()

getCustomCookie(__namedParameters): string

Parameters

Parameter	Type
__namedParameters	{ cookies: object[]; name: string; }
__namedParameters.cookies	object[]
__namedParameters.name	string

Returns

string

---

issueJWT()

issueJWT(payload, type, expiresIn?): string

Parameters

Parameter	Type
payload	Object
type	string
expiresIn?	string

Returns

string

---

removeAuthCookie()

removeAuthCookie(response): void

Parameters

Parameter	Type
response	any

Returns

void

---

removeCustomCookie()

removeCustomCookie(__namedParameters): void

Parameters

Parameter	Type
__namedParameters	{ name: string; response: any; }
__namedParameters.name	string
__namedParameters.response	any

Returns

void

---

setAuthCookie()

setAuthCookie(__namedParameters): void

Parameters

Parameter	Type
__namedParameters	{ expireInDays?: number; pk: string; response: any; username: string; }
__namedParameters.expireInDays?	number
__namedParameters.pk	string
__namedParameters.response	any
__namedParameters.username	string

Returns

void

---

setCustomCookie()

setCustomCookie(__namedParameters): void

Parameters

Parameter	Type
__namedParameters	{ payload: { expiry: number; expirySeconds: number; httpOnly: boolean; name: string; value: string; }; response: any; }
__namedParameters.payload	{ expiry: number; expirySeconds: number; httpOnly: boolean; name: string; value: string; }
__namedParameters.payload.expiry	number
__namedParameters.payload.expirySeconds	number
__namedParameters.payload.httpOnly	boolean
__namedParameters.payload.name	string
__namedParameters.payload.value	string
__namedParameters.response	any

Returns

void

---

verify()

verify(jwt, mustHaveType, decodeUser?): Promise<any>

Parameters

Parameter	Type
jwt	string
mustHaveType	string
decodeUser?	boolean

Returns

Promise<any>