Id によるセッションの部分更新

セッション情報を更新します。

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

セッションを更新

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

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

パスパラメータ

id · string · 必須

更新するセッションの ID。

ボディ

application/jsonapplication/x-www-form-urlencoded

session_metadata · object

セッションに関連付けられたメタデータ。session_metadata をすべて削除するには、null または {} を渡します。

レスポンス

200

application/json

セッションが正常に更新されました。

authenticated_at · string<date-time> object

セッションが作成された日時

authentication · object

ログインフロー中に取得された認証シグナルの詳細

Show child attributes

clients · object[]

セッションのクライアント詳細の一覧

Show child attributes

cookie · object

[非公開早期アクセス] セッションクッキーの設定。

Show child attributes

created_at · string<date-time> object

セッションが作成された日時

device · object

セッションで使用されたデバイスに関するメタデータ

Show child attributes

expires_at · string<date-time> object

セッションが作成された日時

id · string

セッションの ID

idle_expires_at · string<date-time> object

セッションが作成された日時

last_interacted_at · string<date-time> object

セッションが作成された日時

session_metadata · object

セッションに関連付けられたメタデータ。文字列値（最大 255 文字）を持つオブジェクトの形式です。メタデータのプロパティは最大 25 個まで指定できます。

updated_at · string<date-time> object

セッションが作成された日時

user_id · string

他の API と連携する際に使用できるユーザーの ID。