id でリフレッシュトークンを更新

ID を指定してリフレッシュトークンを更新します。

PATCH https://{tenantDomain}/api/v2/refresh-tokens/{id}

リフレッシュトークンを更新する

cURL

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

200

{
  "client_id": "<string>",
  "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_exchanged_at": "2023-11-07T05:31:56Z",
  "refresh_token_metadata": {},
  "resource_servers": [
    {
      "audience": "<string>",
      "scopes": "<string>"
    }
  ],
  "rotating": true,
  "session_id": "<string>",
  "user_id": "auth0|507f1f77bcf86cd799439020"
}

承認

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

refresh_token_metadata · object

リフレッシュトークンに関連付けられたメタデータ。すべてのメタデータを削除するには、null または {} を渡します。

レスポンス

200

application/json

リフレッシュトークンが正常に更新されました。

client_id · string

このリフレッシュトークンが付与されているクライアントアプリケーションの ID

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_exchanged_at · string<date-time> object

リフレッシュトークンが作成された日時

refresh_token_metadata · object

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

resource_servers · object[]

このリフレッシュトークンに関連付けられたリソースサーバー ID と、それぞれに付与されたスコープの一覧

Show child attributes

rotating · boolean

トークンがローテーション型リフレッシュトークンである場合は true

session_id · string | null

このリフレッシュトークンの取得に使用された認証済みセッションのID

user_id · string · デフォルト: auth0|507f1f77bcf86cd799439020

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