OAuth 2.0 Authentication - BoxClient from AccessToken

[KevinForys]

• I have checked that the SDK documentation doesn't solve my issue.
• I have checked that the API documentation doesn't solve my issue.
• I have searched the Box Developer Forums and my issue isn't already reported (or if it has been reported, I have attached a link to it, for reference).
• I have searched Issues in this repo and my issue isn't already reported.

Description of the Issue

I convert a Box Integration App with the Box TS SDK and I convert now correctly the AuthCode to an AccessToken.

I use this section of the migration guide.

The legacy code used sdk.getPersistentClient(tokenInfo, tokenStore); to retrieve a BoxClient.

How can we actually generate an BoxClient from an access token?

I guess that it's should be something like that :

const accessToken = await oauth.getTokensAuthorizationCodeGrant('code');
const boxClient = new BoxClient (accessToken)

Versions Used

Typescript SDK: v1.11.0
Node.js: v20.18.1

[lukaszsocha2]

Hi @KevinForys,
calling getTokensAuthorizationCodeGrant method will inject token automatically to the auth object. All you have to do is to initialise BoxClient with this auth object. All calls performed by BoxClient will be now authenticated.
You should do sth like this:

await oauth.getTokensAuthorizationCodeGrant('code');
const client = new BoxClient({ auth: oauth });

We will update the docs to be more detailed.
Best,
@lukaszsocha2

[lukaszsocha2]

Hi @KevinForys,
this issue was closed as we have merged documentation update that should answer your question. However if you have any further problems, feel free to reopen this issue or create a new one.
Best,
@lukaszsocha2

[KevinForys]

Hi @lukaszsocha2,

Tested and it works! 👍

I used the legacy sdk.getPersistentClient(tokenInfo) on another context : initialise a BoxClient directly from an AccessToken.

My legacy code :

let tokenBoxInfos = {
	accessToken: '<TOKEN>',
	refreshToken: '<TOKEN>'
}

let boxClient = sdk.getPersistentClient(tokenBoxInfos);

I read nothing about "initialise an Auth object from an AccessToken", how can I do that?

I can't reopen this issue.

Super thanks,
@KevinForys

[lukaszsocha2]

Hi @KevinForys,
yes you can achieve something like this by feeding OAuth class token storage with your access token:

const accessToken: AccessToken = {accessToken : '<TOKEN>', refreshToken: '<TOKEN>'}
await oauth.tokenStorage.store(accessToken)
const client = new BoxClient({ auth: oauth });

Best,
@lukaszsocha2

[lukaszsocha2]

Hi @KevinForys,
does the sample code work for you?
I have some suggestion for the improvement in your code. If you keep your token somewhere externally, you can implement your own token storage implementation and pass it to OAuth object. See the documentation https://github.com/box/box-typescript-sdk-gen/blob/main/docs/authentication.md#custom-storage. TokenStorage is defined like this:

export interface TokenStorage {
    store(token: AccessToken): Promise<undefined>;
    get(): Promise<undefined | AccessToken>;
    clear(): Promise<undefined>;
}

In your implementation you could use your own logic to get, store and clear token. Then it will be used by OAuth class to perform token related operations/
But this is just a suggestion. You can still use default InMemoryTokenStorage implementation and feed it with the token as suggested in the previous comment.
Best,
@lukaszsocha2

[KevinForys]

Hi @lukaszsocha2,

I've tested your first proposition but it's not working on my side.

Here's my spike code :

const AccessToken = require('box-typescript-sdk-gen/lib/schemas/accessToken.generated.js');

const testToken = {
    accessToken : '<TOKEN>',
    expiresIn:'3850',
    tokenType: 'bearer',
    refreshToken:'<TOKEN>'
}

const serializedToken = AccessToken.serializeAccessToken(testToken);

/*
    At this step, serializedToken contain :
    {
      access_token: '<TOKEN>',
      expires_in: '3850',
      token_type: 'bearer',
      restricted_to: undefined,
      refresh_token: '<TOKEN>',
      issued_token_type: undefined
    }
*/

this.oauth.tokenStorage.store(serializedToken);

const client  = new BoxClient({ auth: this.oauth });

client.users.getUserMe().then(user => { // Error throw at this step
    console.log(user);
});

Error stack trace :

BoxApiError: 400
    at BoxNetworkClient.<anonymous> (node_modules/box-typescript-sdk-gen/lib/networking/boxNetworkClient.js:166:19)
    at Generator.next (<anonymous>)
    at fulfilled (node_modules/box-typescript-sdk-gen/lib/networking/boxNetworkClient.js:5:58)
    at process.processTicksAndRejections (node:internal/process/task_queues:95:5) {
  timestamp: '1738257600900',
  requestInfo: {
    method: 'POST',
    url: 'https://api.box.com/oauth2/token',
    queryParams: {},
    headers: {
      'Content-Type': 'application/x-www-form-urlencoded',
      'User-Agent': 'Box JavaScript generated SDK v1.11.0 (Node v20.18.1)',
      'X-Box-UA': 'agent=box-javascript-generated-sdk/1.11.0; env=Node/20.18.1'
    },
    body: 'grant_type=refresh_token&client_id=XXX&client_secret=XXX'
  },
  responseInfo: {
    statusCode: 400,
    headers: {
      'alt-svc': 'h3=":443"; ma=2592000,h3-29=":443"; ma=2592000',
      'cache-control': 'no-store',
      connection: 'close',
      'content-type': 'application/json',
      date: 'Thu, 30 Jan 2025 17:21:28 GMT',
      
      via: '1.1 google'
    },
    body: {
      error: 'invalid_request',
      error_description: 'No "refresh_token" parameter found'
    },
    rawBody: '{"error":"invalid_request","error_description":"No \\"refresh_token\\" parameter found"}',
    code: undefined,
    contextInfo: undefined,
    requestId: undefined,
    helpUrl: undefined
  }
}

Thank you for your support,
@KevinForys

[lukaszsocha2]

Hi,
please do not serialize token object.
Call this.oauth.tokenStorage.store(testToken); instead and omit serializarion step.
Best,
@lukaszsocha2