The TokenStorageAdapter is an interface that defines methods for storing, retrieving, and managing service app tokens. The InMemoryTokenStorageAdapter is the default implementation of this interface that stores tokens in memory.

anchorUsing the Token Storage Adapter

In order to leverage the TokenStorageAdapter, developers can extend the interface by creating their own custom adapter to connect to various databases or use the default InMemoryTokenStorageAdapter.

Here's an example of how to create a custom token storage adapter:

import { TokenStorageAdapter, OrgServiceAppAuthorization } from '@webex/byods';

class CustomTokenStorageAdapter implements TokenStorageAdapter {
  async setToken(orgId: string, token: OrgServiceAppAuthorization): Promise<void> {
    // Implement logic to store token in your database
  }

  async getToken(orgId: string): Promise<OrgServiceAppAuthorization | null> {
    // Implement logic to retrieve token from your database
  }

  async listTokens(): Promise<OrgServiceAppAuthorization[]> {
    // Implement logic to list all tokens from your database
  }

  async deleteToken(orgId: string): Promise<void> {
    // Implement logic to delete token from your database
  }

  async resetTokens(): Promise<void> {
    // Implement logic to reset all tokens in your database
  }
} 

In order to use this custom TokenStorageAdapter, initialize the BYODS object:

const customTokenStorageAdapter = new CustomTokenStorageAdapter();
const sdk = new BYODS({
  clientId: '<your-client-id>',
  clientSecret: '<your-client-secret>',
  tokenStorageAdapter: customTokenStorageAdapter,
});

To use the default InMemoryTokenStorageAdapter, simply pass undefined as the argument for the tokenStorageAdapter:

const sdk = new BYODS({
  clientId: '<your-client-id>',
  clientSecret: '<your-client-secret>',
  tokenStorageAdapter: undefined,
});

For more information on creating the BYODS config, see Quickstart Guide.

anchorSet a Token

You can set a token for a specific organization using the setToken() method:

anchorGet a Token

To retrieve a token for a specific organization, use the getToken() method:

anchorList All Tokens

To obtain a list of all stored tokens, use the listTokens() method:

anchorDelete a Token

To delete a token for a specific organization, use the deleteToken() method:

anchorReset All Tokens

To remove all tokens stored in the InMemoryTokenStorageAdapter, use the resetTokens() method:

anchorOrgServiceAppAuthorization Interface

This interface represents the authorization details for a service app within an organization. It includes the following properties:

interface OrgServiceAppAuthorization {
  orgId: string;
  serviceAppToken: ServiceAppToken;
}

anchorServiceAppToken Interface

This interface represents the token details for a service app. It includes the following properties:

interface ServiceAppToken {
  accessToken: string;
  refreshToken: string;
  expiresAt: Date;
  refreshAccessTokenExpiresAt: Date;
}