Op deze pagina

API-referentie: Tenants

Tenant Endpoints

Tenant ophalen

Haal de details op van een specifieke tenant.

Endpoint: GET /tenant/{tenantId}

Parameters:

NaamTypeLocatieVerplichtOmschrijving
tenantIdstringpathJaHet unieke ID van de tenant

Response:

{
	"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
	"displayName": "My Company",
	"createdAt": "2024-01-15T10:30:00Z",
	"plan": "professional"
}

Tenant bijwerken

Werk tenantinstellingen bij, zoals de weergavenaam.

Endpoint: PUT /tenant/{tenantId}

Parameters:

NaamTypeLocatieVerplichtOmschrijving
tenantIdstringpathJaHet unieke ID van de tenant

Request Body:

{
	"displayName": "New Company Name"
}

Response: Geeft het bijgewerkte tenantobject terug.


Tenantstatistieken ophalen

Bekijk gebruiksstatistieken van een tenant.

Endpoint: GET /tenant/{tenantId}/statistics

Parameters:

NaamTypeLocatieVerplichtOmschrijving
tenantIdstringpathJaHet unieke ID van de tenant

Response:

{
	"processCount": 15,
	"datasetCount": 8,
	"userCount": 5,
	"storageUsedBytes": 1073741824
}

Tenant Gebruikers Endpoints

Lijst van tenantgebruikers

Toon allese gebruikers die toegang hebben tot de tenant.

Endpoint: GET /tenant/{tenantId}/gebruikers

Parameters:

NaamTypeLocatieVerplichtOmschrijving
tenantIdstringpathJaHet unieke ID van de tenant

Response:

[
	{
		"id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
		"email": "user@example.com",
		"firstName": "John",
		"lastName": "Doe",
		"createdAt": "2024-01-15T10:30:00Z",
		"lastLoginAt": "2024-03-01T14:00:00Z",
		"tenantId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
		"isActiveInTenant": true,
		"isAdminInTenant": false,
		"isDeveloperInTenant": false,
		"organizationId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
		"isActiveInOrganization": true,
		"isAdminInOrganization": false
	}
]

Tenantgebruiker toevoegen

Voeg een nieuwe gebruiker toe aan een tenant. Bestaat de gebruiker nog niet, dan wordt deze aangemaakt. Heeft de gebruiker al een account, dan wordt deze toegevoegd aan de tenant. De user ID wordt teruggegeven in de response.

Endpoint: POST /tenant/{tenantId}/gebruikers

Parameters:

NaamTypeLocatieVerplichtOmschrijving
tenantIdstringpathJaHet unieke ID van de tenant

Request Body:

{
	"email": "newuser@example.com",
	"firstName": "John",
	"lastName": "Doe",
	"isAdminInTenant": false,
	"isActiveInTenant": true,
	"isDeveloperInTenant": false
}
VeldTypeVerplichtOmschrijving
emailstringJaE-mailadres van de gebruiker
firstNamestringNeeVoornaam van de gebruiker
lastNamestringNeeAchternaam van de gebruiker
isAdminInTenantbooleanNeeOf de gebruiker beheerdersrechten heeft in deze tenant
isActiveInTenantbooleanNeeOf de gebruiker actief is in deze tenant
isDeveloperInTenantbooleanNeeOf de gebruiker ontwikkelaarsrechten heeft in deze tenant

Response:

{
	"id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
	"message": "User added to tenant."
}

Tenantgebruiker bijwerken

Pas de rechten van een gebruiker in een tenant aan.

Endpoint: PUT /tenant/{tenantId}/gebruikers

Request Body:

{
	"userId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
	"tenantId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
	"isAdminInTenant": true,
	"isActiveInTenant": true,
	"isDeveloperInTenant": false
}
VeldTypeVerplichtOmschrijving
userIdstringJaHet unieke ID van de gebruiker
tenantIdstringJaHet unieke ID van de tenant
isAdminInTenantbooleanNeeOf de gebruiker beheerdersrechten heeft
isActiveInTenantbooleanNeeOf de gebruiker actief is in deze tenant
isDeveloperInTenantbooleanNeeOf de gebruiker ontwikkelaarsrechten heeft

Response:

{
	"message": "User tenant settings updated."
}

Tenantgebruiker verwijderen

Verwijder de toegang van een gebruiker tot een tenant.

Endpoint: DELETE /tenant/{tenantId}/gebruikers

Request Body:

{
	"userId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
	"tenantId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
VeldTypeVerplichtOmschrijving
userIdstringJaHet unieke ID van de te verwijderen gebruiker
tenantIdstringJaHet unieke ID van de tenant

Response:

{
	"message": "User removed from tenant."
}