@maxim_mazurok/gapi.client.orgpolicy-v2

TypeScript typings for Organization Policy API v2

The Organization Policy API allows users to configure governance rules on their Google Cloud resources across the resource hierarchy. For detailed description please check documentation.

Installing

Install typings for Organization Policy API:

npm install @types/gapi.client.orgpolicy-v2 --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.orgpolicy-v2"]
  }
}

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

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

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',

    // See, edit, configure, and delete your Google Cloud Organization Policy data and see the email address for your Google Account
    'https://www.googleapis.com/auth/organizationpolicy',

    // See your Google Cloud Organization Policy data and the email address of your Google Account
    'https://www.googleapis.com/auth/organizationpolicy.readonly',
  ],
  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 Organization Policy API resources:

For provenance information see Provenance section on NPM