KurlesHS/restic
1
0
Fork 0
forked from TrueCloudLab/restic
Code Pull requests Activity
restic/vendor/google.golang.org/api/cloudkms/v1/cloudkms-api.json

1559 lines
74 KiB
JSON
Raw Normal View History

Vendor dependencies for GCS
2017-08-05 18:17:15 +00:00
{
"batchPath": "batch",
"title": "Google Cloud Key Management Service (KMS) API",
"ownerName": "Google",
"resources": {
"projects": {
"resources": {
"locations": {
"resources": {
"keyRings": {
"resources": {
"cryptoKeys": {
"resources": {
"cryptoKeyVersions": {
"methods": {
"list": {
"response": {
"$ref": "ListCryptoKeyVersionsResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"pageToken": {
"location": "query",
"description": "Optional pagination token, returned earlier via\nListCryptoKeyVersionsResponse.next_page_token.",
"type": "string"
},
"pageSize": {
"format": "int32",
"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.",
"type": "integer",
"location": "query"
},
"parent": {
"description": "Required. The resource name of the CryptoKey to list, in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
"location": "path"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list",
"path": "v1/{+parent}/cryptoKeyVersions",
"description": "Lists CryptoKeyVersions."
},
"create": {
"httpMethod": "POST",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "CryptoKeyVersion"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"description": "Required. The name of the CryptoKey associated with\nthe CryptoKeyVersions.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
"location": "path"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
"path": "v1/{+parent}/cryptoKeyVersions",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create",
"request": {
"$ref": "CryptoKeyVersion"
},
"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": {
"response": {
"$ref": "CryptoKeyVersion"
},
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"parameters": {
"name": {
"description": "The resource name of the CryptoKeyVersion to destroy.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:destroy",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy",
"path": "v1/{+name}: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.",
"request": {
"$ref": "DestroyCryptoKeyVersionRequest"
}
},
"restore": {
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.restore",
"path": "v1/{+name}:restore",
"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.",
"request": {
"$ref": "RestoreCryptoKeyVersionRequest"
},
"response": {
"$ref": "CryptoKeyVersion"
},
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"parameters": {
"name": {
"description": "The resource name of the CryptoKeyVersion to restore.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:restore"
},
"get": {
"response": {
"$ref": "CryptoKeyVersion"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
"location": "path",
"description": "The name of the CryptoKeyVersion to get.",
"type": "string",
"required": true
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.get",
"path": "v1/{+name}",
"description": "Returns metadata for a given CryptoKeyVersion."
},
"patch": {
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.patch",
"path": "v1/{+name}",
"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.",
"request": {
"$ref": "CryptoKeyVersion"
},
"response": {
"$ref": "CryptoKeyVersion"
},
"parameterOrder": [
"name"
],
"httpMethod": "PATCH",
"parameters": {
"updateMask": {
"location": "query",
"format": "google-fieldmask",
"description": "Required list of fields to be updated in this request.",
"type": "string"
},
"name": {
"description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}"
}
}
}
},
"methods": {
"patch": {
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.patch",
"path": "v1/{+name}",
"description": "Update a CryptoKey.",
"request": {
"$ref": "CryptoKey"
},
"response": {
"$ref": "CryptoKey"
},
"parameterOrder": [
"name"
],
"httpMethod": "PATCH",
"parameters": {
"updateMask": {
"location": "query",
"format": "google-fieldmask",
"description": "Required list of fields to be updated in this request.",
"type": "string"
},
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
"location": "path",
"description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}"
},
"get": {
"response": {
"$ref": "CryptoKey"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"description": "The name of the CryptoKey to get.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
"location": "path"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.get",
"path": "v1/{+name}",
"description": "Returns metadata for a given CryptoKey, as well as its\nprimary CryptoKeyVersion."
},
"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.\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.",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"httpMethod": "POST",
"parameterOrder": [
"resource"
],
"response": {
"$ref": "TestIamPermissionsResponse"
},
"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.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:testIamPermissions",
"path": "v1/{+resource}:testIamPermissions",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.testIamPermissions"
},
"decrypt": {
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.decrypt",
"path": "v1/{+name}:decrypt",
"request": {
"$ref": "DecryptRequest"
},
"description": "Decrypts data that was protected by Encrypt.",
"response": {
"$ref": "DecryptResponse"
},
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"description": "Required. The resource name of the CryptoKey to use for decryption.\nThe server will choose the appropriate version.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
"location": "path"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:decrypt"
},
"list": {
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys",
"path": "v1/{+parent}/cryptoKeys",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.list",
"description": "Lists CryptoKeys.",
"httpMethod": "GET",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "ListCryptoKeysResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"location": "path",
"description": "Required. The resource name of the KeyRing to list, in the format\n`projects/*/locations/*/keyRings/*`.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$"
},
"pageToken": {
"location": "query",
"description": "Optional pagination token, returned earlier via\nListCryptoKeysResponse.next_page_token.",
"type": "string"
},
"pageSize": {
"location": "query",
"format": "int32",
"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.",
"type": "integer"
}
}
},
"encrypt": {
"response": {
"$ref": "EncryptResponse"
},
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"parameters": {
"name": {
"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.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/.+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:encrypt",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.encrypt",
"path": "v1/{+name}:encrypt",
"description": "Encrypts data, so that it can only be recovered by a call to Decrypt.",
"request": {
"$ref": "EncryptRequest"
}
},
"setIamPolicy": {
"path": "v1/{+resource}:setIamPolicy",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.setIamPolicy",
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
"request": {
"$ref": "SetIamPolicyRequest"
},
"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.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:setIamPolicy"
},
"create": {
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.create",
"path": "v1/{+parent}/cryptoKeys",
"description": "Create a new CryptoKey within a KeyRing.\n\nCryptoKey.purpose is required.",
"request": {
"$ref": "CryptoKey"
},
"response": {
"$ref": "CryptoKey"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"parameters": {
"cryptoKeyId": {
"description": "Required. It must be unique within a KeyRing and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`",
"type": "string",
"location": "query"
},
"parent": {
"description": "Required. The name of the KeyRing associated with the\nCryptoKeys.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys"
},
"updatePrimaryVersion": {
"response": {
"$ref": "CryptoKey"
},
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
"location": "path",
"description": "The resource name of the CryptoKey to update.",
"type": "string",
"required": true
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:updatePrimaryVersion",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion",
"path": "v1/{+name}:updatePrimaryVersion",
"request": {
"$ref": "UpdateCryptoKeyPrimaryVersionRequest"
},
"description": "Update the version of a CryptoKey that will be used in Encrypt"
},
"getIamPolicy": {
"httpMethod": "GET",
"parameterOrder": [
"resource"
],
"response": {
"$ref": "Policy"
},
"parameters": {
"resource": {
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
"location": "path",
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:getIamPolicy",
"path": "v1/{+resource}:getIamPolicy",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.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."
}
}
}
},
"methods": {
"list": {
"path": "v1/{+parent}/keyRings",
"id": "cloudkms.projects.locations.keyRings.list",
"description": "Lists KeyRings.",
"httpMethod": "GET",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "ListKeyRingsResponse"
},
"parameters": {
"pageSize": {
"format": "int32",
"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.",
"type": "integer",
"location": "query"
},
"parent": {
"location": "path",
"description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+$"
},
"pageToken": {
"location": "query",
"description": "Optional pagination token, returned earlier via\nListKeyRingsResponse.next_page_token.",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings"
},
"create": {
"httpMethod": "POST",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "KeyRing"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path",
"description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
"type": "string",
"required": true
},
"keyRingId": {
"description": "Required. It must be unique within a location and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`",
"type": "string",
"location": "query"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings",
"path": "v1/{+parent}/keyRings",
"id": "cloudkms.projects.locations.keyRings.create",
"request": {
"$ref": "KeyRing"
},
"description": "Create a new KeyRing in a given Project and Location."
},
"setIamPolicy": {
"response": {
"$ref": "Policy"
},
"parameterOrder": [
"resource"
],
"httpMethod": "POST",
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:setIamPolicy",
"id": "cloudkms.projects.locations.keyRings.setIamPolicy",
"path": "v1/{+resource}:setIamPolicy",
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
"request": {
"$ref": "SetIamPolicyRequest"
}
},
"getIamPolicy": {
"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.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
"location": "path"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:getIamPolicy",
"id": "cloudkms.projects.locations.keyRings.getIamPolicy",
"path": "v1/{+resource}: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."
},
"get": {
"httpMethod": "GET",
"parameterOrder": [
"name"
],
"response": {
"$ref": "KeyRing"
},
"parameters": {
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
"location": "path",
"description": "The name of the KeyRing to get.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}",
"path": "v1/{+name}",
"id": "cloudkms.projects.locations.keyRings.get",
"description": "Returns metadata for a given KeyRing."
},
"testIamPermissions": {
"id": "cloudkms.projects.locations.keyRings.testIamPermissions",
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"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.",
"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.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
"location": "path"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:testIamPermissions"
}
}
}
},
"methods": {
"get": {
"id": "cloudkms.projects.locations.get",
"path": "v1/{+name}",
"description": "Get information about a location.",
"response": {
"$ref": "Location"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"location": "path",
"description": "Resource name for the location.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+$"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}"
},
"list": {
"description": "Lists information about the supported locations for this service.",
"response": {
"$ref": "ListLocationsResponse"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"parameters": {
"pageToken": {
"location": "query",
"description": "The standard list page token.",
"type": "string"
},
"name": {
"pattern": "^projects/[^/]+$",
"location": "path",
"description": "The resource that owns the locations collection, if applicable.",
"type": "string",
"required": true
},
"pageSize": {
"format": "int32",
"description": "The standard list page size.",
"type": "integer",
"location": "query"
},
"filter": {
"description": "The standard list filter.",
"type": "string",
"location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations",
"id": "cloudkms.projects.locations.list",
"path": "v1/{+name}/locations"
}
}
}
}
}
},
"parameters": {
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"default": "true",
"type": "boolean",
"location": "query"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
"callback": {
"description": "JSONP",
"type": "string",
"location": "query"
},
"$.xgafv": {
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
"type": "string"
},
"alt": {
"enum": [
"json",
"media",
"proto"
],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"description": "Data format for response.",
"default": "json"
},
"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.",
"type": "string",
"location": "query"
},
"access_token": {
"location": "query",
"description": "OAuth access token.",
"type": "string"
},
"quotaUser": {
"location": "query",
"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.",
"type": "string"
},
"pp": {
"location": "query",
"description": "Pretty-print response.",
"default": "true",
"type": "boolean"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
"bearer_token": {
"location": "query",
"description": "OAuth bearer token.",
"type": "string"
}
},
"version": "v1",
"baseUrl": "https://cloudkms.googleapis.com/",
"servicePath": "",
"description": "Manages encryption for your cloud services the same way you do on-premises. You can generate, use, rotate, and destroy AES256 encryption keys.",
"kind": "discovery#restDescription",
"basePath": "",
"id": "cloudkms:v1",
"documentationLink": "https://cloud.google.com/kms/",
"revision": "20170725",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
"SetIamPolicyRequest": {
"properties": {
"updateMask": {
"format": "google-fieldmask",
"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.",
"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."
}
},
"id": "SetIamPolicyRequest",
"description": "Request message for `SetIamPolicy` method.",
"type": "object"
},
"DecryptRequest": {
"description": "Request message for KeyManagementService.Decrypt.",
"type": "object",
"properties": {
"additionalAuthenticatedData": {
"format": "byte",
"description": "Optional data that must match the data originally supplied in\nEncryptRequest.additional_authenticated_data.",
"type": "string"
},
"ciphertext": {
"format": "byte",
"description": "Required. The encrypted data originally returned in\nEncryptResponse.ciphertext.",
"type": "string"
}
},
"id": "DecryptRequest"
},
"Location": {
"properties": {
"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"
},
"name": {
"description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
"type": "string"
}
},
"id": "Location",
"description": "A resource that represents Google Cloud Platform location.",
"type": "object"
},
"ListCryptoKeysResponse": {
"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"
},
"totalSize": {
"format": "int32",
"description": "The total number of CryptoKeys that matched the query.",
"type": "integer"
},
"cryptoKeys": {
"description": "The list of CryptoKeys.",
"items": {
"$ref": "CryptoKey"
},
"type": "array"
}
},
"id": "ListCryptoKeysResponse"
},
"Condition": {
"description": "A condition to be met.",
"type": "object",
"properties": {
"iam": {
"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).",
"What types of justifications have been supplied with this request.\nString values should match enum names from tech.iam.JustificationType,\ne.g. \"MANUAL_STRING\". It is not permitted to grant access based on\nthe *absence* of a justification, so justification conditions can only\nbe used in a \"positive\" context (e.g., ALLOW/IN or DENY/NOT_IN).\n\nMultiple justifications, e.g., a Buganizer ID and a manually-entered\nreason, are normal and supported."
],
"enum": [
"NO_ATTR",
"AUTHORITY",
"ATTRIBUTION",
"APPROVER",
"JUSTIFICATION_TYPE"
],
"description": "Trusted attributes supplied by the IAM system.",
"type": "string"
},
"values": {
"description": "The objects of the condition. This is mutually exclusive with 'value'.",
"items": {
"type": "string"
},
"type": "array"
},
"op": {
"enumDescriptions": [
"Default no-op.",
"DEPRECATED. Use IN instead.",
"DEPRECATED. Use NOT_IN instead.",
"The condition is true if the subject (or any element of it if it is\na set) matches any of the supplied values.",
"The condition is true if the subject (or every element of it if it is\na set) matches none of the supplied values.",
"Subject is discharged"
],
"enum": [
"NO_OP",
"EQUALS",
"NOT_EQUALS",
"IN",
"NOT_IN",
"DISCHARGED"
],
"description": "An operator to apply the subject with.",
"type": "string"
},
"svc": {
"description": "Trusted attributes discharged by the service.",
"type": "string"
},
"sys": {
"enum": [
"NO_ATTR",
"REGION",
"SERVICE",
"NAME",
"IP"
],
"description": "Trusted attributes supplied by any service that owns resources and uses\nthe IAM system for access control.",
"type": "string",
"enumDescriptions": [
"Default non-attribute type",
"Region of the resource",
"Service name",
"Resource name",
"IP address of the caller"
]
},
"value": {
"description": "DEPRECATED. Use 'values' instead.",
"type": "string"
}
},
"id": "Condition"
},
"CounterOptions": {
"properties": {
"field": {
"description": "The field value to attribute.",
"type": "string"
},
"metric": {
"description": "The metric to update.",
"type": "string"
}
},
"id": "CounterOptions",
"description": "Options for counters",
"type": "object"
},
"AuditLogConfig": {
"properties": {
"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"
},
"logType": {
"enum": [
"LOG_TYPE_UNSPECIFIED",
"ADMIN_READ",
"DATA_WRITE",
"DATA_READ"
],
"description": "The log type that this config enables.",
"type": "string",
"enumDescriptions": [
"Default case. Should never be this.",
"Admin reads. Example: CloudIAM getIamPolicy",
"Data writes. Example: CloudSQL Users create",
"Data reads. Example: CloudSQL Users list"
]
}
},
"id": "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"
},
"DecryptResponse": {
"description": "Response message for KeyManagementService.Decrypt.",
"type": "object",
"properties": {
"plaintext": {
"format": "byte",
"description": "The decrypted data originally supplied in EncryptRequest.plaintext.",
"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).",
"items": {
"type": "string"
},
"type": "array"
}
},
"id": "TestIamPermissionsRequest"
},
"EncryptResponse": {
"properties": {
"ciphertext": {
"format": "byte",
"description": "The encrypted data.",
"type": "string"
},
"name": {
"description": "The resource name of the CryptoKeyVersion used in encryption.",
"type": "string"
}
},
"id": "EncryptResponse",
"description": "Response message for KeyManagementService.Encrypt.",
"type": "object"
},
"KeyRing": {
"description": "A KeyRing is a toplevel logical grouping of CryptoKeys.",
"type": "object",
"properties": {
"createTime": {
"format": "google-datetime",
"description": "Output only. The time at which this KeyRing was created.",
"type": "string"
},
"name": {
"description": "Output only. The resource name for the KeyRing in the format\n`projects/*/locations/*/keyRings/*`.",
"type": "string"
}
},
"id": "KeyRing"
},
"ListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
"type": "object",
"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": {
"$ref": "Location"
},
"type": "array"
}
},
"id": "ListLocationsResponse"
},
"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).",
"type": "object",
"properties": {
"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"
},
"version": {
"format": "int32",
"description": "Version of the `Policy`. The default version is 0.",
"type": "integer"
},
"auditConfigs": {
"description": "Specifies cloud audit logging configuration for this policy.",
"items": {
"$ref": "AuditConfig"
},
"type": "array"
},
"bindings": {
"description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
"items": {
"$ref": "Binding"
},
"type": "array"
},
"etag": {
"format": "byte",
"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.",
"type": "string"
}
},
"id": "Policy"
},
"RestoreCryptoKeyVersionRequest": {
"properties": {},
"id": "RestoreCryptoKeyVersionRequest",
"description": "Request message for KeyManagementService.RestoreCryptoKeyVersion.",
"type": "object"
},
"UpdateCryptoKeyPrimaryVersionRequest": {
"properties": {
"cryptoKeyVersionId": {
"description": "The id of the child CryptoKeyVersion to use as primary.",
"type": "string"
}
},
"id": "UpdateCryptoKeyPrimaryVersionRequest",
"description": "Request message for KeyManagementService.UpdateCryptoKeyPrimaryVersion.",
"type": "object"
},
"ListKeyRingsResponse": {
"description": "Response message for KeyManagementService.ListKeyRings.",
"type": "object",
"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.",
"type": "string"
},
"totalSize": {
"format": "int32",
"description": "The total number of KeyRings that matched the query.",
"type": "integer"
},
"keyRings": {
"description": "The list of KeyRings.",
"items": {
"$ref": "KeyRing"
},
"type": "array"
}
},
"id": "ListKeyRingsResponse"
},
"DataAccessOptions": {
"description": "Write a Data Access (Gin) log",
"type": "object",
"properties": {},
"id": "DataAccessOptions"
},
"AuditConfig": {
"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": {
"exemptedMembers": {
"items": {
"type": "string"
},
"type": "array"
},
"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.",
"type": "string"
},
"auditLogConfigs": {
"description": "The configuration for logging of each type of permission.\nNext ID: 4",
"items": {
"$ref": "AuditLogConfig"
},
"type": "array"
}
},
"id": "AuditConfig"
},
"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.",
"type": "object",
"properties": {
"destroyEventTime": {
"format": "google-datetime",
"description": "Output only. The time this CryptoKeyVersion's key material was\ndestroyed. Only present if state is\nDESTROYED.",
"type": "string"
},
"destroyTime": {
"format": "google-datetime",
"description": "Output only. The time this CryptoKeyVersion's key material is scheduled\nfor destruction. Only present if state is\nDESTROY_SCHEDULED.",
"type": "string"
},
"createTime": {
"format": "google-datetime",
"description": "Output only. The time at which this CryptoKeyVersion was created.",
"type": "string"
},
"state": {
"description": "The current state of the CryptoKeyVersion.",
"type": "string",
"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"
]
},
"name": {
"description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
"type": "string"
}
},
"id": "CryptoKeyVersion"
},
"CloudAuditOptions": {
"description": "Write a Cloud Audit log",
"type": "object",
"properties": {
"logName": {
"enumDescriptions": [
"Default. Should not be used.",
"Corresponds to \"cloudaudit.googleapis.com/activity\"",
"Corresponds to \"cloudaudit.googleapis.com/data_access\""
],
"enum": [
"UNSPECIFIED_LOG_NAME",
"ADMIN_ACTIVITY",
"DATA_ACCESS"
],
"description": "The log_name to populate in the Cloud Audit Record.",
"type": "string"
}
},
"id": "CloudAuditOptions"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"type": "object",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently.\nThis field is GOOGLE_INTERNAL."
},
"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",
"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"
}
},
"id": "Binding"
},
"Expr": {
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
"type": "object",
"properties": {
"location": {
"description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
"type": "string"
},
"title": {
"description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
"type": "string"
},
"description": {
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
"type": "string"
},
"expression": {
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
"type": "string"
}
},
"id": "Expr"
},
"EncryptRequest": {
"description": "Request message for KeyManagementService.Encrypt.",
"type": "object",
"properties": {
"additionalAuthenticatedData": {
"format": "byte",
"description": "Optional data that, if specified, must also be provided during decryption\nthrough DecryptRequest.additional_authenticated_data. Must be no\nlarger than 64KiB.",
"type": "string"
},
"plaintext": {
"format": "byte",
"description": "Required. The data to encrypt. Must be no larger than 64KiB.",
"type": "string"
}
},
"id": "EncryptRequest"
},
"ListCryptoKeyVersionsResponse": {
"description": "Response message for KeyManagementService.ListCryptoKeyVersions.",
"type": "object",
"properties": {
"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": {
"format": "int32",
"description": "The total number of CryptoKeyVersions that matched the\nquery.",
"type": "integer"
},
"cryptoKeyVersions": {
"description": "The list of CryptoKeyVersions.",
"items": {
"$ref": "CryptoKeyVersion"
},
"type": "array"
}
},
"id": "ListCryptoKeyVersionsResponse"
},
"TestIamPermissionsResponse": {
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
"items": {
"type": "string"
},
"type": "array"
}
},
"id": "TestIamPermissionsResponse",
"description": "Response message for `TestIamPermissions` method.",
"type": "object"
},
"DestroyCryptoKeyVersionRequest": {
"properties": {},
"id": "DestroyCryptoKeyVersionRequest",
"description": "Request message for KeyManagementService.DestroyCryptoKeyVersion.",
"type": "object"
},
"Rule": {
"description": "A rule to be applied in a Policy.",
"type": "object",
"properties": {
"description": {
"description": "Human-readable description of the rule.",
"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"
},
"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": "A permission is a string of form '\u003cservice\u003e.\u003cresource type\u003e.\u003cverb\u003e'\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"
},
"action": {
"description": "Required",
"type": "string",
"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."
],
"enum": [
"NO_ACTION",
"ALLOW",
"ALLOW_WITH_LOG",
"DENY",
"DENY_WITH_LOG",
"LOG"
]
},
"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": {
"type": "string"
},
"type": "array"
}
},
"id": "Rule"
},
"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.",
"type": "object",
"properties": {
"createTime": {
"format": "google-datetime",
"description": "Output only. The time at which this CryptoKey was created.",
"type": "string"
},
"rotationPeriod": {
"format": "google-duration",
"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.",
"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": {
"enum": [
"CRYPTO_KEY_PURPOSE_UNSPECIFIED",
"ENCRYPT_DECRYPT"
],
"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."
]
},
"nextRotationTime": {
"format": "google-datetime",
"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.",
"type": "string"
}
},
"id": "CryptoKey"
},
"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 ==\u003e 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",
"type": "object",
"properties": {
"counter": {
"description": "Counter options.",
"$ref": "CounterOptions"
},
"dataAccess": {
"$ref": "DataAccessOptions",
"description": "Data access options."
},
"cloudAudit": {
"description": "Cloud audit options.",
"$ref": "CloudAuditOptions"
}
},
"id": "LogConfig"
}
},
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"protocol": "rest",
"canonicalName": "Cloud KMS",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"rootUrl": "https://cloudkms.googleapis.com/",
"ownerDomain": "google.com",
"name": "cloudkms"
}
Copy permalink