API Referentie: Organisaties
API-referentie voor organisatiebeheer en gebruikersbeheer endpoints.
Haal de details op van een specifieke tenant.
Endpoint: GET /tenant/{tenantId}
Parameters:
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | De unieke ID van de tenant |
Response:
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"displayName": "Mijn Bedrijf",
"createdAt": "2024-01-15T10:30:00Z",
"plan": "professional"
}
Werk tenantinstellingen bij, zoals de weergavenaam.
Endpoint: PUT /tenant/{tenantId}
Parameters:
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | De unieke ID van de tenant |
Request Body:
{
"displayName": "Nieuwe bedrijfsnaam"
}
Response: Geeft het bijgewerkte tenantobject terug.
Bekijk gebruiksstatistieken van een tenant.
Endpoint: GET /tenant/{tenantId}/statistics
Parameters:
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | De unieke ID van de tenant |
Response:
{
"processCount": 15,
"datasetCount": 8,
"userCount": 5,
"storageUsedBytes": 1073741824
}
Toon alle gebruikers die toegang hebben tot de tenant.
Endpoint: GET /tenant/{tenantId}/users
Parameters:
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | De 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
}
]
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}/users
Parameters:
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | De unieke ID van de tenant |
Request Body:
{
"email": "newuser@example.com",
"firstName": "John",
"lastName": "Doe",
"isAdminInTenant": false,
"isActiveInTenant": true,
"isDeveloperInTenant": false
}
| Veld | Type | Verplicht | Beschrijving |
|---|---|---|---|
| string | Ja | E-mailadres van de gebruiker | |
| firstName | string | Nee | Voornaam van de gebruiker |
| lastName | string | Nee | Achternaam van de gebruiker |
| isAdminInTenant | boolean | Nee | Of de gebruiker adminrechten heeft in deze tenant |
| isActiveInTenant | boolean | Nee | Of de gebruiker actief is in deze tenant |
| isDeveloperInTenant | boolean | Nee | Of de gebruiker developerrechten heeft in deze tenant |
Response:
{
"id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
"message": "Gebruiker toegevoegd aan tenant."
}
Pas de rechten van een gebruiker in een tenant aan.
Endpoint: PUT /tenant/{tenantId}/users
Request Body:
{
"userId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
"tenantId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"isAdminInTenant": true,
"isActiveInTenant": true,
"isDeveloperInTenant": false
}
| Veld | Type | Verplicht | Beschrijving |
|---|---|---|---|
| userId | string | Ja | De unieke ID van de gebruiker |
| tenantId | string | Ja | De unieke ID van de tenant |
| isAdminInTenant | boolean | Nee | Of de gebruiker adminrechten heeft |
| isActiveInTenant | boolean | Nee | Of de gebruiker actief is in deze tenant |
| isDeveloperInTenant | boolean | Nee | Of de gebruiker developerrechten heeft |
Response:
{
"message": "Gebruikersrechten in tenant bijgewerkt."
}
Verwijder de toegang van een gebruiker tot een tenant.
Endpoint: DELETE /tenant/{tenantId}/users
Request Body:
{
"userId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
"tenantId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
| Veld | Type | Verplicht | Beschrijving |
|---|---|---|---|
| userId | string | Ja | De unieke ID van de te verwijderen gebruiker |
| tenantId | string | Ja | De unieke ID van de tenant |
Response:
{
"message": "Gebruiker verwijderd uit tenant."
}