@maxim_mazurok/gapi.client.accessapproval-v1 v0.0.20240517

TypeScript typings for Access Approval API v1

An API for controlling access to data by Google personnel. For detailed description please check documentation.

Installing

Install typings for Access Approval API:

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

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

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 Access Approval API resources:

/*
Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.
*/
await gapi.client.accessapproval.folders.deleteAccessApprovalSettings({
  name: 'name',
});

/*
Gets the settings associated with a project, folder, or organization.
*/
await gapi.client.accessapproval.folders.getAccessApprovalSettings({
  name: 'name',
});

/*
Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.
*/
await gapi.client.accessapproval.folders.getServiceAccount({name: 'name'});

/*
Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.
*/
await gapi.client.accessapproval.folders.updateAccessApprovalSettings({
  name: 'name',
});

/*
Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.
*/
await gapi.client.accessapproval.organizations.deleteAccessApprovalSettings({
  name: 'name',
});

/*
Gets the settings associated with a project, folder, or organization.
*/
await gapi.client.accessapproval.organizations.getAccessApprovalSettings({
  name: 'name',
});

/*
Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.
*/
await gapi.client.accessapproval.organizations.getServiceAccount({
  name: 'name',
});

/*
Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.
*/
await gapi.client.accessapproval.organizations.updateAccessApprovalSettings({
  name: 'name',
});

/*
Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.
*/
await gapi.client.accessapproval.projects.deleteAccessApprovalSettings({
  name: 'name',
});

/*
Gets the settings associated with a project, folder, or organization.
*/
await gapi.client.accessapproval.projects.getAccessApprovalSettings({
  name: 'name',
});

/*
Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.
*/
await gapi.client.accessapproval.projects.getServiceAccount({name: 'name'});

/*
Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.
*/
await gapi.client.accessapproval.projects.updateAccessApprovalSettings({
  name: 'name',
});