Rotate an access token

Rotating an access token consists of the authorization server issuing a new token in place of the existing token, with the same rights and properties as the original token. If, for example, an access token expires, an authorized client can request the token be rotated.

All access tokens in Open Payments have a 10-minute lifespan by default. This includes new access tokens issued as a result of a rotate request.

These code snippets enable the client to call a management endpoint to rotate the specified access token.

Before you begin

We recommend creating a wallet account on the test wallet. Creating an account allows you to test your client against the Open Payments APIs by using an ILP-enabled wallet funded with play money.

Rotate an access token

TypeScript/JavaScript

Prerequisites

Initial configuration

If you’re using JavaScript, only do the first step.

1. Add "type": "module" to package.json.
2. Add the following to tsconfig.json

   {
     "compilerOptions": {
       "target": "ES2022",
       "module": "ES2022"
     }
   }

Import dependencies

import { createAuthenticatedClient } from "@interledger/open-payments";

Copied! Copy import { createAuthenticatedClient } from "@interledger/open-payments";

Initialize Open Payments client

const client = await createAuthenticatedClient({
  walletAddressUrl: WALLET_ADDRESS,
  privateKey: PRIVATE_KEY_PATH,
  keyId: KEY_ID,
});

Copied! Copy const client = await createAuthenticatedClient({ walletAddressUrl: WALLET_ADDRESS, privateKey: PRIVATE_KEY_PATH, keyId: KEY_ID, });

Rotate token

const token = await client.token.rotate({
  url: MANAGE_URL,
  accessToken: ACCESS_TOKEN,
});

Copied! Copy const token = await client.token.rotate({ url: MANAGE_URL, accessToken: ACCESS_TOKEN, });

Output

console.log("ACCESS_TOKEN =", token.access_token.value);
console.log("MANAGE_URL =", token.access_token.manage);

Copied! Copy console.log("ACCESS_TOKEN =", token.access_token.value); console.log("MANAGE_URL =", token.access_token.manage);

For TypeScript, run tsx path/to/directory/index.ts. View full TS source

For JavaScript, run node path/to/directory/index.js. View full JS source

PHP

Prerequisites

Import dependencies

use OpenPayments\AuthClient;
use OpenPayments\Config\Config;

Copied! Copy use OpenPayments\AuthClient; use OpenPayments\Config\Config;

Initialize Open Payments client

$config = new Config($WALLET_ADDRESS, $PRIVATE_KEY, $KEY_ID);
$opClient = new AuthClient($config);

Copied! Copy $config = new Config($WALLET_ADDRESS, $PRIVATE_KEY, $KEY_ID); $opClient = new AuthClient($config);

Rotate token

$token = $opClient->token()->rotate([
  "access_token" => $ACCESS_TOKEN,
  "url" => $TOKEN_MANAGE_URL,
]);

Copied! Copy $token = $opClient->token()->rotate([ "access_token" => $ACCESS_TOKEN, "url" => $TOKEN_MANAGE_URL, ]);

Output

$output->writeln("ACCESS_TOKEN: " . $token->value);
$output->writeln("MANAGE_URL: " . $token->manage);

Copied! Copy $output->writeln("ACCESS_TOKEN: " . $token->value); $output->writeln("MANAGE_URL: " . $token->manage);

View full source

References

• API specification