Skip to content

Commit d98ba63

Browse files
fleuralywangsijie
andauthored
docs: update organization configuration (#652)
Co-authored-by: wangsijie <wangsijie@silverhand.io>
1 parent a2398f3 commit d98ba63

File tree

4 files changed

+51
-0
lines changed

4 files changed

+51
-0
lines changed
Binary file not shown.
Binary file not shown.
Binary file not shown.

docs/docs/recipes/organizations/configuration.mdx

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
sidebar_position: 2
33
---
44

5+
import organizationCreatePermission from './assets/organization-create-permission.webp';
6+
import organizationCreateRole from './assets/organization-create-role.webp';
7+
import organizationRoleList from './assets/organization-role-list.webp';
8+
59
# Configure organizations
610

711
## Configure via Console
@@ -14,6 +18,53 @@ Configuring organizations can be divided into two parts: setting up organization
1418

1519
First, navigate to the organization template in the left navigation menu. You will see that the organization template includes two parts: Organization Roles and Organization Permissions. An organization template defines shared access control policies (permissions and roles) for multiple organizations.
1620

21+
#### Create organization permission
22+
23+
Organization permissions are a key part of organization templates. These permissions are designed specifically for organizations within your product. Here's how to manage them:
24+
25+
- **Find the org permissions tab:** Go to the "org permissions" tab to see your existing permissions.
26+
- **Add, delete, and edit:** You can easily add new organization permissions, delete ones you don't need, and edit existing permissions as required.
27+
{' '}
28+
<center>
29+
<img alt="Organization create permission" src={organizationCreatePermission} width={720} />
30+
</center>
31+
32+
#### Create organization role
33+
34+
<center>
35+
<img alt="Organization role list" src={organizationRoleList} width={720} />
36+
</center>
37+
<center>
38+
<img alt="Organization create role" src={organizationCreateRole} width={720} />
39+
</center>
40+
41+
Logto lets you define organization roles in a variety of ways to fit your system's structure:
42+
43+
**1. Organization permissions only**
44+
45+
- **When to use:** You have separate user/system endpoints and organization endpoints.
46+
- **Explanation:** This is the simplest approach if you clearly divide API permissions from organization permissions. Your organization roles only include the organization permissions you defined.
47+
48+
**2. API permissions only**
49+
50+
- **When to use:** User and organization access control are handled by the same endpoints.
51+
- **Explanation:** Choose this if you want to manage all permissions through API resources registered in Logto cloud.
52+
53+
**3. Combining API and organization permissions**
54+
55+
- **When to use:** You have separate endpoints defined for your product, but some user roles require a mix of both user-level and organization-level permissions.
56+
- **Explanation:** This offers the most flexibility, but can also be the most complex to manage.
57+
58+
### Create and manage organizations
59+
60+
In the organization list, you can create an organization and configure its details. On the organization details page, you can:
61+
62+
1. Modify the organization's name and description.
63+
2. Add members and give them organization roles.
64+
3. Update a user's membership status.
65+
4. Delete the organization.
66+
5. Access a guide to understand more about organizations and the organization template.
67+
1768
### Adding members and assigning organization roles
1869

1970
Users can hold one or more roles. When adding members to an organization, you have the option to assign roles to multiple users at once. If you leave this assignment blank, the added users will not receive any roles.

0 commit comments

Comments
 (0)