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

API-Referenz: Organisationen

warning

Wenn Sie einen Mandanten löschen, werden alle zugehörigen Prozesse, Datensätze und Benutzerzuweisungen dauerhaft entfernt. Dieser Vorgang kann nicht rückgängig gemacht werden. Sie können den Mandanten, mit dem Sie sich authentifizieren, nicht löschen.

warning

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

Organisationen fassen mehrere Mandanten unter einer gemeinsamen Einheit zusammen.

Organisation des Mandanten abrufen

Der Endpunkt kann mit einem mandantenbezogenen API-Schlüssel gelesen werden. Ein organisationsbezogener Schlüssel wird ebenfalls akzeptiert.

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

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

Parameter:

Name Typ Speicherort 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 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
  • 404 Ressource nicht gefunden

Lizenzplatzkapazität und automatische Synchronisierungsrichtlinie der Organisation abrufen

Gibt die organisationsweiten Werte für erworbene und belegte Lizenzplätze je Tarifstufe (Process Foundation, Process Architecture, Process Intelligence), das Kontingent für kostenlose Viewer, das Ziel der automatischen Synchronisierung, Erläuterungen zu Abweichungen bei Lizenzplätzen (was die Engine wann ausführt), das Abrechnungsintervall und die externalApiSeatPolicy zurück. Mit einem mandantenbezogenen API-Schlüssel lesbar. Der Pfadparameter {tenantId} bezeichnet den Kontextmandanten (die Organisation des organisationsbezogenen Schlüssels), nicht das Ziel des Vorgangs.

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

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

Parameter:

Name Typ Speicherort 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 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
  • 404 Ressource nicht gefunden

Organisationsweite Statistiken abrufen

Der Pfadparameter {tenantId} bezeichnet den Kontextmandanten (die Organisation des organisationsbezogenen Schlüssels), nicht das Ziel des Vorgangs.

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

Authentifizierung: Organisationsbezogener API-Schlüssel · Geltungsbereich read

Parameter:

Name Typ Speicherort 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 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen

Alle Mandanten der Organisation auflisten

Der Pfadparameter {tenantId} bezeichnet den Kontextmandanten (die Organisation des organisationsbezogenen Schlüssels), nicht das Ziel des Vorgangs.

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

Authentifizierung: Organisationsbezogener API-Schlüssel · Geltungsbereich read

Parameter:

Name Typ Speicherort Erforderlich Beschreibung
tenantId string Pfad Ja Format: uuid
limit integer Abfrage Nein Maximale Anzahl der zurückzugebenden Elemente
offset integer Abfrage Nein Anzahl der zu überspringenden Elemente

Antwort (200):

Liste der Mandanten

[
	{
		"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 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen

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

Der Pfadparameter {tenantId} bezeichnet den Kontextmandanten (die Organisation des organisationsbezogenen Schlüssels), nicht das Ziel des Vorgangs.

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

Authentifizierung: API-Schlüssel mit Organisationszugriff · write-Berechtigungsumfang

Parameter:

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

Anfragekörper:

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

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 Zeichenfolge Ja Format: uuid
createdBy Zeichenfolge Ja Format: uuid
createdAt Zeichenfolge Ja Format: date-time
displayName Zeichenfolge Ja Standard: ""
Maximale Länge: 128
contactEmail Zeichenfolge Ja Format: email
isActive boolesch Ja Standard: true
shortName Zeichenfolge Ja
useOrganizationTheme boolesch Ja Standard: true
description Zeichenfolge Ja Maximale Länge: 200
organizationId Zeichenfolge Ja Format: uuid
allowedLogins Objekt Ja
url Zeichenfolge Ja Format: uri

Fehler:

  • 400 Ungültige Anfrage, z. B. ungültiger Filterausdruck, Prozess ohne Modell, nicht unterstützter Upload-Typ oder fehlendes Pflichtfeld
  • 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
  • 403 Dem API-Schlüssel fehlt der erforderliche Berechtigungsumfang oder Organisationszugriff, der Mandant ist inaktiv oder der Tarif lässt den Dateityp nicht zu
  • 406 Der Wert kann nicht akzeptiert werden, z. B. weil der Kurzname reserviert oder bereits vergeben ist

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

Der API-Zugriff auf den Mandanten wird sofort beendet. Der Mandant und seine Daten bleiben während der Sicherheitsfrist für die Löschung erhalten. Anschließend werden sie automatisch endgültig gelöscht. Der Mandant, den Sie aktuell verwenden (Kontextmandant), kann nicht gelöscht werden.

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

Authentifizierung: API-Schlüssel mit Organisationszugriff · write-Berechtigungsumfang

Parameter:

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

Antwort (200):

Mandant gelöscht

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

Fehler:

  • 400 Ungültige Anfrage, z. B. ungültiger Filterausdruck, Prozess ohne Modell, nicht unterstützter Upload-Typ oder fehlendes Pflichtfeld
  • 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
  • 403 Dem API-Schlüssel fehlt der erforderliche Berechtigungsumfang oder Organisationszugriff, der Mandant ist inaktiv oder der Tarif lässt den Dateityp nicht zu
  • 404 Ressource nicht gefunden

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

Machen Sie die vorläufige Löschung innerhalb der Sicherheitsfrist rückgängig: Der Mandant und seine Daten werden unverändert wiederhergestellt und der API-Zugriff wird fortgesetzt. Der Pfadparameter {tenantId} bezeichnet den Kontextmandanten (die Organisation des organisationsbezogenen Schlüssels), nicht das Ziel des Vorgangs.

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

Authentifizierung: API-Schlüssel mit Organisationszugriff · write-Berechtigungsumfang

Parameter:

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

Antwort (200):

Mandant wiederhergestellt

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

Fehler:

  • 400 Ungültige Anfrage, z. B. ungültiger Filterausdruck, Prozess ohne Modell, nicht unterstützter Upload-Typ oder fehlendes Pflichtfeld
  • 401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
  • 403 Dem API-Schlüssel fehlt der erforderliche Berechtigungsumfang oder Organisationszugriff, der Mandant ist inaktiv oder der Tarif lässt den Dateityp nicht zu
  • 404 Ressource nicht gefunden

Alle Benutzer der Organisation auflisten

Der Pfadparameter {tenantId} bezeichnet den Kontextmandanten (die Organisation des organisationsbezogenen Schlüssels), nicht das Ziel des Vorgangs.

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

Authentifizierung: API-Schlüssel mit Organisationszugriff · read-Berechtigungsumfang

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 Benutzer der Organisation

[
	{
		"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 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen

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

Die Rollenflags im Anfragekörper (isAdminInOrganization, isActiveInOrganization) werden unverändert übernommen. Geben Sie API-Schlüssel mit Organisationszugriff nur an Organisationsadministratoren aus. Der Pfadparameter {tenantId} bezeichnet den Kontextmandanten (die Organisation des organisationsbezogenen Schlüssels), nicht das Ziel des Vorgangs.

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

Authentifizierung: API-Schlüssel mit Organisationszugriff · write-Berechtigungsumfang

Parameter:

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

Anfragekörper:

{
	"isActiveInOrganization": true,
	"isAdminInOrganization": true
}
Feld Typ Erforderlich Beschreibung
isActiveInOrganization boolesch Nein Gibt an, ob der Benutzer in der Organisation aktiv ist
isAdminInOrganization boolesch Nein Administratorrechte in der Organisation (werden unverändert übernommen: Organisationszugriffsschlüssel nur an Organisationsadministratoren ausgeben)

Antwort (200):

Aktualisiert

{
	"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 Berechtigungsumfang oder Organisationszugriff, der Mandant ist inaktiv oder der Tarif lässt den Dateityp nicht zu
  • 404 Ressource nicht gefunden

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

Der Pfadparameter {tenantId} bezeichnet den Kontextmandanten (die Organisation des organisationsbezogenen Schlüssels), nicht das Ziel des Vorgangs.

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

Authentifizierung: API-Schlüssel mit Organisationszugriff · write-Berechtigungsumfang

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:

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

Zugehörige Dokumentation