Get refresh tokens for a user

Retrieve details for a user’s refresh tokens.

GET https://{tenantDomain}/api/v2/users/{user_id}/refresh-tokens

C#

C#

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

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.Users.RefreshToken.ListAsync(
            userId: "user_id",
            request: new ListRefreshTokensRequestParameters {
                From = "from",
                Take = 1
            }
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &users.ListRefreshTokensRequestParameters{
        From: management.String(
            "from",
        ),
        Take: management.Int(
            1,
        ),
    }
    mgmt.Users.RefreshToken.List(
        context.TODO(),
        "user_id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.users.types.ListRefreshTokensRequestParameters;

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

        client.users().refreshToken().list(
            "user_id",
            ListRefreshTokensRequestParameters
                .builder()
                .from("from")
                .take(1)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Users\RefreshToken\Requests\ListRefreshTokensRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->users->refreshToken->list(
    'user_id',
    new ListRefreshTokensRequestParameters([
        'from' => 'from',
        'take' => 1,
    ]),
);

from auth0.management import ManagementClient

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

client.users.refresh_token.list(
    user_id="user_id",
    from="from",
    take=1,
)

require "auth0"

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

client.users.refresh_token.list(
  user_id: "user_id",
  from: "from",
  take: 1
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.users.refreshToken.list("user_id", {
        from: "from",
        take: 1,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.users.refreshToken.list("user_id", {
        from: "from",
        take: 1,
    });
}
main();

curl --request GET \
  --url https://{tenantDomain}/api/v2/users/{user_id}/refresh-tokens \
  --header 'Authorization: Bearer <token>'

200

{
  "tokens": [
    {
      "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"
    }
  ],
  "next": "<string>"
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Path Parameters

user_id · string · required

ID of the user to get refresh tokens for

Query Parameters

include_totals · boolean

Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).

from · string

An optional cursor from which to start the selection (exclusive).

take · integer

Number of results per page. Defaults to 50.

Required range: 1 <= x <= 100

Response

200

application/json

The refresh tokens were retrieved

tokens · object[]

Show child attributes

next · string

A cursor to be used as the "from" query parameter for the next page of results.