Skip to main content

Class: AdminUsersResource

Hierarchy

  • Copy to Clipboard

    Copy to Clipboard

Methods

create

create(Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Copy to Clipboard

creates a user with the provided information

Parameters

NameTypeDescription
Copy to ClipboardCopy to Clipboarduser creation request body
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

created user

Defined in

medusa-js/src/resources/admin/users.ts:64


delete

delete(Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Copy to Clipboard

deletes a user

Parameters

NameTypeDescription
Copy to ClipboardCopy to Clipboardid of the user to be deleted
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

delete response

Defined in

medusa-js/src/resources/admin/users.ts:94


list

list(Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Copy to Clipboard

lists all users

Parameters

NameType
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

a list of all users

Defined in

medusa-js/src/resources/admin/users.ts:106


resetPassword

resetPassword(Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Copy to Clipboard

resets the users password given the correct token.

Parameters

NameTypeDescription
Copy to ClipboardCopy to Clipboardreset password information.
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

Defined in

medusa-js/src/resources/admin/users.ts:36


retrieve

retrieve(Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Retrieves a given user

Parameters

NameTypeDescription
Copy to ClipboardCopy to Clipboardid of the user
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

the user

Defined in

medusa-js/src/resources/admin/users.ts:50


sendResetPasswordToken

sendResetPasswordToken(Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Copy to Clipboard

resets password by re-sending password token.

Parameters

NameTypeDescription
Copy to ClipboardCopy to Clipboardpayload for generating reset-password token.
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

Defined in

medusa-js/src/resources/admin/users.ts:22


update

update(Copy to Clipboard, Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Copy to Clipboard

updates a given user

Parameters

NameTypeDescription
Copy to ClipboardCopy to Clipboardid of the user to update
Copy to ClipboardCopy to Clipboarduser update request body
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

the updated user

Defined in

medusa-js/src/resources/admin/users.ts:79