API-referentie: tenants

Tenantinformatie ophalen

Endpoint: GET /v1/tenant/{tenantId}

Authenticatie: API-sleutel voor tenant · read scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: uuid

Response (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
	},
	"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
url	string	Ja	Indeling: uri

Fouten:

• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden

Tenantinstellingen bijwerken

Endpoint: PUT /v1/tenant/{tenantId}

Authenticatie: API-sleutel voor tenant · write scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: uuid

Request body:

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

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

Response (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
	},
	"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
url	string	Ja	Indeling: uri

Fouten:

• 400 Ongeldig verzoek, bijvoorbeeld door een ongeldige filterexpressie, een proces zonder model, een niet-ondersteund uploadtype of een ontbrekend verplicht veld
• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 403 API-sleutel heeft niet de vereiste scope of organisatietoegang, de tenant is inactief of het abonnement blokkeert het bestandstype
• 406 De waarde kan niet worden geaccepteerd, bijvoorbeeld omdat de korte naam gereserveerd of al in gebruik is

Tenantstatistieken 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	path	Ja	Indeling: uuid

Response (200):

Tenantstatistieken

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

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

Fouten:

• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden

Gebruikers in de tenant weergeven

Geeft de overeenkomende gebruikers terug als een kale JSON-array: er is geen totaal aantal; gebruik limit/offset voor paginering.

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

Authenticatie: API-sleutel voor tenant · read scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: uuid
limit	integer	query	Nee	Maximumaantal items dat wordt teruggegeven
offset	integer	query	Nee	Aantal over te slaan items

Response (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 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel

Gebruiker aan de tenant toevoegen (er wordt geen uitnodigingsmail verstuurd)

De rolvelden in de body (isAdminInTenant, access: none|portalViewer|designer|architect|intelligence, isDashboardViewer) worden letterlijk overgenomen. Dit endpoint biedt volledige tenant-beheermogelijkheden. Gebruik daarom alleen schrijfsleutels voor vertrouwde aanroepers. Dashboardweergave wordt geregeld met de boolean isDashboardViewer; de oude alleen-lezenviewer is verwijderd.

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

Authenticatie: API-sleutel voor tenant · write scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: 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	E-mailadres van de gebruiker, ook de loginidentiteit Indeling: email
firstName	string	Nee	Optionele voornaam Maximale lengte: 64
lastName	string	Nee	Optionele achternaam Maximale lengte: 64
isActiveInTenant	boolean	Nee	Of de gebruiker actief is in deze tenant
isAdminInTenant	boolean	Nee	Beheerdersrechten in deze tenant, letterlijk overgenomen: volledige tenant-beheeromgeving
access	none | portalViewer | designer | architect | intelligence	Nee	Licentieplaats met één selectie: none | portalViewer | designer | architect | intelligence Toegestane waarden: none, portalViewer, designer, architect, intelligence
isDashboardViewer	boolean	Nee	Of de gebruiker alleen-lezenweergave van dashboards heeft
preferredLocale	en | zh | es | fr | de | pt | it | nl | ja | tr	Nee	Voorkeurstaal van de gebruikersinterface voor de gebruiker Toegestane waarden: en, zh, es, fr, de, pt, it, nl, ja, tr

Response (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 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 409 Het verzoek conflicteert met de huidige status, bijvoorbeeld door een licentieplaatsbeperking of een hergebruikte id

Tenantinstellingen 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	path	Ja	Indeling: uuid
userId	string	path	Ja	Indeling: 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, letterlijk overgenomen: volledige tenant-beheeromgeving
access	none | portalViewer | designer | architect | intelligence	Nee	Licentieplaats met één selectie: none | portalViewer | designer | architect | intelligence. Dashboardweergave wordt geregeld met de boolean isDashboardViewer. Toegestane waarden: none, portalViewer, designer, architect, intelligence
isDashboardViewer	boolean	Nee	Of de gebruiker alleen-lezenweergave van dashboards heeft

Response (200):

Bijgewerkt

{
	"message": "string"
}

Veld	Type	Verplicht	Beschrijving
message	string	Ja

Fouten:

• 400 Ongeldig verzoek, bijvoorbeeld door een ongeldige filterexpressie, een proces zonder model, een niet-ondersteund uploadtype of een ontbrekend verplicht veld
• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden

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	path	Ja	Indeling: uuid
userId	string	path	Ja	Indeling: uuid

Response (200):

Gebruiker verwijderd

{
	"message": "string"
}

Veld	Type	Verplicht	Beschrijving
message	string	Ja

Fouten:

• 400 Ongeldig verzoek, bijvoorbeeld door een ongeldige filterexpressie, een proces zonder model, een niet-ondersteund uploadtype of een ontbrekend verplicht veld
• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 404 Bron niet gevonden

Een eenmalig login-overdrachtstoken voor een gebruiker genereren

Geeft een eenmalig token terug met een geldigheidsduur van 60 seconden, gekoppeld aan de gebruiker, tenant en organisatie, plus de url waarnaar je de browser van de gebruiker stuurt. Open de URL in de browser van de gebruiker. Die komt dan al geauthenticeerd in ProcessMind terecht: geen e-maillink en geen impersonatie, maar een eigen sessie voor de gebruiker. Hiervoor is de speciale scope sessions op de API-sleutel vereist: met een organisatiespecifieke sleutel kun je een token genereren voor elke tenant binnen de organisatie; met een tenantspecifieke sleutel alleen voor gebruikers van de eigen 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 voor tenant of organisatie · sessions scope · limiet 2 verzoeken/s (burst 4)

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: uuid
userId	string	path	Ja	Indeling: uuid

Request body:

Optioneel pad voor de landingspagina, een relatief app-pad, bijvoorbeeld “app” of “app/dashboards”

{
	"path": "string"
}

Veld	Type	Verplicht	Beschrijving
path	string	Nee	Maximale lengte: 512

Response (200):

Login-overdrachtstoken

{
	"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	Indeling: date-time

Fouten:

• 400 Ongeldig verzoek, bijvoorbeeld door een ongeldige filterexpressie, een proces zonder model, een niet-ondersteund uploadtype of een ontbrekend verplicht veld
• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 403 API-sleutel heeft niet de vereiste scope of organisatietoegang, de tenant is inactief of het abonnement blokkeert het bestandstype
• 404 Bron niet gevonden
• 429 Verzoeklimiet bereikt: bekijk de gedocumenteerde limiet van het endpoint

API-sleutels authenticeren je integraties. Met organisatiespecifieke sleutels kun je sleutels van elke tenant binnen de organisatie aanmaken en beheren.

API-sleutels van de tenant weergeven

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

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

Authenticatie: API-sleutel voor organisatie · read scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: uuid
limit	integer	query	Nee	Maximumaantal items dat wordt teruggegeven
offset	integer	query	Nee	Aantal over te slaan items

Response (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 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 403 API-sleutel heeft niet de vereiste scope of organisatietoegang, de tenant is inactief of het abonnement blokkeert het bestandstype

Een tenant-specifieke API-sleutel aanmaken

Hiervoor is een organisatiespecifieke schrijfsleutel vereist. Het geheim wordt aan de serverzijde gegenereerd en precies één keer in de response teruggegeven. Bewaar het veilig. Alleen de hash wordt opgeslagen.

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

Authenticatie: API-sleutel voor organisatie · write scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: 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	Indeling: date-time

Response (201):

API-sleutel aangemaakt, inclusief 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	Indeling: uuid
tenantId	string	Ja	Indeling: uuid
organizationId	string	Ja	Indeling: uuid
displayName	string	Ja	Maximale lengte: 128
partialKey	string	Ja	Maximale lengte: 128
enabled	boolean	Ja	Standaard: true
createdAt	string	Ja	Indeling: date-time
lastUsedAt	string	Ja	Indeling: date-time
expiresAt	string	Ja	Indeling: date-time
scope	object	Ja
secret	string	Ja	Maximale lengte: 128

Fouten:

• 400 Ongeldig verzoek, bijvoorbeeld door een ongeldige filterexpressie, een proces zonder model, een niet-ondersteund uploadtype of een ontbrekend verplicht veld
• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 403 API-sleutel heeft niet de vereiste scope of organisatietoegang, de tenant is inactief of het abonnement blokkeert het bestandstype

Een tenant-specifieke API-sleutel bijwerken

Hiervoor is een organisatiespecifieke schrijfsleutel vereist. Scopevelden worden samengevoegd met de opgeslagen scope.

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

Authenticatie: API-sleutel voor organisatie · write scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: uuid
keyId	string	path	Ja	Indeling: 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	Indeling: date-time

Response (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	Indeling: uuid
tenantId	string	Ja	Indeling: uuid
organizationId	string	Ja	Indeling: uuid
displayName	string	Ja	Maximale lengte: 128
partialKey	string	Ja	Maximale lengte: 128
enabled	boolean	Ja	Standaard: true
createdAt	string	Ja	Indeling: date-time
lastUsedAt	string	Ja	Indeling: date-time
expiresAt	string	Ja	Indeling: date-time
scope	object	Ja

Fouten:

• 400 Ongeldig verzoek, bijvoorbeeld door een ongeldige filterexpressie, een proces zonder model, een niet-ondersteund uploadtype of een ontbrekend verplicht veld
• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 403 API-sleutel heeft niet de vereiste scope of organisatietoegang, de tenant is inactief of het abonnement blokkeert het bestandstype
• 404 Bron niet gevonden

Een tenant-specifieke API-sleutel verwijderen

Hiervoor is een organisatiespecifieke schrijfsleutel vereist. De sleutel wordt logisch verwijderd en kan onmiddellijk niet meer worden gebruikt voor authenticatie.

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

Authenticatie: API-sleutel voor organisatie · write scope

Parameters:

Naam	Type	Locatie	Verplicht	Beschrijving
tenantId	string	path	Ja	Indeling: uuid
keyId	string	path	Ja	Indeling: uuid

Response (200):

API-sleutel verwijderd

{
	"message": "string"
}

Veld	Type	Verplicht	Beschrijving
message	string	Ja

Fouten:

• 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
• 403 API-sleutel heeft niet de vereiste scope of organisatietoegang, de tenant is inactief of het abonnement blokkeert het bestandstype
• 404 Bron niet gevonden