API Reference: Organizations

Organization Endpoints

Organizations group multiple tenants together under a single entity.

Get Organization

Retrieve information about the organization a tenant belongs to.

Endpoint: GET /tenant/{tenantId}/organization

Parameters:

Response:

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

Get Organization Statistics

Retrieve aggregated statistics for the entire organization.

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

Parameters:

Response:

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

List Organization Tenants

Retrieve all tenants in the organization.

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

Parameters:

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

Create a new tenant in the organization.

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

Parameters:

Request Body:

{
	"shortName": "sales-team",
	"displayName": "Sales Team",
	"description": "Tenant for the sales department"
}

Response: Returns the created tenant object.

Delete Tenant

Delete a tenant from the organization.

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

Parameters:

Response:

{
	"success": true
}

Organization Users Endpoints

List Organization Users

Retrieve all users in the organization.

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

Parameters:

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

Update a user’s permissions within the organization.

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

Request Body:

{
	"userId": "e5f6a7b8-c9d0-1234-efa5-678901234567",
	"organizationId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
	"isActiveInOrganization": true,
	"isAdminInOrganization": true
}

Response:

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

Remove Organization User

Remove a user from the organization entirely.

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

Request Body:

{
	"userId": "e5f6a7b8-c9d0-1234-efa5-678901234567",
	"organizationId": "c3d4e5f6-a7b8-9012-cdef-345678901234"
}

Response:

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