Update session

Update session information.

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

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Sessions.UpdateAsync(
            id: "id",
            request: new UpdateSessionRequestContent()
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.UpdateSessionRequestContent;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.sessions().update(
            "id",
            UpdateSessionRequestContent
                .builder()
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Sessions\Requests\UpdateSessionRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->sessions->update(
    'id',
    new UpdateSessionRequestContent([]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.sessions.update(
    id="id",
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.sessions.update(id: "id")

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

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));

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))

}

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

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Path Parameters

id · string · required

ID of the session to update.

Body

application/jsonapplication/x-www-form-urlencoded

session_metadata · object | null

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

Response

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.