Administration
Overview | Sections | Examples | πPDF
Administrator Panelβ
Overviewβ
The YuChat Administrator Panel provides centralized management of users, workspaces, organizations, and system settings.
Key functions:
- Manage accounts and roles
- Control workspaces and participants
- Manage organizations and assign administrators
- View activity analytics and statistics
- Assign and revoke system administrator access
Roles and Access Levelsβ
| Role | Capabilities |
|---|---|
| System Admin | Full access to all workspaces and users; creates organizations; assigns administrators; views all statistics |
| Org Admin | Manages assigned organizations; views all workspaces within organizations; assigns org-level admins |
| WS Admin | Manages their workspaces; assigns user roles; manages participants and channels; views workspace statistics |
System Admin is created during instance setup and assigns other administrators from existing YuChat users.
Panel Sectionsβ
- Accounts
- Workspaces
- Workspace Participants
- Channels
- Statistics
- Organizations
- System Administrators
- Keycloak Sync
Accountsβ
Account Management
Search and filter by:
- Email or username
- Type: Regular, AI Bot, Voice Bot, Integration Bot, Guest
- Status: Pending, Active, Suspended
View:
- Creation date
- Workspace memberships (name, role, status, join date, exit date, reason)
Actions:
- Delete user
| Username | Type | Status | Created | Workspaces | Actions | |
|---|---|---|---|---|---|---|
| User identifier | Display name | Regular / AI Bot / Voice Bot / Integration Bot / Guest | Pending / Active / Suspended | Registration date | Membership details | Delete |
Workspacesβ
Workspace Management
Search and filter by:
- Identifier
- Display name
- Subdomain
- Type: Regular, Demo, Uber
View:
- Creation, update, and deletion dates
- Organization
- Active participants, guests, pending users, chat count
Actions:
- View participants
- Add to organization
- Delete workspace
| Identifier | Name | Subdomain | Type | Created | Updated | Deleted | Organization | Active | Guests | Pending | Chats | Actions |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Unique ID | Display name | e.g., web.yuchat.ai | Regular / Demo / Uber | Date | Date | Date | Org name | Count | Count | Count | Count | View / Assign Org / Delete |
Workspace Participantsβ
Participant Management
- Select a workspace from the dropdown
- Search by full name
View:
- Full name, email
- Status: Pending, Active, Suspended
- Registration date, exit date, exclusion reason
- Role: Owner, Admin, Member, Guest
Actions:
- Change role
- Suspend membership
| Name | Status | Registered | Exited | Reason | Role | Actions | |
|---|---|---|---|---|---|---|---|
| Username | Active / Pending / Suspended | Date | Date | Reason | Owner / Admin / Member / Guest | Change Role / Suspend |
Channelsβ
Channel Management
Search and filter by:
- Name
- Type: Public, Private, General, Breakout
- Workspace
View:
- Creation, archive, and deletion dates
- Participants (username, email, role, join/exit dates)
Actions:
- Exclude participant
- Change role
| Name | Type | Workspace | Created | Archived | Deleted | Participants |
|---|---|---|---|---|---|---|
| Channel name | Public / Private / General / Breakout | WS name | Date | Date | Date | See below |
Participants table:
| Username | Role | Joined | Exited | Actions | |
|---|---|---|---|---|---|
| Name | Member / Owner / Admin | Date | Date | Exclude / Change Role |
Statisticsβ
Activity Analytics
Filters:
- Organization (default: All)
- Workspace (if organization selected)
- Time interval: 7 / 30 / 90 / 365 days
Account metrics:
- Total, Regular, Suspended, Guests, Bots
Activity graphs:
- Messages per day
- Calls per day
- Call participants per day
- Workspaces with calls per day
- Audio notes per day
- Video notes per day
- Screen recordings per day
Organizationsβ
Organization Management
Search by name
View:
- Creation date
- Paid until date
Actions:
- View workspaces
- View/add administrators
- Delete organization
- Edit organization
| Name | Created | Paid Until | Actions |
|---|---|---|---|
| Organization name | Date | Date | View WS / Manage Admins / Delete |
Creating an organization:
- Name (required)
- Paid until date (required)
System Administratorsβ
System Administrator Management
View:
- Account ID
- Username
Actions:
- Revoke administrator rights
| Account ID | Username | Actions | |
|---|---|---|---|
| Unique ID | Username | Revoke Admin Rights |
Keycloak Syncβ
Configure user synchronization from Keycloak to workspaces and channels
The Keycloak Sync section allows you to create and manage rules for automatic user synchronization from a Keycloak directory (LDAP/AD) into YuChat workspaces and channels.
Access: System Admin, Org Admin, WS Admin (within their workspaces)
Configuration Listβ
The section displays a table of existing sync configurations:
| Workspace | LDAP OU | Update Existing | Created | Updated | Actions |
|---|---|---|---|---|---|
| Workspace name | Distinguished Name of OU | Yes / No | Creation date | Last update | Edit / Delete |
Creating / Editing a Configurationβ
The configuration dialog has 4 tabs:
Tab 1 β General Settings
| Parameter | Description | Required |
|---|---|---|
| Workspace | Target workspace for user synchronization | Yes |
| LDAP OU | LDAP organizational unit to sync users from (e.g. CN=Users,DC=company,DC=com) | Yes |
| Update Existing | When enabled, attributes of already existing users will be updated on each sync | No |
Tab 2 β Attribute Mapping
Configure mapping between Keycloak attributes and YuChat profile fields:
| YuChat Field | Default Keycloak Field | Description |
|---|---|---|
| Department | department | Department name |
| Position | position | Job title |
| Phone | phone | Phone number |
| Entry DN | entryDn | LDAP Distinguished Name |
| Full Name | displayName | Display name |
Mapping can be overridden per configuration (e.g. use memberOf instead of entryDn for group-based filtering).
Tab 3 β Filters
Additional user filtering by Keycloak attributes:
| Parameter | Description |
|---|---|
| Attribute Name | Keycloak attribute name (e.g. dev_team) |
| Value | Filter value (e.g. ios) |
| Comparison Type | EQ β exact match, LIKE β partial match |
Multiple filters can be added. Users not matching the filters will not be synced.
Tab 4 β Chat-to-Group Mapping
Configure automatic user assignment to workspace channels (chats) based on their Keycloak group membership.
Prerequisite: A workspace must be selected on the "General Settings" tab β the channel list loads automatically.
Each mapping rule includes:
| Parameter | Description | Required |
|---|---|---|
| Chat | Workspace channel where users will be added. Select from the dropdown list of available channels | Yes |
| Keycloak Groups | Keycloak group names, comma-separated. Users belonging to any of the listed groups will be added to the channel | Yes |
| Remove Non-Members | When enabled, users who no longer belong to any of the specified Keycloak groups will be automatically removed from the channel | No |
How to configure:
- Go to the "Chat-to-Group Mapping" tab
- Click "Add Mapping"
- In the "Chat" field, select a channel from the dropdown
- In the "Keycloak Groups" field, enter group names separated by commas (e.g.
Sales, Marketing) - Enable "Remove Non-Members" if users should be automatically removed when they leave all specified groups
- Repeat steps 2β5 for each channel that needs synchronization
- Click "Save"
Example:
Suppose a workspace has channels "Sales" and "Development", and Keycloak has groups Sales, Development, QA:
| Chat | Keycloak Groups | Remove Non-Members |
|---|---|---|
| Sales | Sales | β |
| Development | Development, QA | β |
Result:
- Users from the
Salesgroup are automatically added to the "Sales" channel - Users from
DevelopmentorQAgroups are added to the "Development" channel - When a user is removed from a group in Keycloak, they will be excluded from the corresponding channel on the next sync
Multiple mappings can be added for the same channel with different groups.
Common Tasksβ
Remove User from All Workspacesβ
Scenario: Employee left the company
- Go to Accounts
- Find user by email or username
- Click Delete
View Monthly Activityβ
Scenario: Generate activity report
- Go to Statistics
- Select organization and workspace
- Set interval to 30 days
- Review graphs: Messages/day, Calls/day, etc.
Promote User to Workspace Adminβ
Scenario: Expand admin team
- Go to Workspace Participants
- Select the workspace
- Find the user
- Click Change Role β Administrator
Delete Inactive Workspaceβ
Scenario: Remove test workspace
- Go to Workspaces
- Filter by Type: Demo
- Find the workspace
- Click Delete Workspace
Move Workspace to Organizationβ
Scenario: Group workspaces together
- Go to Workspaces
- Find the workspace by identifier or name
- Click Add Organization or Change Organization
- Select the organization
Assign System Administratorβ
Scenario: Grant system admin access
- Go to System Administrators
- Click Add Administrator
- Find user by email or username
- Confirm
Auto-Add Users to Channels by Keycloak Groupβ
Scenario: Users from the AD/Keycloak group "Sales" should automatically join the "Sales" channel
Steps:
- Go to Keycloak Sync
- Find the configuration for the target workspace and click Edit (or create a new one)
- Go to the "Chat-to-Group Mapping" tab
- Click "Add Mapping"
- In the "Chat" field, select the Sales channel
- In the "Keycloak Groups" field, enter Sales
- Enable "Remove Non-Members" if needed
- Click "Save"
Suspend Guest Accessβ
Scenario: Guest violated policies
If workspace is unknown:
- Go to Accounts
- Filter by Type: Guest
- Find user by email or username
- Note the workspace from their membership list
- Go to Workspace Participants
- Select that workspace
- Find the participant and click Suspend Membership
If workspace is known:
- Go to Workspace Participants
- Select the workspace
- Find the participant and click Suspend Membership