Skip to content

Commit 90126e9

Browse files
KorayErkanKorayErkan
authored
Merge pull request #245 from VirtualMetric:DT-385-sso-and-multi-tenancy-documentation
DT-385-sso-and-multi-tenancy-documentation
2 parents 9298121 + 0e6aa3b commit 90126e9

File tree

14 files changed

+426
-201
lines changed

14 files changed

+426
-201
lines changed

‎docs/organization/role-based-access-control.mdx‎

Lines changed: 0 additions & 186 deletions
This file was deleted.

‎docs/organization/roles.mdx‎

Lines changed: 158 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,4 +87,161 @@ The following table summarizes the essentials of role permissions:
8787
- ⚪️ _None_: No access
8888
- 📗 _Read_: View-only access
8989
- 🟨 _Read_ + _Edit_: View and modify access
90-
- 📘 _Read_ + _Edit_ + _Delete_: Full access including deletion
90+
- 📘 _Read_ + _Edit_ + _Delete_: Full access including deletion
91+
92+
## Role-Based Access Control
93+
94+
**VirtualMetric DataStream** role-based access control (RBAC) provides granular permission management for enterprise deployments, enabling organizations to control user access to telemetry processing components based on assigned roles. The system supports both built-in roles with predefined permissions and custom roles with fine-grained access controls across **DataStream** components including pipelines, devices, targets, routes, and administrative functions.
95+
96+
### Custom Role Management
97+
98+
Create custom roles with specific permission sets for organizational requirements.
99+
100+
#### Create Custom Role
101+
102+
1. **Access Role Management**
103+
- Click **Create New Role** button
104+
105+
2. **Configure Role Details**
106+
- **Role Name**: Descriptive identifier for the role
107+
- **Description**: Purpose and scope of the role
108+
- **Configuration Method**: Select **Basic** or **Advanced**
109+
110+
3. **Permission Assignment**
111+
112+
**Basic Configuration**:
113+
- **Predefined Permission Sets**: Select from common role templates
114+
- **Simplified Interface**: Checkbox-based permission selection
115+
116+
**Advanced Configuration** (requires Advanced RBAC feature):
117+
- **Granular Permissions**: Individual permission selection per component
118+
- **Fine-grained Control**: Separate Read, Create, Edit, Delete permissions
119+
120+
#### Permission Categories
121+
122+
**System Components**:
123+
- **Pipeline**: Telemetry processing chain management
124+
- **Device**: Data input source configuration
125+
- **Target**: Data output destination management
126+
- **Quick Route**: Simple route configuration
127+
- **Advanced Route**: Complex conditional routing
128+
- **Director**: Service orchestration management
129+
130+
**Administrative Functions**:
131+
- **User**: User account management
132+
- **Role**: Role and permission management
133+
- **Audit**: System audit log access
134+
- **Settings**: System configuration management
135+
- **Usage**: Resource utilization monitoring
136+
137+
**Enterprise Features**:
138+
- **SSO**: Single sign-on configuration
139+
- **MSSP**: Multi-tenant switching capabilities
140+
- **Content Hub**: Pre-built template access
141+
142+
**Permission Levels**:
143+
- **Read**: View component information
144+
- **Create**: Add new components
145+
- **Edit**: Modify existing components
146+
- **Delete**: Remove components
147+
148+
### Role Assignment
149+
150+
Assign roles to users during account creation or through user management.
151+
152+
#### Assign Role to User
153+
154+
1. **Navigate to User Management**
155+
- Access **Organization** → **Users**
156+
- Select target user or create new user
157+
158+
2. **Role Selection**
159+
- **Role Dropdown**: Select from available roles
160+
- **Custom Roles**: Organization-specific roles
161+
162+
3. **Permission Validation**
163+
- System validates role permissions against user requirements
164+
- **Feature Access**: Roles filtered by tenant edition capabilities
165+
- **Tenant Scope**: Permissions limited to tenant boundaries
166+
167+
### Advanced RBAC Features
168+
169+
#### Edition-Based Permission Filtering
170+
171+
**Advanced RBAC Feature** (premium editions):
172+
- **Custom role creation** and modification
173+
- **Granular permission assignment** per component
174+
- **Role management interface** access
175+
176+
**Feature Dependencies**:
177+
- **SSO Permissions**: Require SSO feature in tenant edition
178+
- **MSSP Permissions**: Require MSSP feature for multi-tenant operations
179+
- **Advanced Configuration**: Available only with Advanced RBAC feature
180+
181+
#### Security and Compliance
182+
183+
**Session Management**:
184+
- **Automatic session invalidation** when roles change
185+
- **Permission cache clearing** for immediate access updates
186+
- **Audit trail** for all role and permission modifications
187+
188+
**Access Protection**:
189+
- **Owner role protection** prevents accidental lockout
190+
- **Self-modification restrictions** prevent users from elevating their own permissions
191+
- **Tenant isolation** ensures users cannot access other tenant resources
192+
193+
### Role Modification and Deletion
194+
195+
#### Modify Existing Role
196+
197+
1. **Access Role Settings**
198+
- Select role to modify
199+
200+
2. **Update Permissions**
201+
- **Add/Remove Permissions**: Adjust access levels
202+
- **Change Configuration Method**: Switch between Basic/Advanced
203+
- **Update Description**: Modify role documentation
204+
205+
3. **Apply Changes**
206+
- **User Session Impact**: Existing user sessions invalidated
207+
- **Immediate Effect**: Permission changes take effect immediately
208+
- **Audit Logging**: All changes recorded in audit trail
209+
210+
#### Delete Custom Role
211+
212+
1. **Check Role Usage**
213+
- **User Assignment Validation**: Ensure no users assigned to role
214+
- **Dependency Check**: Verify no system dependencies
215+
216+
2. **Role Removal**
217+
- Navigate to role settings
218+
- Click **Delete Role** (requires confirmation)
219+
- **User Reassignment**: Reassign affected users to other roles first
220+
221+
**Restrictions**:
222+
- **Built-in roles cannot be deleted**
223+
- **Roles with active user assignments** must be unassigned first
224+
- **Owner role deletion** is permanently blocked for tenant security
225+
226+
### Troubleshooting
227+
228+
#### Permission Issues
229+
230+
**User Cannot Access Component**:
231+
1. **Verify Role Assignment**: Check user's assigned role
232+
2. **Review Role Permissions**: Confirm role includes required permissions
233+
3. **Check Edition Features**: Ensure tenant edition supports required features
234+
4. **Validate Tenant Scope**: Confirm user accessing correct tenant resources
235+
236+
**Role Management Not Available**:
237+
1. **Advanced RBAC Feature**: Verify tenant edition includes Advanced RBAC
238+
2. **User Permissions**: Ensure current user has Role Read/Create/Edit permissions
239+
3. **Owner Access**: Confirm Owner role for full role management access
240+
241+
#### Session and Cache Issues
242+
243+
**Permission Changes Not Applied**:
244+
1. **Session Refresh**: Log out and log back in to refresh permissions
245+
2. **Cache Invalidation**: System automatically clears permission cache
246+
3. **Browser Refresh**: Clear browser cache if interface issues persist
247+

‎docs/organization/settings/company.mdx‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Company Details
2+
3+
The **Company Details** tab provides comprehensive information about your organization's **DataStream** account, including company information, account ownership, and operational status. This view allows administrators to review essential company data and manage basic organizational settings.
4+
5+
---
6+
7+
To access the **Company Details** settings:
8+
9+
- Click the hamburger menu on the top left
10+
- Select **Organization** > **Settings**
11+
- The **Company Details** tab is selected by default
12+
13+
The **Settings** interface contains three main tabs:
14+
- **Company Details** - Organization information and account details
15+
- **Authentication** - Single sign-on and authentication configuration
16+
- **Subscription and Billing** - Plan details and billing information
17+
18+
## Company Details Section
19+
20+
The left side displays your organization's core information:
21+
22+
- **Company Name** - Your organization's identifier in **DataStream**
23+
- **Status** - Current operational state (Enabled/Disabled)
24+
25+
## Account Owner Section
26+
27+
Administrative contact information for the organization:
28+
29+
- **Full name** - Primary account administrator's complete name
30+
- **Business email** - Contact email address for account management
31+
32+
## Account Information Section
33+
34+
The right side shows operational details about your **DataStream** account:
35+
36+
- **Status** - Account operational state (Active/Inactive)
37+
- **Added on** - Date when the organization account was created
38+
39+
## Management Operations
40+
41+
- **Manage company details** - Access detailed company configuration and modification options
42+
43+
This interface provides read-only access to essential company information, with management operations available through the dedicated management interface.

0 commit comments

Comments
 (0)