Auf dieser Seite
> ressourcen > dokumentation > api > API Referenz: Organisationen

API-Referenz: Organisationen

warning

Beim Löschen eines Mandanten werden alle zugehörigen Prozesse, Datensätze und Benutzerzuweisungen dauerhaft entfernt. Diese Aktion kann nicht rückgängig gemacht werden. Der Mandant, den Sie zur Authentifizierung verwenden, kann nicht gelöscht werden.

warning

Wenn Sie einen Benutzer aus der Organisation entfernen, verliert er den Zugriff auf alle Mandanten innerhalb der Organisation.

Organisationen fassen mehrere Mandanten unter einer gemeinsamen Einheit zusammen.

Organisation des Mandanten abrufen

Lesender Zugriff ist mit einem mandantenbezogenen API-Schlüssel möglich. Ein organisationsbezogener Schlüssel wird ebenfalls akzeptiert.

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

Authentifizierung: Mandanten- oder organisationsbezogener API-Schlüssel · read-Bereich

Parameter:

Name Typ Ort Erforderlich Beschreibung
tenantId string Pfad Ja Format: uuid

Antwort (200):

Organisationsdetails

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"contactEmail": "string",
	"isActive": true,
	"allowedLogins": {
		"Microsoft": true,
		"Google": true,
		"LinkedIn": true
	},
	"createdBy": "00000000-0000-0000-0000-000000000000"
}
Feld Typ Erforderlich Beschreibung
id string Ja Format: uuid
displayName string Ja Standard: ""
Maximale Länge: 128
createdAt string Ja Format: date-time
contactEmail string Ja Format: email
isActive boolean Ja Standard: true
allowedLogins object Ja
createdBy string Ja Format: uuid

Fehler:

  • 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
  • 404 Ressource nicht gefunden

Lizenzplatzkapazität und automatische Synchronisierungsrichtlinie der Organisation abrufen

Gibt die organisationsweit gekauften und verwendeten Sitzplätze je Stufe zurück, nämlich Prozessgrundlage, Prozessarchitektur und Process Intelligence, außerdem das Kontingent für kostenlose Viewer, das Ziel für die automatische Synchronisierung, die Erläuterung zur Sitzplatzabweichung, das Abrechnungsintervall und die externalApiSeatPolicy. Lesbar mit einem API-Schlüssel mit Mandantenbereich. Der Pfadparameter {tenantId} bezeichnet den Kontextmandanten, also die Organisation des organisationsbezogenen Schlüssels, nicht das Ziel der Operation.

Endpunkt: GET /v1/tenant/{tenantId}/organization/billing/seats

Authentifizierung: Mandanten- oder organisationsbezogener API-Schlüssel · read-Bereich

Parameter:

Name Typ Ort Erforderlich Beschreibung
tenantId string Pfad Ja Format: uuid

Antwort (200):

Lizenzplatzkapazität

{
	"contractType": "free",
	"isTrial": true,
	"purchased": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"inUseBillable": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"inUseFree": 0,
	"totalBillable": 0,
	"freeViewerAllowance": 0,
	"freeViewerOverAllowance": 0,
	"fixedOverage": 0,
	"target": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"drift": [
		{
			"rung": "foundation",
			"paid": 0,
			"actual": 0,
			"state": "equal",
			"buffer": 0
		}
	],
	"interval": "month",
	"nextBilledAt": "string",
	"externalApiSeatPolicy": "autoBill"
}
Feld Typ Erforderlich Beschreibung
contractType free | selfServe | fixed | unlimited Ja Zulässige Werte: free, selfServe, fixed, unlimited
isTrial boolean Ja
purchased object Ja
inUseBillable object Ja
inUseFree number Ja
totalBillable number Ja
freeViewerAllowance number Ja
freeViewerOverAllowance number Ja
fixedOverage number Ja
target object Ja
drift object[] Ja
interval month | year Ja Zulässige Werte: month, year
nextBilledAt string Ja
externalApiSeatPolicy autoBill | requireCapacity Ja Zulässige Werte: autoBill, requireCapacity

Fehler:

  • 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
  • 404 Ressource nicht gefunden

Organisationsweite Statistiken abrufen

Der Pfadparameter {tenantId} bezeichnet den Kontextmandanten, also die Organisation des organisationsbezogenen Schlüssels, nicht das Ziel der Operation.

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

Authentifizierung: Organisationsbezogener API-Schlüssel · read-Bereich

Parameter:

Name Typ Ort Erforderlich Beschreibung
tenantId string Pfad Ja Format: uuid

Antwort (200):

Organisationsstatistiken

{
	"userCount": 0,
	"tenantCount": 0,
	"tenantStatistics": [
		{
			"tenantId": "00000000-0000-0000-0000-000000000000",
			"uploadedDataSize": 0,
			"uploadedDataCount": 0,
			"modelCount": 0,
			"simulationCount": 0,
			"userCount": 0
		}
	]
}
Feld Typ Erforderlich Beschreibung
userCount number Ja
tenantCount number Ja
tenantStatistics object[] Ja

Fehler:

  • 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel

Alle Mandanten der Organisation auflisten

Der Pfadparameter {tenantId} bezeichnet den Kontextmandanten, also die Organisation des organisationsbezogenen Schlüssels, nicht das Ziel der Operation.

Endpunkt: GET /v1/tenant/{tenantId}/organization/tenants

Authentifizierung: Organisationsbezogener API-Schlüssel · read-Bereich

Parameter:

Name Typ Ort Erforderlich Beschreibung
tenantId string Pfad Ja Format: uuid
limit integer Abfrage Nein Maximale Anzahl zurückzugebender Elemente
offset integer Abfrage Nein Anzahl zu überspringender Elemente

Antwort (200):

Mandantenliste

[
	{
		"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"
	}
]

Fehler:

  • 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel

Neuen Mandanten in der Organisation erstellen (erfordert einen organisationsbezogenen API-Schlüssel)

Der Pfadparameter {tenantId} bezeichnet den Kontextmandanten, also die Organisation des organisationsbezogenen Schlüssels, nicht das Ziel der Operation.

Endpunkt: POST /v1/tenant/{tenantId}/organization/tenants

Authentifizierung: Organisationsbezogener API-Schlüssel · write-Bereich

Parameter:

Name Typ Ort Erforderlich Beschreibung
tenantId string Pfad Ja Format: uuid

Request-Body:

{
	"displayName": "string",
	"shortName": "string",
	"description": "string"
}
Feld Typ Erforderlich Beschreibung
displayName string Nein Maximale Länge: 128
shortName string Ja
description string Nein Maximale Länge: 200

Antwort (201):

Mandant erstellt

{
	"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 ein ungültiger Filterausdruck, ein Prozess ohne Modell, ein nicht unterstützter Upload-Typ oder ein fehlendes Pflichtfeld
  • 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
  • 403 Dem API-Schlüssel fehlt der erforderliche Bereich oder der Organisationszugriff, der Mandant ist inaktiv oder der Tarif blockiert den Dateityp
  • 406 Der Wert kann nicht akzeptiert werden, zum Beispiel wegen eines reservierten oder bereits vergebenen Kurznamen

Mandanten in der Organisation vorläufig löschen (erfordert einen organisationsbezogenen API-Schlüssel)

Der API-Zugriff für den Mandanten endet sofort. Der Mandant und seine Daten bleiben während des Sicherheitszeitraums für die Löschung erhalten und werden anschließend durch die automatisierte vollständige Löschung entfernt. Der Mandant, den Sie aktuell verwenden, also der Kontextmandant, kann nicht gelöscht werden.

Endpunkt: DELETE /v1/tenant/{tenantId}/organization/tenants/{targetId}

Authentifizierung: Organisationsbezogener API-Schlüssel · write-Bereich

Parameter:

Name Typ Ort Erforderlich Beschreibung
tenantId string Pfad Ja Format: uuid
targetId string Pfad Ja Format: uuid

Antwort (200):

Mandant gelöscht

{
	"success": true,
	"message": "string"
}
Feld Typ Erforderlich Beschreibung
success boolean Ja
message string Ja

Fehler:

  • 400 Ungültige Anfrage, zum Beispiel ein ungültiger Filterausdruck, ein Prozess ohne Modell, ein nicht unterstützter Upload-Typ oder ein fehlendes Pflichtfeld
  • 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
  • 403 Dem API-Schlüssel fehlt der erforderliche Bereich oder der Organisationszugriff, der Mandant ist inaktiv oder der Tarif blockiert den Dateityp
  • 404 Ressource nicht gefunden

Vorläufig gelöschten Mandanten in der Organisation wiederherstellen (erfordert einen organisationsbezogenen API-Schlüssel)

Machen Sie eine vorläufige Löschung innerhalb des Sicherheitszeitraums rückgängig: Der Mandant und seine Daten werden exakt im vorherigen Zustand wiederhergestellt, und der API-Zugriff wird fortgesetzt. Der Pfadparameter {tenantId} bezeichnet den Kontextmandanten, also die Organisation des organisationsbezogenen Schlüssels, nicht das Ziel der Operation.

Endpunkt: POST /v1/tenant/{tenantId}/organization/tenants/{targetId}/restore

Authentifizierung: Organisationsbezogener API-Schlüssel · write-Bereich

Parameter:

Name Typ Ort Erforderlich Beschreibung
tenantId string Pfad Ja Format: uuid
targetId string Pfad Ja Format: uuid

Antwort (200):

Mandant wiederhergestellt

{
	"success": true,
	"message": "string"
}
Feld Typ Erforderlich Beschreibung
success boolean Ja
message string Ja

Fehler:

  • 400 Ungültige Anfrage, zum Beispiel ein ungültiger Filterausdruck, ein Prozess ohne Modell, ein nicht unterstützter Upload-Typ oder ein fehlendes Pflichtfeld
  • 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
  • 403 Dem API-Schlüssel fehlt der erforderliche Bereich oder der Organisationszugriff, der Mandant ist inaktiv oder der Tarif blockiert den Dateityp
  • 404 Ressource nicht gefunden

Alle Benutzer der Organisation auflisten

Der Pfadparameter {tenantId} bezeichnet den Kontextmandanten, also die Organisation des organisationsbezogenen Schlüssels, nicht das Ziel der Operation.

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

Authentifizierung: Organisationsbezogener API-Schlüssel · read-Bereich

Parameter:

Name Typ Ort Erforderlich Beschreibung
tenantId string Pfad Ja Format: uuid
limit integer Abfrage Nein Maximale Anzahl zurückzugebender Elemente
offset integer Abfrage Nein Anzahl zu überspringender Elemente

Antwort (200):

Liste der Organisationsbenutzer

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

Fehler:

  • 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel

Einstellungen eines Organisationsbenutzers aktualisieren (erfordert einen organisationsbezogenen API-Schlüssel)

Die Rollenflags im Body (isAdminInOrganization, isActiveInOrganization) werden unverändert übernommen. Stellen Sie organisationsbezogene Schlüssel ausschließlich Organisationsadministratoren aus. Der Pfadparameter {tenantId} bezeichnet den Kontextmandanten, also die Organisation des organisationsbezogenen Schlüssels, nicht das Ziel der Operation.

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

Authentifizierung: Organisationsbezogener API-Schlüssel · write-Bereich

Parameter:

Name Typ Ort Erforderlich Beschreibung
tenantId string Pfad Ja Format: uuid
userId string Pfad Ja Format: uuid

Request-Body:

{
	"isActiveInOrganization": true,
	"isAdminInOrganization": true
}
Feld Typ Erforderlich Beschreibung
isActiveInOrganization boolean Nein Gibt an, ob der Benutzer in der Organisation aktiv ist
isAdminInOrganization boolean Nein Administratorrechte in der Organisation, werden unverändert übernommen: organisationsbezogene Schlüssel dürfen nur Organisationsadministratoren ausgestellt werden

Antwort (200):

Aktualisiert

{
	"message": "string"
}
Feld Typ Erforderlich Beschreibung
message string Ja

Fehler:

  • 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
  • 403 Dem API-Schlüssel fehlt der erforderliche Bereich oder der Organisationszugriff, der Mandant ist inaktiv oder der Tarif blockiert den Dateityp
  • 404 Ressource nicht gefunden

Benutzer aus der Organisation entfernen (erfordert einen organisationsbezogenen API-Schlüssel)

Der Pfadparameter {tenantId} bezeichnet den Kontextmandanten, also die Organisation des organisationsbezogenen Schlüssels, nicht das Ziel der Operation.

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

Authentifizierung: Organisationsbezogener API-Schlüssel · write-Bereich

Parameter:

Name Typ Ort Erforderlich Beschreibung
tenantId string Pfad Ja Format: uuid
userId string Pfad Ja Format: uuid

Antwort (200):

Benutzer entfernt

{
	"message": "string"
}
Feld Typ Erforderlich Beschreibung
message string Ja

Fehler:

  • 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
  • 403 Dem API-Schlüssel fehlt der erforderliche Bereich oder der Organisationszugriff, der Mandant ist inaktiv oder der Tarif blockiert den Dateityp
  • 404 Ressource nicht gefunden

Zugehörige Dokumentation