Dokumentacja API: tenanty

Pobierz informacje o tenancie

Endpoint: GET /v1/tenant/{tenantId}

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres read

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid

Odpowiedź (200):

Szczegóły tenanta

{
	"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	Wymagane	Opis
id	string	Tak	Format: uuid
createdBy	string	Tak	Format: uuid
createdAt	string	Tak	Format: date-time
displayName	string	Tak	Wartość domyślna: "" Maksymalna długość: 128
contactEmail	string	Tak	Format: email
isActive	boolean	Tak	Wartość domyślna: true
shortName	string	Tak
useOrganizationTheme	boolean	Tak	Wartość domyślna: true
description	string	Tak	Maksymalna długość: 200
organizationId	string	Tak	Format: uuid
allowedLogins	object	Tak
tenantType	normal | sandbox | demo	Tak	Dozwolone wartości: normal, sandbox, demo Wartość domyślna: normal
url	string	Tak	Format: uri

Błędy:

• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 404 Nie znaleziono zasobu

Zaktualizuj ustawienia tenanta

Endpoint: PUT /v1/tenant/{tenantId}

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres write

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid

Treść żądania:

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

Pole	Typ	Wymagane	Opis
id	string	Nie	Format: uuid
displayName	string	Nie
contactEmail	string	Nie
shortName	string	Nie
description	string	Nie

Odpowiedź (200):

Zaktualizowany 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	Wymagane	Opis
id	string	Tak	Format: uuid
createdBy	string	Tak	Format: uuid
createdAt	string	Tak	Format: date-time
displayName	string	Tak	Wartość domyślna: "" Maksymalna długość: 128
contactEmail	string	Tak	Format: email
isActive	boolean	Tak	Wartość domyślna: true
shortName	string	Tak
useOrganizationTheme	boolean	Tak	Wartość domyślna: true
description	string	Tak	Maksymalna długość: 200
organizationId	string	Tak	Format: uuid
allowedLogins	object	Tak
tenantType	normal | sandbox | demo	Tak	Dozwolone wartości: normal, sandbox, demo Wartość domyślna: normal
url	string	Tak	Format: uri

Błędy:

• 400 Nieprawidłowe żądanie, np. nieprawidłowe wyrażenie filtra, proces bez modelu, nieobsługiwany typ przesyłanego pliku lub brak wymaganego pola
• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 403 Klucz API nie ma wymaganego zakresu ani dostępu do organizacji, tenant jest nieaktywny lub plan nie obsługuje tego typu pliku
• 406 Nie można zaakceptować tej wartości, np. zarezerwowanej lub powielonej krótkiej nazwy

Pobierz statystyki tenanta (rozmiar danych, modele, symulacje, użytkownicy)

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

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres read

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid

Odpowiedź (200):

Statystyki tenanta

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

Pole	Typ	Wymagane	Opis
tenantId	string	Tak	Format: uuid
uploadedDataSize	number	Tak
uploadedDataCount	number	Tak
modelCount	number	Tak
simulationCount	number	Tak
userCount	number	Tak

Błędy:

• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 404 Nie znaleziono zasobu

Wyświetl użytkowników tenanta

Zwraca pasujących użytkowników jako zwykłą tablicę JSON, bez łącznej liczby wyników. Wyniki można stronicować za pomocą limit/offset.

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

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres read

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
limit	integer	zapytanie	Nie	Maksymalna liczba zwracanych elementów
offset	integer	zapytanie	Nie	Liczba pomijanych elementów

Odpowiedź (200):

Lista użytkowników

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

Błędy:

• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API

Dodaj użytkownika do tenanta (zaproszenie e-mail nie zostanie wysłane)

Wartości pól roli w treści żądania (isAdminInTenant, access: none|portalViewer|designer|architect|intelligence, isDashboardViewer) są stosowane dokładnie w podanej postaci. Ten endpoint zapewnia pełny zakres uprawnień administratora tenanta, dlatego klucze z uprawnieniami do zapisu należy udostępniać wyłącznie zaufanym podmiotom. Dostęp do dashboardu w trybie tylko do odczytu określa wartość logiczna isDashboardViewer. Dawny poziom dostępu Viewer tylko do odczytu został usunięty.

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

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres write

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid

Treść żądania:

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

Pole	Typ	Wymagane	Opis
email	string	Tak	Adres e-mail użytkownika (również identyfikator logowania) Format: email
firstName	string	Nie	Imię (opcjonalnie) Maksymalna długość: 64
lastName	string	Nie	Nazwisko (opcjonalnie) Maksymalna długość: 64
isActiveInTenant	boolean	Nie	Określa, czy użytkownik jest aktywny w tej dzierżawie
isAdminInTenant	boolean	Nie	Uprawnienia administratora w tej dzierżawie (zachowywane bez zmian: pełny zakres uprawnień administratora dzierżawy)
access	none | portalViewer | designer | architect | intelligence	Nie	Jedna licencja do wyboru: none | portalViewer | designer | architect | intelligence Dozwolone wartości: none, portalViewer, designer, architect, intelligence
isDashboardViewer	boolean	Nie	Określa, czy użytkownik ma dostęp do dashboardów tylko do odczytu
preferredLocale	en | zh | es | fr | de | pt | it | nl | ja | tr | pl | cs | hu | id | ko | vi | th	Nie	Preferowany język interfejsu użytkownika Dozwolone wartości: en, zh, es, fr, de, pt, it, nl, ja, tr, pl, cs, hu, id, ko, vi, th

Odpowiedź (201):

Dodano użytkownika

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

Pole	Typ	Wymagane	Opis
id	string	Tak	Identyfikator dodanego użytkownika
message	string	Tak

Błędy:

• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 409 Żądanie jest sprzeczne z bieżącym stanem, np. z ograniczeniem liczby licencji lub użytym już identyfikatorem

Zaktualizuj ustawienia użytkownika w tenancie

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

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres write

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
userId	string	ścieżka	Tak	Format: uuid

Treść żądania:

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

Pole	Typ	Wymagane	Opis
isActiveInTenant	boolean	Nie	Czy użytkownik jest aktywny w tym tenancie
isAdminInTenant	boolean	Nie	Uprawnienia administratora w tym tenancie (stosowane dokładnie w podanej postaci: pełny zakres uprawnień administratora tenanta)
access	none | portalViewer | designer | architect | intelligence	Nie	Jedna wybrana licencja: none | portalViewer | designer | architect | intelligence. Dostęp do dashboardu określa wartość logiczna isDashboardViewer. Dozwolone wartości: none, portalViewer, designer, architect, intelligence
isDashboardViewer	boolean	Nie	Czy użytkownik ma dostęp do dashboardu tylko do odczytu

Odpowiedź (200):

Zaktualizowano

{
	"message": "string"
}

Pole	Typ	Wymagane	Opis
message	string	Tak

Błędy:

• 400 Nieprawidłowe żądanie, np. nieprawidłowe wyrażenie filtra, proces bez modelu, nieobsługiwany typ przesyłanego pliku lub brak wymaganego pola
• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 404 Nie znaleziono zasobu

Usuń użytkownika z tenanta

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

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres write

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
userId	string	ścieżka	Tak	Format: uuid

Odpowiedź (200):

Usunięto użytkownika

{
	"message": "string"
}

Pole	Typ	Wymagane	Opis
message	string	Tak

Błędy:

• 400 Nieprawidłowe żądanie, np. nieprawidłowe wyrażenie filtra, proces bez modelu, nieobsługiwany typ przesyłanego pliku lub brak wymaganego pola
• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 404 Nie znaleziono zasobu

Wygeneruj jednorazowy token logowania dla użytkownika

Zwraca jednorazowy token ważny przez 60 sekund, przypisany do użytkownika, tenanta i organizacji, oraz adres url, pod który należy przekierować przeglądarkę użytkownika. Po otwarciu adresu w przeglądarce użytkownik zostaje zalogowany do ProcessMind. Nie jest wysyłany link e-mail ani nie dochodzi do podszywania się pod użytkownika, który otrzymuje własną sesję. Wymagany jest dedykowany zakres sessions klucza API: klucz przypisany do organizacji może wygenerować token dla dowolnego tenanta w tej organizacji, a klucz przypisany do tenanta tylko dla użytkowników tego tenanta. Token należy traktować jak hasło: jest zwracany tylko raz, nigdy nie trafia do logów i można go unieważnić, wyłączając klucz lub użytkownika.

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

Uwierzytelnianie: Klucz API przypisany do tenanta lub organizacji · zakres sessions · limit 2 żądań/s (maksymalnie 4 jednocześnie)

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
userId	string	ścieżka	Tak	Format: uuid

Treść żądania:

Opcjonalna ścieżka docelowa (względna ścieżka w aplikacji, np. “app” lub “app/dashboards”)

{
	"path": "string"
}

Pole	Typ	Wymagane	Opis
path	string	Nie	Maksymalna długość: 512

Odpowiedź (200):

Token przekazania logowania

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

Pole	Typ	Wymagane	Opis
token	string	Tak
url	string	Tak
expiresInSeconds	number	Tak
expiresAt	string	Tak	Format: date-time

Błędy:

• 400 Nieprawidłowe żądanie, np. nieprawidłowe wyrażenie filtra, proces bez modelu, nieobsługiwany typ przesyłanego pliku lub brak wymaganego pola
• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 403 Klucz API nie ma wymaganego zakresu ani dostępu do organizacji, tenant jest nieaktywny lub plan nie obsługuje tego typu pliku
• 404 Nie znaleziono zasobu
• 429 Przekroczono limit żądań. Szczegóły znajdują się w opisie limitu dla tego endpointu

Klucze API służą do uwierzytelniania integracji. Klucze przypisane do organizacji mogą tworzyć klucze dla dowolnego tenanta w organizacji i zarządzać nimi.

Wyświetl klucze API tenanta

Wymagany jest klucz API przypisany do organizacji. Tajny klucz nigdy nie jest zwracany.

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

Uwierzytelnianie: Klucz API przypisany do organizacji · zakres read

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
limit	integer	zapytanie	Nie	Maksymalna liczba zwracanych elementów
offset	integer	zapytanie	Nie	Liczba pomijanych elementów

Odpowiedź (200):

Lista kluczy API

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

Błędy:

• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 403 Klucz API nie ma wymaganego zakresu ani dostępu do organizacji, tenant jest nieaktywny lub plan nie obsługuje tego typu pliku

Utwórz klucz API przypisany do tenanta

Wymagany jest klucz do zapisu przypisany do organizacji. Tajny klucz jest generowany po stronie serwera i zwracany tylko raz w odpowiedzi. Należy go bezpiecznie przechować. Zapisywany jest wyłącznie jego skrót.

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

Uwierzytelnianie: Klucz API przypisany do organizacji · zakres write

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid

Treść żądania:

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

Pole	Typ	Wymagane	Opis
displayName	string	Tak	Maksymalna długość: 128
scope	object	Nie
enabled	boolean	Nie
expiresAt	string	Nie	Format: date-time

Odpowiedź (201):

Utworzono klucz API (zawiera jednorazowy tajny klucz)

{
	"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	Wymagane	Opis
id	string	Tak	Format: uuid
tenantId	string	Tak	Format: uuid
organizationId	string	Tak	Format: uuid
displayName	string	Tak	Maksymalna długość: 128
partialKey	string	Tak	Maksymalna długość: 128
enabled	boolean	Tak	Wartość domyślna: true
createdAt	string	Tak	Format: date-time
lastUsedAt	string	Tak	Format: date-time
expiresAt	string	Tak	Format: date-time
scope	object	Tak
secret	string	Tak	Maksymalna długość: 128

Błędy:

• 400 Nieprawidłowe żądanie, np. nieprawidłowe wyrażenie filtra, proces bez modelu, nieobsługiwany typ przesyłanego pliku lub brak wymaganego pola
• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 403 Klucz API nie ma wymaganego zakresu ani dostępu do organizacji, tenant jest nieaktywny lub plan nie obsługuje tego typu pliku

Zaktualizuj klucz API przypisany do tenanta

Wymagany jest klucz do zapisu przypisany do organizacji. Pola zakresu są łączone z zapisanym zakresem.

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

Uwierzytelnianie: Klucz API przypisany do organizacji · zakres write

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
keyId	string	ścieżka	Tak	Format: uuid

Treść żądania:

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

Pole	Typ	Wymagane	Opis
displayName	string	Nie	Maksymalna długość: 128
scope	object	Nie
enabled	boolean	Nie
expiresAt	string	Nie	Format: date-time

Odpowiedź (200):

Zaktualizowano klucz API

{
	"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	Wymagane	Opis
id	string	Tak	Format: uuid
tenantId	string	Tak	Format: uuid
organizationId	string	Tak	Format: uuid
displayName	string	Tak	Maksymalna długość: 128
partialKey	string	Tak	Maksymalna długość: 128
enabled	boolean	Tak	Wartość domyślna: true
createdAt	string	Tak	Format: date-time
lastUsedAt	string	Tak	Format: date-time
expiresAt	string	Tak	Format: date-time
scope	object	Tak

Błędy:

• 400 Nieprawidłowe żądanie, np. nieprawidłowe wyrażenie filtra, proces bez modelu, nieobsługiwany typ przesyłanego pliku lub brak wymaganego pola
• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 403 Klucz API nie ma wymaganego zakresu ani dostępu do organizacji, tenant jest nieaktywny lub plan nie obsługuje tego typu pliku
• 404 Nie znaleziono zasobu

Usuń klucz API przypisany do tenanta

Wymagany jest klucz do zapisu przypisany do organizacji. Klucz jest usuwany logicznie i natychmiast przestaje służyć do uwierzytelniania.

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

Uwierzytelnianie: Klucz API przypisany do organizacji · zakres write

Parametry:

Nazwa	Typ	Lokalizacja	Wymagane	Opis
tenantId	string	ścieżka	Tak	Format: uuid
keyId	string	ścieżka	Tak	Format: uuid

Odpowiedź (200):

Usunięto klucz API

{
	"message": "string"
}

Pole	Typ	Wymagane	Opis
message	string	Tak

Błędy:

• 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
• 403 Klucz API nie ma wymaganego zakresu ani dostępu do organizacji, tenant jest nieaktywny lub plan nie obsługuje tego typu pliku
• 404 Nie znaleziono zasobu