Saltar al contenido principal
DELETE
Terminar sesión

Terminar Sesión

DELETE /v1/agent-sessions/{sessionID} Termina inmediatamente una sesión de agente activa. El token de acceso y el token de actualización de la sesión se invalidan, y el estado de la sesión pasa a "terminated". Cualquier llamada API posterior que utilice los tokens de esta sesión será rechazada.
La terminación de la sesión se registra en el registro de auditoría con un evento AGENT_SESSION_TERMINATED. Un recibo de terminación no se genera automáticamente generado — use la API de recibos para crear uno si su flujo de trabajo de cumplimiento lo requiere.

Autenticación

Requiere el encabezado X-API-Key o el token Bearer JWT. El espacio de trabajo se deriva de la credencial autenticada; no envíe X-Tenant-ID.

Respuesta

string
Estado actualizado, siempre "terminated" en caso de éxito.
string
El identificador de sesión MAIP que fue terminado.

Ejemplo


Limpieza masiva de sesiones

Para terminar todas las sesiones activas de un agente específico (por ejemplo, durante la respuesta a un incidente), liste las sesiones filtradas por agente y estado, luego termine cada una:
Para una respuesta más rápida a incidentes, suspender el agente bloquea inmediatamente todas las operaciones de sesión sin requerir la terminación individual de la sesión.

Autorizaciones

X-API-Key
string
header
requerido

Clave API para autenticación máquina a máquina

Parámetros de ruta

sessionId
string<uuid>
requerido

Identificador de sesión

Cuerpo

application/json
reason
string
requerido

Motivo de la terminación

Respuesta

Sesión terminada

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

Token de portador de sesión (devuelto una vez en la creación)

scopes
string[]
status
enum<string>
Opciones disponibles:
active,
terminated,
expired
metadata
object
expires_at
string<date-time>
created_at
string<date-time>
terminated_at
string<date-time>