Manages keys and performs cryptographic operations in a central cloud service, for direct use by other cloud resources and applications.
Lists information about the supported locations for this service.
Name | Data Type | Description |
---|---|---|
name
|
string |
The resource that owns the locations collection, if applicable. |
Name | Data Type | Description |
---|---|---|
pageToken
|
string |
The standard list page token. |
pageSize
|
integer |
The standard list page size. |
filter
|
string |
The standard list filter. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ListLocationsResponse | |||||||||||||||||||||||||||||||||
Properties
|
Returns the public key for the given CryptoKeyVersion. The CryptoKey.purpose must be ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT.
Name | Data Type | Description |
---|---|---|
name
|
string |
Required. The name of the CryptoKeyVersion public key to get. |
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
PublicKey | |||||||||||
Properties
|
Decrypts data that was encrypted with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_DECRYPT.
Name | Data Type | Description |
---|---|---|
name
|
string |
Required. The resource name of the CryptoKeyVersion to use for decryption. |
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
AsymmetricDecryptRequest | ||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
AsymmetricDecryptResponse | ||||||||
Properties
|
Signs data using a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_SIGN, producing a signature that can be verified with the public key retrieved from GetPublicKey.
Name | Data Type | Description |
---|---|---|
name
|
string |
Required. The resource name of the CryptoKeyVersion to use for signing. |
Name | Data Type | Description | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
AsymmetricSignRequest | ||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
AsymmetricSignResponse | ||||||||
Properties
|
Decrypts data that was protected by Encrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.
Name | Data Type | Description |
---|---|---|
name
|
string |
Required. The resource name of the CryptoKey to use for decryption. The server will choose the appropriate version. |
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
DecryptRequest | |||||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
DecryptResponse | ||||||||
Properties
|
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.
Name | Data Type | Description |
---|---|---|
name
|
string |
Required. The resource name of the CryptoKeyVersion to destroy. |
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
|
DestroyCryptoKeyVersionRequest | |||||
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
CryptoKeyVersion | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Encrypts data, so that it can only be recovered by a call to Decrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.
Name | Data Type | Description |
---|---|---|
name
|
string |
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. |
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
EncryptRequest | |||||||||||
Properties
|
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
EncryptResponse | |||||||||||
Properties
|
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.
Name | Data Type | Description |
---|---|---|
name
|
string |
Required. The resource name of the CryptoKeyVersion to restore. |
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
|
RestoreCryptoKeyVersionRequest | |||||
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
CryptoKeyVersion | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Update the version of a CryptoKey that will be used in Encrypt.
Returns an error if called on an asymmetric key.
Name | Data Type | Description |
---|---|---|
name
|
string |
Required. The resource name of the CryptoKey to update. |
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
UpdateCryptoKeyPrimaryVersionRequest | ||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
CryptoKey | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Returns metadata for a given CryptoKeyVersion.
Name | Data Type | Description |
---|---|---|
name
|
string |
Required. The name of the CryptoKeyVersion to get. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
CryptoKeyVersion | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
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.
Name | Data Type | Description |
---|---|---|
name
|
string |
Output only. The resource name for this CryptoKeyVersion in the format
|
Name | Data Type | Description |
---|---|---|
updateMask
|
string |
Required. List of fields to be updated in this request. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
CryptoKeyVersion | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
CryptoKeyVersion | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Imports a new CryptoKeyVersion into an existing CryptoKey using the wrapped key material provided in the request.
The version ID will be assigned the next sequential id within the CryptoKey.
Name | Data Type | Description |
---|---|---|
parent
|
string |
Required. The name of the CryptoKey to be imported into. |
Name | Data Type | Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ImportCryptoKeyVersionRequest | ||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
CryptoKeyVersion | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Lists CryptoKeyVersions.
Name | Data Type | Description |
---|---|---|
parent
|
string |
Required. The resource name of the CryptoKey to list, in the format
|
Name | Data Type | Description |
---|---|---|
view
|
string Allowed values: - CRYPTO_KEY_VERSION_VIEW_UNSPECIFIED - FULL |
The fields to include in the response. |
pageToken
|
string |
Optional. Optional pagination token, returned earlier via ListCryptoKeyVersionsResponse.next_page_token. |
pageSize
|
integer |
Optional. 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. |
orderBy
|
string |
Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see Sorting and filtering list results. |
filter
|
string |
Optional. Only include resources that match the filter in the response. For more information, see Sorting and filtering list results. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ListCryptoKeyVersionsResponse | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Create a new CryptoKeyVersion in a CryptoKey.
The server will assign the next sequential id. If unset, state will be set to ENABLED.
Name | Data Type | Description |
---|---|---|
parent
|
string |
Required. The name of the CryptoKey associated with the CryptoKeyVersions. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
CryptoKeyVersion | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
CryptoKeyVersion | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Lists CryptoKeys.
Name | Data Type | Description |
---|---|---|
parent
|
string |
Required. The resource name of the KeyRing to list, in the format
|
Name | Data Type | Description |
---|---|---|
versionView
|
string Allowed values: - CRYPTO_KEY_VERSION_VIEW_UNSPECIFIED - FULL |
The fields of the primary version to include in the response. |
pageToken
|
string |
Optional. Optional pagination token, returned earlier via ListCryptoKeysResponse.next_page_token. |
pageSize
|
integer |
Optional. 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. |
orderBy
|
string |
Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see Sorting and filtering list results. |
filter
|
string |
Optional. Only include resources that match the filter in the response. For more information, see Sorting and filtering list results. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ListCryptoKeysResponse | |||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Create a new CryptoKey within a KeyRing.
CryptoKey.purpose and CryptoKey.version_template.algorithm are required.
Name | Data Type | Description |
---|---|---|
parent
|
string |
Required. The name of the KeyRing associated with the CryptoKeys. |
Name | Data Type | Description |
---|---|---|
skipInitialVersionCreation
|
boolean |
If set to true, the request will create a CryptoKey without any CryptoKeyVersions. You must manually call CreateCryptoKeyVersion or ImportCryptoKeyVersion before you can use this CryptoKey. |
cryptoKeyId
|
string |
Required. It must be unique within a KeyRing and match the regular
expression |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
CryptoKey | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
CryptoKey | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Lists ImportJobs.
Name | Data Type | Description |
---|---|---|
parent
|
string |
Required. The resource name of the KeyRing to list, in the format
|
Name | Data Type | Description |
---|---|---|
pageToken
|
string |
Optional. Optional pagination token, returned earlier via ListImportJobsResponse.next_page_token. |
pageSize
|
integer |
Optional. Optional limit on the number of ImportJobs to include in the response. Further ImportJobs can subsequently be obtained by including the ListImportJobsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. |
orderBy
|
string |
Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see Sorting and filtering list results. |
filter
|
string |
Optional. Only include resources that match the filter in the response. For more information, see Sorting and filtering list results. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ListImportJobsResponse | |||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Create a new ImportJob within a KeyRing.
ImportJob.import_method is required.
Name | Data Type | Description |
---|---|---|
parent
|
string |
Required. The name of the KeyRing associated with the ImportJobs. |
Name | Data Type | Description |
---|---|---|
importJobId
|
string |
Required. It must be unique within a KeyRing and match the regular
expression |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ImportJob | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ImportJob | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Lists KeyRings.
Name | Data Type | Description |
---|---|---|
parent
|
string |
Required. The resource name of the location associated with the
KeyRings, in the format |
Name | Data Type | Description |
---|---|---|
pageToken
|
string |
Optional. Optional pagination token, returned earlier via ListKeyRingsResponse.next_page_token. |
pageSize
|
integer |
Optional. 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. |
orderBy
|
string |
Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see Sorting and filtering list results. |
filter
|
string |
Optional. Only include resources that match the filter in the response. For more information, see Sorting and filtering list results. |
Name | Data Type | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ListKeyRingsResponse | |||||||||||||||||||||||||||
Properties
|
Create a new KeyRing in a given Project and Location.
Name | Data Type | Description |
---|---|---|
parent
|
string |
Required. The resource name of the location associated with the
KeyRings, in the format |
Name | Data Type | Description |
---|---|---|
keyRingId
|
string |
Required. It must be unique within a location and match the regular
expression |
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
KeyRing | |||||||||||
Properties
|
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
KeyRing | |||||||||||
Properties
|
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Name | Data Type | Description |
---|---|---|
resource
|
string |
REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
Name | Data Type | Description |
---|---|---|
options.requestedPolicyVersion
|
integer |
Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Policy | ||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Sets the access control policy on the specified resource. Replaces any existing policy.
Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED
Name | Data Type | Description |
---|---|---|
resource
|
string |
REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
Name | Data Type | Description | |||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
SetIamPolicyRequest | ||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Policy | ||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
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.
Name | Data Type | Description |
---|---|---|
resource
|
string |
REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. |
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
TestIamPermissionsRequest | ||||||||
Properties
|
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
|
TestIamPermissionsResponse | ||||||||
Properties
|
Request message for KeyManagementService.AsymmetricDecrypt.
Name | Data Type | Description |
---|---|---|
ciphertext
|
byte |
Required. The data encrypted with the named CryptoKeyVersion's public key using OAEP. |
Response message for KeyManagementService.AsymmetricDecrypt.
Name | Data Type | Description |
---|---|---|
plaintext
|
byte |
The decrypted data originally encrypted with the matching public key. |
Request message for KeyManagementService.AsymmetricSign.
Name | Data Type | Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
digest
|
Digest |
Required. The digest of the data to sign. The digest must be produced with the same digest algorithm as specified by the key version's algorithm. |
|||||||||||||
Properties
|
Response message for KeyManagementService.AsymmetricSign.
Name | Data Type | Description |
---|---|---|
signature
|
byte |
The created signature. |
Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.
If there are AuditConfigs for both allServices
and a specific service,
the union of the two AuditConfigs is used for that service: the log_types
specified in each AuditConfig are enabled, and the exempted_members in each
AuditLogConfig are exempted.
Example Policy with multiple AuditConfigs:
{
"audit_configs": [
{
"service": "allServices"
"audit_log_configs": [
{
"log_type": "DATA_READ",
"exempted_members": [
"user:jose@example.com"
]
},
{
"log_type": "DATA_WRITE",
},
{
"log_type": "ADMIN_READ",
}
]
},
{
"service": "sampleservice.googleapis.com"
"audit_log_configs": [
{
"log_type": "DATA_READ",
},
{
"log_type": "DATA_WRITE",
"exempted_members": [
"user:aliya@example.com"
]
}
]
}
]
}
For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
service
|
string |
Specifies a service that will be enabled for audit logging.
For example, |
||||||||||
auditLogConfigs
|
array [AuditLogConfig] |
The configuration for logging of each type of permission. |
||||||||||
Properties
|
Provides the configuration for logging a type of permissions. Example:
{
"audit_log_configs": [
{
"log_type": "DATA_READ",
"exempted_members": [
"user:jose@example.com"
]
},
{
"log_type": "DATA_WRITE",
}
]
}
This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
Name | Data Type | Description |
---|---|---|
logType
|
string Allowed values: - LOG_TYPE_UNSPECIFIED - ADMIN_READ - DATA_WRITE - DATA_READ |
The log type that this config enables. |
exemptedMembers
|
array [string] |
Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. |
Associates members
with a role
.
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
role
|
string |
Role that is assigned to |
||||||||||||||||
members
|
array [string] |
Specifies the identities requesting access for a Cloud Platform resource.
|
||||||||||||||||
condition
|
Expr |
The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. |
||||||||||||||||
Properties
|
A CryptoKey represents a logical key that can be used for cryptographic operations.
A CryptoKey is made up of one or more versions, which represent the actual key material used in cryptographic operations.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
versionTemplate
|
CryptoKeyVersionTemplate |
A template describing settings for new CryptoKeyVersion instances. The properties of new CryptoKeyVersion instances created by either CreateCryptoKeyVersion or auto-rotation are controlled by this template. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
rotationPeriod
|
string |
next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. If rotation_period is set, next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
purpose
|
string Allowed values: - CRYPTO_KEY_PURPOSE_UNSPECIFIED - ENCRYPT_DECRYPT - ASYMMETRIC_SIGN - ASYMMETRIC_DECRYPT |
Immutable. The immutable purpose of this CryptoKey. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
primary
|
CryptoKeyVersion |
Output only. A copy of the "primary" CryptoKeyVersion that will be used by Encrypt when this CryptoKey is given in EncryptRequest.name. The CryptoKey's primary version can be updated via UpdateCryptoKeyPrimaryVersion. Keys with purpose ENCRYPT_DECRYPT may have a primary. For other keys, this field will be omitted. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextRotationTime
|
string |
At next_rotation_time, the Key Management Service will automatically:
Key rotations performed manually via CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not affect next_rotation_time. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name
|
string |
Output only. The resource name for this CryptoKey in the format
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
labels
|
object |
Labels with user-defined metadata. For more information, see Labeling Keys. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createTime
|
string |
Output only. The time at which this CryptoKey was created. |
A CryptoKeyVersion represents an individual cryptographic key, and the associated key material.
An ENABLED version can be used for cryptographic operations.
For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt, decrypt, or sign data when an authorized user or application invokes Cloud KMS.
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
state
|
string Allowed values: - CRYPTO_KEY_VERSION_STATE_UNSPECIFIED - PENDING_GENERATION - ENABLED - DISABLED - DESTROYED - DESTROY_SCHEDULED - PENDING_IMPORT - IMPORT_FAILED |
The current state of the CryptoKeyVersion. |
||||||||||
protectionLevel
|
string Allowed values: - PROTECTION_LEVEL_UNSPECIFIED - SOFTWARE - HSM - EXTERNAL |
Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. |
||||||||||
name
|
string |
Output only. The resource name for this CryptoKeyVersion in the format
|
||||||||||
importTime
|
string |
Output only. The time at which this CryptoKeyVersion's key material was imported. |
||||||||||
importJob
|
string |
Output only. The name of the ImportJob used to import this CryptoKeyVersion. Only present if the underlying key material was imported. |
||||||||||
importFailureReason
|
string |
Output only. The root cause of an import failure. Only present if state is IMPORT_FAILED. |
||||||||||
generateTime
|
string |
Output only. The time this CryptoKeyVersion's key material was generated. |
||||||||||
externalProtectionLevelOptions
|
ExternalProtectionLevelOptions |
[ExternalProtectionLevelOptions] stores a group of additional fields for configuring a [CryptoKeyVersion] that are specific to the [EXTERNAL] protection level. |
||||||||||
Properties
|
||||||||||||
destroyTime
|
string |
Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. |
||||||||||
destroyEventTime
|
string |
Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED. |
||||||||||
createTime
|
string |
Output only. The time at which this CryptoKeyVersion was created. |
||||||||||
attestation
|
KeyOperationAttestation |
Output only. Statement that was generated and signed by the HSM at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only provided for key versions with protection_level HSM. |
||||||||||
Properties
|
||||||||||||
algorithm
|
string Allowed values: - CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED - GOOGLE_SYMMETRIC_ENCRYPTION - RSA_SIGN_PSS_2048_SHA256 - RSA_SIGN_PSS_3072_SHA256 - RSA_SIGN_PSS_4096_SHA256 - RSA_SIGN_PSS_4096_SHA512 - RSA_SIGN_PKCS1_2048_SHA256 - RSA_SIGN_PKCS1_3072_SHA256 - RSA_SIGN_PKCS1_4096_SHA256 - RSA_SIGN_PKCS1_4096_SHA512 - RSA_DECRYPT_OAEP_2048_SHA256 - RSA_DECRYPT_OAEP_3072_SHA256 - RSA_DECRYPT_OAEP_4096_SHA256 - RSA_DECRYPT_OAEP_4096_SHA512 - EC_SIGN_P256_SHA256 - EC_SIGN_P384_SHA384 - EXTERNAL_SYMMETRIC_ENCRYPTION |
Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports. |
A CryptoKeyVersionTemplate specifies the properties to use when creating a new CryptoKeyVersion, either manually with CreateCryptoKeyVersion or automatically as a result of auto-rotation.
Name | Data Type | Description |
---|---|---|
protectionLevel
|
string Allowed values: - PROTECTION_LEVEL_UNSPECIFIED - SOFTWARE - HSM - EXTERNAL |
ProtectionLevel to use when creating a CryptoKeyVersion based on this template. Immutable. Defaults to SOFTWARE. |
algorithm
|
string Allowed values: - CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED - GOOGLE_SYMMETRIC_ENCRYPTION - RSA_SIGN_PSS_2048_SHA256 - RSA_SIGN_PSS_3072_SHA256 - RSA_SIGN_PSS_4096_SHA256 - RSA_SIGN_PSS_4096_SHA512 - RSA_SIGN_PKCS1_2048_SHA256 - RSA_SIGN_PKCS1_3072_SHA256 - RSA_SIGN_PKCS1_4096_SHA256 - RSA_SIGN_PKCS1_4096_SHA512 - RSA_DECRYPT_OAEP_2048_SHA256 - RSA_DECRYPT_OAEP_3072_SHA256 - RSA_DECRYPT_OAEP_4096_SHA256 - RSA_DECRYPT_OAEP_4096_SHA512 - EC_SIGN_P256_SHA256 - EC_SIGN_P384_SHA384 - EXTERNAL_SYMMETRIC_ENCRYPTION |
Required. Algorithm to use when creating a CryptoKeyVersion based on this template. For backwards compatibility, GOOGLE_SYMMETRIC_ENCRYPTION is implied if both this field is omitted and CryptoKey.purpose is ENCRYPT_DECRYPT. |
Request message for KeyManagementService.Decrypt.
Name | Data Type | Description |
---|---|---|
ciphertext
|
byte |
Required. The encrypted data originally returned in EncryptResponse.ciphertext. |
additionalAuthenticatedData
|
byte |
Optional. Optional data that must match the data originally supplied in EncryptRequest.additional_authenticated_data. |
Response message for KeyManagementService.Decrypt.
Name | Data Type | Description |
---|---|---|
plaintext
|
byte |
The decrypted data originally supplied in EncryptRequest.plaintext. |
Request message for KeyManagementService.DestroyCryptoKeyVersion.
Name | Data Type | Description |
---|---|---|
DestroyCryptoKeyVersionRequest
|
object |
Request message for KeyManagementService.DestroyCryptoKeyVersion. |
A Digest holds a cryptographic message digest.
Name | Data Type | Description |
---|---|---|
sha512
|
byte |
A message digest produced with the SHA-512 algorithm. |
sha384
|
byte |
A message digest produced with the SHA-384 algorithm. |
sha256
|
byte |
A message digest produced with the SHA-256 algorithm. |
Request message for KeyManagementService.Encrypt.
Name | Data Type | Description |
---|---|---|
plaintext
|
byte |
Required. The data to encrypt. Must be no larger than 64KiB. The maximum size depends on the key version's protection_level. For SOFTWARE keys, the plaintext must be no larger than 64KiB. For HSM keys, the combined length of the plaintext and additional_authenticated_data fields must be no larger than 8KiB. |
additionalAuthenticatedData
|
byte |
Optional. Optional data that, if specified, must also be provided during decryption through DecryptRequest.additional_authenticated_data. The maximum size depends on the key version's protection_level. For SOFTWARE keys, the AAD must be no larger than 64KiB. For HSM keys, the combined length of the plaintext and additional_authenticated_data fields must be no larger than 8KiB. |
Response message for KeyManagementService.Encrypt.
Name | Data Type | Description |
---|---|---|
name
|
string |
The resource name of the CryptoKeyVersion used in encryption. Check this field to verify that the intended resource was used for encryption. |
ciphertext
|
byte |
The encrypted data. |
Represents an expression text. Example:
title: "User account presence"
description: "Determines whether the request has a user account"
expression: "size(request.user) > 0"
Name | Data Type | Description |
---|---|---|
title
|
string |
An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. |
location
|
string |
An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. |
expression
|
string |
Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. |
description
|
string |
An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. |
[ExternalProtectionLevelOptions] stores a group of additional fields for configuring a [CryptoKeyVersion] that are specific to the [EXTERNAL] protection level.
Name | Data Type | Description |
---|---|---|
externalKeyUri
|
string |
The URI for an external resource that this CryptoKeyVersion represents. |
Request message for KeyManagementService.ImportCryptoKeyVersion.
Name | Data Type | Description |
---|---|---|
rsaAesWrappedKey
|
byte |
Wrapped key material produced with RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256. This field contains the concatenation of two wrapped keys:
If importing symmetric key material, it is expected that the unwrapped key contains plain bytes. If importing asymmetric key material, it is expected that the unwrapped key is in PKCS#8-encoded DER format (the PrivateKeyInfo structure from RFC 5208). This format is the same as the format produced by PKCS#11 mechanism CKM_RSA_AES_KEY_WRAP. |
importJob
|
string |
Required. The name of the ImportJob that was used to wrap this key material. |
algorithm
|
string Allowed values: - CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED - GOOGLE_SYMMETRIC_ENCRYPTION - RSA_SIGN_PSS_2048_SHA256 - RSA_SIGN_PSS_3072_SHA256 - RSA_SIGN_PSS_4096_SHA256 - RSA_SIGN_PSS_4096_SHA512 - RSA_SIGN_PKCS1_2048_SHA256 - RSA_SIGN_PKCS1_3072_SHA256 - RSA_SIGN_PKCS1_4096_SHA256 - RSA_SIGN_PKCS1_4096_SHA512 - RSA_DECRYPT_OAEP_2048_SHA256 - RSA_DECRYPT_OAEP_3072_SHA256 - RSA_DECRYPT_OAEP_4096_SHA256 - RSA_DECRYPT_OAEP_4096_SHA512 - EC_SIGN_P256_SHA256 - EC_SIGN_P384_SHA384 - EXTERNAL_SYMMETRIC_ENCRYPTION |
Required. The algorithm of the key being imported. This does not need to match the version_template of the CryptoKey this version imports into. |
An ImportJob can be used to create CryptoKeys and CryptoKeyVersions using pre-existing key material, generated outside of Cloud KMS.
When an ImportJob is created, Cloud KMS will generate a "wrapping key", which is a public/private key pair. You use the wrapping key to encrypt (also known as wrap) the pre-existing key material to protect it during the import process. The nature of the wrapping key depends on the choice of import_method. When the wrapping key generation is complete, the state will be set to ACTIVE and the public_key can be fetched. The fetched public key can then be used to wrap your pre-existing key material.
Once the key material is wrapped, it can be imported into a new CryptoKeyVersion in an existing CryptoKey by calling ImportCryptoKeyVersion. Multiple CryptoKeyVersions can be imported with a single ImportJob. Cloud KMS uses the private key portion of the wrapping key to unwrap the key material. Only Cloud KMS has access to the private key.
An ImportJob expires 3 days after it is created. Once expired, Cloud KMS will no longer be able to import or unwrap any key material that was wrapped with the ImportJob's public key.
For more information, see Importing a key.
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
state
|
string Allowed values: - IMPORT_JOB_STATE_UNSPECIFIED - PENDING_GENERATION - ACTIVE - EXPIRED |
Output only. The current state of the ImportJob, indicating if it can be used. |
||||||||||
publicKey
|
WrappingPublicKey |
Output only. The public key with which to wrap key material prior to import. Only returned if state is ACTIVE. |
||||||||||
Properties
|
||||||||||||
protectionLevel
|
string Allowed values: - PROTECTION_LEVEL_UNSPECIFIED - SOFTWARE - HSM - EXTERNAL |
Required. Immutable. The protection level of the ImportJob. This must match the protection_level of the version_template on the CryptoKey you attempt to import into. |
||||||||||
name
|
string |
Output only. The resource name for this ImportJob in the format
|
||||||||||
importMethod
|
string Allowed values: - IMPORT_METHOD_UNSPECIFIED - RSA_OAEP_3072_SHA1_AES_256 - RSA_OAEP_4096_SHA1_AES_256 |
Required. Immutable. The wrapping method to be used for incoming key material. |
||||||||||
generateTime
|
string |
Output only. The time this ImportJob's key material was generated. |
||||||||||
expireTime
|
string |
Output only. The time at which this ImportJob is scheduled for expiration and can no longer be used to import key material. |
||||||||||
expireEventTime
|
string |
Output only. The time this ImportJob expired. Only present if state is EXPIRED. |
||||||||||
createTime
|
string |
Output only. The time at which this ImportJob was created. |
||||||||||
attestation
|
KeyOperationAttestation |
Output only. Statement that was generated and signed by the key creator (for example, an HSM) at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only present if the chosen ImportMethod is one with a protection level of HSM. |
||||||||||
Properties
|
Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key).
Name | Data Type | Description |
---|---|---|
format
|
string Allowed values: - ATTESTATION_FORMAT_UNSPECIFIED - CAVIUM_V1_COMPRESSED - CAVIUM_V2_COMPRESSED |
Output only. The format of the attestation data. |
content
|
byte |
Output only. The attestation data provided by the HSM when the key operation was performed. |
A KeyRing is a toplevel logical grouping of CryptoKeys.
Name | Data Type | Description |
---|---|---|
name
|
string |
Output only. The resource name for the KeyRing in the format
|
createTime
|
string |
Output only. The time at which this KeyRing was created. |
Response message for KeyManagementService.ListCryptoKeyVersions.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
totalSize
|
integer |
The total number of CryptoKeyVersions that matched the query. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextPageToken
|
string |
A token to retrieve next page of results. Pass this value in ListCryptoKeyVersionsRequest.page_token to retrieve the next page of results. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cryptoKeyVersions
|
array [CryptoKeyVersion] |
The list of CryptoKeyVersions. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Response message for KeyManagementService.ListCryptoKeys.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
totalSize
|
integer |
The total number of CryptoKeys that matched the query. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextPageToken
|
string |
A token to retrieve next page of results. Pass this value in ListCryptoKeysRequest.page_token to retrieve the next page of results. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cryptoKeys
|
array [CryptoKey] |
The list of CryptoKeys. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Response message for KeyManagementService.ListImportJobs.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
totalSize
|
integer |
The total number of ImportJobs that matched the query. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextPageToken
|
string |
A token to retrieve next page of results. Pass this value in ListImportJobsRequest.page_token to retrieve the next page of results. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
importJobs
|
array [ImportJob] |
The list of ImportJobs. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Response message for KeyManagementService.ListKeyRings.
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
totalSize
|
integer |
The total number of KeyRings that matched the query. |
||||||||||
nextPageToken
|
string |
A token to retrieve next page of results. Pass this value in ListKeyRingsRequest.page_token to retrieve the next page of results. |
||||||||||
keyRings
|
array [KeyRing] |
The list of KeyRings. |
||||||||||
Properties
|
The response message for Locations.ListLocations.
Name | Data Type | Description | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
nextPageToken
|
string |
The standard List next-page token. |
|||||||||||||||||||
locations
|
array [Location] |
A list of locations that matches the specified filter in the request. |
|||||||||||||||||||
Properties
|
A resource that represents Google Cloud Platform location.
Name | Data Type | Description |
---|---|---|
name
|
string |
Resource name for the location, which may vary between implementations.
For example: |
metadata
|
object |
Service-specific metadata. For example the available capacity at the given location. |
locationId
|
string |
The canonical id for this location. For example: |
labels
|
object |
Cross-service attributes for the location. For example
|
displayName
|
string |
The friendly name for this location, typically a nearby city name. For example, "Tokyo". |
Cloud KMS metadata for the given google.cloud.location.Location.
Name | Data Type | Description |
---|---|---|
hsmAvailable
|
boolean |
Indicates whether CryptoKeys with protection_level HSM can be created in this location. |
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.
A Policy
is a collection of bindings
. A binding
binds one or more
members
to a single role
. Members can be user accounts, service accounts,
Google groups, and domains (such as G Suite). A role
is a named list of
permissions; each role
can be an IAM predefined role or a user-created
custom role.
Optionally, a binding
can specify a condition
, which is a logical
expression that allows access to a resource only if the expression evaluates
to true
. A condition can add constraints based on attributes of the
request, the resource, or both.
JSON example:
{
"bindings": [
{
"role": "roles/resourcemanager.organizationAdmin",
"members": [
"user:mike@example.com",
"group:admins@example.com",
"domain:google.com",
"serviceAccount:my-project-id@appspot.gserviceaccount.com"
]
},
{
"role": "roles/resourcemanager.organizationViewer",
"members": ["user:eve@example.com"],
"condition": {
"title": "expirable access",
"description": "Does not grant access after Sep 2020",
"expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
}
}
],
"etag": "BwWWja0YfJA=",
"version": 3
}
YAML example:
bindings:
- members:
- user:mike@example.com
- group:admins@example.com
- domain:google.com
- serviceAccount:my-project-id@appspot.gserviceaccount.com
role: roles/resourcemanager.organizationAdmin
- members:
- user:eve@example.com
role: roles/resourcemanager.organizationViewer
condition:
title: expirable access
description: Does not grant access after Sep 2020
expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
- etag: BwWWja0YfJA=
- version: 3
For a description of IAM and its features, see the IAM documentation.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
version
|
integer |
Specifies the format of the policy. Valid values are Any operation that affects conditional role bindings must specify version
Important: If you use IAM Conditions, you must include the If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. |
||||||||||||||||||||||||||||||||
etag
|
byte |
Important: If you use IAM Conditions, you must include the |
||||||||||||||||||||||||||||||||
bindings
|
array [Binding] |
Associates a list of |
||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||
auditConfigs
|
array [AuditConfig] |
Specifies cloud audit logging configuration for this policy. |
||||||||||||||||||||||||||||||||
Properties
|
The public key for a given CryptoKeyVersion. Obtained via GetPublicKey.
Name | Data Type | Description |
---|---|---|
pem
|
string |
The public key, encoded in PEM format. For more information, see the RFC 7468 sections for General Considerations and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). |
algorithm
|
string Allowed values: - CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED - GOOGLE_SYMMETRIC_ENCRYPTION - RSA_SIGN_PSS_2048_SHA256 - RSA_SIGN_PSS_3072_SHA256 - RSA_SIGN_PSS_4096_SHA256 - RSA_SIGN_PSS_4096_SHA512 - RSA_SIGN_PKCS1_2048_SHA256 - RSA_SIGN_PKCS1_3072_SHA256 - RSA_SIGN_PKCS1_4096_SHA256 - RSA_SIGN_PKCS1_4096_SHA512 - RSA_DECRYPT_OAEP_2048_SHA256 - RSA_DECRYPT_OAEP_3072_SHA256 - RSA_DECRYPT_OAEP_4096_SHA256 - RSA_DECRYPT_OAEP_4096_SHA512 - EC_SIGN_P256_SHA256 - EC_SIGN_P384_SHA384 - EXTERNAL_SYMMETRIC_ENCRYPTION |
The Algorithm associated with this key. |
Request message for KeyManagementService.RestoreCryptoKeyVersion.
Name | Data Type | Description |
---|---|---|
RestoreCryptoKeyVersionRequest
|
object |
Request message for KeyManagementService.RestoreCryptoKeyVersion. |
Request message for SetIamPolicy
method.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
updateMask
|
string |
OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
policy
|
Policy |
REQUIRED: The complete policy to be applied to the |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Request message for TestIamPermissions
method.
Name | Data Type | Description |
---|---|---|
permissions
|
array [string] |
The set of permissions to check for the |
Response message for TestIamPermissions
method.
Name | Data Type | Description |
---|---|---|
permissions
|
array [string] |
A subset of |
Request message for KeyManagementService.UpdateCryptoKeyPrimaryVersion.
Name | Data Type | Description |
---|---|---|
cryptoKeyVersionId
|
string |
Required. The id of the child CryptoKeyVersion to use as primary. |
The public key component of the wrapping key. For details of the type of key this public key corresponds to, see the ImportMethod.
Name | Data Type | Description |
---|---|---|
pem
|
string |
The public key, encoded in PEM format. For more information, see the RFC 7468 sections for General Considerations and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). |
'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1
Oauth 2.0 accessCode authentication
Flow:authorizationCode
https://accounts.google.com/o/oauth2/auth
https://accounts.google.com/o/oauth2/token
https://www.googleapis.com/auth/cloudkms
: View and manage your keys and secrets stored in Cloud Key Management Servicehttps://www.googleapis.com/auth/cloud-platform
: View and manage your data across Google Cloud Platform services
'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1
Oauth 2.0 implicit authentication
Flow:implicit
https://accounts.google.com/o/oauth2/auth
https://www.googleapis.com/auth/cloudkms
: View and manage your keys and secrets stored in Cloud Key Management Servicehttps://www.googleapis.com/auth/cloud-platform
: View and manage your data across Google Cloud Platform servicesName | Google |
External URL | https://google.com |
OAS (OpenAPI Specification) | v3.0.0 |