API Referentie: Tenants
API referentie voor beheer van tenants en gebruikersrechten.
Op deze pagina
API Referentie: Organisaties
Organization Endpoints
Organisaties groeperen meerdere tenants binnen één entiteit.
Get Organization
Haal informatie op over de organisatie waar een tenant onderdeel van is.
Endpoint: GET /tenant/{tenantId}/organization
Parameters:
| Naam | Type | Locatie | Vereist | Omschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | Unieke ID van de tenant |
Response:
{
"id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
"displayName": "Acme Corporation",
"createdAt": "2023-06-01T00:00:00Z"
}
Get Organization Statistics
Haalt samengevoegde statistieken op van de hele organisatie.
Endpoint: GET /tenant/{tenantId}/organization/statistics
Parameters:
| Naam | Type | Locatie | Vereist | Omschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | Unieke ID van de tenant |
Response:
{
"tenantCount": 5,
"totalProcessCount": 42,
"totalDatasetCount": 18,
"totalUserCount": 25,
"totalStorageUsedBytes": 5368709120
}
List Organization Tenants
Toon alle tenants in de organisatie.
Endpoint: GET /tenant/{tenantId}/organization/tenants
Parameters:
| Naam | Type | Locatie | Vereist | Omschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | Unieke ID van de tenant |
Response:
[
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"displayName": "Sales Department",
"createdAt": "2024-01-01T00:00:00Z"
},
{
"id": "d4e5f6a7-b8c9-0123-def4-567890123456",
"displayName": "Operations",
"createdAt": "2024-02-15T00:00:00Z"
}
]
Create Tenant
Maak een nieuwe tenant aan in de organisatie.
Endpoint: POST /tenant/{tenantId}/organization/tenants
Parameters:
| Naam | Type | Locatie | Vereist | Omschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | Unieke ID van een bestaande tenant in de organisatie |
Request Body:
{
"shortName": "sales-team",
"displayName": "Sales Team",
"description": "Tenant voor de salesafdeling"
}
| Veld | Type | Vereist | Omschrijving |
|---|---|---|---|
| shortName | string | Ja | URL-vriendelijk kenmerk (alleen kleine letters, koppeltekens toegestaan) |
| displayName | string | Nee | Naam van de tenant zoals zichtbaar voor gebruikers |
| description | string | Nee | Korte omschrijving van de tenant |
Response: Retourneert het aangemaakte tenant-object.
Delete Tenant
Verwijder een tenant uit de organisatie.
Endpoint: DELETE /tenant/{tenantId}/organization/tenants/{targetTenantId}
Parameters:
| Naam | Type | Locatie | Vereist | Omschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | Unieke ID van een bestaande tenant in de organisatie |
| targetTenantId | string | path | Ja | Unieke ID van de tenant die verwijderd moet worden |
Response:
{
"success": true
}
warning
Het verwijderen van een tenant verwijdert permanent alle processen, datasets en gebruikersrechten. Dit kan niet worden teruggedraaid. Je kunt de tenant waarmee je bent ingelogd niet verwijderen.
Organization Users Endpoints
List Organization Users
Toon alle gebruikers in de organisatie.
Endpoint: GET /tenant/{tenantId}/organization/users
Parameters:
| Naam | Type | Locatie | Vereist | Omschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | Unieke ID van de tenant |
Response:
[
{
"id": "e5f6a7b8-c9d0-1234-efa5-678901234567",
"email": "admin@example.com",
"firstName": "Jane",
"lastName": "Smith",
"createdAt": "2023-06-01T00:00:00Z",
"lastLoginAt": "2024-03-01T10:00:00Z",
"organizationId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
"isActiveInOrganization": true,
"isAdminInOrganization": true
}
]
Update Organization User
Pas de rechten van een gebruiker binnen de organisatie aan.
Endpoint: PUT /tenant/{tenantId}/organization/users
Request Body:
{
"userId": "e5f6a7b8-c9d0-1234-efa5-678901234567",
"organizationId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
"isActiveInOrganization": true,
"isAdminInOrganization": true
}
| Veld | Type | Vereist | Omschrijving |
|---|---|---|---|
| userId | string | Ja | Unieke ID van de gebruiker |
| organizationId | string | Ja | Unieke ID van de organisatie |
| isActiveInOrganization | boolean | Nee | Of de gebruiker actief is in de organisatie |
| isAdminInOrganization | boolean | Nee | Of de gebruiker admin-rechten heeft binnen de organisatie |
Response:
{
"message": "User organization settings updated."
}
Remove Organization User
Verwijder een gebruiker volledig uit de organisatie.
Endpoint: DELETE /tenant/{tenantId}/organization/users
Request Body:
{
"userId": "e5f6a7b8-c9d0-1234-efa5-678901234567",
"organizationId": "c3d4e5f6-a7b8-9012-cdef-345678901234"
}
| Veld | Type | Vereist | Omschrijving |
|---|---|---|---|
| userId | string | Ja | Unieke ID van de te verwijderen gebruiker |
| organizationId | string | Ja | Unieke ID van de organisatie |
Response:
{
"message": "User removed from organization."
}
warning
Het verwijderen van een gebruiker uit de organisatie blokkeert direct de toegang tot alle tenants binnen de organisatie.