Files
medusa-store/docs/content/references/js-client/classes/AdminAuthResource.md
Shahed Nasser 02d5c1da88 docs: update Typedoc and regenerate references (#1994)
* generated new services reference

* changed from automatic push to automated pull request

* updated typedoc, regenerated JS Client reference

* regenerated the reference after updating typedoc

* added action for js client
2022-08-04 17:29:52 +03:00

2.0 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

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