Ezen az oldalon
> erőforrások > dokumentáció > api > API referencia: bérlők

API-referencia: bérlők

Bérlő adatainak lekérése

Végpont: GET /v1/tenant/{tenantId}

Hitelesítés: Bérlőhöz kötött API-kulcs · read hatókör

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid

Válasz (200):

Bérlő adatai

{
	"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"
}
Mező Típus Kötelező Leírás
id string Igen Formátum: uuid
createdBy string Igen Formátum: uuid
createdAt string Igen Formátum: date-time
displayName string Igen Alapértelmezett: ""
Maximális hossz: 128
contactEmail string Igen Formátum: email
isActive boolean Igen Alapértelmezett: true
shortName string Igen
useOrganizationTheme boolean Igen Alapértelmezett: true
description string Igen Maximális hossz: 200
organizationId string Igen Formátum: uuid
allowedLogins object Igen
tenantType normal | sandbox | demo Igen Engedélyezett értékek: normal, sandbox, demo
Alapértelmezett: normal
url string Igen Formátum: uri

Hibák:

  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
  • 404 Az erőforrás nem található

Bérlő beállításainak frissítése

Végpont: PUT /v1/tenant/{tenantId}

Hitelesítés: Bérlőhöz kötött API-kulcs · write hatókör

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid

Kérés törzse:

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"contactEmail": "string",
	"shortName": "string",
	"description": "string"
}
Mező Típus Kötelező Leírás
id string Nem Formátum: uuid
displayName string Nem
contactEmail string Nem
shortName string Nem
description string Nem

Válasz (200):

Frissített bérlő

{
	"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"
}
Mező Típus Kötelező Leírás
id string Igen Formátum: uuid
createdBy string Igen Formátum: uuid
createdAt string Igen Formátum: date-time
displayName string Igen Alapértelmezett: ""
Maximális hossz: 128
contactEmail string Igen Formátum: email
isActive boolean Igen Alapértelmezett: true
shortName string Igen
useOrganizationTheme boolean Igen Alapértelmezett: true
description string Igen Maximális hossz: 200
organizationId string Igen Formátum: uuid
allowedLogins object Igen
tenantType normal | sandbox | demo Igen Engedélyezett értékek: normal, sandbox, demo
Alapértelmezett: normal
url string Igen Formátum: uri

Hibák:

  • 400 Hibás kérés: például érvénytelen szűrőkifejezés, modell nélküli folyamat, nem támogatott feltöltési típus vagy hiányzó kötelező mező
  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
  • 403 Az API-kulcs hatóköre vagy szervezeti hozzáférése nem elegendő, a bérlő inaktív, vagy a csomag nem engedélyezi ezt a fájltípust
  • 406 Az érték nem fogadható el (például foglalt vagy már használt rövid név)

Bérlői statisztikák lekérése (adatméret, modellek, szimulációk, felhasználók)

Végpont: GET /v1/tenant/{tenantId}/statistics

Hitelesítés: Bérlőhöz kötött API-kulcs · read hatókör

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid

Válasz (200):

Bérlői statisztikák

{
	"tenantId": "00000000-0000-0000-0000-000000000000",
	"uploadedDataSize": 0,
	"uploadedDataCount": 0,
	"modelCount": 0,
	"simulationCount": 0,
	"userCount": 0
}
Mező Típus Kötelező Leírás
tenantId string Igen Formátum: uuid
uploadedDataSize number Igen
uploadedDataCount number Igen
modelCount number Igen
simulationCount number Igen
userCount number Igen

Hibák:

  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
  • 404 Az erőforrás nem található

A bérlő felhasználóinak listázása

A végpont a találatoknak megfelelő felhasználókat egyszerű JSON-tömbként adja vissza. Összesített darabszám nincs; a lapozáshoz használja a limit/offset paramétereket.

Végpont: GET /v1/tenant/{tenantId}/users

Hitelesítés: Bérlőhöz kötött API-kulcs · read hatókör

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid
limit integer lekérdezés Nem A visszaadandó elemek maximális száma
offset integer lekérdezés Nem Kihagyandó elemek száma

Válasz (200):

Felhasználók listája

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

Hibák:

  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs

Felhasználó hozzáadása a bérlőhöz (nem küld meghívó e-mailt)

A kérés törzsében megadott szerepkörmezők (isAdminInTenant, access: none|portalViewer|designer|architect|intelligence, isDashboardViewer) változtatás nélkül érvényesülnek. Ez a végpont teljes körű bérlői adminisztrációt tesz lehetővé, ezért írási hatókörű kulcsot csak megbízható hívóknak adjon. A dashboard megtekintését az isDashboardViewer logikai érték szabályozza; a korábbi, csak olvasási jogosultságú viewer szintet megszüntettük.

Végpont: POST /v1/tenant/{tenantId}/users

Hitelesítés: Bérlőhöz kötött API-kulcs · write hatókör

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid

Kérés törzse:

{
	"email": "string",
	"firstName": "string",
	"lastName": "string",
	"isActiveInTenant": true,
	"isAdminInTenant": true,
	"access": "none",
	"isDashboardViewer": true,
	"preferredLocale": "en"
}
Mező Típus Kötelező Leírás
email string Igen A felhasználó e-mail-címe, amely a bejelentkezési azonosító is
Formátum: email
firstName string Nem Utónév, nem kötelező
Maximális hossz: 64
lastName string Nem Vezetéknév, nem kötelező
Maximális hossz: 64
isActiveInTenant boolean Nem Aktív-e a felhasználó ebben a Tenantben
isAdminInTenant boolean Nem Rendszergazdai jogosultságok ebben a Tenantben (változtatás nélkül érvényesülnek, a Tenant teljes rendszergazdai felületére kiterjednek)
access none | portalViewer | designer | architect | intelligence Nem Egyetlen felhasználói hely választható: none | portalViewer | designer | architect | intelligence
Engedélyezett értékek: none, portalViewer, designer, architect, intelligence
isDashboardViewer boolean Nem Megtekintheti-e a felhasználó a dashboardot csak olvasási jogosultsággal
preferredLocale en | zh | es | fr | de | pt | it | nl | ja | tr | pl | cs | hu | id | ko | vi | th Nem A felhasználó által előnyben részesített felületi nyelv
Engedélyezett értékek: en, zh, es, fr, de, pt, it, nl, ja, tr, pl, cs, hu, id, ko, vi, th

Válasz (201):

Felhasználó hozzáadva

{
	"id": "string",
	"message": "string"
}
Mező Típus Kötelező Leírás
id string Igen A hozzáadott felhasználó azonosítója
message string Igen

Hibák:

  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
  • 409 A kérés ütközik a jelenlegi állapottal (például licenckorlátba ütközik, vagy egy már használt azonosítót ad meg)

Felhasználó bérlői beállításainak frissítése

Végpont: PUT /v1/tenant/{tenantId}/users/{userId}

Hitelesítés: Bérlőhöz kötött API-kulcs · write hatókör

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid
userId string útvonal Igen Formátum: uuid

Kérés törzse:

{
	"isActiveInTenant": true,
	"isAdminInTenant": true,
	"access": "none",
	"isDashboardViewer": true
}
Mező Típus Kötelező Leírás
isActiveInTenant boolean Nem Aktív-e a felhasználó ebben a bérlőben
isAdminInTenant boolean Nem Adminisztrátori jogosultság ebben a bérlőben (változtatás nélkül érvényesül: teljes körű bérlői adminisztráció)
access none | portalViewer | designer | architect | intelligence Nem Egyetlen licenc választható: none | portalViewer | designer | architect | intelligence. A dashboard megtekintését az isDashboardViewer logikai érték szabályozza.
Engedélyezett értékek: none, portalViewer, designer, architect, intelligence
isDashboardViewer boolean Nem Csak olvasási jogosultságú dashboard-megtekintést kap-e a felhasználó

Válasz (200):

Frissítve

{
	"message": "string"
}
Mező Típus Kötelező Leírás
message string Igen

Hibák:

  • 400 Hibás kérés: például érvénytelen szűrőkifejezés, modell nélküli folyamat, nem támogatott feltöltési típus vagy hiányzó kötelező mező
  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
  • 404 Az erőforrás nem található

Felhasználó eltávolítása a bérlőből

Végpont: DELETE /v1/tenant/{tenantId}/users/{userId}

Hitelesítés: Bérlőhöz kötött API-kulcs · write hatókör

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid
userId string útvonal Igen Formátum: uuid

Válasz (200):

Felhasználó eltávolítva

{
	"message": "string"
}
Mező Típus Kötelező Leírás
message string Igen

Hibák:

  • 400 Hibás kérés: például érvénytelen szűrőkifejezés, modell nélküli folyamat, nem támogatott feltöltési típus vagy hiányzó kötelező mező
  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
  • 404 Az erőforrás nem található

Egyszer használható bejelentkezési átadótoken létrehozása felhasználónak

A végpont egyszer használható tokent ad vissza (60 másodperces érvényességgel), amely a felhasználóhoz, a bérlőhöz és a szervezethez kötődik, valamint a url címet, ahová a felhasználó böngészőjét irányítani kell. Nyissa meg az URL-t a felhasználó böngészőjében. A felhasználó hitelesítve lép be a ProcessMindbe, e-mailes hivatkozás és megszemélyesítés nélkül, saját munkamenettel. Ehhez az API-kulcson külön sessions hatókör szükséges: a szervezethez kötött kulccsal a szervezet bármely bérlőjéhez létrehozható token, a bérlőhöz kötött kulccsal pedig csak a saját bérlő felhasználóihoz. A tokent kezelje úgy, mint egy jelszót: csak egyszer küldi vissza a rendszer, nem kerül naplóba, és a kulcs vagy a felhasználó letiltásával visszavonható.

Végpont: POST /v1/tenant/{tenantId}/users/{userId}/login-token

Hitelesítés: Bérlőhöz vagy szervezethez kötött API-kulcs · sessions hatókör · sebességkorlát: 2 kérés/s (csúcs: 4)

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid
userId string útvonal Igen Formátum: uuid

Kérés törzse:

Opcionális célútvonal (relatív alkalmazásútvonal, például “app” vagy “app/dashboards”)

{
	"path": "string"
}
Mező Típus Kötelező Leírás
path string Nem Maximális hossz: 512

Válasz (200):

Bejelentkezési átadótoken

{
	"token": "string",
	"url": "string",
	"expiresInSeconds": 0,
	"expiresAt": "2024-03-15T16:30:00Z"
}
Mező Típus Kötelező Leírás
token string Igen
url string Igen
expiresInSeconds number Igen
expiresAt string Igen Formátum: date-time

Hibák:

  • 400 Hibás kérés: például érvénytelen szűrőkifejezés, modell nélküli folyamat, nem támogatott feltöltési típus vagy hiányzó kötelező mező
  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
  • 403 Az API-kulcs hatóköre vagy szervezeti hozzáférése nem elegendő, a bérlő inaktív, vagy a csomag nem engedélyezi ezt a fájltípust
  • 404 Az erőforrás nem található
  • 429 A kérések száma túllépte a korlátot: tekintse meg a végponthoz dokumentált sebességkorlátot

Az API-kulcsok hitelesítik az integrációkat. A szervezethez kötött kulcsokkal a szervezet bármely bérlőjének kulcsai létrehozhatók és kezelhetők.

A bérlő API-kulcsainak listázása

Szervezethez kötött API-kulcs szükséges. A titkos kulcsot a rendszer soha nem adja vissza.

Végpont: GET /v1/tenant/{tenantId}/api-keys

Hitelesítés: Szervezethez kötött API-kulcs · read hatókör

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid
limit integer lekérdezés Nem A visszaadandó elemek maximális száma
offset integer lekérdezés Nem Kihagyandó elemek száma

Válasz (200):

API-kulcsok listája

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

Hibák:

  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
  • 403 Az API-kulcs hatóköre vagy szervezeti hozzáférése nem elegendő, a bérlő inaktív, vagy a csomag nem engedélyezi ezt a fájltípust

Bérlőhöz kötött API-kulcs létrehozása

Szervezethez kötött írási kulcs szükséges. A titkos kulcsot a szerver hozza létre, és a válaszban csak egyszer küldi vissza. Tárolja biztonságos helyen. A rendszer csak a kulcs hash-ét őrzi meg.

Végpont: POST /v1/tenant/{tenantId}/api-keys

Hitelesítés: Szervezethez kötött API-kulcs · write hatókör

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid

Kérés törzse:

{
	"displayName": "string",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	},
	"enabled": true,
	"expiresAt": "2024-03-15T16:30:00Z"
}
Mező Típus Kötelező Leírás
displayName string Igen Maximális hossz: 128
scope object Nem
enabled boolean Nem
expiresAt string Nem Formátum: date-time

Válasz (201):

API-kulcs létrehozva (az egyszer használatos titkos kulcsot is tartalmazza)

{
	"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"
}
Mező Típus Kötelező Leírás
id string Igen Formátum: uuid
tenantId string Igen Formátum: uuid
organizationId string Igen Formátum: uuid
displayName string Igen Maximális hossz: 128
partialKey string Igen Maximális hossz: 128
enabled boolean Igen Alapértelmezett: true
createdAt string Igen Formátum: date-time
lastUsedAt string Igen Formátum: date-time
expiresAt string Igen Formátum: date-time
scope object Igen
secret string Igen Maximális hossz: 128

Hibák:

  • 400 Hibás kérés: például érvénytelen szűrőkifejezés, modell nélküli folyamat, nem támogatott feltöltési típus vagy hiányzó kötelező mező
  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
  • 403 Az API-kulcs hatóköre vagy szervezeti hozzáférése nem elegendő, a bérlő inaktív, vagy a csomag nem engedélyezi ezt a fájltípust

Bérlőhöz kötött API-kulcs frissítése

Szervezethez kötött írási kulcs szükséges. A hatókör mezői összeolvadnak a tárolt hatókörrel.

Végpont: PUT /v1/tenant/{tenantId}/api-keys/{keyId}

Hitelesítés: Szervezethez kötött API-kulcs · write hatókör

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid
keyId string útvonal Igen Formátum: uuid

Kérés törzse:

{
	"displayName": "string",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	},
	"enabled": true,
	"expiresAt": "2024-03-15T16:30:00Z"
}
Mező Típus Kötelező Leírás
displayName string Nem Maximális hossz: 128
scope object Nem
enabled boolean Nem
expiresAt string Nem Formátum: date-time

Válasz (200):

API-kulcs frissítve

{
	"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
	}
}
Mező Típus Kötelező Leírás
id string Igen Formátum: uuid
tenantId string Igen Formátum: uuid
organizationId string Igen Formátum: uuid
displayName string Igen Maximális hossz: 128
partialKey string Igen Maximális hossz: 128
enabled boolean Igen Alapértelmezett: true
createdAt string Igen Formátum: date-time
lastUsedAt string Igen Formátum: date-time
expiresAt string Igen Formátum: date-time
scope object Igen

Hibák:

  • 400 Hibás kérés: például érvénytelen szűrőkifejezés, modell nélküli folyamat, nem támogatott feltöltési típus vagy hiányzó kötelező mező
  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
  • 403 Az API-kulcs hatóköre vagy szervezeti hozzáférése nem elegendő, a bérlő inaktív, vagy a csomag nem engedélyezi ezt a fájltípust
  • 404 Az erőforrás nem található

Bérlőhöz kötött API-kulcs törlése

Szervezethez kötött írási kulcs szükséges. A kulcs logikailag törlődik, és azonnal érvénytelenné válik hitelesítésre.

Végpont: DELETE /v1/tenant/{tenantId}/api-keys/{keyId}

Hitelesítés: Szervezethez kötött API-kulcs · write hatókör

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid
keyId string útvonal Igen Formátum: uuid

Válasz (200):

API-kulcs törölve

{
	"message": "string"
}
Mező Típus Kötelező Leírás
message string Igen

Hibák:

  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
  • 403 Az API-kulcs hatóköre vagy szervezeti hozzáférése nem elegendő, a bérlő inaktív, vagy a csomag nem engedélyezi ezt a fájltípust
  • 404 Az erőforrás nem található

Kapcsolódó dokumentáció

Tervezzen jobb folyamatokat. Építsen összekapcsolt architektúrát. Tartsa kézben a működést.

Azonnal hozzáférhet, bankkártya és várakozás nélkül. Alakítsa szervezete működését világos, összekapcsolt folyamatmodellekké.

Építse fel folyamatarchitektúráját, határozza meg a felelősségi köröket és az ellenőrzéseket, és hangolja össze a szerepeket minden szinten.

Indítsa el az ingyenes próbaverziót, és teremtsen megbízható alapot folyamatainak irányításához, kezeléséhez és folyamatos fejlesztéséhez.

Indítsa el ingyenes próbaverzióját