docs: added cloud organizations documentation (#12723)
This commit is contained in:
Shahed Nasser
GitHub
205
www/apps/cloud/app/organization/page.mdx
Normal file
205
www/apps/cloud/app/organization/page.mdx
Normal file
@@ -0,0 +1,205 @@
|
||||
import { InlineIcon } from "docs-ui"
|
||||
import { Plus, EllipsisHorizontal } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Organization`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this guide, you'll learn about organizations in Cloud and how to manage them.
|
||||
|
||||
## What is an Organization?
|
||||
|
||||
In Cloud, an organization is a group of users that have access to the same settings, projects, resources, environments, and billing details.
|
||||
|
||||
As a user, you must be in an organization to create and deploy projects. A user can be a member of multiple organizations.
|
||||
|
||||
You can create a new organization when you sign up for Cloud. This will make you the organization's owner.
|
||||
|
||||
You can also join an existing organization by [receiving an invite from a user in that organization](#invite-members-to-organization).
|
||||
|
||||
---
|
||||
|
||||
## Organization View
|
||||
|
||||
When you open the Cloud dashboard and log in, you're viewing the projects, resources, and settings of a specific organization. You'll find the name of that organization at the top left of the dashboard.
|
||||
|
||||
|
||||
|
||||
### Switch Organization
|
||||
|
||||
If you're a member of multiple organizations, you can switch between them to view their projects, resources, and settings.
|
||||
|
||||
To switch to a different organization:
|
||||
|
||||
1. Click on the organization name at the top left of the Cloud dashboard.
|
||||
2. Choose the organization you want to switch to from the dropdown.
|
||||
|
||||
This will change the view to the selected organization, and you'll see its projects, resources, and settings.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## View Organization Settings
|
||||
|
||||
To view an organization's settings:
|
||||
|
||||
1. If you're in a different organization, [switch to the organization](#switch-organization) whose settings you want to view.
|
||||
2. Click on the [organization switcher](#switch-organization) at the top left of the Cloud dashboard.
|
||||
3. Choose "Organization Settings" from the dropdown.
|
||||
|
||||
This will open a new window where you can view and manage an organization's settings.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Edit Organization Details
|
||||
|
||||
To edit an organization's general details:
|
||||
|
||||
1. [Open the organization's settings](#view-organization-settings).
|
||||
2. In the General tab, you can edit the organization's name and billing email address.
|
||||
3. Once you're done making changes, click the "Save changes" button in the Details section.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Leave Organization
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Leaving an organization will remove you from it, and you'll no longer have access to its projects, resources, and settings. You can only access it by being invited again by another user in the organization.
|
||||
|
||||
</Note>
|
||||
|
||||
To leave an organization:
|
||||
|
||||
1. [Open the organization's settings](#view-organization-settings).
|
||||
2. In the General tab, find the "Leave organization" section.
|
||||
3. Click the "Leave organization" button.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Delete Organization
|
||||
|
||||
<Note type="warning" title="Danger">
|
||||
|
||||
Deleting an organization will remove all its projects, resources, and settings. This action is irreversible, and you won't be able to recover any data after deletion.
|
||||
|
||||
</Note>
|
||||
|
||||
To delete an organization:
|
||||
|
||||
1. [Open the organization's settings](#view-organization-settings).
|
||||
2. In the General tab, find the "Delete organization" section.
|
||||
3. Click the "Delete organization" button.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## View Organization Members
|
||||
|
||||
To view the members of an organization:
|
||||
|
||||
1. [Open the organization's settings](#view-organization-settings).
|
||||
2. Click on the "Team" tab.
|
||||
|
||||
In this window, you can view the members of the organization, their roles, and their email addresses. You can also view invited members who haven't accepted the invitation yet.
|
||||
|
||||
|
||||
|
||||
### View Available Seats
|
||||
|
||||
Based on your organization's plan, you may have a limited number of seats available for members. You can view the number of available seats at the top of the Team tab.
|
||||
|
||||
If you need more seats, you can contact our [sales team](https://medusajs.com/contact/) to add more seats to your organization or upgrade your plan.
|
||||
|
||||
|
||||
|
||||
### Invite Members to Organization
|
||||
|
||||
<Note>
|
||||
|
||||
Make sure you have [enough available seats](#view-available-seats) in your organization before inviting new members.
|
||||
|
||||
</Note>
|
||||
|
||||
To invite members to your organization:
|
||||
|
||||
1. [Open the organization's settings](#view-organization-settings).
|
||||
2. Click on the "Team" tab.
|
||||
3. In the "Invite members" section, enter the email address of the user you want to invite, then click the <InlineIcon alt="plus" Icon={Plus} /> button. You can enter multiple email addresses.
|
||||
4. Once you're done, click the "Invite all" button.
|
||||
|
||||
These users will receive an email invitation to join your organization. They can accept the invitation by clicking the link in the email.
|
||||
|
||||
|
||||
|
||||
### Resend Invitation
|
||||
|
||||
You may need to resend an invitation if a user has lost the invitation email or if the invitation has expired.
|
||||
|
||||
To resend an invitation:
|
||||
|
||||
1. [Open the organization's settings](#view-organization-settings).
|
||||
2. Click on the "Team" tab.
|
||||
3. In the "Invited members" section, find the user whose invitation you want to resend.
|
||||
4. Click the <InlineIcon alt="ellipsis" Icon={EllipsisHorizontal} /> button at the end of the user's row.
|
||||
5. Choose "Resend invite" from the dropdown.
|
||||
|
||||
|
||||
|
||||
### Revoke Invitation
|
||||
|
||||
You can revoke an invitation to a user if you no longer want them to join your organization.
|
||||
|
||||
To revoke an invitation:
|
||||
|
||||
1. [Open the organization's settings](#view-organization-settings).
|
||||
2. Click on the "Team" tab.
|
||||
3. In the "Invited members" section, find the user whose invitation you want to revoke.
|
||||
4. Click the <InlineIcon alt="ellipsis" Icon={EllipsisHorizontal} /> button at the end of the user's row.
|
||||
5. Choose "Revoke invite" from the dropdown.
|
||||
|
||||
|
||||
|
||||
### Remove Members from Organization
|
||||
|
||||
Owner and admin users can remove any members from the organization that aren't owners.
|
||||
|
||||
To remove a member from your organization:
|
||||
|
||||
1. [Open the organization's settings](#view-organization-settings).
|
||||
2. Click on the "Team" tab.
|
||||
3. In the "Organization members" section, find the member you want to remove.
|
||||
4. Click the <InlineIcon alt="ellipsis" Icon={EllipsisHorizontal} /> button at the end of the member's row.
|
||||
5. Choose "Remove from organization" from the dropdown.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Manage Profile Details
|
||||
|
||||
To edit your profile's details:
|
||||
|
||||
1. Click on your name and avatar at the top right of the Cloud dashboard.
|
||||
2. Choose "Settings" from the dropdown.
|
||||
3. In the Profile Settings page, you can edit your name, email address, and your membership in organizations.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Manage Billing Details
|
||||
|
||||
{/* TODO add link */}
|
||||
|
||||
Refer to the [Billing & Usage](#) guide to learn how to manage your organization's billing details, including payment methods, invoices, and usage.
|
||||
@@ -1,3 +1,4 @@
|
||||
export const generatedEditDates = {
|
||||
"app/page.mdx": "2025-06-12T12:31:48.681Z"
|
||||
"app/page.mdx": "2025-06-12T12:31:48.681Z",
|
||||
"app/organization/page.mdx": "2025-06-12T14:43:20.772Z"
|
||||
}
|
||||
@@ -10,6 +10,26 @@ export const generatedSidebars = [
|
||||
"path": "/",
|
||||
"title": "Introduction",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"type": "separator"
|
||||
},
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"type": "category",
|
||||
"title": "Basics",
|
||||
"initialOpen": true,
|
||||
"children": [
|
||||
{
|
||||
"loaded": true,
|
||||
"isPathHref": true,
|
||||
"type": "link",
|
||||
"title": "Organization",
|
||||
"path": "/organization",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -9,6 +9,21 @@ export const sidebar = [
|
||||
path: "/",
|
||||
title: "Introduction",
|
||||
},
|
||||
{
|
||||
type: "separator",
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
title: "Basics",
|
||||
initialOpen: true,
|
||||
children: [
|
||||
{
|
||||
type: "link",
|
||||
title: "Organization",
|
||||
path: "/organization",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
]
|
||||
|
||||
Reference in New Issue
Block a user