Modifier partiellement une session par id

Mettre à jour les informations de la session.

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

Mettre à jour la session

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>"
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de chemin

id · string · requis

ID de la session à mettre à jour.

Corps

application/jsonapplication/x-www-form-urlencoded

session_metadata · object

Métadonnées associées à la session. Transmettez null ou {} pour supprimer toutes les données de session_metadata.

Réponse

200

application/json

Session mise à jour avec succès.

authenticated_at · string<date-time> object

La date et l’heure de création de la session

authentication · object

Détails sur les signaux d’authentification obtenus au cours du flux de connexion

Show child attributes

clients · object[]

Liste des détails de l’application pour la session

Show child attributes

cookie · object

[Accès anticipé privé] Configuration du cookie de session.

Show child attributes

created_at · string<date-time> object

La date et l’heure de création de la session

device · object

Métadonnées liées à l’appareil utilisé pour la session

Show child attributes

expires_at · string<date-time> object

La date et l’heure de création de la session

id · string

L’ID de la session

idle_expires_at · string<date-time> object

La date et l’heure de création de la session

last_interacted_at · string<date-time> object

La date et l’heure de création de la session

session_metadata · object

Métadonnées associées à la session, sous la forme d’un objet contenant des valeurs de type chaîne (max. 255 caractères). Un maximum de 25 propriétés de métadonnées est autorisé.

updated_at · string<date-time> object

La date et l’heure de création de la session

user_id · string

ID de l’utilisateur pouvant être utilisé lors d’interactions avec d’autres API.