Op deze pagina

API Referentie: Organisaties

Organisatie-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:

NaamTypeLocatieVerplichtOmschrijving
tenantIdstringpathJaHet unieke ID van de tenant

Response:

{
	"id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
	"displayName": "Acme Corporation",
	"createdAt": "2023-06-01T00:00:00Z"
}

Get Organization Statistieken

Haalt samengevoegde statistieken op van de hele organisatie.

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

Parameters:

NaamTypeLocatieVerplichtOmschrijving
tenantIdstringpathJaHet unieke ID van de tenant

Response:

{
	"tenantCount": 5,
	"totalProcessCount": 42,
	"totalDatasetCount": 18,
	"totalUserCount": 25,
	"totalStorageUsedBytes": 5368709120
}

List Organization Tenants

Toon allese tenants in de organisatie.

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

Parameters:

NaamTypeLocatieVerplichtOmschrijving
tenantIdstringpathJaHet 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:

NaamTypeLocatieVerplichtOmschrijving
tenantIdstringpathJaUnieke ID van een bestaande tenant in de organisatie

Request Body:

{
	"shortName": "sales-team",
	"displayName": "Sales Team",
	"description": "Tenant for the sales department"
}
VeldTypeVerplichtOmschrijving
shortNamestringJaURL-vriendelijk kenmerk (alleen kleine letters, koppeltekens toegestaan)
displayNamestringNeeNaam van de tenant zoals zichtbaar voor gebruikers
descriptionstringNeeKorte omschrijving van de tenant

Response: Retourneert het aangemaakte tenant-object.


Verwijderen Tenant

Verwijder een tenant uit de organisatie.

Endpoint: DELETE /tenant/{tenantId}/organization/tenants/{targetTenantId}

Parameters:

NaamTypeLocatieVerplichtOmschrijving
tenantIdstringpathJaUnieke ID van een bestaande tenant in de organisatie
targetTenantIdstringpathJaUnieke ID van de tenant die verwijderd moet worden

Response:

{
	"success": true
}

waarschuwing

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 Gebruikers Endpoints

List Organization Gebruikers

Toon allese gebruikers in de organisatie.

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

Parameters:

NaamTypeLocatieVerplichtOmschrijving
tenantIdstringpathJaHet 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 Gebruiker

Pas de rechten van een gebruiker binnen de organisatie aan.

Endpoint: PUT /tenant/{tenantId}/organization/gebruikers

Request Body:

{
	"userId": "e5f6a7b8-c9d0-1234-efa5-678901234567",
	"organizationId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
	"isActiveInOrganization": true,
	"isAdminInOrganization": true
}
VeldTypeVerplichtOmschrijving
userIdstringJaUnieke ID van de gebruiker
organizationIdstringJaUnieke ID van de organisatie
isActiveInOrganizationbooleanNeeOf de gebruiker actief is in de organisatie
isAdminInOrganizationbooleanNeeOf de gebruiker admin-rechten heeft binnen de organisatie

Response:

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

Remove Organization Gebruiker

Verwijder een gebruiker volledig uit de organisatie.

Endpoint: DELETE /tenant/{tenantId}/organization/gebruikers

Request Body:

{
	"userId": "e5f6a7b8-c9d0-1234-efa5-678901234567",
	"organizationId": "c3d4e5f6-a7b8-9012-cdef-345678901234"
}
VeldTypeVerplichtOmschrijving
userIdstringJaUnieke ID van de te verwijderen gebruiker
organizationIdstringJaUnieke ID van de organisatie

Response:

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

waarschuwing

Het verwijderen van een gebruiker uit de organisatie blokkeert direct de toegang tot alle tenants binnen de organisatie.