googleapis.com – cloudkms
Manages keys and performs cryptographic operations in a central cloud service, for direct use by other cloud resources and applications.
- Homepage
- https://api.apis.guru/v2/specs/googleapis.com:cloudkms/v1.json
- Provider
- googleapis.com:cloudkms / cloudkms
- OpenAPI version
- 3.0.0
- Spec (JSON)
- https://api.apis.guru/v2/specs/googleapis.com/cloudkms/v1/openapi.json
- Spec (YAML)
- https://api.apis.guru/v2/specs/googleapis.com/cloudkms/v1/openapi.yaml
Tools (31)
Extracted live via the executor SDK.
-
projects.cloudkmsProjectsLocationsEkmConnectionsCreateCreates a new EkmConnection in a given Project and Location.
-
projects.cloudkmsProjectsLocationsEkmConnectionsListLists EkmConnections.
-
projects.cloudkmsProjectsLocationsEkmConnectionsVerifyConnectivityVerifies that Cloud KMS can successfully connect to the external key manager specified by an EkmConnection. If there is an error connecting to the EKM, this method returns a FAILED_PRECONDITION status containing structured information as described at .
-
projects.cloudkmsProjectsLocationsGenerateRandomBytesGenerate random bytes using the Cloud KMS randomness source in the provided location.
-
projects.cloudkmsProjectsLocationsKeyRingsCreateCreate a new KeyRing in a given Project and Location.
-
projects.cloudkmsProjectsLocationsKeyRingsCryptoKeysCreateCreate a new CryptoKey within a KeyRing. CryptoKey.purpose and CryptoKey.version_template.algorithm are required.
-
projects.cloudkmsProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsAsymmetricDecryptDecrypts data that was encrypted with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_DECRYPT.
-
projects.cloudkmsProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsAsymmetricSignSigns data using a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_SIGN, producing a signature that can be verified with the public key retrieved from GetPublicKey.
-
projects.cloudkmsProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsCreateCreate a new CryptoKeyVersion in a CryptoKey. The server will assign the next sequential id. If unset, state will be set to ENABLED.
-
projects.cloudkmsProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsDestroySchedule a CryptoKeyVersion for destruction. Upon calling this method, CryptoKeyVersion.state will be set to DESTROY_SCHEDULED, and destroy_time will be set to the time destroy_scheduled_duration in the future. At that time, the state will automatically change to DESTROYED, and the key material will be irrevocably destroyed. Before the destroy_time is reached, RestoreCryptoKeyVersion may be called to reverse the process.
-
projects.cloudkmsProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetPublicKeyReturns the public key for the given CryptoKeyVersion. The CryptoKey.purpose must be ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT.
-
projects.cloudkmsProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsImportImport wrapped key material into a CryptoKeyVersion. All requests must specify a CryptoKey. If a CryptoKeyVersion is additionally specified in the request, key material will be reimported into that version. Otherwise, a new version will be created, and will be assigned the next sequential id within the CryptoKey.
-
projects.cloudkmsProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListLists CryptoKeyVersions.
-
projects.cloudkmsProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsMacSignSigns data using a CryptoKeyVersion with CryptoKey.purpose MAC, producing a tag that can be verified by another source with the same key.
-
projects.cloudkmsProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsMacVerifyVerifies MAC tag using a CryptoKeyVersion with CryptoKey.purpose MAC, and returns a response that indicates whether or not the verification was successful.
-
projects.cloudkmsProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsPatchUpdate a CryptoKeyVersion's metadata. state may be changed between ENABLED and DISABLED using this method. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to move between other states.
-
projects.cloudkmsProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRestoreRestore a CryptoKeyVersion in the DESTROY_SCHEDULED state. Upon restoration of the CryptoKeyVersion, state will be set to DISABLED, and destroy_time will be cleared.
-
projects.cloudkmsProjectsLocationsKeyRingsCryptoKeysDecryptDecrypts data that was protected by Encrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.
-
projects.cloudkmsProjectsLocationsKeyRingsCryptoKeysEncryptEncrypts data, so that it can only be recovered by a call to Decrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.
-
projects.cloudkmsProjectsLocationsKeyRingsCryptoKeysListLists CryptoKeys.
-
projects.cloudkmsProjectsLocationsKeyRingsCryptoKeysUpdatePrimaryVersionUpdate the version of a CryptoKey that will be used in Encrypt. Returns an error if called on a key whose purpose is not ENCRYPT_DECRYPT.
-
projects.cloudkmsProjectsLocationsKeyRingsImportJobsCreateCreate a new ImportJob within a KeyRing. ImportJob.import_method is required.
-
projects.cloudkmsProjectsLocationsKeyRingsImportJobsGetReturns metadata for a given ImportJob.
-
projects.cloudkmsProjectsLocationsKeyRingsImportJobsGetIamPolicyGets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
-
projects.cloudkmsProjectsLocationsKeyRingsImportJobsListLists ImportJobs.
-
projects.cloudkmsProjectsLocationsKeyRingsImportJobsSetIamPolicySets the access control policy on the specified resource. Replaces any existing policy. Can return
NOT_FOUND,INVALID_ARGUMENT, andPERMISSION_DENIEDerrors. -
projects.cloudkmsProjectsLocationsKeyRingsImportJobsTestIamPermissionsReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a
NOT_FOUNDerror. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. -
projects.cloudkmsProjectsLocationsKeyRingsListLists KeyRings.
-
projects.cloudkmsProjectsLocationsListLists information about the supported locations for this service.
-
openapi.previewSpecPreview an OpenAPI document before adding it as a source
-
openapi.addSourceAdd an OpenAPI source and register its operations as tools