daea35fe73
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2.9 KiB
2.9 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| jsClientSidebar |
Class: AdminAuthResource
Hierarchy
-
default↳
AdminAuthResource
Methods
createSession
▸ createSession(payload, customHeaders?): ResponsePromise<AdminAuthRes>
Parameters
| Name | Type |
|---|---|
payload |
AdminPostAuthReq |
customHeaders |
Record<string, any> |
Returns
Description
Creates an authenticated session
Defined in
packages/medusa-js/src/resources/admin/auth.ts:38
deleteSession
▸ deleteSession(customHeaders?): ResponsePromise<void>
Parameters
| Name | Type |
|---|---|
customHeaders |
Record<string, any> |
Returns
ResponsePromise<void>
Description
destroys an authenticated session
Defined in
packages/medusa-js/src/resources/admin/auth.ts:25
getSession
▸ getSession(customHeaders?): ResponsePromise<AdminAuthRes>
Parameters
| Name | Type |
|---|---|
customHeaders |
Record<string, any> |
Returns
Description
Retrieves an authenticated session Usually used to check if authenticated session is alive.
Defined in
packages/medusa-js/src/resources/admin/auth.ts:13
getToken
▸ getToken(payload, customHeaders?): ResponsePromise<AdminBearerAuthRes>
Parameters
| Name | Type |
|---|---|
payload |
AdminPostAuthReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminBearerAuthRes>
Description
Retrieves a new JWT access token