"description":"Manages encryption for your cloud services the same way you do on-premises. You can generate, use, rotate, and destroy AES256 encryption keys.",
"description":"Request message for `SetIamPolicy` method.",
"type":"object",
"properties":{
"policy":{
"description":"REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
"$ref":"Policy"
},
"updateMask":{
"description":"OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
"format":"google-fieldmask",
"type":"string"
}
},
"id":"SetIamPolicyRequest"
},
"DecryptRequest":{
"description":"Request message for KeyManagementService.Decrypt.",
"type":"object",
"properties":{
"ciphertext":{
"description":"Required. The encrypted data originally returned in\nEncryptResponse.ciphertext.",
"format":"byte",
"type":"string"
},
"additionalAuthenticatedData":{
"description":"Optional data that must match the data originally supplied in\nEncryptRequest.additional_authenticated_data.",
"format":"byte",
"type":"string"
}
},
"id":"DecryptRequest"
},
"Binding":{
"description":"Associates `members` with a `role`.",
"type":"object",
"properties":{
"members":{
"description":"Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
"type":"array",
"items":{
"type":"string"
}
},
"role":{
"description":"Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
"type":"string"
}
},
"id":"Binding"
},
"EncryptRequest":{
"description":"Request message for KeyManagementService.Encrypt.",
"type":"object",
"properties":{
"plaintext":{
"description":"Required. The data to encrypt. Must be no larger than 64KiB.",
"format":"byte",
"type":"string"
},
"additionalAuthenticatedData":{
"description":"Optional data that, if specified, must also be provided during decryption\nthrough DecryptRequest.additional_authenticated_data. Must be no\nlarger than 64KiB.",
"format":"byte",
"type":"string"
}
},
"id":"EncryptRequest"
},
"ListCryptoKeyVersionsResponse":{
"description":"Response message for KeyManagementService.ListCryptoKeyVersions.",
"type":"object",
"properties":{
"cryptoKeyVersions":{
"description":"The list of CryptoKeyVersions.",
"type":"array",
"items":{
"$ref":"CryptoKeyVersion"
}
},
"nextPageToken":{
"description":"A token to retrieve next page of results. Pass this value in\nListCryptoKeyVersionsRequest.page_token to retrieve the next page of\nresults.",
"type":"string"
},
"totalSize":{
"description":"The total number of CryptoKeyVersions that matched the\nquery.",
"format":"int32",
"type":"integer"
}
},
"id":"ListCryptoKeyVersionsResponse"
},
"Location":{
"description":"A resource that represents Google Cloud Platform location.",
"type":"object",
"properties":{
"labels":{
"description":"Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
"type":"object",
"additionalProperties":{
"type":"string"
}
},
"name":{
"description":"Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
"type":"string"
},
"locationId":{
"description":"The canonical id for this location. For example: `\"us-east1\"`.",
"type":"string"
},
"metadata":{
"additionalProperties":{
"description":"Properties of the object. Contains field @type with type URL.",
"type":"any"
},
"description":"Service-specific metadata. For example the available capacity at the given\nlocation.",
"description":"Response message for KeyManagementService.ListCryptoKeys.",
"type":"object",
"properties":{
"nextPageToken":{
"description":"A token to retrieve next page of results. Pass this value in\nListCryptoKeysRequest.page_token to retrieve the next page of results.",
"type":"string"
},
"cryptoKeys":{
"description":"The list of CryptoKeys.",
"type":"array",
"items":{
"$ref":"CryptoKey"
}
},
"totalSize":{
"description":"The total number of CryptoKeys that matched the query.",
"format":"int32",
"type":"integer"
}
},
"id":"ListCryptoKeysResponse"
},
"TestIamPermissionsResponse":{
"description":"Response message for `TestIamPermissions` method.",
"type":"object",
"properties":{
"permissions":{
"description":"A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
"type":"array",
"items":{
"type":"string"
}
}
},
"id":"TestIamPermissionsResponse"
},
"DestroyCryptoKeyVersionRequest":{
"description":"Request message for KeyManagementService.DestroyCryptoKeyVersion.",
"type":"object",
"properties":{},
"id":"DestroyCryptoKeyVersionRequest"
},
"AuditLogConfig":{
"description":"Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
"type":"object",
"properties":{
"logType":{
"enumDescriptions":[
"Default case. Should never be this.",
"Admin reads. Example: CloudIAM getIamPolicy",
"Data writes. Example: CloudSQL Users create",
"Data reads. Example: CloudSQL Users list"
],
"enum":[
"LOG_TYPE_UNSPECIFIED",
"ADMIN_READ",
"DATA_WRITE",
"DATA_READ"
],
"description":"The log type that this config enables.",
"description":"A CryptoKey represents a logical key that can be used for cryptographic\noperations.\n\nA CryptoKey is made up of one or more versions, which\nrepresent the actual key material used in cryptographic operations.",
"description":"The immutable purpose of this CryptoKey. Currently, the only acceptable\npurpose is ENCRYPT_DECRYPT.",
"type":"string",
"enumDescriptions":[
"Not specified.",
"CryptoKeys with this purpose may be used with\nEncrypt and\nDecrypt."
],
"enum":[
"CRYPTO_KEY_PURPOSE_UNSPECIFIED",
"ENCRYPT_DECRYPT"
]
},
"nextRotationTime":{
"description":"At next_rotation_time, the Key Management Service will automatically:\n\n1. Create a new version of this CryptoKey.\n2. Mark the new version as primary.\n\nKey rotations performed manually via\nCreateCryptoKeyVersion and\nUpdateCryptoKeyPrimaryVersion\ndo not affect next_rotation_time.",
"description":"Output only. The time at which this CryptoKey was created.",
"format":"google-datetime",
"type":"string"
},
"rotationPeriod":{
"description":"next_rotation_time will be advanced by this period when the service\nautomatically rotates a key. Must be at least one day.\n\nIf rotation_period is set, next_rotation_time must also be set.",
"format":"google-duration",
"type":"string"
},
"primary":{
"$ref":"CryptoKeyVersion",
"description":"Output only. A copy of the \"primary\" CryptoKeyVersion that will be used\nby Encrypt when this CryptoKey is given\nin EncryptRequest.name.\n\nThe CryptoKey's primary version can be updated via\nUpdateCryptoKeyPrimaryVersion."
},
"name":{
"description":"Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
"description":"Response message for KeyManagementService.Decrypt.",
"type":"object",
"properties":{
"plaintext":{
"description":"The decrypted data originally supplied in EncryptRequest.plaintext.",
"format":"byte",
"type":"string"
}
},
"id":"DecryptResponse"
},
"TestIamPermissionsRequest":{
"description":"Request message for `TestIamPermissions` method.",
"type":"object",
"properties":{
"permissions":{
"description":"The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
"type":"array",
"items":{
"type":"string"
}
}
},
"id":"TestIamPermissionsRequest"
},
"EncryptResponse":{
"description":"Response message for KeyManagementService.Encrypt.",
"type":"object",
"properties":{
"ciphertext":{
"description":"The encrypted data.",
"format":"byte",
"type":"string"
},
"name":{
"description":"The resource name of the CryptoKeyVersion used in encryption.",
"type":"string"
}
},
"id":"EncryptResponse"
},
"KeyRing":{
"description":"A KeyRing is a toplevel logical grouping of CryptoKeys.",
"type":"object",
"properties":{
"createTime":{
"description":"Output only. The time at which this KeyRing was created.",
"format":"google-datetime",
"type":"string"
},
"name":{
"description":"Output only. The resource name for the KeyRing in the format\n`projects/*/locations/*/keyRings/*`.",
"description":"Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
"description":"`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
"description":"Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
"type":"object",
"properties":{
"service":{
"description":"Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
"description":"A CryptoKeyVersion represents an individual cryptographic key, and the\nassociated key material.\n\nIt can be used for cryptographic operations either directly, or via its\nparent CryptoKey, in which case the server will choose the appropriate\nversion for the operation.\n\nFor security reasons, the raw cryptographic key material represented by a\nCryptoKeyVersion can never be viewed or exported. It can only be used to\nencrypt or decrypt data when an authorized user or application invokes Cloud\nKMS.",
"type":"object",
"properties":{
"createTime":{
"description":"Output only. The time at which this CryptoKeyVersion was created.",
"format":"google-datetime",
"type":"string"
},
"state":{
"enumDescriptions":[
"Not specified.",
"This version may be used in Encrypt and\nDecrypt requests.",
"This version may not be used, but the key material is still available,\nand the version can be placed back into the ENABLED state.",
"This version is destroyed, and the key material is no longer stored.\nA version may not leave this state once entered.",
"This version is scheduled for destruction, and will be destroyed soon.\nCall\nRestoreCryptoKeyVersion\nto put it back into the DISABLED state."
],
"enum":[
"CRYPTO_KEY_VERSION_STATE_UNSPECIFIED",
"ENABLED",
"DISABLED",
"DESTROYED",
"DESTROY_SCHEDULED"
],
"description":"The current state of the CryptoKeyVersion.",
"type":"string"
},
"name":{
"description":"Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
"description":"Output only. The time this CryptoKeyVersion's key material is scheduled\nfor destruction. Only present if state is\nDESTROY_SCHEDULED.",
"description":"Optional limit on the number of KeyRings to include in the\nresponse. Further KeyRings can subsequently be obtained by\nincluding the ListKeyRingsResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
"description":"REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
"description":"Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
"response":{
"$ref":"Policy"
},
"parameterOrder":[
"resource"
],
"httpMethod":"GET",
"scopes":[
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters":{
"resource":{
"description":"REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"description":"Returns metadata for a given KeyRing."
},
"testIamPermissions":{
"response":{
"$ref":"TestIamPermissionsResponse"
},
"parameterOrder":[
"resource"
],
"httpMethod":"POST",
"scopes":[
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters":{
"resource":{
"description":"REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"description":"Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
"description":"Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
"description":"REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"description":"Optional pagination token, returned earlier via\nListCryptoKeysResponse.next_page_token.",
"type":"string"
},
"pageSize":{
"location":"query",
"description":"Optional limit on the number of CryptoKeys to include in the\nresponse. Further CryptoKeys can subsequently be obtained by\nincluding the ListCryptoKeysResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
"description":"Required. The resource name of the CryptoKey or CryptoKeyVersion\nto use for encryption.\n\nIf a CryptoKey is specified, the server will use its\nprimary version.",
"description":"Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
"httpMethod":"POST",
"parameterOrder":[
"resource"
],
"response":{
"$ref":"Policy"
},
"parameters":{
"resource":{
"description":"REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
"description":"REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"description":"Restore a CryptoKeyVersion in the\nDESTROY_SCHEDULED,\nstate.\n\nUpon restoration of the CryptoKeyVersion, state\nwill be set to DISABLED,\nand destroy_time will be cleared.",
"description":"Update a CryptoKeyVersion's metadata.\n\nstate may be changed between\nENABLED and\nDISABLED using this\nmethod. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to\nmove between other states.",
"description":"Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
"description":"Optional limit on the number of CryptoKeyVersions to\ninclude in the response. Further CryptoKeyVersions can\nsubsequently be obtained by including the\nListCryptoKeyVersionsResponse.next_page_token in a subsequent request.\nIf unspecified, the server will pick an appropriate default.",
"description":"Create a new CryptoKeyVersion in a CryptoKey.\n\nThe server will assign the next sequential id. If unset,\nstate will be set to\nENABLED.",
"description":"Schedule a CryptoKeyVersion for destruction.\n\nUpon calling this method, CryptoKeyVersion.state will be set to\nDESTROY_SCHEDULED\nand destroy_time will be set to a time 24\nhours in the future, at which point the state\nwill be changed to\nDESTROYED, and the key\nmaterial will be irrevocably destroyed.\n\nBefore the destroy_time is reached,\nRestoreCryptoKeyVersion may be called to reverse the process.",
"description":"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.",
"description":"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.",
