API-Referenz: Organisationen

Organisation-Endpunkte

Organisationen bündeln mehrere Tenants unter einer gemeinsamen Einheit.

Organisation abrufen

Informationen zur Organisation, zu der ein Tenant gehört, abrufen.

Endpoint: GET /tenant/{tenantId}/organization

Parameter:

Name	Typ	Ort	Erforderlich	Beschreibung
tenantId	string	path	Ja	Eindeutige Kennung des Tenants

Response:

{
	"id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
	"displayName": "Acme Corporation",
	"createdAt": "2023-06-01T00:00:00Z"
}

---

Organisationsstatistiken abrufen

Aggregierte Statusstiken für die gesamte Organisation anzeigen.

Endpoint: GET /tenant/{tenantId}/organization/statistics

Parameter:

Name	Typ	Ort	Erforderlich	Beschreibung
tenantId	string	path	Ja	Eindeutige Kennung des Tenants

Response:

{
	"tenantCount": 5,
	"totalProcessCount": 42,
	"totalDatasetCount": 18,
	"totalUserCount": 25,
	"totalStorageUsedBytes": 5368709120
}

---

Tenants der Organisation auflisten

Alle Tenants der Organisation abrufen.

Endpoint: GET /tenant/{tenantId}/organization/tenants

Parameter:

Name	Typ	Ort	Erforderlich	Beschreibung
tenantId	string	path	Ja	Eindeutige Kennung des Tenants

Response:

[
	{
		"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
		"displayName": "Sales Department",
		"createdAt": "2024-01-01T00:00:00Z"
	},
	{
		"id": "d4e5f6a7-b8c9-0123-def4-567890123456",
		"displayName": "Operations",
		"createdAt": "2024-02-15T00:00:00Z"
	}
]

---

Tenant erstellen

Einen neuen Tenant in der Organisation anlegen.

Endpoint: POST /tenant/{tenantId}/organization/tenants

Parameter:

Name	Typ	Ort	Erforderlich	Beschreibung
tenantId	string	path	Ja	Die eindeutige ID eines bestehenden Tenants in der Organisation

Request Body:

{
	"shortName": "sales-team",
	"displayName": "Sales Team",
	"description": "Tenant for the sales department"
}

Feld	Typ	Erforderlich	Beschreibung
shortName	string	Ja	URL-freundlicher Name (nur Kleinbuchstaben und Bindestriche)
displayName	string	Nein	Anzeigename für den Tenant
description	string	Nein	Beschreibung des Tenants

Response: Gibt das erstellte Tenant-Objekt zurück.

---

Tenant löschen

Einen Tenant aus der Organisation entfernen.

Endpoint: DELETE /tenant/{tenantId}/organization/tenants/{targetTenantId}

Parameter:

Name	Typ	Ort	Erforderlich	Beschreibung
tenantId	string	path	Ja	Die ID eines bestehenden Tenants in der Organisation
targetTenantId	string	path	Ja	Die ID des zu löschenden Tenants

Response:

{
	"success": true
}

---

Endpunkte für Organisationsnutzer

Organisationsbenutzer auflisten

Rufen Sie alle Benutzer innerhalb der Organisation ab.

Endpunkt: GET /tenant/{tenantId}/organization/users

Parameter:

Name	Typ	Ort	Erforderlich	Beschreibung
tenantId	string	path	Ja	Eindeutige Kennung des Tenants

Response:

[
	{
		"id": "e5f6a7b8-c9d0-1234-efa5-678901234567",
		"email": "admin@example.com",
		"firstName": "Jane",
		"lastName": "Smith",
		"createdAt": "2023-06-01T00:00:00Z",
		"lastLoginAt": "2024-03-01T10:00:00Z",
		"organizationId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
		"isActiveInOrganization": true,
		"isAdminInOrganization": true
	}
]

---

Organisationsbenutzer aktualisieren

Aktualisieren Sie die Berechtigungen eines Benutzers innerhalb der Organisation.

Endpunkt: PUT /tenant/{tenantId}/organization/users

Request Body:

{
	"userId": "e5f6a7b8-c9d0-1234-efa5-678901234567",
	"organizationId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
	"isActiveInOrganization": true,
	"isAdminInOrganization": true
}

Feld	Typ	Erforderlich	Beschreibung
userId	string	Ja	Die eindeutige Kennung des Benutzers
organizationId	string	Ja	Die eindeutige Kennung der Organisation
isActiveInOrganization	boolean	Nein	Gibt an, ob der Benutzer in der Organisation aktiv ist
isAdminInOrganization	boolean	Nein	Gibt an, ob der Benutzer Administratorrechte in der Organisation besitzt

Response:

{
	"message": "User organization settings updated."
}

---

Organisationsbenutzer entfernen

Entfernen Sie einen Benutzer vollständig aus der Organisation.

Endpunkt: DELETE /tenant/{tenantId}/organization/users

Request Body:

{
	"userId": "e5f6a7b8-c9d0-1234-efa5-678901234567",
	"organizationId": "c3d4e5f6-a7b8-9012-cdef-345678901234"
}

Feld	Typ	Erforderlich	Beschreibung
userId	string	Ja	Die eindeutige Kennung des zu entfernenden Benutzers
organizationId	string	Ja	Die eindeutige Kennung der Organisation

Response:

{
	"message": "User removed from organization."
}