Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(2462)

Unified Diff: discovery/googleapis_beta/cloudkms__v1beta1.json

Issue 2734843002: Api-roll 46: 2017-03-06 (Closed)
Patch Set: Created 3 years, 9 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: discovery/googleapis_beta/cloudkms__v1beta1.json
diff --git a/discovery/googleapis_beta/cloudkms__v1beta1.json b/discovery/googleapis_beta/cloudkms__v1beta1.json
index 48d366e66dba4fca1271642da64759742ae0f799..8cf281e018c8517ab3ac7fabd08b715bbef95d72 100644
--- a/discovery/googleapis_beta/cloudkms__v1beta1.json
+++ b/discovery/googleapis_beta/cloudkms__v1beta1.json
@@ -25,34 +25,6 @@
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query",
- "type": "string"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "location": "query",
- "type": "string"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "enum": [
- "1",
- "2"
- ],
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "type": "string"
- },
"alt": {
"default": "json",
"description": "Data format for response.",
@@ -69,13 +41,13 @@
"location": "query",
"type": "string"
},
- "access_token": {
- "description": "OAuth access token.",
+ "key": {
+ "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.",
"location": "query",
"type": "string"
},
- "key": {
- "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.",
+ "access_token": {
+ "description": "OAuth access token.",
"location": "query",
"type": "string"
},
@@ -110,6 +82,34 @@
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
}
},
"protocol": "rest",
@@ -126,11 +126,6 @@
"name"
],
"parameters": {
- "filter": {
- "description": "The standard list filter.",
- "location": "query",
- "type": "string"
- },
"name": {
"description": "The resource that owns the locations collection, if applicable.",
"location": "path",
@@ -148,6 +143,11 @@
"format": "int32",
"location": "query",
"type": "integer"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "location": "query",
+ "type": "string"
}
},
"path": "v1beta1/{+name}/locations",
@@ -194,13 +194,6 @@
"parent"
],
"parameters": {
- "parent": {
- "description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
- "location": "path",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "required": true,
- "type": "string"
- },
"pageToken": {
"description": "Optional pagination token, returned earlier via\nListKeyRingsResponse.next_page_token.",
"location": "query",
@@ -211,6 +204,13 @@
"format": "int32",
"location": "query",
"type": "integer"
+ },
+ "parent": {
+ "description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "required": true,
+ "type": "string"
}
},
"path": "v1beta1/{+parent}/keyRings",
@@ -329,7 +329,7 @@
]
},
"testIamPermissions": {
- "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.",
+ "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.",
"httpMethod": "POST",
"id": "cloudkms.projects.locations.keyRings.testIamPermissions",
"parameterOrder": [
@@ -359,31 +359,25 @@
"resources": {
"cryptoKeys": {
"methods": {
- "patch": {
- "description": "Update a CryptoKey.",
- "httpMethod": "PATCH",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.patch",
+ "updatePrimaryVersion": {
+ "description": "Update the version of a CryptoKey that will be used in Encrypt",
+ "httpMethod": "POST",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion",
"parameterOrder": [
"name"
],
"parameters": {
- "updateMask": {
- "description": "Required list of fields to be updated in this request.",
- "format": "google-fieldmask",
- "location": "query",
- "type": "string"
- },
"name": {
- "description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
+ "description": "The resource name of the CryptoKey to update.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
"required": true,
"type": "string"
}
},
- "path": "v1beta1/{+name}",
+ "path": "v1beta1/{+name}:updatePrimaryVersion",
"request": {
- "$ref": "CryptoKey"
+ "$ref": "UpdateCryptoKeyPrimaryVersionRequest"
},
"response": {
"$ref": "CryptoKey"
@@ -392,6 +386,30 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
+ "getIamPolicy": {
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "httpMethod": "GET",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.getIamPolicy",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/{+resource}:getIamPolicy",
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
"get": {
"description": "Returns metadata for a given CryptoKey, as well as its\nprimary CryptoKeyVersion.",
"httpMethod": "GET",
@@ -416,8 +434,41 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
+ "patch": {
+ "description": "Update a CryptoKey.",
+ "httpMethod": "PATCH",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.patch",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "updateMask": {
+ "description": "Required list of fields to be updated in this request.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ },
+ "name": {
+ "description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/{+name}",
+ "request": {
+ "$ref": "CryptoKey"
+ },
+ "response": {
+ "$ref": "CryptoKey"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
"testIamPermissions": {
- "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.",
+ "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.",
"httpMethod": "POST",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.testIamPermissions",
"parameterOrder": [
@@ -478,6 +529,13 @@
"parent"
],
"parameters": {
+ "parent": {
+ "description": "Required. The resource name of the KeyRing to list, in the format\n`projects/*/locations/*/keyRings/*`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
"pageToken": {
"description": "Optional pagination token, returned earlier via\nListCryptoKeysResponse.next_page_token.",
"location": "query",
@@ -488,13 +546,6 @@
"format": "int32",
"location": "query",
"type": "integer"
- },
- "parent": {
- "description": "Required. The resource name of the KeyRing to list, in the format\n`projects/*/locations/*/keyRings/*`.",
- "location": "path",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "required": true,
- "type": "string"
}
},
"path": "v1beta1/{+parent}/cryptoKeys",
@@ -540,17 +591,17 @@
"parent"
],
"parameters": {
+ "cryptoKeyId": {
+ "description": "Required. It must be unique within a KeyRing and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`",
+ "location": "query",
+ "type": "string"
+ },
"parent": {
"description": "Required. The name of the KeyRing associated with the\nCryptoKeys.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
"required": true,
"type": "string"
- },
- "cryptoKeyId": {
- "description": "Required. It must be unique within a KeyRing and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`",
- "location": "query",
- "type": "string"
}
},
"path": "v1beta1/{+parent}/cryptoKeys",
@@ -590,57 +641,6 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
- },
- "updatePrimaryVersion": {
- "description": "Update the version of a CryptoKey that will be used in Encrypt",
- "httpMethod": "POST",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion",
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "description": "The resource name of the CryptoKey to update.",
- "location": "path",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "required": true,
- "type": "string"
- }
- },
- "path": "v1beta1/{+name}:updatePrimaryVersion",
- "request": {
- "$ref": "UpdateCryptoKeyPrimaryVersionRequest"
- },
- "response": {
- "$ref": "CryptoKey"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "getIamPolicy": {
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
- "httpMethod": "GET",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.getIamPolicy",
- "parameterOrder": [
- "resource"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
- "location": "path",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "required": true,
- "type": "string"
- }
- },
- "path": "v1beta1/{+resource}:getIamPolicy",
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
}
},
"resources": {
@@ -654,6 +654,13 @@
"parent"
],
"parameters": {
+ "parent": {
+ "description": "Required. The resource name of the CryptoKey to list, in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
"pageToken": {
"description": "Optional pagination token, returned earlier via\nListCryptoKeyVersionsResponse.next_page_token.",
"location": "query",
@@ -664,13 +671,6 @@
"format": "int32",
"location": "query",
"type": "integer"
- },
- "parent": {
- "description": "Required. The resource name of the CryptoKey to list, in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
- "location": "path",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "required": true,
- "type": "string"
}
},
"path": "v1beta1/{+parent}/cryptoKeyVersions",
@@ -681,25 +681,25 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
- "destroy": {
- "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.",
+ "create": {
+ "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.",
"httpMethod": "POST",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create",
"parameterOrder": [
- "name"
+ "parent"
],
"parameters": {
- "name": {
- "description": "The resource name of the CryptoKeyVersion to destroy.",
+ "parent": {
+ "description": "Required. The name of the CryptoKey associated with\nthe CryptoKeyVersions.",
"location": "path",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
"required": true,
"type": "string"
}
},
- "path": "v1beta1/{+name}:destroy",
+ "path": "v1beta1/{+parent}/cryptoKeyVersions",
"request": {
- "$ref": "DestroyCryptoKeyVersionRequest"
+ "$ref": "CryptoKeyVersion"
},
"response": {
"$ref": "CryptoKeyVersion"
@@ -708,25 +708,25 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
- "create": {
- "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.",
+ "destroy": {
+ "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.",
"httpMethod": "POST",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy",
"parameterOrder": [
- "parent"
+ "name"
],
"parameters": {
- "parent": {
- "description": "Required. The name of the CryptoKey associated with\nthe CryptoKeyVersions.",
+ "name": {
+ "description": "The resource name of the CryptoKeyVersion to destroy.",
"location": "path",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
"required": true,
"type": "string"
}
},
- "path": "v1beta1/{+parent}/cryptoKeyVersions",
+ "path": "v1beta1/{+name}:destroy",
"request": {
- "$ref": "CryptoKeyVersion"
+ "$ref": "DestroyCryptoKeyVersionRequest"
},
"response": {
"$ref": "CryptoKeyVersion"
@@ -830,656 +830,657 @@
}
}
},
- "revision": "20170201",
+ "revision": "20170222",
"rootUrl": "https://cloudkms.googleapis.com/",
"schemas": {
- "DecryptResponse": {
- "description": "Response message for KeyManagementService.Decrypt.",
- "id": "DecryptResponse",
+ "CryptoKey": {
+ "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.",
+ "id": "CryptoKey",
"properties": {
- "plaintext": {
- "description": "The decrypted data originally supplied in EncryptRequest.plaintext.",
- "format": "byte",
+ "purpose": {
+ "description": "The immutable purpose of this CryptoKey. Currently, the only acceptable\npurpose is ENCRYPT_DECRYPT.",
+ "enum": [
+ "CRYPTO_KEY_PURPOSE_UNSPECIFIED",
+ "ENCRYPT_DECRYPT"
+ ],
+ "enumDescriptions": [
+ "Not specified.",
+ "CryptoKeys with this purpose may be used with\nEncrypt and\nDecrypt."
+ ],
+ "type": "string"
+ },
+ "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.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "createTime": {
+ "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/*`.",
"type": "string"
}
},
"type": "object"
},
- "TestIamPermissionsRequest": {
- "description": "Request message for `TestIamPermissions` method.",
- "id": "TestIamPermissionsRequest",
+ "Rule": {
+ "description": "A rule to be applied in a Policy.",
+ "id": "Rule",
"properties": {
+ "in": {
+ "description": "If one or more 'in' clauses are specified, the rule matches if\nthe PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
"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).",
+ "description": "A permission is a string of form '<service>.<resource type>.<verb>'\n(e.g., 'storage.buckets.list'). A value of '*' matches all permissions,\nand a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.",
"items": {
"type": "string"
},
"type": "array"
- }
- },
- "type": "object"
- },
- "Policy": {
- "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).",
- "id": "Policy",
- "properties": {
- "etag": {
- "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.",
- "format": "byte",
- "type": "string"
},
- "iamOwned": {
- "type": "boolean"
+ "action": {
+ "description": "Required",
+ "enum": [
+ "NO_ACTION",
+ "ALLOW",
+ "ALLOW_WITH_LOG",
+ "DENY",
+ "DENY_WITH_LOG",
+ "LOG"
+ ],
+ "enumDescriptions": [
+ "Default no action.",
+ "Matching 'Entries' grant access.",
+ "Matching 'Entries' grant access and the caller promises to log\nthe request per the returned log_configs.",
+ "Matching 'Entries' deny access.",
+ "Matching 'Entries' deny access and the caller promises to log\nthe request per the returned log_configs.",
+ "Matching 'Entries' tell IAM.Check callers to generate logs."
+ ],
+ "type": "string"
},
- "rules": {
- "description": "If more than one rule is specified, the rules are applied in the following\nmanner:\n- All matching LOG rules are always applied.\n- If any DENY/DENY_WITH_LOG rule matches, permission is denied.\n Logging will be applied if one or more matching rule requires logging.\n- Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is\n granted.\n Logging will be applied if one or more matching rule requires logging.\n- Otherwise, if no rule applies, permission is denied.",
+ "notIn": {
+ "description": "If one or more 'not_in' clauses are specified, the rule matches\nif the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.\nThe format for in and not_in entries is the same as for members in a\nBinding (see google/iam/v1/policy.proto).",
"items": {
- "$ref": "Rule"
+ "type": "string"
},
"type": "array"
},
- "version": {
- "description": "Version of the `Policy`. The default version is 0.",
- "format": "int32",
- "type": "integer"
+ "description": {
+ "description": "Human-readable description of the rule.",
+ "type": "string"
},
- "auditConfigs": {
- "description": "Specifies cloud audit logging configuration for this policy.",
+ "conditions": {
+ "description": "Additional restrictions that must be met",
"items": {
- "$ref": "AuditConfig"
+ "$ref": "Condition"
},
"type": "array"
},
- "bindings": {
- "description": "Associates a list of `members` to a `role`.\nMultiple `bindings` must not be specified for the same `role`.\n`bindings` with no members will result in an error.",
+ "logConfig": {
+ "description": "The config returned to callers of tech.iam.IAM.CheckPolicy for any entries\nthat match the LOG action.",
"items": {
- "$ref": "Binding"
+ "$ref": "LogConfig"
},
"type": "array"
}
},
"type": "object"
},
- "ListLocationsResponse": {
- "description": "The response message for Locations.ListLocations.",
- "id": "ListLocationsResponse",
+ "LogConfig": {
+ "description": "Specifies what kind of log the caller must write\nIncrement a streamz counter with the specified metric and field names.\n\nMetric names should start with a '/', generally be lowercase-only,\nand end in \"_count\". Field names should not contain an initial slash.\nThe actual exported metric names will have \"/iam/policy\" prepended.\n\nField names correspond to IAM request parameters and field values are\ntheir respective values.\n\nAt present the only supported field names are\n - \"iam_principal\", corresponding to IAMContext.principal;\n - \"\" (empty string), resulting in one aggretated counter with no field.\n\nExamples:\n counter { metric: \"/debug_access_count\" field: \"iam_principal\" }\n ==> increment counter /iam/policy/backend_debug_access_count\n {iam_principal=[value of IAMContext.principal]}\n\nAt this time we do not support:\n* multiple field names (though this may be supported in the future)\n* decrementing the counter\n* incrementing it by anything other than 1",
+ "id": "LogConfig",
"properties": {
- "locations": {
- "description": "A list of locations that matches the specified filter in the request.",
- "items": {
- "$ref": "Location"
- },
- "type": "array"
+ "counter": {
+ "$ref": "CounterOptions",
+ "description": "Counter options."
},
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
+ "dataAccess": {
+ "$ref": "DataAccessOptions",
+ "description": "Data access options."
+ },
+ "cloudAudit": {
+ "$ref": "CloudAuditOptions",
+ "description": "Cloud audit options."
}
},
"type": "object"
},
- "KeyRing": {
- "description": "A KeyRing is a toplevel logical grouping of CryptoKeys.",
- "id": "KeyRing",
+ "SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "id": "SetIamPolicyRequest",
"properties": {
- "createTime": {
- "description": "Output only. The time at which this KeyRing was created.",
- "format": "google-datetime",
- "type": "string"
+ "policy": {
+ "$ref": "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."
},
- "name": {
- "description": "Output only. The resource name for the KeyRing in the format\n`projects/*/locations/*/keyRings/*`.",
+ "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, a default\nmask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
+ "format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
- "EncryptResponse": {
- "description": "Response message for KeyManagementService.Encrypt.",
- "id": "EncryptResponse",
+ "DecryptRequest": {
+ "description": "Request message for KeyManagementService.Decrypt.",
+ "id": "DecryptRequest",
"properties": {
- "name": {
- "description": "The resource name of the CryptoKeyVersion used in encryption.",
+ "ciphertext": {
+ "description": "Required. The encrypted data originally returned in\nEncryptResponse.ciphertext.",
+ "format": "byte",
"type": "string"
},
- "ciphertext": {
- "description": "The encrypted data.",
+ "additionalAuthenticatedData": {
+ "description": "Optional data that must match the data originally supplied in\nEncryptRequest.additional_authenticated_data.",
"format": "byte",
"type": "string"
}
},
"type": "object"
},
- "RestoreCryptoKeyVersionRequest": {
- "description": "Request message for KeyManagementService.RestoreCryptoKeyVersion.",
- "id": "RestoreCryptoKeyVersionRequest",
- "properties": {},
- "type": "object"
- },
- "UpdateCryptoKeyPrimaryVersionRequest": {
- "description": "Request message for KeyManagementService.UpdateCryptoKeyPrimaryVersion.",
- "id": "UpdateCryptoKeyPrimaryVersionRequest",
+ "Location": {
+ "description": "A resource that represents Google Cloud Platform location.",
+ "id": "Location",
"properties": {
- "cryptoKeyVersionId": {
- "description": "The id of the child CryptoKeyVersion to use as primary.",
+ "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.",
+ "type": "object"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
+ "type": "object"
}
},
"type": "object"
},
- "ListKeyRingsResponse": {
- "description": "Response message for KeyManagementService.ListKeyRings.",
- "id": "ListKeyRingsResponse",
+ "ListCryptoKeysResponse": {
+ "description": "Response message for KeyManagementService.ListCryptoKeys.",
+ "id": "ListCryptoKeysResponse",
"properties": {
"nextPageToken": {
- "description": "A token to retrieve next page of results. Pass this value in\nListKeyRingsRequest.page_token to retrieve the next page of results.",
+ "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"
},
- "totalSize": {
- "description": "The total number of KeyRings that matched the query.",
- "format": "int32",
- "type": "integer"
- },
- "keyRings": {
- "description": "The list of KeyRings.",
+ "cryptoKeys": {
+ "description": "The list of CryptoKeys.",
"items": {
- "$ref": "KeyRing"
+ "$ref": "CryptoKey"
},
"type": "array"
+ },
+ "totalSize": {
+ "description": "The total number of CryptoKeys that matched the query.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
},
- "DataAccessOptions": {
- "description": "Write a Data Access (Gin) log",
- "id": "DataAccessOptions",
- "properties": {},
- "type": "object"
- },
- "AuditConfig": {
- "description": "Specifies the audit configuration for a service.\nIt consists of which permission types are logged, and what identities, if\nany, are exempted from logging.\nAn AuditConifg must have one or more AuditLogConfigs.",
- "id": "AuditConfig",
+ "Condition": {
+ "description": "A condition to be met.",
+ "id": "Condition",
"properties": {
- "service": {
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `resourcemanager`, `storage`, `compute`.\n`allServices` is a special value that covers all services.",
+ "iam": {
+ "description": "Trusted attributes supplied by the IAM system.",
+ "enum": [
+ "NO_ATTR",
+ "AUTHORITY",
+ "ATTRIBUTION",
+ "APPROVER"
+ ],
+ "enumDescriptions": [
+ "Default non-attribute.",
+ "Either principal or (if present) authority selector.",
+ "The principal (even if an authority selector is present), which\nmust only be used for attribution, not authorization.",
+ "An approver (distinct from the requester) that has authorized this\nrequest.\nWhen used with IN, the condition indicates that one of the approvers\nassociated with the request matches the specified principal, or is a\nmember of the specified group. Approvers can only grant additional\naccess, and are thus only used in a strictly positive context\n(e.g. ALLOW/IN or DENY/NOT_IN).\nSee: go/rpc-security-policy-dynamicauth."
+ ],
"type": "string"
},
- "auditLogConfigs": {
- "description": "The configuration for logging of each type of permission.\nNext ID: 4",
- "items": {
- "$ref": "AuditLogConfig"
- },
- "type": "array"
- },
- "exemptedMembers": {
- "description": "Specifies the identities that are exempted from \"data access\" audit\nlogging for the `service` specified above.\nFollows the same format of Binding.members.\nThis field is deprecated in favor of per-permission-type exemptions.",
+ "values": {
+ "description": "The objects of the condition. This is mutually exclusive with 'value'.",
"items": {
"type": "string"
},
"type": "array"
- }
- },
- "type": "object"
- },
- "CryptoKeyVersion": {
- "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.",
- "id": "CryptoKeyVersion",
- "properties": {
- "createTime": {
- "description": "Output only. The time at which this CryptoKeyVersion was created.",
- "format": "google-datetime",
- "type": "string"
},
- "state": {
- "description": "The current state of the CryptoKeyVersion.",
+ "op": {
+ "description": "An operator to apply the subject with.",
"enum": [
- "CRYPTO_KEY_VERSION_STATE_UNSPECIFIED",
- "ENABLED",
- "DISABLED",
- "DESTROYED",
- "DESTROY_SCHEDULED"
+ "NO_OP",
+ "EQUALS",
+ "NOT_EQUALS",
+ "IN",
+ "NOT_IN",
+ "DISCHARGED"
],
"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."
+ "Default no-op.",
+ "DEPRECATED. Use IN instead.",
+ "DEPRECATED. Use NOT_IN instead.",
+ "Set-inclusion check.",
+ "Set-exclusion check.",
+ "Subject is discharged"
],
"type": "string"
},
- "name": {
- "description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
+ "svc": {
+ "description": "Trusted attributes discharged by the service.",
"type": "string"
},
- "destroyEventTime": {
- "description": "Output only. The time this CryptoKeyVersion's key material was\ndestroyed. Only present if state is\nDESTROYED.",
- "format": "google-datetime",
+ "value": {
+ "description": "DEPRECATED. Use 'values' instead.",
"type": "string"
},
- "destroyTime": {
- "description": "Output only. The time this CryptoKeyVersion's key material is scheduled\nfor destruction. Only present if state is\nDESTROY_SCHEDULED.",
- "format": "google-datetime",
+ "sys": {
+ "description": "Trusted attributes supplied by any service that owns resources and uses\nthe IAM system for access control.",
+ "enum": [
+ "NO_ATTR",
+ "REGION",
+ "SERVICE",
+ "NAME",
+ "IP"
+ ],
+ "enumDescriptions": [
+ "Default non-attribute type",
+ "Region of the resource",
+ "Service name",
+ "Resource name",
+ "IP address of the caller"
+ ],
"type": "string"
}
},
"type": "object"
},
- "CloudAuditOptions": {
- "description": "Write a Cloud Audit log",
- "id": "CloudAuditOptions",
- "properties": {},
+ "CounterOptions": {
+ "description": "Options for counters",
+ "id": "CounterOptions",
+ "properties": {
+ "metric": {
+ "description": "The metric to update.",
+ "type": "string"
+ },
+ "field": {
+ "description": "The field value to attribute.",
+ "type": "string"
+ }
+ },
"type": "object"
},
- "Binding": {
- "description": "Associates `members` with a `role`.",
- "id": "Binding",
+ "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.",
+ "id": "AuditLogConfig",
"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* `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",
+ "logType": {
+ "description": "The log type that this config enables.",
+ "enum": [
+ "LOG_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "DATA_WRITE",
+ "DATA_READ"
+ ],
+ "enumDescriptions": [
+ "Default case. Should never be this.",
+ "Admin reads. Example: CloudIAM getIamPolicy",
+ "Data writes. Example: CloudSQL Users create",
+ "Data reads. Example: CloudSQL Users list"
+ ],
+ "type": "string"
+ },
+ "exemptedMembers": {
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
"items": {
"type": "string"
},
"type": "array"
- },
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
}
},
"type": "object"
},
- "EncryptRequest": {
- "description": "Request message for KeyManagementService.Encrypt.",
- "id": "EncryptRequest",
+ "DecryptResponse": {
+ "description": "Response message for KeyManagementService.Decrypt.",
+ "id": "DecryptResponse",
"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.",
+ "description": "The decrypted data originally supplied in EncryptRequest.plaintext.",
"format": "byte",
"type": "string"
}
},
"type": "object"
},
- "ListCryptoKeyVersionsResponse": {
- "description": "Response message for KeyManagementService.ListCryptoKeyVersions.",
- "id": "ListCryptoKeyVersionsResponse",
+ "TestIamPermissionsRequest": {
+ "description": "Request message for `TestIamPermissions` method.",
+ "id": "TestIamPermissionsRequest",
"properties": {
- "totalSize": {
- "description": "The total number of CryptoKeyVersions that matched the\nquery.",
+ "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).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Policy": {
+ "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).",
+ "id": "Policy",
+ "properties": {
+ "version": {
+ "description": "Version of the `Policy`. The default version is 0.",
"format": "int32",
"type": "integer"
},
- "cryptoKeyVersions": {
- "description": "The list of CryptoKeyVersions.",
+ "auditConfigs": {
+ "description": "Specifies cloud audit logging configuration for this policy.",
"items": {
- "$ref": "CryptoKeyVersion"
+ "$ref": "AuditConfig"
},
"type": "array"
},
- "nextPageToken": {
- "description": "A token to retrieve next page of results. Pass this value in\nListCryptoKeyVersionsRequest.page_token to retrieve the next page of\nresults.",
+ "bindings": {
+ "description": "Associates a list of `members` to a `role`.\nMultiple `bindings` must not be specified for the same `role`.\n`bindings` with no members will result in an error.",
+ "items": {
+ "$ref": "Binding"
+ },
+ "type": "array"
+ },
+ "etag": {
+ "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.",
+ "format": "byte",
"type": "string"
+ },
+ "iamOwned": {
+ "type": "boolean"
+ },
+ "rules": {
+ "description": "If more than one rule is specified, the rules are applied in the following\nmanner:\n- All matching LOG rules are always applied.\n- If any DENY/DENY_WITH_LOG rule matches, permission is denied.\n Logging will be applied if one or more matching rule requires logging.\n- Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is\n granted.\n Logging will be applied if one or more matching rule requires logging.\n- Otherwise, if no rule applies, permission is denied.",
+ "items": {
+ "$ref": "Rule"
+ },
+ "type": "array"
}
},
"type": "object"
},
- "TestIamPermissionsResponse": {
- "description": "Response message for `TestIamPermissions` method.",
- "id": "TestIamPermissionsResponse",
+ "EncryptResponse": {
+ "description": "Response message for KeyManagementService.Encrypt.",
+ "id": "EncryptResponse",
"properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "ciphertext": {
+ "description": "The encrypted data.",
+ "format": "byte",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource name of the CryptoKeyVersion used in encryption.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "id": "ListLocationsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
"items": {
- "type": "string"
+ "$ref": "Location"
},
"type": "array"
}
},
"type": "object"
},
- "DestroyCryptoKeyVersionRequest": {
- "description": "Request message for KeyManagementService.DestroyCryptoKeyVersion.",
- "id": "DestroyCryptoKeyVersionRequest",
- "properties": {},
- "type": "object"
- },
- "CryptoKey": {
- "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.",
- "id": "CryptoKey",
+ "KeyRing": {
+ "description": "A KeyRing is a toplevel logical grouping of CryptoKeys.",
+ "id": "KeyRing",
"properties": {
"createTime": {
- "description": "Output only. The time at which this CryptoKey was created.",
+ "description": "Output only. The time at which this KeyRing 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/*`.",
- "type": "string"
- },
- "purpose": {
- "description": "The immutable purpose of this CryptoKey. Currently, the only acceptable\npurpose is ENCRYPT_DECRYPT.",
- "enum": [
- "CRYPTO_KEY_PURPOSE_UNSPECIFIED",
- "ENCRYPT_DECRYPT"
- ],
- "enumDescriptions": [
- "Not specified.",
- "CryptoKeys with this purpose may be used with\nEncrypt and\nDecrypt."
- ],
+ "description": "Output only. The resource name for the KeyRing in the format\n`projects/*/locations/*/keyRings/*`.",
"type": "string"
- },
- "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.",
- "format": "google-datetime",
+ }
+ },
+ "type": "object"
+ },
+ "RestoreCryptoKeyVersionRequest": {
+ "description": "Request message for KeyManagementService.RestoreCryptoKeyVersion.",
+ "id": "RestoreCryptoKeyVersionRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "UpdateCryptoKeyPrimaryVersionRequest": {
+ "description": "Request message for KeyManagementService.UpdateCryptoKeyPrimaryVersion.",
+ "id": "UpdateCryptoKeyPrimaryVersionRequest",
+ "properties": {
+ "cryptoKeyVersionId": {
+ "description": "The id of the child CryptoKeyVersion to use as primary.",
"type": "string"
}
},
"type": "object"
},
- "Rule": {
- "description": "A rule to be applied in a Policy.",
- "id": "Rule",
+ "DataAccessOptions": {
+ "description": "Write a Data Access (Gin) log",
+ "id": "DataAccessOptions",
+ "properties": {},
+ "type": "object"
+ },
+ "ListKeyRingsResponse": {
+ "description": "Response message for KeyManagementService.ListKeyRings.",
+ "id": "ListKeyRingsResponse",
"properties": {
- "description": {
- "description": "Human-readable description of the rule.",
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results. Pass this value in\nListKeyRingsRequest.page_token to retrieve the next page of results.",
"type": "string"
},
- "conditions": {
- "description": "Additional restrictions that must be met",
- "items": {
- "$ref": "Condition"
- },
- "type": "array"
- },
- "logConfig": {
- "description": "The config returned to callers of tech.iam.IAM.CheckPolicy for any entries\nthat match the LOG action.",
- "items": {
- "$ref": "LogConfig"
- },
- "type": "array"
+ "totalSize": {
+ "description": "The total number of KeyRings that matched the query.",
+ "format": "int32",
+ "type": "integer"
},
- "in": {
- "description": "If one or more 'in' clauses are specified, the rule matches if\nthe PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.",
+ "keyRings": {
+ "description": "The list of KeyRings.",
"items": {
- "type": "string"
+ "$ref": "KeyRing"
},
"type": "array"
- },
- "permissions": {
- "description": "A permission is a string of form '<service>.<resource type>.<verb>'\n(e.g., 'storage.buckets.list'). A value of '*' matches all permissions,\nand a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.",
+ }
+ },
+ "type": "object"
+ },
+ "AuditConfig": {
+ "description": "Specifies the audit configuration for a service.\nIt consists of which permission types are logged, and what identities, if\nany, are exempted from logging.\nAn AuditConifg 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.\nExample Policy with multiple AuditConfigs:\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}\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.",
+ "id": "AuditConfig",
+ "properties": {
+ "exemptedMembers": {
"items": {
"type": "string"
},
"type": "array"
},
- "action": {
- "description": "Required",
- "enum": [
- "NO_ACTION",
- "ALLOW",
- "ALLOW_WITH_LOG",
- "DENY",
- "DENY_WITH_LOG",
- "LOG"
- ],
- "enumDescriptions": [
- "Default no action.",
- "Matching 'Entries' grant access.",
- "Matching 'Entries' grant access and the caller promises to log\nthe request per the returned log_configs.",
- "Matching 'Entries' deny access.",
- "Matching 'Entries' deny access and the caller promises to log\nthe request per the returned log_configs.",
- "Matching 'Entries' tell IAM.Check callers to generate logs."
- ],
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `resourcemanager`, `storage`, `compute`.\n`allServices` is a special value that covers all services.",
"type": "string"
},
- "notIn": {
- "description": "If one or more 'not_in' clauses are specified, the rule matches\nif the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.\nThe format for in and not_in entries is the same as for members in a\nBinding (see google/iam/v1/policy.proto).",
+ "auditLogConfigs": {
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",
"items": {
- "type": "string"
+ "$ref": "AuditLogConfig"
},
"type": "array"
}
},
"type": "object"
},
- "LogConfig": {
- "description": "Specifies what kind of log the caller must write\nIncrement a streamz counter with the specified metric and field names.\n\nMetric names should start with a '/', generally be lowercase-only,\nand end in \"_count\". Field names should not contain an initial slash.\nThe actual exported metric names will have \"/iam/policy\" prepended.\n\nField names correspond to IAM request parameters and field values are\ntheir respective values.\n\nAt present the only supported field names are\n - \"iam_principal\", corresponding to IAMContext.principal;\n - \"\" (empty string), resulting in one aggretated counter with no field.\n\nExamples:\n counter { metric: \"/debug_access_count\" field: \"iam_principal\" }\n ==> increment counter /iam/policy/backend_debug_access_count\n {iam_principal=[value of IAMContext.principal]}\n\nAt this time we do not support:\n* multiple field names (though this may be supported in the future)\n* decrementing the counter\n* incrementing it by anything other than 1",
- "id": "LogConfig",
+ "CryptoKeyVersion": {
+ "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.",
+ "id": "CryptoKeyVersion",
"properties": {
- "dataAccess": {
- "$ref": "DataAccessOptions",
- "description": "Data access options."
+ "state": {
+ "description": "The current state of the CryptoKeyVersion.",
+ "enum": [
+ "CRYPTO_KEY_VERSION_STATE_UNSPECIFIED",
+ "ENABLED",
+ "DISABLED",
+ "DESTROYED",
+ "DESTROY_SCHEDULED"
+ ],
+ "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."
+ ],
+ "type": "string"
},
- "cloudAudit": {
- "$ref": "CloudAuditOptions",
- "description": "Cloud audit options."
+ "name": {
+ "description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
+ "type": "string"
},
- "counter": {
- "$ref": "CounterOptions",
- "description": "Counter options."
- }
- },
- "type": "object"
- },
- "SetIamPolicyRequest": {
- "description": "Request message for `SetIamPolicy` method.",
- "id": "SetIamPolicyRequest",
- "properties": {
- "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, a default\nmask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
- "format": "google-fieldmask",
+ "destroyEventTime": {
+ "description": "Output only. The time this CryptoKeyVersion's key material was\ndestroyed. Only present if state is\nDESTROYED.",
+ "format": "google-datetime",
"type": "string"
},
- "policy": {
- "$ref": "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."
- }
- },
- "type": "object"
- },
- "DecryptRequest": {
- "description": "Request message for KeyManagementService.Decrypt.",
- "id": "DecryptRequest",
- "properties": {
- "ciphertext": {
- "description": "Required. The encrypted data originally returned in\nEncryptResponse.ciphertext.",
- "format": "byte",
+ "destroyTime": {
+ "description": "Output only. The time this CryptoKeyVersion's key material is scheduled\nfor destruction. Only present if state is\nDESTROY_SCHEDULED.",
+ "format": "google-datetime",
"type": "string"
},
- "additionalAuthenticatedData": {
- "description": "Optional data that must match the data originally supplied in\nEncryptRequest.additional_authenticated_data.",
- "format": "byte",
+ "createTime": {
+ "description": "Output only. The time at which this CryptoKeyVersion was created.",
+ "format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
- "Location": {
- "description": "A resource that represents Google Cloud Platform location.",
- "id": "Location",
- "properties": {
- "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.",
- "type": "object"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
- "type": "object"
- }
- },
+ "CloudAuditOptions": {
+ "description": "Write a Cloud Audit log",
+ "id": "CloudAuditOptions",
+ "properties": {},
"type": "object"
},
- "ListCryptoKeysResponse": {
- "description": "Response message for KeyManagementService.ListCryptoKeys.",
- "id": "ListCryptoKeysResponse",
+ "Binding": {
+ "description": "Associates `members` with a `role`.",
+ "id": "Binding",
"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.",
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
"type": "string"
},
- "cryptoKeys": {
- "description": "The list of CryptoKeys.",
+ "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* `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",
"items": {
- "$ref": "CryptoKey"
+ "type": "string"
},
"type": "array"
- },
- "totalSize": {
- "description": "The total number of CryptoKeys that matched the query.",
- "format": "int32",
- "type": "integer"
}
},
"type": "object"
},
- "Condition": {
- "description": "A condition to be met.",
- "id": "Condition",
+ "EncryptRequest": {
+ "description": "Request message for KeyManagementService.Encrypt.",
+ "id": "EncryptRequest",
"properties": {
- "op": {
- "description": "An operator to apply the subject with.",
- "enum": [
- "NO_OP",
- "EQUALS",
- "NOT_EQUALS",
- "IN",
- "NOT_IN",
- "DISCHARGED"
- ],
- "enumDescriptions": [
- "Default no-op.",
- "DEPRECATED. Use IN instead.",
- "DEPRECATED. Use NOT_IN instead.",
- "Set-inclusion check.",
- "Set-exclusion check.",
- "Subject is discharged"
- ],
- "type": "string"
- },
- "svc": {
- "description": "Trusted attributes discharged by the service.",
- "type": "string"
- },
- "sys": {
- "description": "Trusted attributes supplied by any service that owns resources and uses\nthe IAM system for access control.",
- "enum": [
- "NO_ATTR",
- "REGION",
- "SERVICE",
- "NAME",
- "IP"
- ],
- "enumDescriptions": [
- "Default non-attribute type",
- "Region of the resource",
- "Service name",
- "Resource name",
- "IP address of the caller"
- ],
- "type": "string"
- },
- "value": {
- "description": "DEPRECATED. Use 'values' instead.",
+ "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"
},
- "values": {
- "description": "The objects of the condition. This is mutually exclusive with 'value'.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "iam": {
- "description": "Trusted attributes supplied by the IAM system.",
- "enum": [
- "NO_ATTR",
- "AUTHORITY",
- "ATTRIBUTION"
- ],
- "enumDescriptions": [
- "Default non-attribute.",
- "Either principal or (if present) authority selector.",
- "The principal (even if an authority selector is present), which\nmust only be used for attribution, not authorization."
- ],
+ "plaintext": {
+ "description": "Required. The data to encrypt. Must be no larger than 64KiB.",
+ "format": "byte",
"type": "string"
}
},
"type": "object"
},
- "CounterOptions": {
- "description": "Options for counters",
- "id": "CounterOptions",
+ "ListCryptoKeyVersionsResponse": {
+ "description": "Response message for KeyManagementService.ListCryptoKeyVersions.",
+ "id": "ListCryptoKeyVersionsResponse",
"properties": {
- "metric": {
- "description": "The metric to update.",
- "type": "string"
+ "cryptoKeyVersions": {
+ "description": "The list of CryptoKeyVersions.",
+ "items": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "type": "array"
},
- "field": {
- "description": "The field value to attribute.",
+ "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"
}
},
"type": "object"
},
- "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.",
- "id": "AuditLogConfig",
+ "TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "id": "TestIamPermissionsResponse",
"properties": {
- "exemptedMembers": {
- "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
"items": {
"type": "string"
},
"type": "array"
- },
- "logType": {
- "description": "The log type that this config enables.",
- "enum": [
- "LOG_TYPE_UNSPECIFIED",
- "ADMIN_READ",
- "DATA_WRITE",
- "DATA_READ"
- ],
- "enumDescriptions": [
- "Default case. Should never be this.",
- "Admin reads. Example: CloudIAM getIamPolicy",
- "Data writes. Example: CloudSQL Users create",
- "Data reads. Example: CloudSQL Users list"
- ],
- "type": "string"
}
},
"type": "object"
+ },
+ "DestroyCryptoKeyVersionRequest": {
+ "description": "Request message for KeyManagementService.DestroyCryptoKeyVersion.",
+ "id": "DestroyCryptoKeyVersionRequest",
+ "properties": {},
+ "type": "object"
}
},
"servicePath": "",
« no previous file with comments | « discovery/googleapis_beta/clouderrorreporting__v1beta1.json ('k') | discovery/googleapis_beta/cloudmonitoring__v2beta2.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698