Skip to content

Commit 1beaca0

Browse files
OKhalkovashvayka
authored andcommitted
Improve docs Entity groups (permissions, share, public-private)
Affects: /docs/pe/user-guide/groups/
1 parent 68f1c3f commit 1beaca0

File tree

1 file changed

+61
-1
lines changed

1 file changed

+61
-1
lines changed

_includes/docs/pe/user-guide/groups.md

Lines changed: 61 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,12 +97,72 @@ For example, let's create an action to quickly go to the dashboard with full inf
9797

9898
{% include images-gallery.html imageCollection="action-configuration" showListImageTitles="true" %}
9999

100-
### Batch operations
100+
### Group permissions
101+
Use the Permissions tab to define who can access the entities inside this group and what actions they can perform.
102+
A permission links a Group role to a User group and applies only to the entities inside this group.
103+
Permissions supplement tenant-wide RBAC and do not override global restrictions. See [Group roles in RBAC](/docs/{{docsPrefix}}user-guide/rbac/#group-role){:target="_blank"}.
104+
105+
**How to add group permissions:**
106+
- Open **Entity group details****Permissions** tab.
107+
- Click "**+**" (Plus icon) to add a group permission.
108+
- Select **Role** (Group role) from dropdown list.
109+
- Select **User group owner** [Tenant](/docs/{{docsPrefix}}user-guide/ui/tenants){:target="_blank"} or a specific [Customer](/docs/{{docsPrefix}}user-guide/ui/customers){:target="_blank"}, and **User group**
110+
- Click "**Add**" to save. The group permission appears in the table.
111+
112+
You can **Edit** or **Delete** existing group permissions at any time from **Permissions** tab:
113+
- **Edit**: click "**Edit**" (pencil icon) of the target permission → update fields → "**Save**".
114+
- **Delete**: click "**Delete**" (trash icon) of the target permission → "**Confirm**".
115+
116+
Changes take effect immediately for all members who can access the group.
117+
118+
To review assigned permissions from the [user side](/docs/{{docsPrefix}}user-guide/ui/users/#assigning-permissions-to-user-group): Open **Users group** details → **Roles** tab.
119+
120+
## Batch operations
101121

102122
Over each entity of the group, you can perform operations such as: change the owner of the entity, move it to another group, add or remove an entity from the group.
103123

104124
{% include images-gallery.html imageCollection="batch-operations" showListImageTitles="true" %}
105125

126+
## Share entity group
127+
128+
Sharing a group provides access to all entities inside the group at once and creates a permission entry that links this entity group to the selected user group.
129+
130+
**How to share an entity group:**
131+
- In **Groups** tab, click "**Share**" icon in the row of the target group.
132+
- Choose [**Customer**](/docs/{{docsPrefix}}user-guide/ui/customers/){:target="_blank"} from dropdown list.
133+
- (Optional) Enable **All users** checkbox to provide access to every user of that customer.
134+
- Choose the Permissions access: Read, Write, or Other (Roles).
135+
- Click "**Share**" to apply. The access is propagated to all entities within the group.
136+
137+
To update or revoke access, open the group [permissions](#group-permissions) tab and edit/delete the corresponding permission.
138+
139+
## Make group public or private
140+
141+
Public groups provide read-only access to anyone (no sign-in). Use it for non-sensitive data only. When you set a group as Public,
142+
the platform adds permissions to that entity group for the Public customer’s "Public users" group.
143+
144+
**Make public:**
145+
146+
- In the **Groups** tab, click "**Make public**" icon of the target group.
147+
148+
- Confirm in the dialog.
149+
150+
The Public checkbox becomes enabled for this group.
151+
152+
{% capture public %}
153+
**Note:** Public dashboards that use device data, require the dashboard and the related device group must be public.
154+
{% endcapture %}
155+
{% include templates/info-banner.md content=public %}
156+
157+
**Make private (revoke public access):**
158+
159+
- In the Groups tab, click "**Make private**" icon of the target group.
160+
161+
- Confirm in the dialog. Public access is removed.
162+
163+
If you need controlled access for specific customers or users, use [Share entity group](#share-entity-group)
164+
or configure entries on the [Permissions](#group-permissions) tab.
165+
106166
## Delete entity group
107167

108168
You can delete an entity group along with all its entities using one of the following ways:

0 commit comments

Comments
 (0)