Files
medusa-store/docs/content/references/js-client/classes/AdminAuthResource.md
Shahed Nasser 3b28f46705 docs: added reference for JS Client (#1629)
* added reference for JS Client

* added reference for JS Client

* added reference for JS Client
2022-07-08 18:21:46 +03:00

2.1 KiB

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

packages/medusa-js/src/resources/admin/auth.ts:33


deleteSession

deleteSession(customHeaders?): ResponsePromise<void>

description destroys an authenticated session

Parameters

Name Type
customHeaders Record<string, any>

Returns

ResponsePromise<void>

Defined in

packages/medusa-js/src/resources/admin/auth.ts:22


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

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