Referência de API: Organizações

Endpoints de Organização

Organizações reúnem vários tenants sob uma única entidade.

Consultar Organização

Recupere informações da organização à qual o tenant pertence.

Endpoint: GET /tenant/{tenantId}/organization

Parâmetros:

Resposta:

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

Estatísticas da Organização

Recupere estatísticas agregadas de toda a organização.

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

Parâmetros:

Resposta:

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

Listar Tenants da Organização

Retorne todos os tenants da organização.

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

Parâmetros:

Resposta:

[
	{
		"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"
	}
]

Criar Tenant

Crie um novo tenant na organização.

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

Parâmetros:

Corpo da Requisição:

{
	"shortName": "sales-team",
	"displayName": "Sales Team",
	"description": "Tenant para o time de vendas"
}

Resposta: Retorna o objeto tenant criado.

Excluir Tenant

Exclua um tenant da organização.

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

Parâmetros:

Resposta:

{
	"success": true
}

Endpoints de Usuários da Organização

Listar Usuários da Organização

Retorne todos os usuários da organização.

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

Parâmetros:

Resposta:

[
	{
		"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
	}
]

Atualizar Usuário da Organização

Atualize as permissões de um usuário na organização.

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

Corpo da Requisição:

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

Resposta:

{
	"message": "Configurações do usuário na organização atualizadas."
}

Remover Usuário da Organização

Remova um usuário completamente da organização.

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

Corpo da Requisição:

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

Resposta:

{
	"message": "Usuário removido da organização."
}