@maxim_mazurok/gapi.client.sts-v1beta

TypeScript typings for Security Token Service API v1beta

The Security Token Service exchanges Google or third-party credentials for a short-lived access token to Google Cloud resources. For detailed description please check documentation.

Installing

Install typings for Security Token Service API:

npm install @types/gapi.client.sts-v1beta --save-dev

TypeScript 6.0+

TypeScript 6.0 changed types to default to []. You must now explicitly list type packages in tsconfig.json:

{
  "compilerOptions": {
    "types": ["gapi", "gapi.auth2", "gapi.client", "gapi.client.sts-v1beta"]
  }
}

Usage

You need to initialize Google API client in your code:

gapi.load('client', () => {
  // now we can use gapi.client
  // ...
});

Then load api client wrapper:

gapi.client.load(
  'https://sts.googleapis.com/$discovery/rest?version=v1beta',
  () => {
    // now we can use:
    // gapi.client.sts
  },
);

// Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
gapi.client.load('sts', 'v1beta', () => {
  // now we can use:
  // gapi.client.sts
});

After that you can use Security Token Service API resources:

/*
Exchanges a credential for a Google OAuth 2.0 access token. The token asserts an external identity within a workload identity pool, or it applies a Credential Access Boundary to a Google access token. When you call this method, do not send the `Authorization` HTTP header in the request. This method does not require the `Authorization` header, and using the header can cause the request to fail.
*/
await gapi.client.sts.token({});

For provenance information see Provenance section on NPM