@leonardodino/gtoken

node-gtoken

Node.js Google Authentication Service Account Tokens

Installation

npm install @leonardodino/gtoken

or

yarn add @leonardodino/gtoken

Usage

const key = '-----BEGIN RSA PRIVATE KEY-----\nXXXXXXXXXXX...';
const { GoogleToken } = require('@leonardodino/gtoken');
const gtoken = new GoogleToken({
  email: '[e-mail]',
  scope: ['https://scope1', 'https://scope2'], // or space-delimited string of scopes
  key: key
});

Options

Various options that can be set when creating initializing the gtoken object.

• options.email or options.iss: The service account email address.
• options.scope: An array of scope strings or space-delimited string of scopes.
• options.sub: The email address of the user requesting delegated access.
• options.key: The raw RSA private key value.

.getToken()

Returns the cached token or requests a new one and returns it.

gtoken.getToken(function(err, token) {
  if (err) {
    console.log(err);
    return;
  }
  console.log(token);
});

You can also use the async/await style API:

const token = await gtoken.getToken()
console.log(token);

Or use promises: or

gtoken.getToken()
  .then(token => {
    console.log(token)
  })
  .catch(e => console.error);

Properties

Various properties set on the gtoken object after call to .getToken().

• gtoken.token: The access token.
• gtoken.expiresAt: The expiry date as milliseconds since 1970/01/01
• gtoken.key: The raw key value.
• gtoken.rawToken: Most recent raw token data received from Google.

.hasExpired()

Returns true if the token has expired, or token does not exist.

gtoken.getToken(function(err, token) {
  if(token) {
    gtoken.hasExpired(); // false
  }
});

.revokeToken()

Revoke the token if set.

gtoken.revokeToken(function(err) {
  if (err) {
    console.log(err);
    return;
  }
  console.log('Token revoked!');
});

Changelog

2.0.0 -> 3.0.0

New features:

• Fewer dependencies, code works everywhere.

Breaking changes:

• remove support for reading files (keyFile option)
• remove getCredentials method.
• remove ensureEmail private method.

1.2.2 -> 2.0.0

New features:

• API now supports callback and promise based workflows

Breaking changes:

• GoogleToken is now a class type, and must be instantiated.
• GoogleToken.expires_at renamed to GoogleToken.expiresAt
• GoogleToken.raw_token renamed to GoogleToken.rawToken
• GoogleToken.token_expires renamed to GoogleToken.tokenExpires

License

MIT

Changelog

3.0.2 (2019-06-26)

Bug Fixes

• docs: make anchors work in jsdoc (#215) (c5f6c89)