docs: update users user guide (#11531)
This commit is contained in:
Shahed Nasser
GitHub
@@ -12,7 +12,7 @@ export const metadata = {
|
||||
|
||||
Your Medusa store's settings are where you can manage your store's details, regions, sales channels, and more.
|
||||
|
||||
You can access your store's settings by clicking "Settings" item at the bottom of the sidebar. This shows a settings panel with a different sidebar to manage your store's data.
|
||||
You can access your store's settings by clicking the "Settings" item at the bottom of the sidebar. This shows a settings panel with a different sidebar to manage your store's data.
|
||||
|
||||
You can also go back to the main sidebar by clicking the <InlineIcon Icon={ArrowUturnLeft} alt="back" /> icon at the top of the sidebar.
|
||||
|
||||
|
||||
@@ -10,11 +10,11 @@ export const metadata = {
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you'll learn how to manage invites in your store.
|
||||
In this guide, you'll learn how to manage invites in your store.
|
||||
|
||||
## Overview
|
||||
## Add Admin Users through Invites
|
||||
|
||||
To add a new user to your team, you must invite them. The user gets a notification of the invite to sign up, but you can also send them the invite link to sign up.
|
||||
To add a new user to your team, you must invite them. The user gets a notification of the invite to sign up, but you can also manually send them the invite link to sign up.
|
||||
|
||||
<Note>
|
||||
|
||||
@@ -22,20 +22,18 @@ The form of notification sent (for example, an email) depends on what's configur
|
||||
|
||||
</Note>
|
||||
|
||||
---
|
||||
|
||||
## Invite a User
|
||||
|
||||
To send an invite to a user:
|
||||
|
||||
1. Go to Settings → Users.
|
||||
2. Click the Invite button.
|
||||
3. Enter the user’s email and choose their role.
|
||||
3. Enter the user’s email.
|
||||
4. Once done, click on the "Send invite" button.
|
||||
|
||||
<Note title="Info">
|
||||
|
||||
A user's role doesn't actually change the user's privileges. All users have the same admin privileges.
|
||||
|
||||
</Note>
|
||||
|
||||
|
||||
---
|
||||
|
||||
@@ -47,10 +45,14 @@ To view pending invites:
|
||||
2. Click the Invite button.
|
||||
3. Below the form, you'll find a Pending Invites table with all the invites that haven't been accepted yet.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Resend an Invite
|
||||
|
||||
You can resend an invite if the user hasn't received it, they lost their link, or the invite has expired.
|
||||
|
||||
To resend an invite to a user:
|
||||
|
||||
1. Go to Settings → Users.
|
||||
@@ -58,6 +60,8 @@ To resend an invite to a user:
|
||||
3. In the Pending Invites table, find the user to resend their invite and click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon.
|
||||
4. Choose "Resend invite" from the dropdown.
|
||||
|
||||
A notification will be sent to the user as configured by your technical team.
|
||||
|
||||
---
|
||||
|
||||
## Get Invite Link
|
||||
@@ -71,14 +75,22 @@ To copy the invite link:
|
||||
3. In the Pending Invites table, find the user to resend their invite and click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon.
|
||||
3. Choose “Copy invite link” from the dropdown.
|
||||
|
||||
You can then send this link to the user to sign up.
|
||||
|
||||
---
|
||||
|
||||
## Revoke Invite
|
||||
## Delete Invite
|
||||
|
||||
To revoke an invite:
|
||||
<Note type="warning">
|
||||
|
||||
Deleting an invite will revoke the invite and the user won't be able to sign up using that invite link.
|
||||
|
||||
</Note>
|
||||
|
||||
To delete an invite:
|
||||
|
||||
1. Go to Settings → Users.
|
||||
2. Click the Invite button.
|
||||
3. In the Pending Invites table, find the user to resend their invite and click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon.
|
||||
4. Choose Revoke from the dropdown.
|
||||
5. Confirm revoking the invite by clicking the Revoke button in the pop-up.
|
||||
4. Choose Delete from the dropdown.
|
||||
5. Confirm deleting the invite by clicking the Delete button in the pop-up.
|
||||
|
||||
@@ -3,7 +3,7 @@ sidebar_position: 3
|
||||
sidebar_label: Users
|
||||
---
|
||||
|
||||
import { EllipsisHorizontal } from "@medusajs/icons"
|
||||
import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Users`,
|
||||
@@ -11,24 +11,66 @@ export const metadata = {
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll learn how to invite new users, edit other users’ information, and remove users from your store.
|
||||
In this guide, you’ll learn how to manage users in your store.
|
||||
|
||||
<Note title="Tip">
|
||||
|
||||
You can't create a user. Instead, you need to [invite them](./invites/page.mdx) to join your store.
|
||||
|
||||
</Note>
|
||||
|
||||
## View Users
|
||||
|
||||
View admin users by going to Settings → Users.
|
||||
You can view admin users by going to Settings → Users. In the list, you can see user details such as the name and email. You can also search, filter, and sort the users to find the specific item you are looking for.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## View User Details
|
||||
|
||||
To view the details of a user:
|
||||
|
||||
1. Go to Settings → Users.
|
||||
2. Click on the user in the list.
|
||||
|
||||
This opens the user's details page where you can also manage the user.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Edit a User’s Details
|
||||
|
||||
To edit a user’s details in your team:
|
||||
To edit the details of an admin user:
|
||||
|
||||
1. Go to Settings → Users.
|
||||
2. Find the user in the list and click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at its right.
|
||||
1. Go to the user's details page.
|
||||
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
|
||||
3. Choose Edit from the dropdown.
|
||||
4. In the drawer that opens, edit the user’s information.
|
||||
4. In the side window that opens, you can edit the user's first and last names.
|
||||
5. Once done, click the Save button.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Manage User Metadata
|
||||
|
||||
Metadata is custom data that can be associated with the user in key-value pairs. This is usually used by developers for custom integrations or to store additional information about the user.
|
||||
|
||||
To edit the user's metadata:
|
||||
|
||||
1. Click the <InlineIcon Icon={ArrowUpRightOnBox} alt="arrow" /> icon at the right of the "Metadata" section.
|
||||
2. In the side window that opens:
|
||||
- Manage the key-value pairs in the table.
|
||||
- To add a new row of key-value pairs before or after a row:
|
||||
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
|
||||
- Choose "Insert row above" or "Insert row below" from the dropdown.
|
||||
- To delete a row of key-value pairs:
|
||||
- Hover over the row and click the <InlineIcon Icon={EllipsisVertical} alt="three-dots" /> icon at its right.
|
||||
- Choose "Delete row" from the dropdown.
|
||||
3. Once you're done, click the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Delete a User
|
||||
@@ -45,4 +87,4 @@ To delete a user from your store:
|
||||
2. Find the user in the list and click on it.
|
||||
3. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
|
||||
4. Choose Delete from the dropdown.
|
||||
4. Confirm deleting the user by clicking the Delete button in the pop-up.
|
||||
4. Confirm deleting the user by entering their name and clicking the "Delete" button in the pop-up.
|
||||
|
||||
@@ -3,7 +3,7 @@ export const generatedEditDates = {
|
||||
"app/tips/bulk-editor/page.mdx": "2025-02-14T14:16:04.867Z",
|
||||
"app/tips/lists/page.mdx": "2025-02-14T14:16:04.867Z",
|
||||
"app/settings/sales-channels/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/settings/users/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/settings/users/page.mdx": "2025-02-19T11:34:00.736Z",
|
||||
"app/settings/regions/manage/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/settings/taxes/tax-rates/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/page.mdx": "2025-02-14T11:18:46.636Z",
|
||||
@@ -13,7 +13,7 @@ export const generatedEditDates = {
|
||||
"app/settings/regions/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/settings/regions/shipping-options/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/orders/page.mdx": "2025-02-17T15:13:42.484Z",
|
||||
"app/settings/users/invites/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/settings/users/invites/page.mdx": "2025-02-19T11:38:54.009Z",
|
||||
"app/settings/taxes/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/settings/developer/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
"app/settings/taxes/manage/page.mdx": "2024-05-03T17:36:38+03:00",
|
||||
|
||||
@@ -371,7 +371,16 @@ export const generatedSidebar = [
|
||||
"type": "link",
|
||||
"title": "Users",
|
||||
"path": "/settings/users",
|
||||
"children": []
|
||||
"children": [
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"type": "link",
|
||||
"title": "Invites",
|
||||
"path": "/settings/users/invites",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
|
||||
@@ -228,6 +228,13 @@ export const sidebar = sidebarAttachHrefCommonOptions([
|
||||
type: "link",
|
||||
title: "Users",
|
||||
path: "/settings/users",
|
||||
children: [
|
||||
{
|
||||
type: "link",
|
||||
title: "Invites",
|
||||
path: "/settings/users/invites",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
|
||||
Reference in New Issue
Block a user