API de Ligações
As ligações representam tenants Microsoft 365 vinculados. Cada ligação corresponde a um tenant Microsoft (identificado pelo seu msTenantId) ao qual foi concedido consentimento administrativo.
Listar Ligações
Devolve todos os tenants Microsoft 365 ligados a conta autenticada.
GET /tenants/me/connectionsExemplo de Pedido
bash
curl https://api.aether365.io/tenants/me/connections \
-H "Authorization: Bearer <token>"Exemplo de Resposta
json
{
"success": true,
"data": [
{
"id": "conn_abc123",
"msTenantId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"label": "Contoso Production",
"connectedAt": "2026-02-01T09:00:00Z",
"isPrimary": true
},
{
"id": "conn_def456",
"msTenantId": "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy",
"label": "Contoso Staging",
"connectedAt": "2026-03-15T14:30:00Z",
"isPrimary": false
}
]
}Campos da Resposta
| Campo | Tipo | Descrição |
|---|---|---|
id | string | Identificador da ligação |
msTenantId | string | ID do tenant Microsoft Entra (GUID) |
label | string | Rótulo de apresentação atribuído durante a ligação |
connectedAt | string | Data e hora ISO 8601 da ligação do tenant |
isPrimary | boolean | Se este é o tenant atualmente ativo |
Ativar uma Ligação
Define um tenant ligado como o tenant ativo. As vistas do painel de controlo e os pedidos a API sem um filtro explicito de tenant operam sobre o tenant ativo.
POST /tenants/me/connections/{connectionId}/activateParâmetros de Caminho
| Parâmetro | Tipo | Descrição |
|---|---|---|
connectionId | string | O ID da ligação a ativar |
Exemplo de Pedido
bash
curl -X POST https://api.aether365.io/tenants/me/connections/conn_def456/activate \
-H "Authorization: Bearer <token>"Exemplo de Resposta
json
{
"success": true,
"data": {
"id": "conn_def456",
"msTenantId": "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy",
"label": "Contoso Staging",
"connectedAt": "2026-03-15T14:30:00Z",
"isPrimary": true
}
}Remover uma Ligação
Desliga um tenant Microsoft 365. Interrompe futuras análises para este tenant. Os dados de análise existentes são retidos de acordo com a política de retenção.
DELETE /tenants/me/connections/{connectionId}WARNING
Esta ação não pode ser desfeita. Religar o tenant requer repetir o fluxo de consentimento administrativo.
Parâmetros de Caminho
| Parâmetro | Tipo | Descrição |
|---|---|---|
connectionId | string | O ID da ligação a remover |
Exemplo de Pedido
bash
curl -X DELETE https://api.aether365.io/tenants/me/connections/conn_def456 \
-H "Authorization: Bearer <token>"Exemplo de Resposta
json
{
"success": true,
"data": null
}Erros
| Código | HTTP | Descrição |
|---|---|---|
CONNECTION_NOT_FOUND | 404 | Não existe ligação com este ID para este tenant |
CANNOT_REMOVE_LAST_CONNECTION | 409 | Não é possível remover a única ligação restante |