Saltar para o conteúdo principal
DELETE
Encerrar Sessão

Encerrar Sessão

DELETE /v1/agent-sessions/{sessionID} Encerra imediatamente uma sessão de agente ativa. O token de acesso e o token de atualização da sessão são invalidados, e o status da sessão transita para "terminated". Quaisquer chamadas de API subsequentes usando os tokens desta sessão serão rejeitadas.
O término da sessão é registrado no log de auditoria com um AGENT_SESSION_TERMINATED evento. Um recibo de rescisão não é automaticamente gerado — use a API de recibos para criar um se seu fluxo de trabalho de conformidade o exige.

Autenticação

Requer cabeçalho X-API-Key ou token JWT de portador. O espaço de trabalho é derivado da credencial autenticada; não envie X-Tenant-ID.

Resposta

string
Status atualizado, sempre "terminated" em caso de sucesso.
string
O identificador de sessão MAIP que foi encerrado.

Exemplo


Limpeza de Sessão em Massa

Para encerrar todas as sessões ativas para um agente específico (por exemplo, durante a resposta a incidentes), liste as sessões filtradas por agente e status e, em seguida, encerre cada uma:
Para uma resposta mais rápida a incidentes, suspender o agente bloqueia imediatamente todas as operações de sessão sem exigir o término individual da sessão.

Autorizações

X-API-Key
string
header
obrigatório

Chave de API para autenticação máquina a máquina

Parâmetros de caminho

sessionId
string<uuid>
obrigatório

Identificador da sessão

Corpo

application/json
reason
string
obrigatório

Motivo da rescisão

Resposta

Sessão encerrada

session_id
string<uuid>
agent_id
string<uuid>
token
string

Token de portador da sessão (retornado uma vez na criação)

scopes
string[]
status
enum<string>
Opções disponíveis:
active,
terminated,
expired
metadata
object
expires_at
string<date-time>
created_at
string<date-time>
terminated_at
string<date-time>