0.0.20241024 • Published 11 months ago

@maxim_mazurok/gapi.client.cloudkms-v1 v0.0.20241024

Weekly downloads
-
License
MIT
Repository
github
Last release
11 months ago

TypeScript typings for Cloud Key Management Service (KMS) API v1

Manages keys and performs cryptographic operations in a central cloud service, for direct use by other cloud resources and applications. For detailed description please check documentation.

Installing

Install typings for Cloud Key Management Service (KMS) API:

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

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

    // View and manage your keys and secrets stored in Cloud Key Management Service
    'https://www.googleapis.com/auth/cloudkms',
  ],
  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 Cloud Key Management Service (KMS) API resources:

/*
Returns the AutokeyConfig for a folder.
*/
await gapi.client.cloudkms.folders.getAutokeyConfig({name: 'name'});

/*
Updates the AutokeyConfig for a folder. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.
*/
await gapi.client.cloudkms.folders.updateAutokeyConfig({name: 'name'});

/*
Returns the effective Cloud KMS Autokey configuration for a given project.
*/
await gapi.client.cloudkms.projects.showEffectiveAutokeyConfig({
  parent: 'parent',
});
0.0.20241024

11 months ago

0.0.20241018

11 months ago

0.0.20241009

11 months ago

0.0.20240926

12 months ago

0.0.20241003

11 months ago

0.0.20240918

12 months ago

0.0.20240910

1 year ago

0.0.20240912

12 months ago

0.0.20240903

1 year ago

0.0.20240829

1 year ago

0.0.20240808

1 year ago

0.0.20240723

1 year ago

0.0.20240801

1 year ago

0.0.20240523

1 year ago

0.0.20240613

1 year ago

0.0.20240611

1 year ago

0.0.20240621

1 year ago

0.0.20240516

1 year ago

0.0.20240711

1 year ago

0.0.20240513

1 year ago

0.0.20240502

1 year ago

0.0.20240425

1 year ago

0.0.20240418

1 year ago

0.0.20240411

1 year ago

0.0.20240314

1 year ago

0.0.20240219

2 years ago

0.0.20240212

2 years ago

0.0.20240131

2 years ago

0.0.20240105

2 years ago

0.0.20240101

2 years ago

0.0.20231212

2 years ago

0.0.20231130

2 years ago

0.0.20230731

2 years ago

0.0.20231109

2 years ago

0.0.20230808

2 years ago

0.0.20230927

2 years ago

0.0.20230724

2 years ago

0.0.20231025

2 years ago

0.0.20231104

2 years ago

0.0.20230711

2 years ago

0.0.20230831

2 years ago

0.0.20230914

2 years ago

0.0.20230911

2 years ago

0.0.20231012

2 years ago

0.0.20231005

2 years ago

0.0.20231004

2 years ago

0.0.20230625

2 years ago

0.0.20230519

2 years ago

0.0.20230614

2 years ago

0.0.20230515

2 years ago

0.0.20230620

2 years ago

0.0.20230504

2 years ago

0.0.20230427

2 years ago

0.0.20230421

2 years ago

0.0.20230224

3 years ago

0.0.20230324

2 years ago

0.0.20230407

2 years ago

0.0.20230307

3 years ago

0.0.20230330

2 years ago

0.0.20230310

3 years ago

0.0.20230127

3 years ago

0.0.20230218

3 years ago

0.0.20230210

3 years ago

0.0.20230106

3 years ago

0.0.20221202

3 years ago

0.0.20221111

3 years ago

0.0.20230120

3 years ago

0.0.20221209

3 years ago

0.0.20221107

3 years ago

0.0.20221028

3 years ago

0.0.20221014

3 years ago

0.0.20221021

3 years ago

0.0.20220923

3 years ago

0.0.20220916

3 years ago

0.0.20220819

3 years ago

0.0.20220909

3 years ago

0.0.20220902

3 years ago

0.0.20220826

3 years ago

0.0.20220818

3 years ago

0.0.20220729

3 years ago