Skip to content

Commit b66efda

Browse files
authored
Merge pull request #573 from zihanKuang/org-team-issue
Docs: Refactor and Enhance Organization and User Management Documentation
2 parents fd9aaeb + 2f207d5 commit b66efda

File tree

10 files changed

+165
-37
lines changed

10 files changed

+165
-37
lines changed

content/en/cloud/identity/organizations/_index.md

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,9 @@ description: >
55
categories: [Identity]
66
tags: [orgs]
77
---
8-
<div style="display:flex; align-items: start;flex-direction: row;flex: 1 1 auto; ">
9-
<div style="flex-direction: column;">
10-
<p>
11-
Organizations are the basic unit of multi-tenancy inside of Layer5 Cloud. Organizations can have any number of teams. Teams can have any number of users. Users can belong to any number of teams. Users may belong to any number of organizations.
12-
</p>
13-
<p>
14-
Outside of grouping users together, teams offer control access to workspaces and to workspace resources such as environments and managed and unmanaged connections
15-
</p>
16-
</div>
17-
<div style="flex-direction: column;min-width: 50%;justify-items: center;margin-left:1rem;">
18-
<h4 style="text-align:center;font-weight:bold;">Organizational Hierarchy</h4>
19-
<img
20-
src="/cloud/identity/images/organization_units.svg"
21-
link="images/organization_units.svg"
22-
alt="Organizational units"
23-
width="auto" />
24-
</div>
25-
</div>
8+
9+
Organizations are the basic unit of multi-tenancy inside of Layer5 Cloud. Organizations can have any number of teams. Teams can have any number of users. Users can belong to any number of teams. Users may belong to any number of organizations.
10+
11+
Outside of grouping users together, teams offer control access to workspaces and to workspace resources such as environments and managed and unmanaged connections
12+
13+
<img src="/cloud/identity/images/organization_units.svg" alt="Organizational units" style="width: 35%;" />
Loading
Loading
Loading
Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
---
2+
title: Organization Management
3+
description: >
4+
Create, edit, invite members to, and delete your Organizations within Layer5 Cloud.
5+
weight: 1
6+
categories: [Identity]
7+
tags: [orgs]
8+
---
9+
10+
This guide covers creating new organizations, editing their details, inviting members, and deleting organizations when necessary.
11+
12+
![Organization Overview](/cloud/identity/organizations/org-management/org_overview.png)
13+
14+
{{< alert title="Permissions Required" type="info" >}}
15+
Operations described on this page for managing your Organization typically require Organization Administrator or similar administrative roles. To understand the specific roles needed for each action, please refer to the [Default Permissions reference](https://docs.layer5.io/cloud/reference/default-permissions/).
16+
{{< /alert >}}
17+
18+
## Creating an Organization
19+
20+
An Organization provides a way to structure your teams, users, and resource access for different projects or initiatives.
21+
22+
### How to create an Organization
23+
24+
1. Go to the Organizations section, click the **Add Organization** button
25+
2. The "Create New Organization" modal will appear:
26+
- Organization Name: Enter a unique name for your new Organization. This is a required field.
27+
- Country (Optional): Select the country for your Organization.
28+
- Region (Optional): Choose the time zone for your Organization.
29+
- Add Organization Members (Optional): You can begin adding **existing** Layer5 Cloud users to your new Organization in this field.
30+
31+
<img src="/cloud/identity/organizations/org-management/create_org.png" alt="Filling out new Organization details" style="width: 30%;" />
32+
33+
{{< alert type="info" title="Unable to Create More Organizations?" >}}
34+
If the "Add Organization" button is disabled, it means your current role does not permit creating additional Organizations. Only users with roles like Organization Administrator or Provider Administrator can create new Organizations.
35+
{{< /alert >}}
36+
37+
## Editing Your Organization
38+
39+
You can update your Organization's name, location, associated teams, branding, and access its invitation link by editing its details.
40+
41+
### How to Edit Your Organization
42+
43+
1. Select the Organization you want to modify and click its **"Edit"** button.
44+
2. The "Edit Organization" model will open:
45+
- Add Team: Associate existing Teams with this Organization.
46+
- Theme: Customize your Organization's visual theme by selecting from the available color swatches.
47+
- Logos: Upload specific logo versions for various display contexts by clicking the respective **"Upload"** buttons.
48+
- Invitations: Access a shareable link to invite users to your Organization.
49+
50+
<img src="/cloud/identity/organizations/org-management/edit_org.png" alt="Editing Organization Details" style="width: 30%;" />
51+
52+
## Using the Open Organization Invitation Link
53+
54+
To invite multiple users to your organization at once, or to allow open sign-ups (for example, for a public community), you can use the "Open Organization Invitation Link." This is a shareable link that lets users join directly.
55+
56+
### When to Use This Link
57+
* Bulk Onboarding: To quickly onboard many users without sending individual emails.
58+
* Public Sign-ups: To let people sign up openly, for instance, by posting the link on a community page or another public resource.
59+
* Cross-Organizational Collaboration: To make it easy for collaborators from other organizations or external partners to join.
60+
61+
![Obtain Organization Invite Link](/cloud/identity/organizations/org-management/org_open_invite.gif)
62+
63+
{{< alert title="Inviting Users to Specific Teams" type="info" >}}
64+
If you want to invite users directly to a specific team within your organization, please refer to the documentation on [Open Team Invites](https://docs.layer5.io/cloud/identity/teams/)
65+
{{< /alert >}}
66+
67+
### How it Works
68+
69+
- For New Users (without an existing Layer5 Cloud account):
70+
* When a new user clicks the invitation link, they will be directed to the sign-up page.
71+
* After creating their account, they will be automatically added to the organization associated with the invite link.
72+
73+
- For Existing Users (with a Layer5 Cloud account):
74+
* An existing user who clicks the invitation link will be able to join the organization using their current account.[^1]
75+
76+
## Deleting Your Organization
77+
78+
Deleting an Organization is a permanent action that removes it entirely, including all associated teams, user memberships within that Organization, and its resources.
79+
80+
{{< alert type="warning" title="Deletion is Permanent and Unrecoverable" >}}
81+
Once an Organization is deleted, **this action cannot be undone**.
82+
{{< /alert >}}
83+
84+
### Consequences of Deletion
85+
86+
Upon confirming deletion, the following are **permanently and irretrievably removed**:
87+
* The Organization Itself: Including all its unique settings and configurations.
88+
* All Associated Teams: All teams belonging to this Organization.
89+
* User Access to this Organization: Users' memberships, roles, and permissions specific to this Organization are revoked. (Note: Users' individual accounts themselves are not deleted from the system).
90+
* Owned Workspaces: All Workspaces belonging to this Organization.
91+
* Designs and Environments: All Designs and Environments within the Organization's deleted Workspaces will also be permanently removed.
92+
93+
### When NOT to Delete
94+
Avoid deleting an Organization if:
95+
* You might need the Organization or its data later.
96+
* Critical resources within it have not been backed up or migrated.
97+
* Other users or services still depend on it.
98+
* You only need to modify memberships or restructure parts of it.
99+
* You are unsure about the full extent of its data or dependencies.
100+
101+
### When Deletion May Be Appropriate
102+
103+
* The Organization was for a temporary project or test and is no longer needed.
104+
* It was created in error or is now redundant due to consolidation.
105+
* Permanent removal of all its data is required for compliance or data lifecycle management.
106+
* You are certain all its resources are obsolete or migrated, and no dependencies remain.
107+
108+
### How to Delete Your Organization
109+
110+
1. Select the Organization you want to delete and click its **"Delete"** button.
111+
2. A confirmation modal will appear, requiring you to verify this action.
112+
3. Click the "Delete" button to permanently remove the Organization. To abort the deletion, click "Cancel".
113+
114+
<img src="/cloud/identity/organizations/org-management/delete_org.png" alt="Delete Organization" style="width: 30%;" />
115+
116+
[^1]: Existing users who click this invitation link might encounter a "Page not found" error. This is a temporary bug and is being addressed.
Loading
Loading
227 KB
Loading
Loading
Lines changed: 43 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,71 @@
11
---
22
title: User Management
33
description: >
4-
Efficiently manage and organize users within Layer5 Cloud with our comprehensive user management capabilities.
4+
Learn how to create, add, invite, and manage users within Layer5 Cloud.
55
weight: 4
66
categories: [Identity]
77
tags: [users]
88
---
99

10-
There are three essential aspects of user management:
10+
This guide outlines methods for creating user accounts, adding users to organizations, inviting new members, and managing user access within Layer5 Cloud to maintain a secure and organized environment.
1111

12-
- Create User
13-
- Add User/ Remove User
14-
- Invite User
12+
![User Management options](/cloud/identity/users/org_invite.png)
1513

16-
## Create User
14+
## Create User Account
1715

1816
Seamlessly initiate new user accounts, ensuring a smooth onboarding process. Specify user details, such as email, and tailor their access by adding them to one or more organizations. Optionally assign roles, defining their scope within the platform. Complete the process by sending a personalized account setup email, streamlining the user's introduction to Layer5 Cloud.
1917

20-
<img src="/cloud/identity/users/create-user.gif" alt="Create User" />
18+
![Create User](/cloud/identity/users/create-user.gif)
2119

22-
{{< alert type="info" title="Note" >}}
23-
Only Provider Admins and Organization Admin can create users. For more information, see [Roles](/cloud/security/roles).
20+
{{< alert type="info" title="Permission Required for User Creation" >}}
21+
Only Provider Admins and Organization Admins can create users. For more information, see [Roles](/cloud/security/roles).
2422
{{< /alert >}}
2523

26-
## Add User/ Remove User
24+
## Add / Remove Existing User
2725

28-
Add or remove users from the selected organization.
26+
This section explains how to add existing Layer5 Cloud users to one of your organizations or remove them.
2927

30-
1. Navigate to the **Users** tab in the Identity section.
28+
![Flow for organization and team membership](/cloud/identity/users/Slide41.svg)
29+
30+
### Adding a User to an Organization
31+
32+
If someone already has a Layer5 Cloud account but isn't part of your organization, you can add them.
33+
34+
1. Go to the Users tab in the Identity section
3135
2. Click the **Add User** button.
3236
3. Select the organization to which you want to add the user.
3337
4. Select the user from the list of available users.
34-
5. From below chips, click on cross icon to remove the user from the organization.
38+
5. Assign appropriate roles within the organization.
3539

36-
<img src="/cloud/identity/users/add-user.gif" alt="Add User" />
40+
![Add User to Organization](/cloud/identity/users/add-user.gif)
3741

38-
![Flow for organization and team membership](/cloud/identity/users/Slide41.svg)
42+
### Removing Users from an Organization
43+
44+
You can remove users from an organization one by one or several at once. This action takes away their membership and access to that specific organization's resources but doesn’t delete their overall Layer5 Cloud account.
45+
46+
#### Method 1: Individual User Removal (One by One)
47+
* **Locate the User:** Find the specific user you wish to remove from the list.
48+
* **Use Row Action:** Click the "Remove User" icon.
49+
* **Confirm:** When prompted, confirm your decision to remove the user from the organization.
50+
51+
#### Method 2: Bulk User Removal (Multiple Users at Once)
52+
* **Select Users:** Use the checkboxes next to each user's name to select all the users you intend to remove.
53+
* **Use Bulk Action:** Click the "Delete" button.
54+
* **Confirm:** When prompted, confirm that you want to remove all the selected users from the organization.
55+
56+
![Removing Users from an Organization](/cloud/identity/users/remove_user.png)
3957

40-
## Invite User
58+
## Invite User via Email
4159

42-
Invite users to join your organization. Specify the user's name and email address and tailor their involvement by adding them to **organizations** and **teams**, optionally assigning predefined roles.
60+
You can invite new or existing users to join one of your organizations by sending them an email invitation.
4361

62+
* **How to Invite:**
63+
1. Click the "Invite User" button.
64+
2. Enter the person's First Name, Last Name, and Email address.
65+
3. Assign them to a target Organization. Optionally, Team(s) and Organization Role(s) they will receive.
66+
4. Layer5 Cloud sends an invitation email to the user.
67+
* **What the User Does:** The person you invited will click a link in the email to accept. If they're new to Layer5 Cloud, they'll need to create an account first before they can join your organization.
4468

45-
{{< alert type="info" title="Note" >}}
46-
An Organization Admin can assign organization roles to users but provider roles can only be assigned by Provider Admins. For more information, see [Roles](/cloud/security/roles).
69+
{{< alert type="info" title="Permissions for Role Assignment" >}}
70+
An Organization Admin can assign organization roles to users, but provider roles can only be assigned by Provider Admins. For more information, see [Roles](/cloud/security/roles).
4771
{{< /alert >}}

0 commit comments

Comments
 (0)