View Source GoogleApi.CloudKMS.V1.Api.Folders (google_api_cloud_kms v0.41.0)
API calls for all endpoints tagged Folders
.
Summary
Functions
Returns the AutokeyConfig for a folder.
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.
Functions
cloudkms_folders_get_autokey_config(connection, name, optional_params \\ [], opts \\ [])
View Source@spec cloudkms_folders_get_autokey_config( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.AutokeyConfig.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns the AutokeyConfig for a folder.
Parameters
-
connection
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Name of the AutokeyConfig resource, e.g.folders/{FOLDER_NUMBER}/autokeyConfig
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type: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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type: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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudKMS.V1.Model.AutokeyConfig{}}
on success -
{:error, info}
on failure
cloudkms_folders_update_autokey_config(connection, name, optional_params \\ [], opts \\ [])
View Source@spec cloudkms_folders_update_autokey_config( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudKMS.V1.Model.AutokeyConfig.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.CloudKMS.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Identifier. Name of the AutokeyConfig resource, e.g.folders/{FOLDER_NUMBER}/autokeyConfig
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type: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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type: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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - Required. Masks which fields of the AutokeyConfig to update, e.g.keyProject
. -
:body
(type:GoogleApi.CloudKMS.V1.Model.AutokeyConfig.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudKMS.V1.Model.AutokeyConfig{}}
on success -
{:error, info}
on failure