AdminAuthResource

admin/auth.AdminAuthResource

Methods

createSession

createSession(payload, customHeaders?): ResponsePromise<AdminAuthRes>

Parameters

payloadAdminPostAuthReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminAuthRes>

ResponsePromiseResponsePromise<AdminAuthRes>Required

Description

Creates an authenticated session

---

deleteSession

deleteSession(customHeaders?): ResponsePromise<void>

Parameters

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<void>

ResponsePromiseResponsePromise<void>Required

Description

destroys an authenticated session

---

getSession

getSession(customHeaders?): ResponsePromise<AdminAuthRes>

Parameters

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminAuthRes>

ResponsePromiseResponsePromise<AdminAuthRes>Required

Description

Retrieves an authenticated session Usually used to check if authenticated session is alive.

---

getToken

getToken(payload, customHeaders?): ResponsePromise<AdminBearerAuthRes>

Parameters

payloadAdminPostAuthReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminBearerAuthRes>

ResponsePromiseResponsePromise<AdminBearerAuthRes>Required

Description

Retrieves a new JWT access token