Na této stránce
> zdroje > dokumentace > api > Dokumentace API: tenanti

Dokumentace API: tenanti

Získat informace o tenantovi

Endpoint: GET /v1/tenant/{tenantId}

Ověření: API key s rozsahem tenanta · rozsah read

Parametry:

Název Typ Umístění Povinné Popis
tenantId string cesta Ano Formát: uuid

Odpověď (200):

Podrobnosti o tenantovi

{
	"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
	},
	"tenantType": "normal",
	"url": "string"
}
Pole Typ Povinné Popis
id string Ano Formát: uuid
createdBy string Ano Formát: uuid
createdAt string Ano Formát: date-time
displayName string Ano Výchozí hodnota: ""
Maximální délka: 128
contactEmail string Ano Formát: email
isActive boolean Ano Výchozí hodnota: true
shortName string Ano
useOrganizationTheme boolean Ano Výchozí hodnota: true
description string Ano Maximální délka: 200
organizationId string Ano Formát: uuid
allowedLogins object Ano
tenantType normal | sandbox | demo Ano Povolené hodnoty: normal, sandbox, demo
Výchozí hodnota: normal
url string Ano Formát: uri

Chyby:

  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API key
  • 404 Zdroj nebyl nalezen

Aktualizovat nastavení tenanta

Endpoint: PUT /v1/tenant/{tenantId}

Ověření: API key s rozsahem tenanta · rozsah write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string cesta Ano Formát: uuid

Tělo požadavku:

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"contactEmail": "string",
	"shortName": "string",
	"description": "string"
}
Pole Typ Povinné Popis
id string Ne Formát: uuid
displayName string Ne
contactEmail string Ne
shortName string Ne
description string Ne

Odpověď (200):

Aktualizovaný tenant

{
	"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
	},
	"tenantType": "normal",
	"url": "string"
}
Pole Typ Povinné Popis
id string Ano Formát: uuid
createdBy string Ano Formát: uuid
createdAt string Ano Formát: date-time
displayName string Ano Výchozí hodnota: ""
Maximální délka: 128
contactEmail string Ano Formát: email
isActive boolean Ano Výchozí hodnota: true
shortName string Ano
useOrganizationTheme boolean Ano Výchozí hodnota: true
description string Ano Maximální délka: 200
organizationId string Ano Formát: uuid
allowedLogins object Ano
tenantType normal | sandbox | demo Ano Povolené hodnoty: normal, sandbox, demo
Výchozí hodnota: normal
url string Ano Formát: uri

Chyby:

  • 400 Chybný požadavek, například neplatný výraz filtru, proces bez modelu, nepodporovaný typ nahrávaného souboru nebo chybějící povinné pole
  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API key
  • 403 API key nemá požadovaný rozsah nebo přístup k organizaci, tenant je neaktivní nebo tarif nepovoluje daný typ souboru
  • 406 Hodnotu nelze přijmout, například jde o rezervovaný nebo duplicitní krátký název

Získat statistiky tenanta (objem dat, modely, simulace, uživatelé)

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

Ověření: API key s rozsahem tenanta · rozsah read

Parametry:

Název Typ Umístění Povinné Popis
tenantId string cesta Ano Formát: uuid

Odpověď (200):

Statistiky tenanta

{
	"tenantId": "00000000-0000-0000-0000-000000000000",
	"uploadedDataSize": 0,
	"uploadedDataCount": 0,
	"modelCount": 0,
	"simulationCount": 0,
	"userCount": 0
}
Pole Typ Povinné Popis
tenantId string Ano Formát: uuid
uploadedDataSize number Ano
uploadedDataCount number Ano
modelCount number Ano
simulationCount number Ano
userCount number Ano

Chyby:

  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API key
  • 404 Zdroj nebyl nalezen

Zobrazit uživatele tenanta

Vrátí odpovídající uživatele jako prosté pole JSON. Celkový počet se nevrací. Stránkujte pomocí limit/offset.

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

Ověření: API key s rozsahem tenanta · rozsah read

Parametry:

Název Typ Umístění Povinné Popis
tenantId string cesta Ano Formát: uuid
limit integer dotaz Ne Maximální počet vrácených položek
offset integer dotaz Ne Počet přeskočených položek

Odpověď (200):

Seznam uživatelů

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

Chyby:

  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API key

Přidat uživatele do tenanta (e-mail s pozvánkou se neodesílá)

Hodnoty rolí v těle požadavku (isAdminInTenant, access: none|portalViewer|designer|architect|intelligence, isDashboardViewer) se použijí přesně tak, jak jsou zadány. Tento endpoint poskytuje úplnou správu tenanta, proto jej zpřístupňujte pouze důvěryhodným volajícím pomocí API key s oprávněním k zápisu. Zobrazení dashboardu určuje booleovské pole isDashboardViewer. Dřívější úroveň přístupu pouze pro čtení byla odstraněna.

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

Ověření: API key s rozsahem tenanta · rozsah write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string cesta Ano Formát: uuid

Tělo požadavku:

{
	"email": "string",
	"firstName": "string",
	"lastName": "string",
	"isActiveInTenant": true,
	"isAdminInTenant": true,
	"access": "none",
	"isDashboardViewer": true,
	"preferredLocale": "en"
}
Pole Typ Povinné Popis
email string Ano E-mailová adresa uživatele (slouží také jako přihlašovací identita)
Formát: email
firstName string Ne Jméno uživatele, nepovinné
Maximální délka: 64
lastName string Ne Příjmení uživatele, nepovinné
Maximální délka: 64
isActiveInTenant boolean Ne Určuje, zda je uživatel v tomto Tenant aktivní
isAdminInTenant boolean Ne Administrátorská oprávnění v tomto Tenant (v plném rozsahu správce Tenant)
access none | portalViewer | designer | architect | intelligence Ne Jedna licence: none | portalViewer | designer | architect | intelligence
Povolené hodnoty: none, portalViewer, designer, architect, intelligence
isDashboardViewer boolean Ne Určuje, zda má uživatel přístup k dashboardu pouze pro čtení
preferredLocale en | zh | es | fr | de | pt | it | nl | ja | tr | pl | cs | hu | id | ko | vi | th Ne Preferovaný jazyk rozhraní uživatele
Povolené hodnoty: en, zh, es, fr, de, pt, it, nl, ja, tr, pl, cs, hu, id, ko, vi, th

Odpověď (201):

Uživatel byl přidán

{
	"id": "string",
	"message": "string"
}
Pole Typ Povinné Popis
id string Ano ID nově přidaného uživatele
message string Ano

Chyby:

  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API key
  • 409 Požadavek je v rozporu s aktuálním stavem, například kvůli limitu licencí nebo opakovanému použití ID

Aktualizovat nastavení uživatele v tenantovi

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

Ověření: API key s rozsahem tenanta · rozsah write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string cesta Ano Formát: uuid
userId string cesta Ano Formát: uuid

Tělo požadavku:

{
	"isActiveInTenant": true,
	"isAdminInTenant": true,
	"access": "none",
	"isDashboardViewer": true
}
Pole Typ Povinné Popis
isActiveInTenant boolean Ne Zda je uživatel v tomto tenantovi aktivní
isAdminInTenant boolean Ne Administrátorská oprávnění v tomto tenantovi (použijí se přesně tak, jak jsou zadána: úplná správa tenanta)
access none | portalViewer | designer | architect | intelligence Ne Licence s výběrem jedné možnosti: none | portalViewer | designer | architect | intelligence. Zobrazení dashboardu určuje booleovské pole isDashboardViewer.
Povolené hodnoty: none, portalViewer, designer, architect, intelligence
isDashboardViewer boolean Ne Zda má uživatel přístup k dashboardu pouze pro čtení

Odpověď (200):

Aktualizováno

{
	"message": "string"
}
Pole Typ Povinné Popis
message string Ano

Chyby:

  • 400 Chybný požadavek, například neplatný výraz filtru, proces bez modelu, nepodporovaný typ nahrávaného souboru nebo chybějící povinné pole
  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API key
  • 404 Zdroj nebyl nalezen

Odebrat uživatele z tenanta

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

Ověření: API key s rozsahem tenanta · rozsah write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string cesta Ano Formát: uuid
userId string cesta Ano Formát: uuid

Odpověď (200):

Uživatel byl odebrán

{
	"message": "string"
}
Pole Typ Povinné Popis
message string Ano

Chyby:

  • 400 Chybný požadavek, například neplatný výraz filtru, proces bez modelu, nepodporovaný typ nahrávaného souboru nebo chybějící povinné pole
  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API key
  • 404 Zdroj nebyl nalezen

Vygenerovat jednorázový předávací token pro přihlášení uživatele

Vrátí jednorázový token s platností 60 sekund, který je svázán s uživatelem, tenantem a organizací, a také url, na kterou má prohlížeč uživatele přejít. Otevřete URL v prohlížeči uživatele. Uživatel se dostane do ProcessMind již ověřený: bez e-mailového odkazu a bez přihlášení jeho jménem, získá vlastní relaci. API key musí mít vyhrazený rozsah sessions: klíč s rozsahem organizace může token vytvořit pro libovolný tenant dané organizace, klíč s rozsahem tenanta pouze pro uživatele vlastního tenanta. S tokenem zacházejte jako s heslem: vrátí se pouze jednou, nikdy se nezapisuje do logu a jeho platnost lze zrušit deaktivací klíče nebo uživatele.

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

Ověření: API key s rozsahem tenanta nebo organizace · rozsah sessions · limit 2 požadavky/s (nárazově 4)

Parametry:

Název Typ Umístění Povinné Popis
tenantId string cesta Ano Formát: uuid
userId string cesta Ano Formát: uuid

Tělo požadavku:

Volitelná cílová cesta (relativní cesta v aplikaci, například “app” nebo “app/dashboards”)

{
	"path": "string"
}
Pole Typ Povinné Popis
path string Ne Maximální délka: 512

Odpověď (200):

Předávací token pro přihlášení

{
	"token": "string",
	"url": "string",
	"expiresInSeconds": 0,
	"expiresAt": "2024-03-15T16:30:00Z"
}
Pole Typ Povinné Popis
token string Ano
url string Ano
expiresInSeconds number Ano
expiresAt string Ano Formát: date-time

Chyby:

  • 400 Chybný požadavek, například neplatný výraz filtru, proces bez modelu, nepodporovaný typ nahrávaného souboru nebo chybějící povinné pole
  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API key
  • 403 API key nemá požadovaný rozsah nebo přístup k organizaci, tenant je neaktivní nebo tarif nepovoluje daný typ souboru
  • 404 Zdroj nebyl nalezen
  • 429 Překročen limit požadavků: viz limit uvedený u endpointu

API keys slouží k ověřování vašich integrací. API keys s rozsahem organizace mohou vytvářet a spravovat klíče libovolného tenanta v organizaci.

Zobrazit API keys tenanta

Vyžaduje API key s rozsahem organizace. Tajný klíč se nikdy nevrací.

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

Ověření: API key s rozsahem organizace · rozsah read

Parametry:

Název Typ Umístění Povinné Popis
tenantId string cesta Ano Formát: uuid
limit integer dotaz Ne Maximální počet vrácených položek
offset integer dotaz Ne Počet přeskočených položek

Odpověď (200):

Seznam API keys

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

Chyby:

  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API key
  • 403 API key nemá požadovaný rozsah nebo přístup k organizaci, tenant je neaktivní nebo tarif nepovoluje daný typ souboru

Vytvořit API key s rozsahem tenanta

Vyžaduje API key s rozsahem organizace a oprávněním k zápisu . Tajný klíč se vygeneruje na serveru a v odpovědi se vrátí pouze jednou. Bezpečně jej uložte. Uchovává se pouze jeho hash.

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

Ověření: API key s rozsahem organizace · rozsah write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string cesta Ano Formát: uuid

Tělo požadavku:

{
	"displayName": "string",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	},
	"enabled": true,
	"expiresAt": "2024-03-15T16:30:00Z"
}
Pole Typ Povinné Popis
displayName string Ano Maximální délka: 128
scope object Ne
enabled boolean Ne
expiresAt string Ne Formát: date-time

Odpověď (201):

API key byl vytvořen (obsahuje jednorázový tajný klíč)

{
	"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"
}
Pole Typ Povinné Popis
id string Ano Formát: uuid
tenantId string Ano Formát: uuid
organizationId string Ano Formát: uuid
displayName string Ano Maximální délka: 128
partialKey string Ano Maximální délka: 128
enabled boolean Ano Výchozí hodnota: true
createdAt string Ano Formát: date-time
lastUsedAt string Ano Formát: date-time
expiresAt string Ano Formát: date-time
scope object Ano
secret string Ano Maximální délka: 128

Chyby:

  • 400 Chybný požadavek, například neplatný výraz filtru, proces bez modelu, nepodporovaný typ nahrávaného souboru nebo chybějící povinné pole
  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API key
  • 403 API key nemá požadovaný rozsah nebo přístup k organizaci, tenant je neaktivní nebo tarif nepovoluje daný typ souboru

Aktualizovat API key s rozsahem tenanta

Vyžaduje API key s rozsahem organizace a oprávněním k zápisu . Pole scope se sloučí s uloženým scope.

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

Ověření: API key s rozsahem organizace · rozsah write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string cesta Ano Formát: uuid
keyId string cesta Ano Formát: uuid

Tělo požadavku:

{
	"displayName": "string",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	},
	"enabled": true,
	"expiresAt": "2024-03-15T16:30:00Z"
}
Pole Typ Povinné Popis
displayName string Ne Maximální délka: 128
scope object Ne
enabled boolean Ne
expiresAt string Ne Formát: date-time

Odpověď (200):

API key byl aktualizován

{
	"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
	}
}
Pole Typ Povinné Popis
id string Ano Formát: uuid
tenantId string Ano Formát: uuid
organizationId string Ano Formát: uuid
displayName string Ano Maximální délka: 128
partialKey string Ano Maximální délka: 128
enabled boolean Ano Výchozí hodnota: true
createdAt string Ano Formát: date-time
lastUsedAt string Ano Formát: date-time
expiresAt string Ano Formát: date-time
scope object Ano

Chyby:

  • 400 Chybný požadavek, například neplatný výraz filtru, proces bez modelu, nepodporovaný typ nahrávaného souboru nebo chybějící povinné pole
  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API key
  • 403 API key nemá požadovaný rozsah nebo přístup k organizaci, tenant je neaktivní nebo tarif nepovoluje daný typ souboru
  • 404 Zdroj nebyl nalezen

Odstranit API key s rozsahem tenanta

Vyžaduje API key s rozsahem organizace a oprávněním k zápisu . Klíč se odstraní logicky a okamžitě přestane sloužit k ověřování.

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

Ověření: API key s rozsahem organizace · rozsah write

Parametry:

Název Typ Umístění Povinné Popis
tenantId string cesta Ano Formát: uuid
keyId string cesta Ano Formát: uuid

Odpověď (200):

API key byl odstraněn

{
	"message": "string"
}
Pole Typ Povinné Popis
message string Ano

Chyby:

  • 401 Chybějící, neplatný, deaktivovaný nebo prošlý API key
  • 403 API key nemá požadovaný rozsah nebo přístup k organizaci, tenant je neaktivní nebo tarif nepovoluje daný typ souboru
  • 404 Zdroj nebyl nalezen

Související dokumentace

Navrhujte lepší procesy. Propojte je do společné architektury. Mějte vše pod kontrolou.

Získejte přístup ihned, bez čekání a bez platební karty. Převádějte způsob práce ve své organizaci do přehledných a propojených návrhů procesů.

Vytvořte architekturu procesů, určete vlastníky a kontrolní mechanismy a slaďte role a odpovědnosti na všech úrovních.

Spusťte zkušební verzi a vytvořte spolehlivý základ pro řízení, správu a průběžné zlepšování procesů.

Získejte zkušební verzi zdarma