Update session

Update session information.

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

Update session

cURL

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

import requests

url = "https://{tenantDomain}/api/v2/sessions/{id}"

payload = { "session_metadata": {} }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({session_metadata: {}})
};

fetch('https://{tenantDomain}/api/v2/sessions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/sessions/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'session_metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantDomain}/api/v2/sessions/{id}"

	payload := strings.NewReader("{\n  \"session_metadata\": {}\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://{tenantDomain}/api/v2/sessions/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"session_metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/sessions/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"session_metadata\": {}\n}"

response = http.request(request)
puts response.read_body

200

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

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 of the session to update.

Corps

application/jsonapplication/x-www-form-urlencoded

session_metadata · object | null

Metadata associated with the session. Pass null or {} to remove all session_metadata.

Réponse

200

application/json

Session successfully updated.

id · string

The ID of the session

user_id · string

ID of the user which can be used when interacting with other APIs.

created_at · string<date-time> object

The date and time when the session was created

updated_at · string<date-time> object

The date and time when the session was created

authenticated_at · string<date-time> object

The date and time when the session was created

idle_expires_at · string<date-time> object

The date and time when the session was created

expires_at · string<date-time> object

The date and time when the session was created

last_interacted_at · string<date-time> object

The date and time when the session was created

device · object

Metadata related to the device used in the session

Show child attributes

clients · object[]

List of client details for the session

Show child attributes

authentication · object

Details about authentication signals obtained during the login flow

Show child attributes

cookie · object

[Private Early Access] Session cookie configuration.

Show child attributes

session_metadata · object | null

Metadata associated with the session, in the form of an object with string values (max 255 chars). Maximum of 25 metadata properties allowed.