medusa-store/docs/content/references/js-client/classes/AdminAuthResource.md

Class: AdminAuthResource

Hierarchy

• default

  ↳ AdminAuthResource

Methods

createSession

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

Description

Creates an authenticated session

Parameters

Name	Type
payload	AdminPostAuthReq
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminAuthRes>

Defined in

medusa-js/src/resources/admin/auth.ts:37

---

deleteSession

▸ deleteSession(customHeaders?): ResponsePromise<void>

Description

destroys an authenticated session

Parameters

Name	Type
customHeaders	Record<string, any>

Returns

ResponsePromise<void>

Defined in

medusa-js/src/resources/admin/auth.ts:24

---

getSession

▸ getSession(customHeaders?): ResponsePromise<AdminAuthRes>

Description

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

Parameters

Name	Type
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminAuthRes>

Defined in

medusa-js/src/resources/admin/auth.ts:12