API-referentie: Tenants

Tenant-informatie ophalen

Endpoint: GET /v1/tenant/{tenantId}

Authenticatie: API-sleutel voor Tenant · read-scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Formaat: uuid

Antwoord (200):

Tenantgegevens

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

Veld	Type	Verplicht	Beschrijving
id	string	Ja	Indeling: uuid
createdBy	string	Ja	Indeling: uuid
createdAt	string	Ja	Indeling: date-time
displayName	string	Ja	Standaard: "" Maximale lengte: 128
contactEmail	string	Ja	Indeling: email
isActive	boolean	Ja	Standaard: true
shortName	string	Ja
useOrganizationTheme	boolean	Ja	Standaard: true
description	string	Ja	Maximale lengte: 200
organizationId	string	Ja	Indeling: uuid
allowedLogins	object	Ja
tenantType	normal | sandbox | demo	Ja	Toegestane waarden: normal, sandbox, demo Standaard: normal
url	string	Ja	Indeling: uri

Fouten:

• 401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen
• 404 Bron niet gevonden

Tenant-instellingen bijwerken

Endpoint: PUT /v1/tenant/{tenantId}

Authenticatie: API-sleutel voor Tenant · write-scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Formaat: uuid

Request body:

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

Veld	Type	Verplicht	Beschrijving
id	string	Nee	Formaat: uuid
displayName	string	Nee
contactEmail	string	Nee
shortName	string	Nee
description	string	Nee

Antwoord (200):

Tenant bijgewerkt

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

Veld	Type	Verplicht	Beschrijving
id	string	Ja	Indeling: uuid
createdBy	string	Ja	Indeling: uuid
createdAt	string	Ja	Indeling: date-time
displayName	string	Ja	Standaard: "" Maximale lengte: 128
contactEmail	string	Ja	Indeling: email
isActive	boolean	Ja	Standaard: true
shortName	string	Ja
useOrganizationTheme	boolean	Ja	Standaard: true
description	string	Ja	Maximale lengte: 200
organizationId	string	Ja	Indeling: uuid
allowedLogins	object	Ja
tenantType	normal | sandbox | demo	Ja	Toegestane waarden: normal, sandbox, demo Standaard: normal
url	string	Ja	Indeling: uri

Fouten:

• 400 Ongeldig verzoek: bijvoorbeeld een ongeldige filterexpressie, een proces zonder model, een niet-ondersteund uploadtype of een verplicht veld dat ontbreekt
• 401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen
• 403 De API-sleutel heeft niet de vereiste scope of toegang tot de organisatie, de Tenant is inactief of het abonnement staat dit bestandstype niet toe
• 406 De waarde kan niet worden geaccepteerd (bijvoorbeeld een gereserveerde of dubbele korte naam)

Tenant-statistieken ophalen (datagrootte, modellen, simulaties, gebruikers)

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

Authenticatie: API-sleutel voor Tenant · read-scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Formaat: uuid

Antwoord (200):

Tenant-statistieken

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

Veld	Type	Verplicht	Beschrijving
tenantId	string	Ja	Formaat: uuid
uploadedDataSize	number	Ja
uploadedDataCount	number	Ja
modelCount	number	Ja
simulationCount	number	Ja
userCount	number	Ja

Fouten:

• 401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen
• 404 Bron niet gevonden

Gebruikers in de Tenant weergeven

Geeft de overeenkomende gebruikers terug als een gewone JSON-array: er is geen totaal aantal; gebruik limit/offset om door de pagina’s te bladeren.

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

Authenticatie: API-sleutel voor Tenant · read-scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Formaat: uuid
limit	integer	query	Nee	Maximumaantal items in het antwoord
offset	integer	query	Nee	Aantal items dat wordt overgeslagen

Antwoord (200):

Lijst met gebruikers

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

Fouten:

• 401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen

Een gebruiker toevoegen aan de Tenant (er wordt geen uitnodigingsmail verstuurd)

Rolvelden in de body (isAdminInTenant, access: none|portalViewer|designer|architect|intelligence, isDashboardViewer) worden exact overgenomen. Dit endpoint biedt volledige beheerdersrechten voor de Tenant. Geef daarom alleen sleutels met schrijfrechten uit aan vertrouwde aanroepers. Dashboardtoegang wordt bepaald door de boolean isDashboardViewer; de oude alleen-lezen viewer-rol is verwijderd.

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

Authenticatie: API-sleutel voor Tenant · write-scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Formaat: uuid

Request body:

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

Veld	Type	Verplicht	Beschrijving
email	string	Ja	Het e-mailadres van de gebruiker (ook de inlogidentiteit) Formaat: email
firstName	string	Nee	Optionele voornaam Maximale lengte: 64
lastName	string	Nee	Optionele achternaam Maximale lengte: 64
isActiveInTenant	boolean	Nee	Geeft aan of de gebruiker actief is in deze tenant
isAdminInTenant	boolean	Nee	Beheerdersrechten in deze tenant (worden ongewijzigd toegepast: volledige tenantbeheerrechten)
access	none | portalViewer | designer | architect | intelligence	Nee	Eén licentieplaats selecteren: none | portalViewer | designer | architect | intelligence Toegestane waarden: none, portalViewer, designer, architect, intelligence
isDashboardViewer	boolean	Nee	Geeft aan of de gebruiker dashboards alleen-lezen kan bekijken
preferredLocale	en | zh | es | fr | de | pt | it | nl | ja | tr | pl | cs | hu | id | ko | vi | th	Nee	Voorkeurstaal van de gebruikersinterface voor de gebruiker Toegestane waarden: en, zh, es, fr, de, pt, it, nl, ja, tr, pl, cs, hu, id, ko, vi, th

Antwoord (201):

Gebruiker toegevoegd

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

Veld	Type	Verplicht	Beschrijving
id	string	Ja	De id van de zojuist toegevoegde gebruiker
message	string	Ja

Fouten:

• 401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen
• 409 Het verzoek botst met de huidige status (bijvoorbeeld door een licentieplaatslimiet of een hergebruikte id)

Tenant-instellingen van een gebruiker bijwerken

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

Authenticatie: API-sleutel voor Tenant · write-scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Formaat: uuid
userId	string	pad	Ja	Formaat: uuid

Request body:

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

Veld	Type	Verplicht	Beschrijving
isActiveInTenant	boolean	Nee	Of de gebruiker actief is in deze Tenant
isAdminInTenant	boolean	Nee	Beheerdersrechten in deze Tenant (worden exact overgenomen: volledige beheerdersrechten voor de Tenant)
access	none | portalViewer | designer | architect | intelligence	Nee	Eén licentieplaats selecteren: none | portalViewer | designer | architect | intelligence. Dashboardtoegang wordt bepaald door de boolean isDashboardViewer. Toegestane waarden: none, portalViewer, designer, architect, intelligence
isDashboardViewer	boolean	Nee	Of de gebruiker alleen-lezen toegang tot dashboards heeft

Antwoord (200):

Bijgewerkt

{
	"message": "string"
}

Veld	Type	Verplicht	Beschrijving
message	string	Ja

Fouten:

• 400 Ongeldig verzoek: bijvoorbeeld een ongeldige filterexpressie, een proces zonder model, een niet-ondersteund uploadtype of een verplicht veld dat ontbreekt
• 401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen
• 404 Bron niet gevonden

Een gebruiker uit de Tenant verwijderen

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

Authenticatie: API-sleutel voor Tenant · write-scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Formaat: uuid
userId	string	pad	Ja	Formaat: uuid

Antwoord (200):

Gebruiker verwijderd

{
	"message": "string"
}

Veld	Type	Verplicht	Beschrijving
message	string	Ja

Fouten:

• 400 Ongeldig verzoek: bijvoorbeeld een ongeldige filterexpressie, een proces zonder model, een niet-ondersteund uploadtype of een verplicht veld dat ontbreekt
• 401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen
• 404 Bron niet gevonden

Een eenmalig inlogtoken voor een gebruiker aanmaken

Geeft een eenmalig te gebruiken token terug (geldigheid 60 s), gekoppeld aan de gebruiker, Tenant en organisatie, plus de url waar de browser van de gebruiker naartoe moet. Open de URL in de browser van de gebruiker; die wordt dan aangemeld bij ProcessMind. Er is geen e-maillink of imitatie van de gebruiker nodig; de gebruiker krijgt een eigen sessie. Hiervoor is de speciale scope sessions op de API-sleutel vereist: met een sleutel op organisatieniveau kun je tokens aanmaken voor elke Tenant binnen de organisatie, met een sleutel op Tenantniveau alleen voor gebruikers van die Tenant. Behandel het token als een wachtwoord: het wordt één keer teruggegeven, nooit gelogd en ingetrokken zodra de sleutel of gebruiker wordt uitgeschakeld.

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

Authenticatie: API-sleutel op Tenant- of organisatieniveau · sessions-scope · limiet 2 verzoeken/s (piek 4)

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Formaat: uuid
userId	string	pad	Ja	Formaat: uuid

Request body:

Optioneel bestemmingspad (relatief pad in de app, bijvoorbeeld “app” of “app/dashboards”)

{
	"path": "string"
}

Veld	Type	Verplicht	Beschrijving
path	string	Nee	Maximale lengte: 512

Antwoord (200):

Inlogtoken

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

Veld	Type	Verplicht	Beschrijving
token	string	Ja
url	string	Ja
expiresInSeconds	number	Ja
expiresAt	string	Ja	Formaat: date-time

Fouten:

• 400 Ongeldig verzoek: bijvoorbeeld een ongeldige filterexpressie, een proces zonder model, een niet-ondersteund uploadtype of een verplicht veld dat ontbreekt
• 401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen
• 403 De API-sleutel heeft niet de vereiste scope of toegang tot de organisatie, de Tenant is inactief of het abonnement staat dit bestandstype niet toe
• 404 Bron niet gevonden
• 429 Verzoeklimiet bereikt: bekijk de gedocumenteerde limiet voor dit endpoint

API-sleutels geven je integraties toegang. Met sleutels op organisatieniveau kun je sleutels aanmaken en beheren voor elke Tenant binnen de organisatie.

API-sleutels van de Tenant weergeven

Hiervoor is een API-sleutel op organisatieniveau vereist. Het geheim wordt nooit teruggegeven.

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

Authenticatie: API-sleutel op organisatieniveau · read-scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Formaat: uuid
limit	integer	query	Nee	Maximumaantal items in het antwoord
offset	integer	query	Nee	Aantal items dat wordt overgeslagen

Antwoord (200):

Lijst met API-sleutels

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

Fouten:

• 401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen
• 403 De API-sleutel heeft niet de vereiste scope of toegang tot de organisatie, de Tenant is inactief of het abonnement staat dit bestandstype niet toe

Een API-sleutel voor een Tenant aanmaken

Hiervoor is een API-sleutel met schrijfrechten op organisatieniveau vereist. Het geheim wordt aan de serverkant gegenereerd en precies één keer in het antwoord teruggegeven. Bewaar het veilig. Alleen de hash wordt opgeslagen.

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

Authenticatie: API-sleutel op organisatieniveau · write-scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Formaat: uuid

Request body:

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

Veld	Type	Verplicht	Beschrijving
displayName	string	Ja	Maximale lengte: 128
scope	object	Nee
enabled	boolean	Nee
expiresAt	string	Nee	Formaat: date-time

Antwoord (201):

API-sleutel aangemaakt (bevat het eenmalige geheim)

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

Veld	Type	Verplicht	Beschrijving
id	string	Ja	Formaat: uuid
tenantId	string	Ja	Formaat: uuid
organizationId	string	Ja	Formaat: uuid
displayName	string	Ja	Maximale lengte: 128
partialKey	string	Ja	Maximale lengte: 128
enabled	boolean	Ja	Standaard: true
createdAt	string	Ja	Formaat: date-time
lastUsedAt	string	Ja	Formaat: date-time
expiresAt	string	Ja	Formaat: date-time
scope	object	Ja
secret	string	Ja	Maximale lengte: 128

Fouten:

• 400 Ongeldig verzoek: bijvoorbeeld een ongeldige filterexpressie, een proces zonder model, een niet-ondersteund uploadtype of een verplicht veld dat ontbreekt
• 401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen
• 403 De API-sleutel heeft niet de vereiste scope of toegang tot de organisatie, de Tenant is inactief of het abonnement staat dit bestandstype niet toe

Een API-sleutel voor een Tenant bijwerken

Hiervoor is een API-sleutel met schrijfrechten op organisatieniveau vereist. Scopevelden worden samengevoegd met de opgeslagen scope.

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

Authenticatie: API-sleutel op organisatieniveau · write-scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Formaat: uuid
keyId	string	pad	Ja	Formaat: uuid

Request body:

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

Veld	Type	Verplicht	Beschrijving
displayName	string	Nee	Maximale lengte: 128
scope	object	Nee
enabled	boolean	Nee
expiresAt	string	Nee	Formaat: date-time

Antwoord (200):

API-sleutel bijgewerkt

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

Veld	Type	Verplicht	Beschrijving
id	string	Ja	Formaat: uuid
tenantId	string	Ja	Formaat: uuid
organizationId	string	Ja	Formaat: uuid
displayName	string	Ja	Maximale lengte: 128
partialKey	string	Ja	Maximale lengte: 128
enabled	boolean	Ja	Standaard: true
createdAt	string	Ja	Formaat: date-time
lastUsedAt	string	Ja	Formaat: date-time
expiresAt	string	Ja	Formaat: date-time
scope	object	Ja

Fouten:

• 400 Ongeldig verzoek: bijvoorbeeld een ongeldige filterexpressie, een proces zonder model, een niet-ondersteund uploadtype of een verplicht veld dat ontbreekt
• 401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen
• 403 De API-sleutel heeft niet de vereiste scope of toegang tot de organisatie, de Tenant is inactief of het abonnement staat dit bestandstype niet toe
• 404 Bron niet gevonden

Een API-sleutel voor een Tenant verwijderen

Hiervoor is een API-sleutel met schrijfrechten op organisatieniveau vereist. De sleutel wordt logisch verwijderd en werkt meteen niet meer voor authenticatie.

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

Authenticatie: API-sleutel op organisatieniveau · write-scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	pad	Ja	Formaat: uuid
keyId	string	pad	Ja	Formaat: uuid

Antwoord (200):

API-sleutel verwijderd

{
	"message": "string"
}

Veld	Type	Verplicht	Beschrijving
message	string	Ja

Fouten:

• 401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen
• 403 De API-sleutel heeft niet de vereiste scope of toegang tot de organisatie, de Tenant is inactief of het abonnement staat dit bestandstype niet toe
• 404 Bron niet gevonden