API-Referenz: Mandanten

Mandanteninformationen abrufen

Endpunkt: GET /v1/tenant/{tenantId}

Authentifizierung: Mandantenbezogener API-Schlüssel · read Berechtigungsumfang

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	string	path	Ja	Format: uuid

Antwort (200):

Mandantendetails

{
	"id": "00000000-0000-0000-0000-000000000000",
	"createdBy": "00000000-0000-0000-0000-000000000000",
	"createdAt": "2024-03-15T16:30:00Z",
	"displayName": "string",
	"contactEmail": "string",
	"isActive": true,
	"shortName": "string",
	"useOrganizationTheme": true,
	"description": "string",
	"organizationId": "00000000-0000-0000-0000-000000000000",
	"allowedLogins": {
		"Microsoft": true,
		"Google": true,
		"LinkedIn": true
	},
	"url": "string"
}

Feld	Typ	Erforderlich	Beschreibung
id	string	Ja	Format: uuid
createdBy	string	Ja	Format: uuid
createdAt	string	Ja	Format: date-time
displayName	string	Ja	Standard: "" Maximale Länge: 128
contactEmail	string	Ja	Format: email
isActive	boolean	Ja	Standard: true
shortName	string	Ja
useOrganizationTheme	boolean	Ja	Standard: true
description	string	Ja	Maximale Länge: 200
organizationId	string	Ja	Format: uuid
allowedLogins	object	Ja
url	string	Ja	Format: uri

Fehler:

• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 404 Ressource nicht gefunden

Mandanteneinstellungen aktualisieren

Endpunkt: PUT /v1/tenant/{tenantId}

Authentifizierung: Mandantenbezogener API-Schlüssel · write Berechtigungsumfang

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	string	path	Ja	Format: uuid

Anfragetext:

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"contactEmail": "string",
	"shortName": "string",
	"description": "string"
}

Feld	Typ	Erforderlich	Beschreibung
id	string	Nein	Format: uuid
displayName	string	Nein
contactEmail	string	Nein
shortName	string	Nein
description	string	Nein

Antwort (200):

Mandant aktualisiert

{
	"id": "00000000-0000-0000-0000-000000000000",
	"createdBy": "00000000-0000-0000-0000-000000000000",
	"createdAt": "2024-03-15T16:30:00Z",
	"displayName": "string",
	"contactEmail": "string",
	"isActive": true,
	"shortName": "string",
	"useOrganizationTheme": true,
	"description": "string",
	"organizationId": "00000000-0000-0000-0000-000000000000",
	"allowedLogins": {
		"Microsoft": true,
		"Google": true,
		"LinkedIn": true
	},
	"url": "string"
}

Feld	Typ	Erforderlich	Beschreibung
id	string	Ja	Format: uuid
createdBy	string	Ja	Format: uuid
createdAt	string	Ja	Format: date-time
displayName	string	Ja	Standard: "" Maximale Länge: 128
contactEmail	string	Ja	Format: email
isActive	boolean	Ja	Standard: true
shortName	string	Ja
useOrganizationTheme	boolean	Ja	Standard: true
description	string	Ja	Maximale Länge: 200
organizationId	string	Ja	Format: uuid
allowedLogins	object	Ja
url	string	Ja	Format: uri

Fehler:

• 400 Ungültige Anfrage, zum Beispiel durch einen ungültigen Filterausdruck, einen Prozess ohne Modell, einen nicht unterstützten Upload-Typ oder ein fehlendes Pflichtfeld
• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 403 Dem API-Schlüssel fehlt der erforderliche Geltungsbereich oder der Zugriff auf die Organisation, der Mandant ist inaktiv oder der Tarif lässt den Dateityp nicht zu
• 406 Der Wert kann nicht angenommen werden, zum Beispiel weil der Kurzname reserviert oder bereits vergeben ist

Mandantenstatistiken abrufen (Datenvolumen, Modelle, Simulationen, Benutzer)

Endpunkt: GET /v1/tenant/{tenantId}/statistics

Authentifizierung: Mandantenbezogener API-Schlüssel · read Geltungsbereich

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	Zeichenfolge	Pfad	Ja	Format: uuid

Antwort (200):

Mandantenstatistiken

{
	"tenantId": "00000000-0000-0000-0000-000000000000",
	"uploadedDataSize": 0,
	"uploadedDataCount": 0,
	"modelCount": 0,
	"simulationCount": 0,
	"userCount": 0
}

Feld	Typ	Erforderlich	Beschreibung
tenantId	Zeichenfolge	Ja	Format: uuid
uploadedDataSize	Zahl	Ja
uploadedDataCount	Zahl	Ja
modelCount	Zahl	Ja
simulationCount	Zahl	Ja
userCount	Zahl	Ja

Fehler:

• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 404 Ressource nicht gefunden

Benutzer im Mandanten auflisten

Gibt die passenden Benutzer als einfaches JSON-Array zurück. Es gibt keine Gesamtzahl; verwenden Sie limit/offset für die Seitennavigation.

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

Authentifizierung: Mandantenbezogener API-Schlüssel · read Geltungsbereich

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	Zeichenfolge	Pfad	Ja	Format: uuid
limit	Ganzzahl	Abfrage	Nein	Maximale Anzahl der zurückzugebenden Einträge
offset	Ganzzahl	Abfrage	Nein	Anzahl der zu überspringenden Einträge

Antwort (200):

Benutzerliste

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"email": "string",
		"firstName": "string",
		"lastName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"lastLoginAt": "2024-03-15T16:30:00Z",
		"tenantId": "00000000-0000-0000-0000-000000000000",
		"isActiveInTenant": true,
		"isAdminInTenant": true,
		"access": "none",
		"isDashboardViewer": true,
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"isActiveInOrganization": true,
		"isAdminInOrganization": true
	}
]

Fehler:

• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen

Benutzer zum Mandanten hinzufügen (es wird keine Einladungs-E-Mail versendet)

Rollenfelder im Anforderungstext (isAdminInTenant, access: none|portalViewer|designer|architect|intelligence, isDashboardViewer) werden unverändert übernommen. Dieser Endpunkt bietet vollständige Mandantenadministration. Geben Sie daher nur vertrauenswürdigen Aufrufern API-Schlüssel mit Schreibberechtigung. Der Dashboard-Zugriff wird über den booleschen Wert isDashboardViewer gesteuert; die frühere Nur-Lese-Viewer-Stufe wurde entfernt.

Endpunkt: POST /v1/tenant/{tenantId}/users

Authentifizierung: Mandantenbezogener API-Schlüssel · write Geltungsbereich

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	Zeichenfolge	Pfad	Ja	Format: uuid

Anforderungstext:

{
	"email": "string",
	"firstName": "string",
	"lastName": "string",
	"isActiveInTenant": true,
	"isAdminInTenant": true,
	"access": "none",
	"isDashboardViewer": true,
	"preferredLocale": "en"
}

Feld	Typ	Erforderlich	Beschreibung
email	Zeichenfolge	Ja	E-Mail-Adresse des Benutzers (auch für die Anmeldung verwendet) Format: email
firstName	Zeichenfolge	Nein	Optionaler Vorname Maximale Länge: 64
lastName	Zeichenfolge	Nein	Optionaler Nachname Maximale Länge: 64
isActiveInTenant	boolesch	Nein	Gibt an, ob der Benutzer in diesem Mandanten aktiv ist
isAdminInTenant	boolesch	Nein	Administrationsrechte in diesem Mandanten (werden unverändert übernommen: vollständige Mandantenadministration)
access	none | portalViewer | designer | architect | intelligence	Nein	Einzelauswahl für den Lizenzplatz: none | portalViewer | designer | architect | intelligence Zulässige Werte: none, portalViewer, designer, architect, intelligence
isDashboardViewer	boolesch	Nein	Gibt an, ob der Benutzer Dashboards schreibgeschützt anzeigen kann
preferredLocale	en | zh | es | fr | de | pt | it | nl | ja | tr	Nein	Bevorzugte Sprache der Benutzeroberfläche Zulässige Werte: en, zh, es, fr, de, pt, it, nl, ja, tr

Antwort (201):

Benutzer hinzugefügt

{
	"id": "string",
	"message": "string"
}

Feld	Typ	Erforderlich	Beschreibung
id	Zeichenfolge	Ja	ID des neu hinzugefügten Benutzers
message	Zeichenfolge	Ja

Fehler:

• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 409 Die Anforderung steht im Konflikt mit dem aktuellen Status, zum Beispiel aufgrund einer Lizenzplatzbeschränkung oder einer bereits verwendeten ID

Mandanteneinstellungen eines Benutzers aktualisieren

Endpunkt: PUT /v1/tenant/{tenantId}/users/{userId}

Authentifizierung: Mandantenbezogener API-Schlüssel · write Geltungsbereich

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	Zeichenfolge	Pfad	Ja	Format: uuid
userId	Zeichenfolge	Pfad	Ja	Format: uuid

Anforderungstext:

{
	"isActiveInTenant": true,
	"isAdminInTenant": true,
	"access": "none",
	"isDashboardViewer": true
}

Feld	Typ	Erforderlich	Beschreibung
isActiveInTenant	boolesch	Nein	Gibt an, ob der Benutzer in diesem Mandanten aktiv ist
isAdminInTenant	boolesch	Nein	Administrationsrechte in diesem Mandanten (werden unverändert übernommen: vollständige Mandantenadministration)
access	none | portalViewer | designer | architect | intelligence	Nein	Einzelauswahl für den Lizenzplatz: none | portalViewer | designer | architect | intelligence. Der Dashboard-Zugriff wird über den booleschen Wert isDashboardViewer gesteuert. Zulässige Werte: none, portalViewer, designer, architect, intelligence
isDashboardViewer	boolesch	Nein	Gibt an, ob der Benutzer Dashboards schreibgeschützt anzeigen kann

Antwort (200):

Aktualisiert

{
	"message": "string"
}

Feld	Typ	Erforderlich	Beschreibung
message	Zeichenfolge	Ja

Fehler:

• 400 Ungültige Anfrage, zum Beispiel durch einen ungültigen Filterausdruck, einen Prozess ohne Modell, einen nicht unterstützten Upload-Typ oder ein fehlendes Pflichtfeld
• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 404 Ressource nicht gefunden

Benutzer aus dem Mandanten entfernen

Endpunkt: DELETE /v1/tenant/{tenantId}/users/{userId}

Authentifizierung: Mandantenbezogener API-Schlüssel · write Geltungsbereich

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	Zeichenfolge	Pfad	Ja	Format: uuid
userId	Zeichenfolge	Pfad	Ja	Format: uuid

Antwort (200):

Benutzer entfernt

{
	"message": "string"
}

Feld	Typ	Erforderlich	Beschreibung
message	Zeichenfolge	Ja

Fehler:

• 400 Ungültige Anfrage, zum Beispiel durch einen ungültigen Filterausdruck, einen Prozess ohne Modell, einen nicht unterstützten Upload-Typ oder ein fehlendes Pflichtfeld
• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 404 Ressource nicht gefunden

Einmaliges Anmeldetoken zur Benutzeranmeldung erstellen

Gibt ein einmalig verwendbares Token (60 Sekunden TTL) zurück, das an Benutzer, Mandant und Organisation gebunden ist, sowie die url, an die der Browser des Benutzers weitergeleitet werden soll. Öffnen Sie die URL im Browser des Benutzers. Dieser wird dann bereits authentifiziert bei ProcessMind angemeldet. Es ist weder ein E-Mail-Link noch eine Identitätsübernahme erforderlich; der Benutzer erhält eine eigene Sitzung. Erfordert den speziellen Geltungsbereich sessions für den API-Schlüssel: Ein organisationsbezogener Schlüssel kann ein Token für jeden Mandanten der Organisation erstellen, ein mandantenbezogener Schlüssel nur für Benutzer des eigenen Mandanten. Behandeln Sie das Token wie ein Passwort: Es wird nur einmal zurückgegeben, niemals protokolliert und durch Deaktivieren des Schlüssels oder des Benutzers widerrufen.

Endpunkt: POST /v1/tenant/{tenantId}/users/{userId}/login-token

Authentifizierung: Mandanten- oder organisationsbezogener API-Schlüssel · sessions Geltungsbereich · Ratenbegrenzung: 2 Anfragen/s (Spitzenwert 4)

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	Zeichenfolge	Pfad	Ja	Format: uuid
userId	Zeichenfolge	Pfad	Ja	Format: uuid

Anforderungstext:

Optionaler Zielpfad (relativer Anwendungspfad, zum Beispiel “app” oder “app/dashboards”)

{
	"path": "string"
}

Feld	Typ	Erforderlich	Beschreibung
path	Zeichenfolge	Nein	Maximale Länge: 512

Antwort (200):

Anmeldetoken

{
	"token": "string",
	"url": "string",
	"expiresInSeconds": 0,
	"expiresAt": "2024-03-15T16:30:00Z"
}

Feld	Typ	Erforderlich	Beschreibung
token	Zeichenfolge	Ja
url	Zeichenfolge	Ja
expiresInSeconds	Zahl	Ja
expiresAt	Zeichenfolge	Ja	Format: date-time

Fehler:

• 400 Ungültige Anfrage, zum Beispiel durch einen ungültigen Filterausdruck, einen Prozess ohne Modell, einen nicht unterstützten Upload-Typ oder ein fehlendes Pflichtfeld
• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 403 Dem API-Schlüssel fehlt der erforderliche Geltungsbereich oder der Zugriff auf die Organisation, der Mandant ist inaktiv oder der Tarif lässt den Dateityp nicht zu
• 404 Ressource nicht gefunden
• 429 Ratenbegrenzung erreicht: Beachten Sie die für den Endpunkt dokumentierte Ratenbegrenzung

API-Schlüssel authentifizieren Ihre Integrationen. Organisationsbezogene Schlüssel können die Schlüssel aller Mandanten der Organisation bereitstellen und verwalten.

API-Schlüssel des Mandanten auflisten

Erfordert einen organisationsbezogenen API-Schlüssel. Das Geheimnis wird niemals zurückgegeben.

Endpunkt: GET /v1/tenant/{tenantId}/api-keys

Authentifizierung: Organisationsbezogener API-Schlüssel · read Geltungsbereich

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	Zeichenfolge	Pfad	Ja	Format: uuid
limit	Ganzzahl	Abfrage	Nein	Maximale Anzahl der zurückzugebenden Einträge
offset	Ganzzahl	Abfrage	Nein	Anzahl der zu überspringenden Einträge

Antwort (200):

Liste der API-Schlüssel

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"tenantId": "00000000-0000-0000-0000-000000000000",
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"displayName": "string",
		"partialKey": "string",
		"enabled": true,
		"createdAt": "2024-03-15T16:30:00Z",
		"lastUsedAt": "2024-03-15T16:30:00Z",
		"expiresAt": "2024-03-15T16:30:00Z",
		"scope": {
			"read": true,
			"write": true,
			"uploadData": true,
			"sessions": true
		}
	}
]

Fehler:

• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 403 Dem API-Schlüssel fehlt der erforderliche Geltungsbereich oder der Zugriff auf die Organisation, der Mandant ist inaktiv oder der Tarif lässt den Dateityp nicht zu

Mandantenbezogenen API-Schlüssel erstellen

Erfordert einen organisationsbezogenen API-Schlüssel mit Schreibberechtigung. Das Geheimnis wird serverseitig erstellt und genau einmal in der Antwort zurückgegeben. Bewahren Sie es sicher auf. Gespeichert wird nur sein Hash.

Endpunkt: POST /v1/tenant/{tenantId}/api-keys

Authentifizierung: Organisationsbezogener API-Schlüssel · write Geltungsbereich

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	Zeichenfolge	Pfad	Ja	Format: uuid

Anforderungstext:

{
	"displayName": "string",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	},
	"enabled": true,
	"expiresAt": "2024-03-15T16:30:00Z"
}

Feld	Typ	Erforderlich	Beschreibung
displayName	Zeichenfolge	Ja	Maximale Länge: 128
scope	Objekt	Nein
enabled	boolesch	Nein
expiresAt	Zeichenfolge	Nein	Format: date-time

Antwort (201):

API-Schlüssel erstellt (enthält das einmalig zurückgegebene Geheimnis)

{
	"id": "00000000-0000-0000-0000-000000000000",
	"tenantId": "00000000-0000-0000-0000-000000000000",
	"organizationId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"partialKey": "string",
	"enabled": true,
	"createdAt": "2024-03-15T16:30:00Z",
	"lastUsedAt": "2024-03-15T16:30:00Z",
	"expiresAt": "2024-03-15T16:30:00Z",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	},
	"secret": "string"
}

Feld	Typ	Erforderlich	Beschreibung
id	Zeichenfolge	Ja	Format: uuid
tenantId	Zeichenfolge	Ja	Format: uuid
organizationId	Zeichenfolge	Ja	Format: uuid
displayName	Zeichenfolge	Ja	Maximale Länge: 128
partialKey	Zeichenfolge	Ja	Maximale Länge: 128
enabled	boolesch	Ja	Standard: true
createdAt	Zeichenfolge	Ja	Format: date-time
lastUsedAt	Zeichenfolge	Ja	Format: date-time
expiresAt	Zeichenfolge	Ja	Format: date-time
scope	Objekt	Ja
secret	Zeichenfolge	Ja	Maximale Länge: 128

Fehler:

• 400 Ungültige Anfrage, zum Beispiel durch einen ungültigen Filterausdruck, einen Prozess ohne Modell, einen nicht unterstützten Upload-Typ oder ein fehlendes Pflichtfeld
• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 403 Dem API-Schlüssel fehlt der erforderliche Geltungsbereich oder der Zugriff auf die Organisation, der Mandant ist inaktiv oder der Tarif lässt den Dateityp nicht zu

Mandantenbezogenen API-Schlüssel aktualisieren

Erfordert einen organisationsbezogenen API-Schlüssel mit Schreibberechtigung. Die Felder des Geltungsbereichs werden mit dem gespeicherten Geltungsbereich zusammengeführt.

Endpunkt: PUT /v1/tenant/{tenantId}/api-keys/{keyId}

Authentifizierung: Organisationsbezogener API-Schlüssel · write Geltungsbereich

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	Zeichenfolge	Pfad	Ja	Format: uuid
keyId	Zeichenfolge	Pfad	Ja	Format: uuid

Anforderungstext:

{
	"displayName": "string",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	},
	"enabled": true,
	"expiresAt": "2024-03-15T16:30:00Z"
}

Feld	Typ	Erforderlich	Beschreibung
displayName	Zeichenfolge	Nein	Maximale Länge: 128
scope	Objekt	Nein
enabled	boolesch	Nein
expiresAt	Zeichenfolge	Nein	Format: date-time

Antwort (200):

API-Schlüssel aktualisiert

{
	"id": "00000000-0000-0000-0000-000000000000",
	"tenantId": "00000000-0000-0000-0000-000000000000",
	"organizationId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"partialKey": "string",
	"enabled": true,
	"createdAt": "2024-03-15T16:30:00Z",
	"lastUsedAt": "2024-03-15T16:30:00Z",
	"expiresAt": "2024-03-15T16:30:00Z",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	}
}

Feld	Typ	Erforderlich	Beschreibung
id	Zeichenfolge	Ja	Format: uuid
tenantId	Zeichenfolge	Ja	Format: uuid
organizationId	Zeichenfolge	Ja	Format: uuid
displayName	Zeichenfolge	Ja	Maximale Länge: 128
partialKey	Zeichenfolge	Ja	Maximale Länge: 128
enabled	boolesch	Ja	Standard: true
createdAt	Zeichenfolge	Ja	Format: date-time
lastUsedAt	Zeichenfolge	Ja	Format: date-time
expiresAt	Zeichenfolge	Ja	Format: date-time
scope	Objekt	Ja

Fehler:

• 400 Ungültige Anfrage, zum Beispiel durch einen ungültigen Filterausdruck, einen Prozess ohne Modell, einen nicht unterstützten Upload-Typ oder ein fehlendes Pflichtfeld
• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 403 Dem API-Schlüssel fehlt der erforderliche Geltungsbereich oder der Zugriff auf die Organisation, der Mandant ist inaktiv oder der Tarif lässt den Dateityp nicht zu
• 404 Ressource nicht gefunden

Mandantenbezogenen API-Schlüssel löschen

Erfordert einen organisationsbezogenen API-Schlüssel mit Schreibberechtigung. Der Schlüssel wird logisch gelöscht und kann sofort nicht mehr zur Authentifizierung verwendet werden.

Endpunkt: DELETE /v1/tenant/{tenantId}/api-keys/{keyId}

Authentifizierung: Organisationsbezogener API-Schlüssel · write Geltungsbereich

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	Zeichenfolge	Pfad	Ja	Format: uuid
keyId	Zeichenfolge	Pfad	Ja	Format: uuid

Antwort (200):

API-Schlüssel gelöscht

{
	"message": "string"
}

Feld	Typ	Erforderlich	Beschreibung
message	Zeichenfolge	Ja

Fehler:

• 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
• 403 Dem API-Schlüssel fehlt der erforderliche Geltungsbereich oder der Zugriff auf die Organisation, der Mandant ist inaktiv oder der Tarif lässt den Dateityp nicht zu
• 404 Ressource nicht gefunden