Op deze pagina
> bronnen > documentatie > api > API referentie: organisaties

API-referentie: organisaties

warning

Als je een tenant verwijdert, worden alle bijbehorende processen, datasets en gebruikerstoewijzingen definitief verwijderd. Deze actie kan niet ongedaan worden gemaakt. Je kunt de tenant waarmee je bent aangemeld niet verwijderen.

warning

Als je een gebruiker uit de organisatie verwijdert, verliest diegene de toegang tot alle tenants binnen de organisatie.

Organisaties brengen meerdere tenants samen onder één entiteit.

De organisatie van de tenant ophalen

Op te vragen met een API-key voor één tenant. Een API-key voor de organisatie werkt ook.

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

Authenticatie: API-key voor één tenant of organisatie · scope read

Parameters:

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

Response (200):

Organisatiegegevens

{
	"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"
}
Veld Type Verplicht Beschrijving
id string Ja Indeling: uuid
displayName string Ja Standaard: ""
Maximale lengte: 128
createdAt string Ja Indeling: date-time
contactEmail string Ja Indeling: email
isActive boolean Ja Standaard: true
allowedLogins object Ja
createdBy string Ja Indeling: uuid

Fouten:

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

Licentiecapaciteit en automatisch synchronisatiebeleid van de organisatie ophalen

Geeft per niveau het aantal aangeschafte en gebruikte licentieplaatsen voor de hele organisatie terug (Process Foundation, Process Architecture, Process Intelligence), plus het aantal gratis viewer-licentieplaatsen, het doel voor automatische synchronisatie, uitleg over afwijkingen in het licentiegebruik (wat de engine doet en wanneer), de factureringsperiode en het externalApiSeatPolicy. Op te vragen met een API-key voor één tenant. De padparameter {tenantId} verwijst naar de contexttenant (de organisatie van de organisatiesleutel), niet naar het doel van de bewerking.

Endpoint: GET /v1/tenant/{tenantId}/organization/billing/seats

Authenticatie: API-key voor één tenant of organisatie · scope read

Parameters:

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

Response (200):

Licentiecapaciteit

{
	"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"
}
Veld Type Verplicht Beschrijving
contractType free | selfServe | fixed | unlimited Ja Toegestane waarden: free, selfServe, fixed, unlimited
isTrial boolean Ja
purchased object Ja
inUseBillable object Ja
inUseFree number Ja
inUseDashboardViewers number Ja
totalBillable number Ja
freeViewerAllowance number Ja
freeViewerOverAllowance number Ja
dashboardViewerAllowance number Ja
dashboardViewerOverAllowance number Ja
fixedOverage number Ja
target object Ja
drift object[] Ja
interval month | year Ja Toegestane waarden: month, year
nextBilledAt string Ja
externalApiSeatPolicy autoBill | requireCapacity Ja Toegestane waarden: autoBill, requireCapacity

Fouten:

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

Organisatiestatistieken ophalen

De padparameter {tenantId} verwijst naar de contexttenant (de organisatie van de organisatiesleutel), niet naar het doel van de bewerking.

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

Authenticatie: API-key voor de organisatie · scope read

Parameters:

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

Response (200):

Organisatiestatistieken

{
	"userCount": 0,
	"tenantCount": 0,
	"tenantStatistics": [
		{
			"tenantId": "00000000-0000-0000-0000-000000000000",
			"uploadedDataSize": 0,
			"uploadedDataCount": 0,
			"modelCount": 0,
			"simulationCount": 0,
			"userCount": 0
		}
	]
}
Veld Type Verplicht Beschrijving
userCount number Ja
tenantCount number Ja
tenantStatistics object[] Ja

Fouten:

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

Alle tenants in de organisatie weergeven

De padparameter {tenantId} verwijst naar de contexttenant (de organisatie van de organisatiesleutel), niet naar het doel van de bewerking.

Endpoint: GET /v1/tenant/{tenantId}/organization/tenants

Authenticatie: API-key voor de organisatie · scope read

Parameters:

Naam Type Locatie Verplicht Beschrijving
tenantId string path Ja Indeling: uuid
limit integer query Nee Maximumaantal resultaten
offset integer query Nee Aantal resultaten om over te slaan

Response (200):

Lijst met tenants

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

Fouten:

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

Een tenant aan de organisatie toevoegen (vereist een API-key voor de organisatie)

De padparameter {tenantId} verwijst naar de contexttenant (de organisatie van de organisatiesleutel), niet naar het doel van de bewerking.

Endpoint: POST /v1/tenant/{tenantId}/organization/tenants

Authenticatie: API-key voor de organisatie · scope write

Parameters:

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

Requestbody:

{
	"displayName": "string",
	"shortName": "string",
	"description": "string",
	"timezone": "string",
	"tenantType": "normal"
}
Veld Type Verplicht Beschrijving
displayName string Nee Maximale lengte: 128
shortName string Ja
description string Nee Maximale lengte: 200
timezone string Nee Maximale lengte: 64
tenantType normal | sandbox | demo Nee Toegestane waarden: normal, sandbox, demo

Response (201):

Tenant aangemaakt

{
	"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 door een ongeldige filterexpressie, een proces zonder model, een niet-ondersteund uploadtype of een ontbrekend verplicht veld
  • 401 API-key ontbreekt, is ongeldig, uitgeschakeld of verlopen
  • 403 De API-key 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 omdat de korte naam gereserveerd is of al bestaat

Een tenant in de organisatie voorlopig verwijderen (vereist een API-key voor de organisatie)

De API-toegang voor de tenant wordt meteen stopgezet. De tenant en de bijbehorende data blijven bewaard tijdens de veiligheidsperiode voor verwijdering. Daarna verwijdert het systeem ze definitief. De tenant die je op dat moment gebruikt (de contexttenant) kan niet worden verwijderd.

Endpoint: DELETE /v1/tenant/{tenantId}/organization/tenants/{targetId}

Authenticatie: API-key voor de organisatie · scope write

Parameters:

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

Response (200):

Tenant verwijderd

{
	"success": true,
	"message": "string"
}
Veld Type Verplicht Beschrijving
success boolean Ja
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 API-key ontbreekt, is ongeldig, uitgeschakeld of verlopen
  • 403 De API-key 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 voorlopig verwijderde tenant in de organisatie herstellen (vereist een API-key voor de organisatie)

Maak een voorlopige verwijdering ongedaan binnen de veiligheidsperiode: de tenant en de bijbehorende data worden precies teruggezet zoals ze waren en de API-toegang wordt hersteld. De padparameter {tenantId} verwijst naar de contexttenant (de organisatie van de organisatiesleutel), niet naar het doel van de bewerking.

Endpoint: POST /v1/tenant/{tenantId}/organization/tenants/{targetId}/restore

Authenticatie: API-key voor de organisatie · scope write

Parameters:

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

Response (200):

Tenant hersteld

{
	"success": true,
	"message": "string"
}
Veld Type Verplicht Beschrijving
success boolean Ja
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 API-key ontbreekt, is ongeldig, uitgeschakeld of verlopen
  • 403 De API-key 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

Alle gebruikers in de organisatie weergeven

De padparameter {tenantId} verwijst naar de contexttenant (de organisatie van de organisatiesleutel), niet naar het doel van de bewerking.

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

Authenticatie: API-key voor de organisatie · scope read

Parameters:

Naam Type Locatie Verplicht Beschrijving
tenantId string path Ja Indeling: uuid
limit integer query Nee Maximumaantal resultaten
offset integer query Nee Aantal resultaten om over te slaan

Response (200):

Lijst met organisatiegebruikers

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

Fouten:

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

Instellingen van een organisatiegebruiker wijzigen (vereist een API-key voor de organisatie)

De rolvlaggen in de body (isAdminInOrganization, isActiveInOrganization) worden precies overgenomen. Geef alleen API-keys voor de organisatie uit aan organisatiebeheerders. De padparameter {tenantId} verwijst naar de contexttenant (de organisatie van de organisatiesleutel), niet naar het doel van de bewerking.

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

Authenticatie: API-key voor de organisatie · scope write

Parameters:

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

Requestbody:

{
	"isActiveInOrganization": true,
	"isAdminInOrganization": true
}
Veld Type Verplicht Beschrijving
isActiveInOrganization boolean Nee Of de gebruiker actief is in de organisatie
isAdminInOrganization boolean Nee Beheerdersrechten voor de organisatie (worden precies overgenomen: geef alleen API-keys voor de organisatie uit aan organisatiebeheerders)

Response (200):

Bijgewerkt

{
	"message": "string"
}
Veld Type Verplicht Beschrijving
message string Ja

Fouten:

  • 401 API-key ontbreekt, is ongeldig, uitgeschakeld of verlopen
  • 403 De API-key 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 gebruiker uit de organisatie verwijderen (vereist een API-key voor de organisatie)

De padparameter {tenantId} verwijst naar de contexttenant (de organisatie van de organisatiesleutel), niet naar het doel van de bewerking.

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

Authenticatie: API-key voor de organisatie · scope write

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:

  • 401 API-key ontbreekt, is ongeldig, uitgeschakeld of verlopen
  • 403 De API-key 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

Gerelateerde documentatie

Verbeter processen. Bouw aan een samenhangende architectuur. Houd de regie.

Krijg meteen toegang, zonder creditcard of wachttijd. Maak van de manier waarop je organisatie werkt heldere, samenhangende procesmodellen.

Breng de procesarchitectuur in kaart, leg verantwoordelijkheden en beheersmaatregelen vast en stem rollen en taken op elk niveau op elkaar af.

Start je gratis proefperiode en bouw een betrouwbare basis om processen te beheren en continu te verbeteren.

Start vandaag je gratis proefperiode