Na tej stronie
> zasoby > dokumentacja > api > Dokumentacja API: organizacje

Dokumentacja API: organizacje

warning

Usunięcie tenanta trwale skasuje wszystkie jego procesy, zbiory danych i przypisania użytkowników. Tej operacji nie można cofnąć. Nie można usunąć tenanta używanego do uwierzytelnienia.

warning

Usunięcie użytkownika z organizacji odbierze mu dostęp do wszystkich tenantów w tej organizacji.

Organizacje grupują wiele tenantów w ramach jednej jednostki.

Pobieranie organizacji przypisanej do tenanta

Dane można odczytać za pomocą klucza API przypisanego do tenanta. Akceptowany jest również klucz przypisany do organizacji.

Punkt końcowy: GET /v1/tenant/{tenantId}/organization

Uwierzytelnianie: Klucz API przypisany do tenanta lub organizacji · zakres read

Parametry:

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

Odpowiedź (200):

Szczegóły organizacji

{
	"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"
}
Pole Typ Wymagane Opis
id string Tak Format: uuid
displayName string Tak Wartość domyślna: ""
Maksymalna długość: 128
createdAt string Tak Format: date-time
contactEmail string Tak Format: email
isActive boolean Tak Wartość domyślna: true
allowedLogins object Tak
createdBy string Tak Format: uuid

Błędy:

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

Pobieranie limitu licencji organizacji i zasad automatycznej synchronizacji

Zwraca liczbę zakupionych i używanych licencji w całej organizacji dla poszczególnych poziomów (Process Foundation, Process Architecture, Process Intelligence), limit bezpłatnych licencji Viewer, cel automatycznej synchronizacji, wyjaśnienie rozbieżności w liczbie licencji (co i kiedy zrobi mechanizm), okres rozliczeniowy oraz externalApiSeatPolicy. Dane można odczytać za pomocą klucza API przypisanego do tenanta. Parametr ścieżki {tenantId} wskazuje tenanta kontekstowego (organizację, do której przypisano klucz organizacji), a nie obiekt operacji.

Punkt końcowy: GET /v1/tenant/{tenantId}/organization/billing/seats

Uwierzytelnianie: Klucz API przypisany do tenanta lub organizacji · zakres read

Parametry:

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

Odpowiedź (200):

Limit licencji

{
	"contractType": "free",
	"isTrial": true,
	"purchased": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"inUseBillable": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"inUseFree": 0,
	"inUseDashboardViewers": 0,
	"totalBillable": 0,
	"freeViewerAllowance": 0,
	"freeViewerOverAllowance": 0,
	"dashboardViewerAllowance": 0,
	"dashboardViewerOverAllowance": 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"
}
Pole Typ Wymagane Opis
contractType free | selfServe | fixed | unlimited Tak Dozwolone wartości: free, selfServe, fixed, unlimited
isTrial boolean Tak
purchased object Tak
inUseBillable object Tak
inUseFree number Tak
inUseDashboardViewers number Tak
totalBillable number Tak
freeViewerAllowance number Tak
freeViewerOverAllowance number Tak
dashboardViewerAllowance number Tak
dashboardViewerOverAllowance number Tak
fixedOverage number Tak
target object Tak
drift object[] Tak
interval month | year Tak Dozwolone wartości: month, year
nextBilledAt string Tak
externalApiSeatPolicy autoBill | requireCapacity Tak Dozwolone wartości: autoBill, requireCapacity

Błędy:

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

Pobieranie statystyk całej organizacji

Parametr ścieżki {tenantId} wskazuje tenanta kontekstowego (organizację, do której przypisano klucz organizacji), a nie obiekt operacji.

Punkt końcowy: GET /v1/tenant/{tenantId}/organization/statistics

Uwierzytelnianie: Klucz API przypisany do organizacji · zakres read

Parametry:

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

Odpowiedź (200):

Statystyki organizacji

{
	"userCount": 0,
	"tenantCount": 0,
	"tenantStatistics": [
		{
			"tenantId": "00000000-0000-0000-0000-000000000000",
			"uploadedDataSize": 0,
			"uploadedDataCount": 0,
			"modelCount": 0,
			"simulationCount": 0,
			"userCount": 0
		}
	]
}
Pole Typ Wymagane Opis
userCount number Tak
tenantCount number Tak
tenantStatistics object[] Tak

Błędy:

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

Wyświetlanie wszystkich tenantów w organizacji

Parametr ścieżki {tenantId} wskazuje tenanta kontekstowego (organizację, do której przypisano klucz organizacji), a nie obiekt operacji.

Punkt końcowy: GET /v1/tenant/{tenantId}/organization/tenants

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 tenantów

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

Błędy:

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

Tworzenie tenanta w organizacji (wymaga klucza API przypisanego do organizacji)

Parametr ścieżki {tenantId} wskazuje tenanta kontekstowego (organizację, do której przypisano klucz organizacji), a nie obiekt operacji.

Punkt końcowy: POST /v1/tenant/{tenantId}/organization/tenants

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",
	"shortName": "string",
	"description": "string",
	"timezone": "string",
	"tenantType": "normal"
}
Pole Typ Wymagane Opis
displayName string Nie Maksymalna długość: 128
shortName string Tak
description string Nie Maksymalna długość: 200
timezone string Nie Maksymalna długość: 64
tenantType normal | sandbox | demo Nie Dozwolone wartości: normal, sandbox, demo

Odpowiedź (201):

Utworzono 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:

  • 400 Nieprawidłowe żądanie, np. błędne 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 lub dostępu do organizacji, tenant jest nieaktywny albo plan nie obsługuje tego typu pliku
  • 406 Nie można zaakceptować tej wartości, np. zarezerwowanej lub powielonej krótkiej nazwy

Miękkie usuwanie tenanta z organizacji (wymaga klucza API przypisanego do organizacji)

Dostęp API do tenanta zostaje natychmiast zablokowany. Tenant i jego dane pozostają zachowane przez okres ochronny, a następnie są usuwane automatycznie. Nie można usunąć aktualnie używanego tenanta (tenanta kontekstowego).

Punkt końcowy: DELETE /v1/tenant/{tenantId}/organization/tenants/{targetId}

Uwierzytelnianie: Klucz API przypisany do organizacji · zakres write

Parametry:

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

Odpowiedź (200):

Usunięto tenanta

{
	"success": true,
	"message": "string"
}
Pole Typ Wymagane Opis
success boolean Tak
message string Tak

Błędy:

  • 400 Nieprawidłowe żądanie, np. błędne 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 lub dostępu do organizacji, tenant jest nieaktywny albo plan nie obsługuje tego typu pliku
  • 404 Nie znaleziono zasobu

Przywracanie miękko usuniętego tenanta w organizacji (wymaga klucza API przypisanego do organizacji)

Cofnięcie miękkiego usunięcia w okresie ochronnym przywraca tenanta i jego dane w niezmienionej postaci oraz ponownie włącza dostęp API. Parametr ścieżki {tenantId} wskazuje tenanta kontekstowego (organizację, do której przypisano klucz organizacji), a nie obiekt operacji.

Punkt końcowy: POST /v1/tenant/{tenantId}/organization/tenants/{targetId}/restore

Uwierzytelnianie: Klucz API przypisany do organizacji · zakres write

Parametry:

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

Odpowiedź (200):

Przywrócono tenanta

{
	"success": true,
	"message": "string"
}
Pole Typ Wymagane Opis
success boolean Tak
message string Tak

Błędy:

  • 400 Nieprawidłowe żądanie, np. błędne 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 lub dostępu do organizacji, tenant jest nieaktywny albo plan nie obsługuje tego typu pliku
  • 404 Nie znaleziono zasobu

Wyświetlanie wszystkich użytkowników w organizacji

Parametr ścieżki {tenantId} wskazuje tenanta kontekstowego (organizację, do której przypisano klucz organizacji), a nie obiekt operacji.

Punkt końcowy: GET /v1/tenant/{tenantId}/organization/users

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 użytkowników organizacji

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

Błędy:

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

Zmiana ustawień użytkownika organizacji (wymaga klucza API przypisanego do organizacji)

Flagi ról w treści żądania (isAdminInOrganization, isActiveInOrganization) są stosowane dokładnie zgodnie z podanymi wartościami. Klucze przypisane do organizacji należy wydawać wyłącznie administratorom organizacji. Parametr ścieżki {tenantId} wskazuje tenanta kontekstowego (organizację, do której przypisano klucz organizacji), a nie obiekt operacji.

Punkt końcowy: PUT /v1/tenant/{tenantId}/organization/users/{userId}

Uwierzytelnianie: Klucz API przypisany do organizacji · zakres write

Parametry:

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

Treść żądania:

{
	"isActiveInOrganization": true,
	"isAdminInOrganization": true
}
Pole Typ Wymagane Opis
isActiveInOrganization boolean Nie Czy użytkownik jest aktywny w organizacji
isAdminInOrganization boolean Nie Uprawnienia administratora organizacji (stosowane dokładnie zgodnie z podaną wartością: klucze przypisane do organizacji należy wydawać wyłącznie administratorom)

Odpowiedź (200):

Zaktualizowano

{
	"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 lub dostępu do organizacji, tenant jest nieaktywny albo plan nie obsługuje tego typu pliku
  • 404 Nie znaleziono zasobu

Usuwanie użytkownika z organizacji (wymaga klucza API przypisanego do organizacji)

Parametr ścieżki {tenantId} wskazuje tenanta kontekstowego (organizację, do której przypisano klucz organizacji), a nie obiekt operacji.

Punkt końcowy: DELETE /v1/tenant/{tenantId}/organization/users/{userId}

Uwierzytelnianie: Klucz API przypisany do organizacji · 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:

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

Powiązana dokumentacja

Projektuj lepsze procesy. Buduj spójną architekturę. Zachowaj kontrolę.

Uzyskaj dostęp od razu, bez karty kredytowej i czekania. Przedstaw sposób działania organizacji w postaci przejrzystych, powiązanych modeli procesów.

Buduj architekturę procesów, określaj właścicieli i mechanizmy kontroli oraz uzgadniaj role i zakresy odpowiedzialności na każdym poziomie.

Rozpocznij okres próbny i stwórz solidną podstawę do nadzorowania, zarządzania i ciągłego doskonalenia procesów.

Rozpocznij okres próbny