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

API-referentie: organisaties

warning

Als je een tenant verwijdert, worden alle processen, datasets en gebruikerstoewijzingen permanent verwijderd. Deze actie kan niet ongedaan worden gemaakt. Je kunt de tenant die je gebruikt voor authenticatie niet verwijderen.

warning

Als je een gebruiker uit de organisatie verwijdert, vervalt diens toegang tot alle tenants binnen de organisatie.

Organisaties groeperen meerdere tenants onder één entiteit.

De organisatie voor de tenant ophalen

Leesbaar met een tenantgebonden API-sleutel. Een organisatiegebonden sleutel wordt ook geaccepteerd.

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

Auth: Tenant- of organisatiegebonden API-sleutel · read-scope

Parameters:

Naam Type Locatie Vereist Beschrijving
tenantId string pad 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 Vereist 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 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
  • 404 Bron niet gevonden

De licentieplaatscapaciteit en het beleid voor automatische synchronisatie van de organisatie ophalen

Retourneert het aantal aangeschafte en gebruikte seats voor de hele organisatie per niveau (Procesfundament, Procesarchitectuur, Process Intelligence), de limiet voor gratis viewers, het doel voor automatische synchronisatie, de uitleg over seatverschillen, het factureringsinterval en externalApiSeatPolicy. Leesbaar met een tenantgebonden API-sleutel. De padparameter {tenantId} is de contexttenant, dus de organisatie van de organisatiesleutel, en niet het doel van de bewerking.

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

Auth: Tenant- of organisatiegebonden API-sleutel · read-scope

Parameters:

Naam Type Locatie Vereist Beschrijving
tenantId string pad Ja Indeling: uuid

Response (200):

Licentieplaatscapaciteit

{
	"contractType": "free",
	"isTrial": true,
	"purchased": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"inUseBillable": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"inUseFree": 0,
	"totalBillable": 0,
	"freeViewerAllowance": 0,
	"freeViewerOverAllowance": 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 Vereist 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
totalBillable number Ja
freeViewerAllowance number Ja
freeViewerOverAllowance 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 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
  • 404 Bron niet gevonden

Statistieken voor de hele organisatie ophalen

De padparameter {tenantId} is de contexttenant (de organisatie van de organisatiegebonden sleutel), niet het doel van de bewerking.

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

Auth: Organisatiegebonden API-sleutel · read-scope

Parameters:

Naam Type Locatie Vereist Beschrijving
tenantId string pad 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 Vereist Beschrijving
userCount number Ja
tenantCount number Ja
tenantStatistics object[] Ja

Fouten:

  • 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel

Alle tenants in de organisatie weergeven

De padparameter {tenantId} is de contexttenant (de organisatie van de organisatiegebonden sleutel), niet het doel van de bewerking.

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

Auth: Organisatiegebonden API-sleutel · read-scope

Parameters:

Naam Type Locatie Vereist Beschrijving
tenantId string pad Ja Indeling: uuid
limit integer query Nee Maximumaantal items dat wordt geretourneerd
offset integer query Nee Aantal over te slaan items

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
		},
		"url": "string"
	}
]

Fouten:

  • 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel

Een nieuwe tenant maken in de organisatie (vereist een organisatiegebonden API-sleutel)

De padparameter {tenantId} is de contexttenant (de organisatie van de organisatiegebonden sleutel), niet het doel van de bewerking.

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

Auth: Organisatiegebonden API-sleutel · write-scope

Parameters:

Naam Type Locatie Vereist Beschrijving
tenantId string pad Ja Indeling: uuid

Request body:

{
	"displayName": "string",
	"shortName": "string",
	"description": "string"
}
Veld Type Vereist Beschrijving
displayName string Nee Maximale lengte: 128
shortName string Ja
description string Nee Maximale lengte: 200

Response (201):

Tenant gemaakt

{
	"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 Vereist 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 De 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 short name gereserveerd of al in gebruik is

Een tenant in de organisatie soft deleten (vereist een organisatiegebonden API-sleutel)

De API-toegang voor de tenant stopt onmiddellijk. De tenant en de bijbehorende data worden tijdens de veiligheidsperiode voor verwijdering bewaard en daarna automatisch volledig verwijderd. De tenant die je momenteel gebruikt, de contexttenant, kan niet worden verwijderd.

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

Auth: Organisatiegebonden API-sleutel · write-scope

Parameters:

Naam Type Locatie Vereist Beschrijving
tenantId string pad Ja Indeling: uuid
targetId string pad Ja Indeling: uuid

Response (200):

Tenant verwijderd

{
	"success": true,
	"message": "string"
}
Veld Type Vereist 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 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
  • 403 De API-sleutel heeft niet de vereiste scope of organisatietoegang, de tenant is inactief of het abonnement blokkeert het bestandstype
  • 404 Bron niet gevonden

Een soft gedelete tenant in de organisatie herstellen (vereist een organisatiegebonden API-sleutel)

Maak een soft delete ongedaan binnen de veiligheidsperiode voor verwijdering: de tenant en de bijbehorende data worden precies teruggezet en de API-toegang wordt hervat. De padparameter {tenantId} is de contexttenant (de organisatie van de organisatiegebonden sleutel), niet het doel van de bewerking.

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

Auth: Organisatiegebonden API-sleutel · write-scope

Parameters:

Naam Type Locatie Vereist Beschrijving
tenantId string pad Ja Indeling: uuid
targetId string pad Ja Indeling: uuid

Response (200):

Tenant hersteld

{
	"success": true,
	"message": "string"
}
Veld Type Vereist 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 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
  • 403 De API-sleutel heeft niet de vereiste scope of organisatietoegang, de tenant is inactief of het abonnement blokkeert het bestandstype
  • 404 Bron niet gevonden

Alle gebruikers in de organisatie weergeven

De padparameter {tenantId} is de contexttenant (de organisatie van de organisatiegebonden sleutel), niet het doel van de bewerking.

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

Auth: Organisatiegebonden API-sleutel · read-scope

Parameters:

Naam Type Locatie Vereist Beschrijving
tenantId string pad Ja Indeling: uuid
limit integer query Nee Maximumaantal items dat wordt geretourneerd
offset integer query Nee Aantal over te slaan items

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

Instellingen van een organisatiegebruiker bijwerken (vereist een organisatiegebonden API-sleutel)

De rolvlaggen in de body (isAdminInOrganization, isActiveInOrganization) worden letterlijk toegepast. Geef organisatiegebonden sleutels alleen uit aan organisatiebeheerders. De padparameter {tenantId} is de contexttenant (de organisatie van de organisatiegebonden sleutel), niet het doel van de bewerking.

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

Auth: Organisatiegebonden API-sleutel · write-scope

Parameters:

Naam Type Locatie Vereist Beschrijving
tenantId string pad Ja Indeling: uuid
userId string pad Ja Indeling: uuid

Request body:

{
	"isActiveInOrganization": true,
	"isAdminInOrganization": true
}
Veld Type Vereist Beschrijving
isActiveInOrganization boolean Nee Of de gebruiker actief is in de organisatie
isAdminInOrganization boolean Nee Beheerdersrechten voor de organisatie, letterlijk toegepast: geef organisatiegebonden sleutels alleen uit aan organisatiebeheerders

Response (200):

Bijgewerkt

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

Fouten:

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

Een gebruiker uit de organisatie verwijderen (vereist een organisatiegebonden API-sleutel)

De padparameter {tenantId} is de contexttenant (de organisatie van de organisatiegebonden sleutel), niet het doel van de bewerking.

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

Auth: Organisatiegebonden API-sleutel · write-scope

Parameters:

Naam Type Locatie Vereist Beschrijving
tenantId string pad Ja Indeling: uuid
userId string pad Ja Indeling: uuid

Response (200):

Gebruiker verwijderd

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

Fouten:

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

Gerelateerde documentatie