Whaller
This guide explains how to set up Single Sign-On (SSO) between SmartLink and Whaller using SAML 2.0.
Prerequisites
- Whaller Business or Enterprise subscription
- Administrator access to Whaller
- Verified email domain in Whaller
- Application configured in SmartLink with SAML2
Note: SSO is only available with Whaller's Business and Enterprise plans.
Configuration in SmartLink
1. Create the application
- Log in to SmartLink as an administrator
- Go to Applications → Add
- Create a new application:
- Name: Whaller
- URL:
https://[your-organization].whaller.com - Description: Secure enterprise social network
- Icon: Choose the Whaller icon
2. Configure SAML2
- In the Authentication tab
- Select SAML2
- Configure the following parameters:
- Entity ID:
[appid] - ACS URL:
https://[your-organization].whaller.com/saml/acs - Format NameID:
emailAddress - App ID:
[appid](automatically generated unique identifier)
- Entity ID:
3. Retrieve the metadata
Note the following URLs:
- IdP Metadata:
https://[your-smartlink].link.vaultys.org/api/saml2/[appid]/metadata - SSO URL:
https://[your-smartlink].link.vaultys.org/api/saml2/[appid]/sso - SLO URL:
https://[your-smartlink].link.vaultys.org/api/saml2/[appid]/slo - Entity ID:
[appid] - X.509 Certificate: Download from SmartLink
Configuration in Whaller
1. Access SSO settings
- Log in to Whaller as an administrator
- Go to Administration → Settings → Authentication
- In the SSO SAML section, click on Configure
2. Identity provider configuration
Configure the SAML parameters:
- IdP Entity ID:
[appid] - SSO URL:
https://[your-smartlink].link.vaultys.org/api/saml2/[appid]/sso - SLO URL:
https://[your-smartlink].link.vaultys.org/api/saml2/[appid]/slo - X.509 Certificate: Paste the certificate from SmartLink
- Binding:
HTTP-POST
3. Attribute configuration
| Whaller Attribute | SAML Attribute | Required |
|---|---|---|
email | ✅ | |
| First Name | firstName | ✅ |
| Last Name | lastName | ✅ |
| Display Name | displayName | ❌ |
| Service | department | ❌ |
| Job Title | title | ❌ |
| Manager | manager | ❌ |
| Location | location | ❌ |
4. Domain configuration
- In Allowed Domains
- Add your company domains
- Enable Force SSO for these domains
Sphere and Permissions Configuration
Sphere Types
spheres:
- type: "corporate"
name: "Enterprise"
visibility: "public"
auto_add_users: true
moderation: true
features:
- news
- events
- documents
- messages
- type: "project"
name: "Projects"
visibility: "private"
invitation_only: true
features:
- tasks
- calendar
- documents
- chat
- type: "community"
name: "Communities"
visibility: "discoverable"
join_approval: true
features:
- discussions
- polls
- ideas
- wiki
Roles and Permissions
{
"roles": {
"admin": {
"permissions": [
"manage_spheres",
"manage_users",
"manage_settings",
"view_analytics",
"export_data"
],
"saml_groups": ["smartlink-whaller-admins"]
},
"manager": {
"permissions": [
"create_spheres",
"moderate_content",
"invite_users",
"manage_sphere_settings"
],
"saml_groups": ["smartlink-managers"]
},
"contributor": {
"permissions": [
"create_content",
"comment",
"share",
"upload_files"
],
"saml_groups": ["smartlink-users"]
},
"reader": {
"permissions": [
"view_content",
"react",
"download_files"
],
"saml_groups": ["smartlink-external", "smartlink-guests"]
}
}
}
Group Synchronization
<!-- SAML assertion for groups -->
<saml:Attribute Name="groups">
<saml:AttributeValue>smartlink-whaller-admins</saml:AttributeValue>
<saml:AttributeValue>smartlink-department-hr</saml:AttributeValue>
<saml:AttributeValue>smartlink-project-alpha</saml:AttributeValue>
</saml:Attribute>
Specific Features
Security and Privacy
{
"security_features": {
"encryption": {
"at_rest": "AES-256",
"in_transit": "TLS 1.3",
"end_to_end": true
},
"data_sovereignty": {
"hosting": "France",
"no_third_party_access": true,
"gdpr_compliant": true
},
"content_control": {
"watermark": true,
"download_restrictions": true,
"copy_protection": false,
"expiring_content": true
},
"audit": {
"access_logs": true,
"activity_tracking": true,
"export_logs": true
}
}
}
Document Management
documents:
storage:
quota_per_sphere: "50GB"
quota_per_user: "10GB"
max_file_size: "2GB"
versioning:
enabled: true
max_versions: 10
auto_cleanup: "after_90_days"
collaboration:
co_editing: true
commenting: true
approval_workflow: true
supported_formats:
- documents: [".pdf", ".doc", ".docx", ".odt"]
- spreadsheets: [".xls", ".xlsx", ".ods"]
- presentations: [".ppt", ".pptx", ".odp"]
- images: [".jpg", ".png", ".gif", ".svg"]
- videos: [".mp4", ".avi", ".mov"]
Analytics and Reporting
{
"analytics": {
"dashboard": {
"active_users": "daily/weekly/monthly",
"content_creation": "posts/comments/files",
"engagement_rate": "views/interactions",
"sphere_activity": "per_sphere_metrics"
},
"reports": {
"user_activity": {
"frequency": "weekly",
"format": "pdf",
"recipients": ["admins"]
},
"content_moderation": {
"frequency": "daily",
"auto_flag": true,
"ai_assistance": true
},
"compliance": {
"gdpr_report": "monthly",
"audit_trail": "continuous",
"data_retention": "automated"
}
}
}
}
Whaller API
Client API with SSO authentication
import requests
from datetime import datetime
class WhallerAPI:
def __init__(self, domain, api_key):
self.base_url = f"https://{domain}.whaller.com/api/v2"
self.headers = {
'Authorization': f'Bearer {api_key}',
'Content-Type': 'application/json'
}
def get_user_by_sso_email(self, email):
"""Retrieve a user by their SSO email"""
response = requests.get(
f"{self.base_url}/users",
params={'email': email},
headers=self.headers
)
return response.json()
def create_sphere(self, name, sphere_type, members):
"""Create a new sphere"""
data = {
'name': name,
'type': sphere_type,
'members': members,
'settings': {
'moderation': True,
'invitation_only': False
}
}
response = requests.post(
f"{self.base_url}/spheres",
json=data,
headers=self.headers
)
return response.json()
def post_message(self, sphere_id, content, attachments=None):
"""Post a message in a sphere"""
data = {
'content': content,
'attachments': attachments or [],
'visibility': 'all_members'
}
response = requests.post(
f"{self.base_url}/spheres/{sphere_id}/messages",
json=data,
headers=self.headers
)
return response.json()
Webhooks
// Whaller webhooks configuration
app.post('/webhook/whaller', async (req, res) => {
const { event, data } = req.body;
const signature = req.headers['x-whaller-signature'];
// Verify the signature
if (!verifyWhallerSignature(signature, req.body)) {
return res.status(401).json({ error: 'Invalid signature' });
}
switch(event) {
case 'user.created':
await handleNewUser(data);
break;
case 'sphere.created':
await syncSphereToExternalTools(data);
break;
case 'message.posted':
await processNewMessage(data);
break;
case 'document.uploaded':
await scanDocument(data);
break;
case 'user.deactivated':
await handleUserDeactivation(data);
break;
}
res.status(200).json({ received: true });
});