IAdminForthAuth

Methods

authorizeByCookies()

authorizeByCookies(__namedParameters): Promise<AdminUserAuthorizationResult>

Takes auth jwt from cookies, verifies it and runs adminUserAuthorize hooks.

Parameters

Parameter	Type
__namedParameters	{ cookies: object[]; extra: HttpExtra; response: IAdminForthHttpResponse; }
__namedParameters.cookies	object[]
__namedParameters.extra	HttpExtra
__namedParameters.response	IAdminForthHttpResponse

Returns

Promise<AdminUserAuthorizationResult>

---

getAuthCookie()

getAuthCookie(cookies): string

Returns auth jwt from cookies, or null if it is not there.

Parameters

Parameter	Type
cookies	object[]

Returns

string

---

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 | number

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

---

runAdminUserAuthorizeHooks()

runAdminUserAuthorizeHooks(adminUser, response, extra): Promise<{ allowed: boolean; error?: string; }>

Runs adminUserAuthorize hooks for already authenticated user.

Parameters

Parameter	Type
adminUser	AdminUser
response	IAdminForthHttpResponse
extra	HttpExtra

Returns

Promise<{ allowed: boolean; error?: string; }>

---

setAuthCookie()

setAuthCookie(__namedParameters): void

Parameters

Parameter	Type
__namedParameters	{ expireInDuration?: string; pk: string; response: any; username: string; }
__namedParameters.expireInDuration?	string
__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>