Class: AdminUsersResource
Hierarchy
defaultCopy to Clipboard↳
AdminUsersResourceCopy to Clipboard
Methods
create
▸ create(payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminUserResCopy to Clipboard>
DescriptionCopy to Clipboard
creates a user with the provided information
Parameters
| Name | Type | Description |
|---|---|---|
payloadCopy to Clipboard | AdminCreateUserPayloadCopy to Clipboard | user creation request body |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminUserResCopy to Clipboard>
created user
Defined in
medusa-js/src/resources/admin/users.ts:64
delete
▸ delete(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>
DescriptionCopy to Clipboard
deletes a user
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | id of the user to be deleted |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>
delete response
Defined in
medusa-js/src/resources/admin/users.ts:94
list
▸ list(customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminUsersListResCopy to Clipboard>
DescriptionCopy to Clipboard
lists all users
Parameters
| Name | Type |
|---|---|
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminUsersListResCopy to Clipboard>
a list of all users
Defined in
medusa-js/src/resources/admin/users.ts:106
resetPassword
▸ resetPassword(payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminUserResCopy to Clipboard>
DescriptionCopy to Clipboard
resets the users password given the correct token.
Parameters
| Name | Type | Description |
|---|---|---|
payloadCopy to Clipboard | AdminResetPasswordRequestCopy to Clipboard | reset password information. |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminUserResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/users.ts:36
retrieve
▸ retrieve(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminUserResCopy to Clipboard>
Retrieves a given user
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | id of the user |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminUserResCopy to Clipboard>
the user
Defined in
medusa-js/src/resources/admin/users.ts:50
sendResetPasswordToken
▸ sendResetPasswordToken(payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<voidCopy to Clipboard>
DescriptionCopy to Clipboard
resets password by re-sending password token.
Parameters
| Name | Type | Description |
|---|---|---|
payloadCopy to Clipboard | AdminResetPasswordTokenRequestCopy to Clipboard | payload for generating reset-password token. |
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/users.ts:22
update
▸ update(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminUserResCopy to Clipboard>
DescriptionCopy to Clipboard
updates a given user
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | id of the user to update |
payloadCopy to Clipboard | AdminUpdateUserPayloadCopy to Clipboard | user update request body |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminUserResCopy to Clipboard>
the updated user