Class: AdminAuthResource

Hierarchy

• defaultCopy to Clipboard

  ↳ AdminAuthResourceCopy to Clipboard

Methods

createSession

▸ createSession(payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminAuthResCopy to Clipboard>

DescriptionCopy to Clipboard

Creates an authenticated session

Parameters

Name	Type
payloadCopy to Clipboard	AdminPostAuthReqCopy to Clipboard
customHeadersCopy to Clipboard	RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns

ResponsePromiseCopy to Clipboard<AdminAuthResCopy to Clipboard>

Defined in

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

---

deleteSession

▸ deleteSession(customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<voidCopy to Clipboard>

DescriptionCopy to Clipboard

destroys an authenticated session

Parameters

Name	Type
customHeadersCopy to Clipboard	RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns

ResponsePromiseCopy to Clipboard<voidCopy to Clipboard>

Defined in

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

---

getSession

▸ getSession(customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminAuthResCopy to Clipboard>

DescriptionCopy to Clipboard

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

Parameters

Name	Type
customHeadersCopy to Clipboard	RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns

ResponsePromiseCopy to Clipboard<AdminAuthResCopy to Clipboard>

Defined in

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