google_api_cloud_kms v0.1.0 GoogleApi.CloudKMS.V1.Api.Projects View Source
API calls for all endpoints tagged Projects
.
Link to this section Summary
Functions
Gets information about a location
Create a new KeyRing in a given Project and Location
Create a new CryptoKey within a KeyRing. CryptoKey.purpose is required
Create a new CryptoKeyVersion in a CryptoKey. The server will assign the next sequential id. If unset, state will be set to ENABLED
Schedule a CryptoKeyVersion for destruction. Upon calling this method, CryptoKeyVersion.state will be set to DESTROY_SCHEDULED and destroy_time will be set to a time 24 hours in the future, at which point the state will be changed to DESTROYED, and the key material will be irrevocably destroyed. Before the destroy_time is reached, RestoreCryptoKeyVersion may be called to reverse the process
Returns metadata for a given CryptoKeyVersion
Lists CryptoKeyVersions
Update a CryptoKeyVersion's metadata. state may be changed between ENABLED and DISABLED using this method. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to move between other states
Restore a CryptoKeyVersion in the DESTROY_SCHEDULED state. Upon restoration of the CryptoKeyVersion, state will be set to DISABLED, and destroy_time will be cleared
Decrypts data that was protected by Encrypt
Encrypts data, so that it can only be recovered by a call to Decrypt
Returns metadata for a given CryptoKey, as well as its primary CryptoKeyVersion
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set
Lists CryptoKeys
Update a CryptoKey
Sets the access control policy on the specified resource. Replaces any existing policy
Returns 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_FOUND error. 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
Update the version of a CryptoKey that will be used in Encrypt
Returns metadata for a given KeyRing
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set
Lists KeyRings
Sets the access control policy on the specified resource. Replaces any existing policy
Returns 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_FOUND error. 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
Lists information about the supported locations for this service
Link to this section Functions
cloudkms_projects_locations_get( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.Location.t()} | {:error, Tesla.Env.t()}
Gets information about a location.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of `name`. Resource name for the location.
- locations_id (String.t): Part of `name`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.Location{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_create( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.KeyRing.t()} | {:error, Tesla.Env.t()}
Create a new KeyRing in a given Project and Location.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of `parent`. Required. The resource name of the location associated with the KeyRings, in the format `projects//locations/`.
- locations_id (String.t): Part of `parent`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :keyRingId (String.t): Required. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}`
- :body (KeyRing):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.KeyRing{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_create( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.CryptoKey.t()} | {:error, Tesla.Env.t()}
Create a new CryptoKey within a KeyRing. CryptoKey.purpose is required.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of `parent`. Required. The name of the KeyRing associated with the CryptoKeys.
- locations_id (String.t): Part of `parent`. See documentation of `projectsId`.
- key_rings_id (String.t): Part of `parent`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :cryptoKeyId (String.t): Required. It must be unique within a KeyRing and match the regular expression `[a-zA-Z0-9_-]{1,63}`
- :body (CryptoKey):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.CryptoKey{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_create( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion.t()} | {:error, Tesla.Env.t()}
Create a new CryptoKeyVersion in a CryptoKey. The server will assign the next sequential id. If unset, state will be set to ENABLED.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of `parent`. Required. The name of the CryptoKey associated with the CryptoKeyVersions.
- locations_id (String.t): Part of `parent`. See documentation of `projectsId`.
- key_rings_id (String.t): Part of `parent`. See documentation of `projectsId`.
- crypto_keys_id (String.t): Part of `parent`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :body (CryptoKeyVersion):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_destroy( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion.t()} | {:error, Tesla.Env.t()}
Schedule a CryptoKeyVersion for destruction. Upon calling this method, CryptoKeyVersion.state will be set to DESTROY_SCHEDULED and destroy_time will be set to a time 24 hours in the future, at which point the state will be changed to DESTROYED, and the key material will be irrevocably destroyed. Before the destroy_time is reached, RestoreCryptoKeyVersion may be called to reverse the process.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of `name`. The resource name of the CryptoKeyVersion to destroy.
- locations_id (String.t): Part of `name`. See documentation of `projectsId`.
- key_rings_id (String.t): Part of `name`. See documentation of `projectsId`.
- crypto_keys_id (String.t): Part of `name`. See documentation of `projectsId`.
- crypto_key_versions_id (String.t): Part of `name`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :body (DestroyCryptoKeyVersionRequest):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_get( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion.t()} | {:error, Tesla.Env.t()}
Returns metadata for a given CryptoKeyVersion.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of `name`. The name of the CryptoKeyVersion to get.
- locations_id (String.t): Part of `name`. See documentation of `projectsId`.
- key_rings_id (String.t): Part of `name`. See documentation of `projectsId`.
- crypto_keys_id (String.t): Part of `name`. See documentation of `projectsId`.
- crypto_key_versions_id (String.t): Part of `name`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_list( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.ListCryptoKeyVersionsResponse.t()} | {:error, Tesla.Env.t()}
Lists CryptoKeyVersions.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of `parent`. Required. The resource name of the CryptoKey to list, in the format `projects//locations//keyRings//cryptoKeys/`.
- locations_id (String.t): Part of `parent`. See documentation of `projectsId`.
- key_rings_id (String.t): Part of `parent`. See documentation of `projectsId`.
- crypto_keys_id (String.t): Part of `parent`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :pageToken (String.t): Optional pagination token, returned earlier via ListCryptoKeyVersionsResponse.next_page_token.
- :pageSize (integer()): Optional limit on the number of CryptoKeyVersions to include in the response. Further CryptoKeyVersions can subsequently be obtained by including the ListCryptoKeyVersionsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.ListCryptoKeyVersionsResponse{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_patch( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion.t()} | {:error, Tesla.Env.t()}
Update a CryptoKeyVersion's metadata. state may be changed between ENABLED and DISABLED using this method. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to move between other states.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of `cryptoKeyVersion.name`. Output only. The resource name for this CryptoKeyVersion in the format `projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/*`.
- locations_id (String.t): Part of `cryptoKeyVersion.name`. See documentation of `projectsId`.
- key_rings_id (String.t): Part of `cryptoKeyVersion.name`. See documentation of `projectsId`.
- crypto_keys_id (String.t): Part of `cryptoKeyVersion.name`. See documentation of `projectsId`.
- crypto_key_versions_id (String.t): Part of `cryptoKeyVersion.name`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :updateMask (String.t): Required list of fields to be updated in this request.
- :body (CryptoKeyVersion):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_crypto_key_versions_restore( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion.t()} | {:error, Tesla.Env.t()}
Restore a CryptoKeyVersion in the DESTROY_SCHEDULED state. Upon restoration of the CryptoKeyVersion, state will be set to DISABLED, and destroy_time will be cleared.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of `name`. The resource name of the CryptoKeyVersion to restore.
- locations_id (String.t): Part of `name`. See documentation of `projectsId`.
- key_rings_id (String.t): Part of `name`. See documentation of `projectsId`.
- crypto_keys_id (String.t): Part of `name`. See documentation of `projectsId`.
- crypto_key_versions_id (String.t): Part of `name`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :body (RestoreCryptoKeyVersionRequest):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_decrypt( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.DecryptResponse.t()} | {:error, Tesla.Env.t()}
Decrypts data that was protected by Encrypt.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of `name`. Required. The resource name of the CryptoKey to use for decryption. The server will choose the appropriate version.
- locations_id (String.t): Part of `name`. See documentation of `projectsId`.
- key_rings_id (String.t): Part of `name`. See documentation of `projectsId`.
- crypto_keys_id (String.t): Part of `name`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :body (DecryptRequest):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.DecryptResponse{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_encrypt( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.EncryptResponse.t()} | {:error, Tesla.Env.t()}
Encrypts data, so that it can only be recovered by a call to Decrypt.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of `name`. Required. The resource name of the CryptoKey or CryptoKeyVersion to use for encryption. If a CryptoKey is specified, the server will use its primary version.
- locations_id (String.t): Part of `name`. See documentation of `projectsId`.
- key_rings_id (String.t): Part of `name`. See documentation of `projectsId`.
- crypto_keys_id (String.t): Part of `name`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :body (EncryptRequest):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.EncryptResponse{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_get( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.CryptoKey.t()} | {:error, Tesla.Env.t()}
Returns metadata for a given CryptoKey, as well as its primary CryptoKeyVersion.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of `name`. The name of the CryptoKey to get.
- locations_id (String.t): Part of `name`. See documentation of `projectsId`.
- key_rings_id (String.t): Part of `name`. See documentation of `projectsId`.
- crypto_keys_id (String.t): Part of `name`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.CryptoKey{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_get_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.Policy.t()} | {:error, Tesla.Env.t()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of `resource`. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
- locations_id (String.t): Part of `resource`. See documentation of `projectsId`.
- key_rings_id (String.t): Part of `resource`. See documentation of `projectsId`.
- crypto_keys_id (String.t): Part of `resource`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.Policy{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_list( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.ListCryptoKeysResponse.t()} | {:error, Tesla.Env.t()}
Lists CryptoKeys.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of `parent`. Required. The resource name of the KeyRing to list, in the format `projects//locations//keyRings/*`.
- locations_id (String.t): Part of `parent`. See documentation of `projectsId`.
- key_rings_id (String.t): Part of `parent`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :pageToken (String.t): Optional pagination token, returned earlier via ListCryptoKeysResponse.next_page_token.
- :pageSize (integer()): Optional limit on the number of CryptoKeys to include in the response. Further CryptoKeys can subsequently be obtained by including the ListCryptoKeysResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.ListCryptoKeysResponse{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_patch( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.CryptoKey.t()} | {:error, Tesla.Env.t()}
Update a CryptoKey.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of `cryptoKey.name`. Output only. The resource name for this CryptoKey in the format `projects//locations//keyRings//cryptoKeys/`.
- locations_id (String.t): Part of `cryptoKey.name`. See documentation of `projectsId`.
- key_rings_id (String.t): Part of `cryptoKey.name`. See documentation of `projectsId`.
- crypto_keys_id (String.t): Part of `cryptoKey.name`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :updateMask (String.t): Required list of fields to be updated in this request.
- :body (CryptoKey):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.CryptoKey{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_set_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.Policy.t()} | {:error, Tesla.Env.t()}
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of `resource`. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
- locations_id (String.t): Part of `resource`. See documentation of `projectsId`.
- key_rings_id (String.t): Part of `resource`. See documentation of `projectsId`.
- crypto_keys_id (String.t): Part of `resource`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :body (SetIamPolicyRequest):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.Policy{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_test_iam_permissions( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.TestIamPermissionsResponse.t()} | {:error, Tesla.Env.t()}
Returns 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_FOUND error. 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.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of `resource`. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
- locations_id (String.t): Part of `resource`. See documentation of `projectsId`.
- key_rings_id (String.t): Part of `resource`. See documentation of `projectsId`.
- crypto_keys_id (String.t): Part of `resource`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :body (TestIamPermissionsRequest):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.TestIamPermissionsResponse{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_crypto_keys_update_primary_version( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.CryptoKey.t()} | {:error, Tesla.Env.t()}
Update the version of a CryptoKey that will be used in Encrypt.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of `name`. The resource name of the CryptoKey to update.
- locations_id (String.t): Part of `name`. See documentation of `projectsId`.
- key_rings_id (String.t): Part of `name`. See documentation of `projectsId`.
- crypto_keys_id (String.t): Part of `name`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :body (UpdateCryptoKeyPrimaryVersionRequest):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.CryptoKey{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.KeyRing.t()} | {:error, Tesla.Env.t()}
Returns metadata for a given KeyRing.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of `name`. The name of the KeyRing to get.
- locations_id (String.t): Part of `name`. See documentation of `projectsId`.
- key_rings_id (String.t): Part of `name`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.KeyRing{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_get_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.Policy.t()} | {:error, Tesla.Env.t()}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of `resource`. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
- locations_id (String.t): Part of `resource`. See documentation of `projectsId`.
- key_rings_id (String.t): Part of `resource`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.Policy{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_list( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.ListKeyRingsResponse.t()} | {:error, Tesla.Env.t()}
Lists KeyRings.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of `parent`. Required. The resource name of the location associated with the KeyRings, in the format `projects//locations/`.
- locations_id (String.t): Part of `parent`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :pageToken (String.t): Optional pagination token, returned earlier via ListKeyRingsResponse.next_page_token.
- :pageSize (integer()): Optional limit on the number of KeyRings to include in the response. Further KeyRings can subsequently be obtained by including the ListKeyRingsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.ListKeyRingsResponse{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_set_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.Policy.t()} | {:error, Tesla.Env.t()}
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of `resource`. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
- locations_id (String.t): Part of `resource`. See documentation of `projectsId`.
- key_rings_id (String.t): Part of `resource`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :body (SetIamPolicyRequest):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.Policy{}} on success {:error, info} on failure
cloudkms_projects_locations_key_rings_test_iam_permissions( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.TestIamPermissionsResponse.t()} | {:error, Tesla.Env.t()}
Returns 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_FOUND error. 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.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of `resource`. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
- locations_id (String.t): Part of `resource`. See documentation of `projectsId`.
- key_rings_id (String.t): Part of `resource`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :body (TestIamPermissionsRequest):
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.TestIamPermissionsResponse{}} on success {:error, info} on failure
cloudkms_projects_locations_list(Tesla.Env.client(), String.t(), keyword()) :: {:ok, GoogleApi.CloudKMS.V1.Model.ListLocationsResponse.t()} | {:error, Tesla.Env.t()}
Lists information about the supported locations for this service.
Parameters
- connection (GoogleApi.CloudKMS.V1.Connection): Connection to server
- projects_id (String.t): Part of `name`. The resource that owns the locations collection, if applicable.
opts (KeywordList): [optional] Optional parameters
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :pageToken (String.t): The standard list page token.
- :pageSize (integer()): The standard list page size.
- :filter (String.t): The standard list filter.
Returns
{:ok, %GoogleApi.CloudKMS.V1.Model.ListLocationsResponse{}} on success {:error, info} on failure