Actualizar parcialmente una sesión por id

Actualice la información de la sesión.

PATCH https://{tenantDomain}/api/v2/sessions/{id}

Actualizar la sesión

cURL

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/sessions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "session_metadata": {}
}
'

200

{
  "authenticated_at": "2023-11-07T05:31:56Z",
  "authentication": {
    "methods": [
      {
        "name": "<string>",
        "timestamp": "2023-11-07T05:31:56Z",
        "type": "<string>"
      }
    ]
  },
  "clients": [
    {
      "client_id": "<string>"
    }
  ],
  "cookie": {},
  "created_at": "2023-11-07T05:31:56Z",
  "device": {
    "initial_asn": "<string>",
    "initial_ip": "<string>",
    "initial_user_agent": "<string>",
    "last_asn": "<string>",
    "last_ip": "<string>",
    "last_user_agent": "<string>"
  },
  "expires_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "idle_expires_at": "2023-11-07T05:31:56Z",
  "last_interacted_at": "2023-11-07T05:31:56Z",
  "session_metadata": {},
  "updated_at": "2023-11-07T05:31:56Z",
  "user_id": "<string>"
}

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parámetros de ruta

id · string · requerido

ID de la sesión que se va a actualizar.

Cuerpo

application/jsonapplication/x-www-form-urlencoded

session_metadata · object

Metadatos asociados a la sesión. Pasa null o {} para eliminar todos los session_metadata.

Respuesta

200

application/json

Sesión actualizada correctamente.

authenticated_at · string<date-time> object

La fecha y hora en que se creó la sesión

authentication · object

Detalles sobre las señales de autenticación obtenidas durante el flujo de inicio de sesión

Show child attributes

clients · object[]

Lista de detalles del cliente para la sesión

Show child attributes

cookie · object

[Acceso anticipado privado] Configuración de la cookie de sesión.

Show child attributes

created_at · string<date-time> object

La fecha y hora en que se creó la sesión

device · object

Metadatos relacionados con el dispositivo utilizado en la sesión

Show child attributes

expires_at · string<date-time> object

La fecha y hora en que se creó la sesión

id · string

El ID de la sesión

idle_expires_at · string<date-time> object

La fecha y hora en que se creó la sesión

last_interacted_at · string<date-time> object

La fecha y hora en que se creó la sesión

session_metadata · object

Metadatos asociados a la sesión, en forma de objeto con valores de cadena (máx. 255 caracteres). Se permite un máximo de 25 propiedades de metadatos.

updated_at · string<date-time> object

La fecha y hora en que se creó la sesión

user_id · string

ID del usuario que puede usarse al interactuar con otras API.