Class JWTAccess (7.4.1)

Package

google-auth-library!

constructor(email?: string | null, key?: string | null, keyId?: string | null, eagerRefreshThresholdMillis?: number);

JWTAccess service account credentials.

Create a new access token by using the credential to create a new JWT token that's recognized as the access token.

Parameters

Name	Description
email	`string \| null` the service account email address.
key	`string \| null` the private key that will be used to sign the token.
keyId	`string \| null` the ID of the private key used to sign the token.
eagerRefreshThresholdMillis	`number`

eagerRefreshThresholdMillis: number;

Property Value

Type	Description
number

email?: string | null;

Property Value

Type	Description
string \| null

key?: string | null;

Property Value

Type	Description
string \| null

keyId?: string | null;

Property Value

Type	Description
string \| null

projectId?: string;

Property Value

Type	Description
string

fromJSON(json: JWTInput): void;

Create a JWTAccess credentials instance using the given input options.

Parameter

Name	Description
json	`JWTInput` The input object.

Returns

Type	Description
void

fromStream(inputStream: stream.Readable): Promise<void>;

Create a JWTAccess credentials instance using the given input stream.

Parameter

Name	Description
inputStream	`stream.Readable` The input stream.

Returns

Type	Description
Promise<void>

fromStream(inputStream: stream.Readable, callback: (err?: Error) => void): void;

Parameters

Returns

Type	Description
void

getRequestHeaders(url: string, additionalClaims?: Claims): Headers;

Get a non-expired access token, after refreshing if necessary.

Parameters

Name	Description
url	`string` The URI being authorized.
additionalClaims	`Claims` An object with a set of additional claims to include in the payload.

Returns

Type	Description
Headers	An object that includes the authorization header.