API Referenz: Tenants
Tenant Endpoints
Get Tenant
Zeigt Details zu einem bestimmten Tenant.
Endpoint: GET /tenant/{tenantId}
Parameter:
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | Die eindeutige Kennung des Tenants |
Response:
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"displayName": "My Company",
"createdAt": "2024-01-15T10:30:00Z",
"plan": "professional"
}
Update Tenant
Aktualisiere Tenant-Einstellungen wie den Anzeigenamen.
Endpoint: PUT /tenant/{tenantId}
Parameter:
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | Die eindeutige Kennung des Tenants |
Request Body:
{
"displayName": "New Company Name"
}
Response: Gibt das aktualisierte Tenant-Objekt zurück.
Get Tenant Statistics
Stellt Nutzungsstatistiken für einen Tenant bereit.
Endpoint: GET /tenant/{tenantId}/statistics
Parameter:
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | Die eindeutige Kennung des Tenants |
Response:
{
"processCount": 15,
"datasetCount": 8,
"userCount": 5,
"storageUsedBytes": 1073741824
}
Tenant Users Endpoints
List Tenant Users
Zeigt alle User mit Zugriff auf einen Tenant.
Endpoint: GET /tenant/{tenantId}/users
Parameter:
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | Die eindeutige Kennung des Tenants |
Response:
[
{
"id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
"email": "user@example.com",
"firstName": "John",
"lastName": "Doe",
"createdAt": "2024-01-15T10:30:00Z",
"lastLoginAt": "2024-03-01T14:00:00Z",
"tenantId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"isActiveInTenant": true,
"isAdminInTenant": false,
"isDeveloperInTenant": false,
"organizationId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
"isActiveInOrganization": true,
"isAdminInOrganization": false
}
]
Add Tenant User
Fügen Sie einen neuen User zu einem Tenant hinzu. Der User wird erstellt, falls noch kein Account existiert, oder dem Tenant hinzugefügt, wenn bereits ein Account vorhanden ist. Die User-ID ist in der Response enthalten.
Endpoint: POST /tenant/{tenantId}/users
Parameter:
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | Die eindeutige Kennung des Tenants |
Request Body:
{
"email": "newuser@example.com",
"firstName": "John",
"lastName": "Doe",
"isAdminInTenant": false,
"isActiveInTenant": true,
"isDeveloperInTenant": false
}
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| string | Ja | E-Mail-Adresse des Users | |
| firstName | string | Nein | Vorname des Users |
| lastName | string | Nein | Nachname des Users |
| isAdminInTenant | boolean | Nein | Ob der User Adminrechte im Tenant hat |
| isActiveInTenant | boolean | Nein | Ob der User im Tenant aktiv ist |
| isDeveloperInTenant | boolean | Nein | Ob der User Developer-Zugriff im Tenant besitzt |
Response:
{
"id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
"message": "User erfolgreich zum Tenant hinzugefügt."
}
Update Tenant User
Aktualisiere die Berechtigungen eines Users innerhalb des Tenants.
Endpoint: PUT /tenant/{tenantId}/users
Request Body:
{
"userId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
"tenantId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"isAdminInTenant": true,
"isActiveInTenant": true,
"isDeveloperInTenant": false
}
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| userId | string | Ja | Die eindeutige Kennung des Users |
| tenantId | string | Ja | Die eindeutige Kennung des Tenants |
| isAdminInTenant | boolean | Nein | Ob der User Adminrechte hat |
| isActiveInTenant | boolean | Nein | Ob der User im Tenant aktiv ist |
| isDeveloperInTenant | boolean | Nein | Ob der User Developer-Zugriff hat |
Response:
{
"message": "User Tenant-Einstellungen aktualisiert."
}
Remove Tenant User
Entfernt den Zugriff eines Users auf einen Tenant.
Endpoint: DELETE /tenant/{tenantId}/users
Request Body:
{
"userId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
"tenantId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| userId | string | Ja | Die eindeutige Kennung des zu entfernenden Users |
| tenantId | string | Ja | Die eindeutige Kennung des Tenants |
Response:
{
"message": "User wurde aus dem Tenant entfernt."
}