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

TypeScript

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.refreshTokens.update("id", {});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.refreshTokens.update("id", {});
}
main();

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v3/management"
    client "github.com/auth0/go-auth0/v3/management/client"
    option "github.com/auth0/go-auth0/v3/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.UpdateRefreshTokenRequestContent{}
    mgmt.RefreshTokens.Update(
        context.TODO(),
        "id",
        request,
    )
}

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.RefreshTokens.UpdateAsync(
            id: "id",
            request: new UpdateRefreshTokenRequestContent()
        );
    }

}

package com.example.usage;

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

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

        client.refreshTokens().update(
            "id",
            UpdateRefreshTokenRequestContent
                .builder()
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\RefreshTokens\Requests\UpdateRefreshTokenRequestContent;

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

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

{
  "id": "<string>",
  "user_id": "auth0|507f1f77bcf86cd799439020",
  "created_at": "2023-11-07T05:31:56Z",
  "idle_expires_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "device": {
    "initial_ip": "<string>",
    "initial_asn": "<string>",
    "initial_user_agent": "<string>",
    "last_ip": "<string>",
    "last_asn": "<string>",
    "last_user_agent": "<string>"
  },
  "client_id": "<string>",
  "session_id": "<string>",
  "rotating": true,
  "resource_servers": [
    {
      "audience": "<string>",
      "scopes": "<string>"
    }
  ],
  "refresh_token_metadata": {},
  "last_exchanged_at": "2023-11-07T05:31:56Z"
}

PATCH

https://{tenantDomain}/api/v2

refresh-tokens

{id}

TypeScript

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.refreshTokens.update("id", {});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.refreshTokens.update("id", {});
}
main();

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v3/management"
    client "github.com/auth0/go-auth0/v3/management/client"
    option "github.com/auth0/go-auth0/v3/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.UpdateRefreshTokenRequestContent{}
    mgmt.RefreshTokens.Update(
        context.TODO(),
        "id",
        request,
    )
}

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.RefreshTokens.UpdateAsync(
            id: "id",
            request: new UpdateRefreshTokenRequestContent()
        );
    }

}

package com.example.usage;

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

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

        client.refreshTokens().update(
            "id",
            UpdateRefreshTokenRequestContent
                .builder()
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\RefreshTokens\Requests\UpdateRefreshTokenRequestContent;

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

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

{
  "id": "<string>",
  "user_id": "auth0|507f1f77bcf86cd799439020",
  "created_at": "2023-11-07T05:31:56Z",
  "idle_expires_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "device": {
    "initial_ip": "<string>",
    "initial_asn": "<string>",
    "initial_user_agent": "<string>",
    "last_ip": "<string>",
    "last_asn": "<string>",
    "last_user_agent": "<string>"
  },
  "client_id": "<string>",
  "session_id": "<string>",
  "rotating": true,
  "resource_servers": [
    {
      "audience": "<string>",
      "scopes": "<string>"
    }
  ],
  "refresh_token_metadata": {},
  "last_exchanged_at": "2023-11-07T05:31:56Z"
}

承認

Authorization

string

header

必須

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

パスパラメータ

string

必須

更新するリフレッシュトークンの ID。

ボディ

refresh_token_metadata

object | null

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

レスポンス

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

string

リフレッシュトークンの ID

user_id

string

デフォルト:auth0|507f1f77bcf86cd799439020

他の API とやり取りする際に使用できるユーザーの ID。

created_at

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

idle_expires_at

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

expires_at

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

device

object

リフレッシュトークンの発行時または交換時に使用されたデバイス

Show child attributes

client_id

string

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

session_id

string | null

この refresh-token の取得に使用された認証済み session の ID

rotating

boolean

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

resource_servers

object[]

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

Show child attributes

refresh_token_metadata

object | null

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

last_exchanged_at

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