TypeScript typings for Policy Troubleshooter API v1beta

For detailed description please check documentation.

Installing

Install typings for Policy Troubleshooter API:

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

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://policytroubleshooter.googleapis.com/$discovery/rest?version=v1beta',
  () => {
    // now we can use:
    // gapi.client.policytroubleshooter
  },
);

// 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('policytroubleshooter', 'v1beta', () => {
  // now we can use:
  // gapi.client.policytroubleshooter
});

Don't forget to authenticate your client before sending any request to resources:

// declare client_id registered in Google Developers Console
var client_id = '',
  scope = [
    // See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
    'https://www.googleapis.com/auth/cloud-platform',
  ],
  immediate = true;
// ...

gapi.auth.authorize(
  {client_id: client_id, scope: scope, immediate: immediate},
  authResult => {
    if (authResult && !authResult.error) {
      /* handle successful authorization */
    } else {
      /* handle authorization error */
    }
  },
);

After that you can use Policy Troubleshooter API resources:

/*
Checks whether a member has a specific permission for a specific resource, and explains why the member does or does not have that permission.
*/
await gapi.client.policytroubleshooter.iam.troubleshoot({});

For provenance information see Provenance section on NPM