The AccessToken class represents authorization to use the SDK as a specific, authenticated user. See Authentication for more details and examples.

Summary of Properties and Methods

Static Properties

Static Methods

Constructor

const { AccessToken } = require('@catalytic/sdk');
const accessToken = new AccessToken('YOUR_SERIALIZED_ACCESS_TOKEN_STRING');

Instance Properties

Instance Methods

Constructors

AccessTokens can be constructed by passing the serialized AccessToken string to the AccessToken constructor. See Authentication for more details on accessing the serialized AccessToken string.

AccessToken(token: string)

const accessToken = new AccessToken('YOUR_SERIALIZED_ACCESS_TOKEN_STRING');

The fromFile Static Method

Load an Access Token by name from the default Access Token directory, a given directory or a specific file location. The default directory is AccessToken.DEFAULT_ACCESS_TOKEN_DIR, which will be $HOME/.catalytic/tokens or the equivalent depending on the OS.

Method Signature

fromFile(fileNameOrPath: string): AccessToken;

The fromEnv Static Method

Deserializes an Access Token from a token string stored in the CATALYTIC_TOKEN env var.

Method Signature

static AccessToken fromEnv()

The listAccessTokens Static Method

Gets all Access Tokens stored in a given directory, or in the default Access Token directory if none is specified. The default directory is AccessToken.DEFAULT_ACCESS_TOKEN_DIR, which will be $HOME/.catalytic/tokens or the equivalent depending on the OS.

Method Signature

listAccessTokens(accessTokensDirectory?: string): { [accessTokenName: string]: AccessToken }

The deleteAccessTokenFile Static Method

Deletes saved Access Token. Note that this does not permanently revoke the Access Token. To permanently revoke an Access Token, use the Catalytic Web App

Method Signature

deleteAccessTokenFile(fileNameOrPath: string): void;

The saveToFile Instance Method

Saves an Access Token to a file, allowing for load via AccessToken.fromFile. Throws AccessTokenNameConflictException if the file already exists.

public saveToFile(fileName: string): void;
public saveToFile(fileName: string, directoryPath: string): void;