Referência API: Tenants

Endpoints de Tenant

Consultar Tenant

Recupere detalhes de um tenant específico.

Endpoint: GET /tenant/{tenantId}

Parâmetros:

Resposta:

{
	"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
	"displayName": "Minha Empresa",
	"createdAt": "2024-01-15T10:30:00Z",
	"plan": "professional"
}

Atualizar Tenant

Atualize configurações do tenant, como o nome exibido.

Endpoint: PUT /tenant/{tenantId}

Parâmetros:

Request Body:

{
	"displayName": "Novo Nome da Empresa"
}

Resposta: Retorna o tenant atualizado.

Estatísticas do Tenant

Veja estatísticas de uso de um tenant.

Endpoint: GET /tenant/{tenantId}/statistics

Parâmetros:

Resposta:

{
	"processCount": 15,
	"datasetCount": 8,
	"userCount": 5,
	"storageUsedBytes": 1073741824
}

Endpoints de Usuários do Tenant

Listar Usuários do Tenant

Veja todos os usuários com acesso ao tenant.

Endpoint: GET /tenant/{tenantId}/users

Parâmetros:

Resposta:

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

Adicionar Usuário ao Tenant

Adicione um novo usuário a um tenant. O usuário será criado caso não exista ou adicionado ao tenant se já tiver uma conta. O ID do usuário é retornado na resposta.

Endpoint: POST /tenant/{tenantId}/users

Parâmetros:

Request Body:

{
	"email": "newuser@example.com",
	"firstName": "John",
	"lastName": "Doe",
	"isAdminInTenant": false,
	"isActiveInTenant": true,
	"isDeveloperInTenant": false
}

Resposta:

{
	"id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
	"message": "Usuário adicionado ao tenant."
}

Atualizar Usuário do Tenant

Atualize as permissões de um usuário no tenant.

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
}

Resposta:

{
	"message": "Configurações do usuário no tenant atualizadas."
}

Remover Usuário do Tenant

Remova o acesso de um usuário ao tenant.

Endpoint: DELETE /tenant/{tenantId}/users

Request Body:

{
	"userId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
	"tenantId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Resposta:

{
	"message": "Usuário removido do tenant."
}