docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/containeranalysis_v1alpha1.projects.notes.html b/docs/dyn/containeranalysis_v1alpha1.projects.notes.html
index 79badc2..f5e84b1 100644
--- a/docs/dyn/containeranalysis_v1alpha1.projects.notes.html
+++ b/docs/dyn/containeranalysis_v1alpha1.projects.notes.html
@@ -92,7 +92,7 @@
<code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the access control policy for a note or an `Occurrence` resource.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, name=None, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p>
+ <code><a href="#list">list(parent, filter=None, name=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all `Notes` for a given project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -113,17 +113,57 @@
Args:
parent: string, This field contains the project Id for example:
-"projects/{project_id} (required)
+"projects/{project_id} (required)
body: object, The request body.
The object takes the form of:
{ # Provides a detailed description of a `Note`.
- "buildType": { # Note holding the version of the provider's builder and the signature of # Build provenance type for a verifiable build.
+ "relatedUrl": [ # URLs associated with this note
+ { # Metadata for any related URL information
+ "url": "A String", # Specific URL to associate with the note
+ "label": "A String", # Label to describe usage of the URL
+ },
+ ],
+ "expirationTime": "A String", # Time of expiration for this note, null if note does not expire.
+ "baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
+ # relationship. Linked occurrences are derived from this or an
+ # equivalent image via:
+ # FROM <Basis.resource_url>
+ # Or an equivalent reference, e.g. a tag of the resource_url.
+ "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image.
+ "v2Blob": [ # The ordered list of v2 blobs that represent a given image.
+ "A String",
+ ],
+ "v1Name": "A String", # The layer-id of the final layer in the Docker image's v1
+ # representation.
+ # This field can be used as a filter in list requests.
+ "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
+ # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
+ # Only the name of the final blob is kept.
+ # This field can be used as a filter in list requests.
+ },
+ "resourceUrl": "A String", # The resource_url for the resource representing the basis of
+ # associated occurrence images.
+ },
+ "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This
+ # field can be used as a filter in list requests.
+ "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
+ "resourceUri": [ # Resource URI for the artifact being deployed.
+ "A String",
+ ],
+ },
+ "buildType": { # Note holding the version of the provider's builder and the signature of # Build provenance type for a verifiable build.
# the provenance message in linked BuildDetails.
- "builderVersion": "A String", # Version of the builder which produced this Note.
- "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this
+ "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this
# `BuilderDetails`.
- "publicKey": "A String", # Public key of the builder which can be used to verify that the related
+ "keyId": "A String", # An Id for the key used to sign. This could be either an Id for the key
+ # stored in `public_key` (such as the Id or fingerprint for a PGP key, or the
+ # CN for a cert), or a reference to an external key (such as a reference to a
+ # key in Cloud Key Management Service).
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
+ # `key_id`
+ "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string.
+ "publicKey": "A String", # Public key of the builder which can be used to verify that the related
# findings are valid and unchanged. If `key_type` is empty, this defaults
# to PEM encoded public keys.
#
@@ -136,209 +176,169 @@
# from `BuildDetails` are base64-decoded into a binary representation in
# signed.bin. OpenSSL can then verify the signature:
# `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
- # `key_id`
- "keyId": "A String", # An Id for the key used to sign. This could be either an Id for the key
- # stored in `public_key` (such as the Id or fingerprint for a PGP key, or the
- # CN for a cert), or a reference to an external key (such as a reference to a
- # key in Cloud Key Management Service).
- "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string.
+ },
+ "builderVersion": "A String", # Version of the builder which produced this Note.
+ },
+ "longDescription": "A String", # A detailed description of this `Note`.
+ "shortDescription": "A String", # A one sentence description of this `Note`.
+ "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For # A note describing an attestation role.
+ # example, an organization might have one `AttestationAuthority` for "QA" and
+ # one for "build". This Note is intended to act strictly as a grouping
+ # mechanism for the attached Occurrences (Attestations). This grouping
+ # mechanism also provides a security boundary, since IAM ACLs gate the ability
+ # for a principle to attach an Occurrence to a given Note. It also provides a
+ # single point of lookup to find all attached Attestation Occurrences, even if
+ # they don't all live in the same project.
+ "hint": { # This submessage provides human-readable hints about the purpose of the
+ # AttestationAuthority. Because the name of a Note acts as its resource
+ # reference, it is important to disambiguate the canonical name of the Note
+ # (which might be a UUID for security purposes) from "readable" names more
+ # suitable for debug output. Note that these hints should NOT be used to
+ # look up AttestationAuthorities in security sensitive contexts, such as when
+ # looking up Attestations to verify.
+ "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa".
},
},
- "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This
- # field can be used as a filter in list requests.
- "upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given # A note describing an upgrade.
- # version. For each package version combination (i.e. bash 4.0, bash 4.1,
- # bash 4.1.2), there will be a Upgrade Note.
- "version": { # Version contains structured information about the version of the package. # Required - The version of the package in machine + human readable form.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "distributions": [ # Metadata about the upgrade for each specific operating system.
- { # The Upgrade Distribution represents metadata about the Upgrade for each
- # operating system (CPE). Some distributions have additional metadata around
- # updates, classifying them into various categories and severities.
- "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
- # https://cpe.mitre.org/specification/.
- "cve": [ # The cve that would be resolved by this upgrade.
- "A String",
- ],
- "severity": "A String", # The severity as specified by the upstream operating system.
- "classification": "A String", # The operating system classification of this Upgrade, as specified by the
- # upstream operating system upgrade feed.
- },
- ],
- "package": "A String", # Required - The package this Upgrade is for.
- },
- "name": "A String", # The name of the note in the form
- # "projects/{provider_project_id}/notes/{NOTE_ID}"
- "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
- "cvssScore": 3.14, # The CVSS score for this Vulnerability.
- "severity": "A String", # Note provider assigned impact of the vulnerability
- "details": [ # All information about the package to specifically identify this
+ "name": "A String", # The name of the note in the form
+ # "projects/{provider_project_id}/notes/{NOTE_ID}"
+ "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
+ "cvssScore": 3.14, # The CVSS score for this Vulnerability.
+ "severity": "A String", # Note provider assigned impact of the vulnerability
+ "details": [ # All information about the package to specifically identify this
# vulnerability. One entry per (version range and cpe_uri) the
# package vulnerability has manifested in.
{ # Identifies all occurrences of this vulnerability in the package for a
# specific distro/location
# For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in
- # which the vulnerability manifests. Examples include distro or storage
- # location for vulnerable jar.
- # This field can be used as a filter in list requests.
- "description": "A String", # A vendor-specific description of this note.
- "minAffectedVersion": { # Version contains structured information about the version of the package. # The min version of the package in which the vulnerability exists.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "package": "A String", # The name of the package where the vulnerability was found.
- # This field can be used as a filter in list requests.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems,
- # node.js packages etc)
- "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to
+ "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to
# obsolete details.
- "maxAffectedVersion": { # Version contains structured information about the version of the package. # The max version of the package in which the vulnerability exists.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "fixedLocation": { # The location of the vulnerability # The fix for this specific package version.
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
+ "fixedLocation": { # The location of the vulnerability # The fix for this specific package version.
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
# format. Examples include distro or storage location for vulnerable jar.
# This field can be used as a filter in list requests.
- "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
+ "package": "A String", # The package being described.
+ "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
# filter in list requests.
# For a discussion of this in Debian/Ubuntu:
# http://serverfault.com/questions/604541/debian-packages-version-convention
# For a discussion of this in Redhat/Fedora/Centos:
# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
# If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
},
- "package": "A String", # The package being described.
+ },
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems,
+ # node.js packages etc)
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in
+ # which the vulnerability manifests. Examples include distro or storage
+ # location for vulnerable jar.
+ # This field can be used as a filter in list requests.
+ "description": "A String", # A vendor-specific description of this note.
+ "minAffectedVersion": { # Version contains structured information about the version of the package. # The min version of the package in which the vulnerability exists.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
+ "package": "A String", # The name of the package where the vulnerability was found.
+ # This field can be used as a filter in list requests.
+ "maxAffectedVersion": { # Version contains structured information about the version of the package. # The max version of the package in which the vulnerability exists.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
},
},
],
},
- "package": { # This represents a particular package that is distributed over # A note describing a package hosted by various package managers.
+ "upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given # A note describing an upgrade.
+ # version. For each package version combination (i.e. bash 4.0, bash 4.1,
+ # bash 4.1.2), there will be a Upgrade Note.
+ "package": "A String", # Required - The package this Upgrade is for.
+ "version": { # Version contains structured information about the version of the package. # Required - The version of the package in machine + human readable form.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "distributions": [ # Metadata about the upgrade for each specific operating system.
+ { # The Upgrade Distribution represents metadata about the Upgrade for each
+ # operating system (CPE). Some distributions have additional metadata around
+ # updates, classifying them into various categories and severities.
+ "cve": [ # The cve that would be resolved by this upgrade.
+ "A String",
+ ],
+ "classification": "A String", # The operating system classification of this Upgrade, as specified by the
+ # upstream operating system upgrade feed.
+ "severity": "A String", # The severity as specified by the upstream operating system.
+ "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
+ # https://cpe.mitre.org/specification/.
+ },
+ ],
+ },
+ "package": { # This represents a particular package that is distributed over # A note describing a package hosted by various package managers.
# various channels.
# e.g. glibc (aka libc6) is distributed by many, at various versions.
- "distribution": [ # The various channels by which a package is distributed.
+ "name": "A String", # The name of the package.
+ "distribution": [ # The various channels by which a package is distributed.
{ # This represents a particular channel of distribution for a given package.
- # e.g. Debian's jessie-backports dpkg mirror
- "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)
- # denoting the package manager version distributing a package.
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
- "description": "A String", # The distribution channel-specific description of this package.
- "url": "A String", # The distribution channel-specific homepage for this package.
- "architecture": "A String", # The CPU architecture for which packages in this distribution
- # channel were built
- "latestVersion": { # Version contains structured information about the version of the package. # The latest available version of this package in
+ # e.g. Debian's jessie-backports dpkg mirror
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
+ "latestVersion": { # Version contains structured information about the version of the package. # The latest available version of this package in
# this distribution channel.
# For a discussion of this in Debian/Ubuntu:
# http://serverfault.com/questions/604541/debian-packages-version-convention
# For a discussion of this in Redhat/Fedora/Centos:
# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
# If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
},
+ "description": "A String", # The distribution channel-specific description of this package.
+ "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)
+ # denoting the package manager version distributing a package.
+ "url": "A String", # The distribution channel-specific homepage for this package.
+ "architecture": "A String", # The CPU architecture for which packages in this distribution
+ # channel were built
},
],
- "name": "A String", # The name of the package.
},
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
- # a filter in list requests.
- "relatedUrl": [ # URLs associated with this note
- { # Metadata for any related URL information
- "url": "A String", # Specific URL to associate with the note
- "label": "A String", # Label to describe usage of the URL
- },
- ],
- "longDescription": "A String", # A detailed description of this `Note`.
- "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For # A note describing an attestation role.
- # example, an organization might have one `AttestationAuthority` for "QA" and
- # one for "build". This Note is intended to act strictly as a grouping
- # mechanism for the attached Occurrences (Attestations). This grouping
- # mechanism also provides a security boundary, since IAM ACLs gate the ability
- # for a principle to attach an Occurrence to a given Note. It also provides a
- # single point of lookup to find all attached Attestation Occurrences, even if
- # they don't all live in the same project.
- "hint": { # This submessage provides human-readable hints about the purpose of the
- # AttestationAuthority. Because the name of a Note acts as its resource
- # reference, it is important to disambiguate the canonical name of the Note
- # (which might be a UUID for security purposes) from "readable" names more
- # suitable for debug output. Note that these hints should NOT be used to
- # look up AttestationAuthorities in security sensitive contexts, such as when
- # looking up Attestations to verify.
- "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa".
- },
- },
- "baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
- # relationship. Linked occurrences are derived from this or an
- # equivalent image via:
- # FROM <Basis.resource_url>
- # Or an equivalent reference, e.g. a tag of the resource_url.
- "resourceUrl": "A String", # The resource_url for the resource representing the basis of
- # associated occurrence images.
- "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image.
- "v1Name": "A String", # The layer-id of the final layer in the Docker image's v1
- # representation.
- # This field can be used as a filter in list requests.
- "v2Blob": [ # The ordered list of v2 blobs that represent a given image.
- "A String",
- ],
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
- # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
- # Only the name of the final blob is kept.
- # This field can be used as a filter in list requests.
- },
- },
- "expirationTime": "A String", # Time of expiration for this note, null if note does not expire.
- "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
- "resourceUri": [ # Resource URI for the artifact being deployed.
- "A String",
- ],
- },
- "shortDescription": "A String", # A one sentence description of this `Note`.
- "createTime": "A String", # Output only. The time this note was created. This field can be used as a
+ "createTime": "A String", # Output only. The time this note was created. This field can be used as a
# filter in list requests.
- "discovery": { # A note that indicates a type of analysis a provider would perform. This note # A note describing a provider/analysis type.
- # exists in a provider's project. A `Discovery` occurrence is created in a
- # consumer's project at the start of analysis. The occurrence's operation will
+ "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
+ # a filter in list requests.
+ "discovery": { # A note that indicates a type of analysis a provider would perform. This note # A note describing a provider/analysis type.
+ # exists in a provider's project. A `Discovery` occurrence is created in a
+ # consumer's project at the start of analysis. The occurrence's operation will
# indicate the status of the analysis. Absence of an occurrence linked to this
- # note for a resource indicates that analysis hasn't started.
- "analysisKind": "A String", # The kind of analysis that is handled by this discovery.
+ # note for a resource indicates that analysis hasn't started.
+ "analysisKind": "A String", # The kind of analysis that is handled by this discovery.
},
}
name: string, The name of the project.
-Should be of the form "providers/{provider_id}".
+Should be of the form "providers/{provider_id}".
@Deprecated
noteId: string, The ID to use for this note.
x__xgafv: string, V1 error format.
@@ -350,12 +350,52 @@
An object of the form:
{ # Provides a detailed description of a `Note`.
- "buildType": { # Note holding the version of the provider's builder and the signature of # Build provenance type for a verifiable build.
+ "relatedUrl": [ # URLs associated with this note
+ { # Metadata for any related URL information
+ "url": "A String", # Specific URL to associate with the note
+ "label": "A String", # Label to describe usage of the URL
+ },
+ ],
+ "expirationTime": "A String", # Time of expiration for this note, null if note does not expire.
+ "baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
+ # relationship. Linked occurrences are derived from this or an
+ # equivalent image via:
+ # FROM <Basis.resource_url>
+ # Or an equivalent reference, e.g. a tag of the resource_url.
+ "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image.
+ "v2Blob": [ # The ordered list of v2 blobs that represent a given image.
+ "A String",
+ ],
+ "v1Name": "A String", # The layer-id of the final layer in the Docker image's v1
+ # representation.
+ # This field can be used as a filter in list requests.
+ "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
+ # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
+ # Only the name of the final blob is kept.
+ # This field can be used as a filter in list requests.
+ },
+ "resourceUrl": "A String", # The resource_url for the resource representing the basis of
+ # associated occurrence images.
+ },
+ "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This
+ # field can be used as a filter in list requests.
+ "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
+ "resourceUri": [ # Resource URI for the artifact being deployed.
+ "A String",
+ ],
+ },
+ "buildType": { # Note holding the version of the provider's builder and the signature of # Build provenance type for a verifiable build.
# the provenance message in linked BuildDetails.
- "builderVersion": "A String", # Version of the builder which produced this Note.
- "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this
+ "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this
# `BuilderDetails`.
- "publicKey": "A String", # Public key of the builder which can be used to verify that the related
+ "keyId": "A String", # An Id for the key used to sign. This could be either an Id for the key
+ # stored in `public_key` (such as the Id or fingerprint for a PGP key, or the
+ # CN for a cert), or a reference to an external key (such as a reference to a
+ # key in Cloud Key Management Service).
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
+ # `key_id`
+ "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string.
+ "publicKey": "A String", # Public key of the builder which can be used to verify that the related
# findings are valid and unchanged. If `key_type` is empty, this defaults
# to PEM encoded public keys.
#
@@ -368,204 +408,164 @@
# from `BuildDetails` are base64-decoded into a binary representation in
# signed.bin. OpenSSL can then verify the signature:
# `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
- # `key_id`
- "keyId": "A String", # An Id for the key used to sign. This could be either an Id for the key
- # stored in `public_key` (such as the Id or fingerprint for a PGP key, or the
- # CN for a cert), or a reference to an external key (such as a reference to a
- # key in Cloud Key Management Service).
- "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string.
+ },
+ "builderVersion": "A String", # Version of the builder which produced this Note.
+ },
+ "longDescription": "A String", # A detailed description of this `Note`.
+ "shortDescription": "A String", # A one sentence description of this `Note`.
+ "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For # A note describing an attestation role.
+ # example, an organization might have one `AttestationAuthority` for "QA" and
+ # one for "build". This Note is intended to act strictly as a grouping
+ # mechanism for the attached Occurrences (Attestations). This grouping
+ # mechanism also provides a security boundary, since IAM ACLs gate the ability
+ # for a principle to attach an Occurrence to a given Note. It also provides a
+ # single point of lookup to find all attached Attestation Occurrences, even if
+ # they don't all live in the same project.
+ "hint": { # This submessage provides human-readable hints about the purpose of the
+ # AttestationAuthority. Because the name of a Note acts as its resource
+ # reference, it is important to disambiguate the canonical name of the Note
+ # (which might be a UUID for security purposes) from "readable" names more
+ # suitable for debug output. Note that these hints should NOT be used to
+ # look up AttestationAuthorities in security sensitive contexts, such as when
+ # looking up Attestations to verify.
+ "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa".
},
},
- "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This
- # field can be used as a filter in list requests.
- "upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given # A note describing an upgrade.
- # version. For each package version combination (i.e. bash 4.0, bash 4.1,
- # bash 4.1.2), there will be a Upgrade Note.
- "version": { # Version contains structured information about the version of the package. # Required - The version of the package in machine + human readable form.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "distributions": [ # Metadata about the upgrade for each specific operating system.
- { # The Upgrade Distribution represents metadata about the Upgrade for each
- # operating system (CPE). Some distributions have additional metadata around
- # updates, classifying them into various categories and severities.
- "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
- # https://cpe.mitre.org/specification/.
- "cve": [ # The cve that would be resolved by this upgrade.
- "A String",
- ],
- "severity": "A String", # The severity as specified by the upstream operating system.
- "classification": "A String", # The operating system classification of this Upgrade, as specified by the
- # upstream operating system upgrade feed.
- },
- ],
- "package": "A String", # Required - The package this Upgrade is for.
- },
- "name": "A String", # The name of the note in the form
- # "projects/{provider_project_id}/notes/{NOTE_ID}"
- "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
- "cvssScore": 3.14, # The CVSS score for this Vulnerability.
- "severity": "A String", # Note provider assigned impact of the vulnerability
- "details": [ # All information about the package to specifically identify this
+ "name": "A String", # The name of the note in the form
+ # "projects/{provider_project_id}/notes/{NOTE_ID}"
+ "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
+ "cvssScore": 3.14, # The CVSS score for this Vulnerability.
+ "severity": "A String", # Note provider assigned impact of the vulnerability
+ "details": [ # All information about the package to specifically identify this
# vulnerability. One entry per (version range and cpe_uri) the
# package vulnerability has manifested in.
{ # Identifies all occurrences of this vulnerability in the package for a
# specific distro/location
# For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in
- # which the vulnerability manifests. Examples include distro or storage
- # location for vulnerable jar.
- # This field can be used as a filter in list requests.
- "description": "A String", # A vendor-specific description of this note.
- "minAffectedVersion": { # Version contains structured information about the version of the package. # The min version of the package in which the vulnerability exists.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "package": "A String", # The name of the package where the vulnerability was found.
- # This field can be used as a filter in list requests.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems,
- # node.js packages etc)
- "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to
+ "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to
# obsolete details.
- "maxAffectedVersion": { # Version contains structured information about the version of the package. # The max version of the package in which the vulnerability exists.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "fixedLocation": { # The location of the vulnerability # The fix for this specific package version.
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
+ "fixedLocation": { # The location of the vulnerability # The fix for this specific package version.
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
# format. Examples include distro or storage location for vulnerable jar.
# This field can be used as a filter in list requests.
- "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
+ "package": "A String", # The package being described.
+ "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
# filter in list requests.
# For a discussion of this in Debian/Ubuntu:
# http://serverfault.com/questions/604541/debian-packages-version-convention
# For a discussion of this in Redhat/Fedora/Centos:
# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
# If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
},
- "package": "A String", # The package being described.
+ },
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems,
+ # node.js packages etc)
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in
+ # which the vulnerability manifests. Examples include distro or storage
+ # location for vulnerable jar.
+ # This field can be used as a filter in list requests.
+ "description": "A String", # A vendor-specific description of this note.
+ "minAffectedVersion": { # Version contains structured information about the version of the package. # The min version of the package in which the vulnerability exists.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
+ "package": "A String", # The name of the package where the vulnerability was found.
+ # This field can be used as a filter in list requests.
+ "maxAffectedVersion": { # Version contains structured information about the version of the package. # The max version of the package in which the vulnerability exists.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
},
},
],
},
- "package": { # This represents a particular package that is distributed over # A note describing a package hosted by various package managers.
+ "upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given # A note describing an upgrade.
+ # version. For each package version combination (i.e. bash 4.0, bash 4.1,
+ # bash 4.1.2), there will be a Upgrade Note.
+ "package": "A String", # Required - The package this Upgrade is for.
+ "version": { # Version contains structured information about the version of the package. # Required - The version of the package in machine + human readable form.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "distributions": [ # Metadata about the upgrade for each specific operating system.
+ { # The Upgrade Distribution represents metadata about the Upgrade for each
+ # operating system (CPE). Some distributions have additional metadata around
+ # updates, classifying them into various categories and severities.
+ "cve": [ # The cve that would be resolved by this upgrade.
+ "A String",
+ ],
+ "classification": "A String", # The operating system classification of this Upgrade, as specified by the
+ # upstream operating system upgrade feed.
+ "severity": "A String", # The severity as specified by the upstream operating system.
+ "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
+ # https://cpe.mitre.org/specification/.
+ },
+ ],
+ },
+ "package": { # This represents a particular package that is distributed over # A note describing a package hosted by various package managers.
# various channels.
# e.g. glibc (aka libc6) is distributed by many, at various versions.
- "distribution": [ # The various channels by which a package is distributed.
+ "name": "A String", # The name of the package.
+ "distribution": [ # The various channels by which a package is distributed.
{ # This represents a particular channel of distribution for a given package.
- # e.g. Debian's jessie-backports dpkg mirror
- "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)
- # denoting the package manager version distributing a package.
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
- "description": "A String", # The distribution channel-specific description of this package.
- "url": "A String", # The distribution channel-specific homepage for this package.
- "architecture": "A String", # The CPU architecture for which packages in this distribution
- # channel were built
- "latestVersion": { # Version contains structured information about the version of the package. # The latest available version of this package in
+ # e.g. Debian's jessie-backports dpkg mirror
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
+ "latestVersion": { # Version contains structured information about the version of the package. # The latest available version of this package in
# this distribution channel.
# For a discussion of this in Debian/Ubuntu:
# http://serverfault.com/questions/604541/debian-packages-version-convention
# For a discussion of this in Redhat/Fedora/Centos:
# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
# If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
},
+ "description": "A String", # The distribution channel-specific description of this package.
+ "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)
+ # denoting the package manager version distributing a package.
+ "url": "A String", # The distribution channel-specific homepage for this package.
+ "architecture": "A String", # The CPU architecture for which packages in this distribution
+ # channel were built
},
],
- "name": "A String", # The name of the package.
},
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
- # a filter in list requests.
- "relatedUrl": [ # URLs associated with this note
- { # Metadata for any related URL information
- "url": "A String", # Specific URL to associate with the note
- "label": "A String", # Label to describe usage of the URL
- },
- ],
- "longDescription": "A String", # A detailed description of this `Note`.
- "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For # A note describing an attestation role.
- # example, an organization might have one `AttestationAuthority` for "QA" and
- # one for "build". This Note is intended to act strictly as a grouping
- # mechanism for the attached Occurrences (Attestations). This grouping
- # mechanism also provides a security boundary, since IAM ACLs gate the ability
- # for a principle to attach an Occurrence to a given Note. It also provides a
- # single point of lookup to find all attached Attestation Occurrences, even if
- # they don't all live in the same project.
- "hint": { # This submessage provides human-readable hints about the purpose of the
- # AttestationAuthority. Because the name of a Note acts as its resource
- # reference, it is important to disambiguate the canonical name of the Note
- # (which might be a UUID for security purposes) from "readable" names more
- # suitable for debug output. Note that these hints should NOT be used to
- # look up AttestationAuthorities in security sensitive contexts, such as when
- # looking up Attestations to verify.
- "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa".
- },
- },
- "baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
- # relationship. Linked occurrences are derived from this or an
- # equivalent image via:
- # FROM <Basis.resource_url>
- # Or an equivalent reference, e.g. a tag of the resource_url.
- "resourceUrl": "A String", # The resource_url for the resource representing the basis of
- # associated occurrence images.
- "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image.
- "v1Name": "A String", # The layer-id of the final layer in the Docker image's v1
- # representation.
- # This field can be used as a filter in list requests.
- "v2Blob": [ # The ordered list of v2 blobs that represent a given image.
- "A String",
- ],
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
- # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
- # Only the name of the final blob is kept.
- # This field can be used as a filter in list requests.
- },
- },
- "expirationTime": "A String", # Time of expiration for this note, null if note does not expire.
- "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
- "resourceUri": [ # Resource URI for the artifact being deployed.
- "A String",
- ],
- },
- "shortDescription": "A String", # A one sentence description of this `Note`.
- "createTime": "A String", # Output only. The time this note was created. This field can be used as a
+ "createTime": "A String", # Output only. The time this note was created. This field can be used as a
# filter in list requests.
- "discovery": { # A note that indicates a type of analysis a provider would perform. This note # A note describing a provider/analysis type.
- # exists in a provider's project. A `Discovery` occurrence is created in a
- # consumer's project at the start of analysis. The occurrence's operation will
+ "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
+ # a filter in list requests.
+ "discovery": { # A note that indicates a type of analysis a provider would perform. This note # A note describing a provider/analysis type.
+ # exists in a provider's project. A `Discovery` occurrence is created in a
+ # consumer's project at the start of analysis. The occurrence's operation will
# indicate the status of the analysis. Absence of an occurrence linked to this
- # note for a resource indicates that analysis hasn't started.
- "analysisKind": "A String", # The kind of analysis that is handled by this discovery.
+ # note for a resource indicates that analysis hasn't started.
+ "analysisKind": "A String", # The kind of analysis that is handled by this discovery.
},
}</pre>
</div>
@@ -576,7 +576,7 @@
Args:
name: string, The name of the note in the form of
-"providers/{provider_id}/notes/{NOTE_ID}" (required)
+"providers/{provider_id}/notes/{NOTE_ID}" (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -603,7 +603,7 @@
Args:
name: string, The name of the note in the form of
-"providers/{provider_id}/notes/{NOTE_ID}" (required)
+"providers/{provider_id}/notes/{NOTE_ID}" (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -613,12 +613,52 @@
An object of the form:
{ # Provides a detailed description of a `Note`.
- "buildType": { # Note holding the version of the provider's builder and the signature of # Build provenance type for a verifiable build.
+ "relatedUrl": [ # URLs associated with this note
+ { # Metadata for any related URL information
+ "url": "A String", # Specific URL to associate with the note
+ "label": "A String", # Label to describe usage of the URL
+ },
+ ],
+ "expirationTime": "A String", # Time of expiration for this note, null if note does not expire.
+ "baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
+ # relationship. Linked occurrences are derived from this or an
+ # equivalent image via:
+ # FROM <Basis.resource_url>
+ # Or an equivalent reference, e.g. a tag of the resource_url.
+ "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image.
+ "v2Blob": [ # The ordered list of v2 blobs that represent a given image.
+ "A String",
+ ],
+ "v1Name": "A String", # The layer-id of the final layer in the Docker image's v1
+ # representation.
+ # This field can be used as a filter in list requests.
+ "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
+ # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
+ # Only the name of the final blob is kept.
+ # This field can be used as a filter in list requests.
+ },
+ "resourceUrl": "A String", # The resource_url for the resource representing the basis of
+ # associated occurrence images.
+ },
+ "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This
+ # field can be used as a filter in list requests.
+ "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
+ "resourceUri": [ # Resource URI for the artifact being deployed.
+ "A String",
+ ],
+ },
+ "buildType": { # Note holding the version of the provider's builder and the signature of # Build provenance type for a verifiable build.
# the provenance message in linked BuildDetails.
- "builderVersion": "A String", # Version of the builder which produced this Note.
- "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this
+ "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this
# `BuilderDetails`.
- "publicKey": "A String", # Public key of the builder which can be used to verify that the related
+ "keyId": "A String", # An Id for the key used to sign. This could be either an Id for the key
+ # stored in `public_key` (such as the Id or fingerprint for a PGP key, or the
+ # CN for a cert), or a reference to an external key (such as a reference to a
+ # key in Cloud Key Management Service).
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
+ # `key_id`
+ "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string.
+ "publicKey": "A String", # Public key of the builder which can be used to verify that the related
# findings are valid and unchanged. If `key_type` is empty, this defaults
# to PEM encoded public keys.
#
@@ -631,204 +671,164 @@
# from `BuildDetails` are base64-decoded into a binary representation in
# signed.bin. OpenSSL can then verify the signature:
# `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
- # `key_id`
- "keyId": "A String", # An Id for the key used to sign. This could be either an Id for the key
- # stored in `public_key` (such as the Id or fingerprint for a PGP key, or the
- # CN for a cert), or a reference to an external key (such as a reference to a
- # key in Cloud Key Management Service).
- "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string.
+ },
+ "builderVersion": "A String", # Version of the builder which produced this Note.
+ },
+ "longDescription": "A String", # A detailed description of this `Note`.
+ "shortDescription": "A String", # A one sentence description of this `Note`.
+ "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For # A note describing an attestation role.
+ # example, an organization might have one `AttestationAuthority` for "QA" and
+ # one for "build". This Note is intended to act strictly as a grouping
+ # mechanism for the attached Occurrences (Attestations). This grouping
+ # mechanism also provides a security boundary, since IAM ACLs gate the ability
+ # for a principle to attach an Occurrence to a given Note. It also provides a
+ # single point of lookup to find all attached Attestation Occurrences, even if
+ # they don't all live in the same project.
+ "hint": { # This submessage provides human-readable hints about the purpose of the
+ # AttestationAuthority. Because the name of a Note acts as its resource
+ # reference, it is important to disambiguate the canonical name of the Note
+ # (which might be a UUID for security purposes) from "readable" names more
+ # suitable for debug output. Note that these hints should NOT be used to
+ # look up AttestationAuthorities in security sensitive contexts, such as when
+ # looking up Attestations to verify.
+ "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa".
},
},
- "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This
- # field can be used as a filter in list requests.
- "upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given # A note describing an upgrade.
- # version. For each package version combination (i.e. bash 4.0, bash 4.1,
- # bash 4.1.2), there will be a Upgrade Note.
- "version": { # Version contains structured information about the version of the package. # Required - The version of the package in machine + human readable form.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "distributions": [ # Metadata about the upgrade for each specific operating system.
- { # The Upgrade Distribution represents metadata about the Upgrade for each
- # operating system (CPE). Some distributions have additional metadata around
- # updates, classifying them into various categories and severities.
- "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
- # https://cpe.mitre.org/specification/.
- "cve": [ # The cve that would be resolved by this upgrade.
- "A String",
- ],
- "severity": "A String", # The severity as specified by the upstream operating system.
- "classification": "A String", # The operating system classification of this Upgrade, as specified by the
- # upstream operating system upgrade feed.
- },
- ],
- "package": "A String", # Required - The package this Upgrade is for.
- },
- "name": "A String", # The name of the note in the form
- # "projects/{provider_project_id}/notes/{NOTE_ID}"
- "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
- "cvssScore": 3.14, # The CVSS score for this Vulnerability.
- "severity": "A String", # Note provider assigned impact of the vulnerability
- "details": [ # All information about the package to specifically identify this
+ "name": "A String", # The name of the note in the form
+ # "projects/{provider_project_id}/notes/{NOTE_ID}"
+ "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
+ "cvssScore": 3.14, # The CVSS score for this Vulnerability.
+ "severity": "A String", # Note provider assigned impact of the vulnerability
+ "details": [ # All information about the package to specifically identify this
# vulnerability. One entry per (version range and cpe_uri) the
# package vulnerability has manifested in.
{ # Identifies all occurrences of this vulnerability in the package for a
# specific distro/location
# For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in
- # which the vulnerability manifests. Examples include distro or storage
- # location for vulnerable jar.
- # This field can be used as a filter in list requests.
- "description": "A String", # A vendor-specific description of this note.
- "minAffectedVersion": { # Version contains structured information about the version of the package. # The min version of the package in which the vulnerability exists.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "package": "A String", # The name of the package where the vulnerability was found.
- # This field can be used as a filter in list requests.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems,
- # node.js packages etc)
- "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to
+ "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to
# obsolete details.
- "maxAffectedVersion": { # Version contains structured information about the version of the package. # The max version of the package in which the vulnerability exists.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "fixedLocation": { # The location of the vulnerability # The fix for this specific package version.
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
+ "fixedLocation": { # The location of the vulnerability # The fix for this specific package version.
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
# format. Examples include distro or storage location for vulnerable jar.
# This field can be used as a filter in list requests.
- "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
+ "package": "A String", # The package being described.
+ "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
# filter in list requests.
# For a discussion of this in Debian/Ubuntu:
# http://serverfault.com/questions/604541/debian-packages-version-convention
# For a discussion of this in Redhat/Fedora/Centos:
# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
# If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
},
- "package": "A String", # The package being described.
+ },
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems,
+ # node.js packages etc)
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in
+ # which the vulnerability manifests. Examples include distro or storage
+ # location for vulnerable jar.
+ # This field can be used as a filter in list requests.
+ "description": "A String", # A vendor-specific description of this note.
+ "minAffectedVersion": { # Version contains structured information about the version of the package. # The min version of the package in which the vulnerability exists.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
+ "package": "A String", # The name of the package where the vulnerability was found.
+ # This field can be used as a filter in list requests.
+ "maxAffectedVersion": { # Version contains structured information about the version of the package. # The max version of the package in which the vulnerability exists.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
},
},
],
},
- "package": { # This represents a particular package that is distributed over # A note describing a package hosted by various package managers.
+ "upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given # A note describing an upgrade.
+ # version. For each package version combination (i.e. bash 4.0, bash 4.1,
+ # bash 4.1.2), there will be a Upgrade Note.
+ "package": "A String", # Required - The package this Upgrade is for.
+ "version": { # Version contains structured information about the version of the package. # Required - The version of the package in machine + human readable form.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "distributions": [ # Metadata about the upgrade for each specific operating system.
+ { # The Upgrade Distribution represents metadata about the Upgrade for each
+ # operating system (CPE). Some distributions have additional metadata around
+ # updates, classifying them into various categories and severities.
+ "cve": [ # The cve that would be resolved by this upgrade.
+ "A String",
+ ],
+ "classification": "A String", # The operating system classification of this Upgrade, as specified by the
+ # upstream operating system upgrade feed.
+ "severity": "A String", # The severity as specified by the upstream operating system.
+ "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
+ # https://cpe.mitre.org/specification/.
+ },
+ ],
+ },
+ "package": { # This represents a particular package that is distributed over # A note describing a package hosted by various package managers.
# various channels.
# e.g. glibc (aka libc6) is distributed by many, at various versions.
- "distribution": [ # The various channels by which a package is distributed.
+ "name": "A String", # The name of the package.
+ "distribution": [ # The various channels by which a package is distributed.
{ # This represents a particular channel of distribution for a given package.
- # e.g. Debian's jessie-backports dpkg mirror
- "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)
- # denoting the package manager version distributing a package.
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
- "description": "A String", # The distribution channel-specific description of this package.
- "url": "A String", # The distribution channel-specific homepage for this package.
- "architecture": "A String", # The CPU architecture for which packages in this distribution
- # channel were built
- "latestVersion": { # Version contains structured information about the version of the package. # The latest available version of this package in
+ # e.g. Debian's jessie-backports dpkg mirror
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
+ "latestVersion": { # Version contains structured information about the version of the package. # The latest available version of this package in
# this distribution channel.
# For a discussion of this in Debian/Ubuntu:
# http://serverfault.com/questions/604541/debian-packages-version-convention
# For a discussion of this in Redhat/Fedora/Centos:
# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
# If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
},
+ "description": "A String", # The distribution channel-specific description of this package.
+ "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)
+ # denoting the package manager version distributing a package.
+ "url": "A String", # The distribution channel-specific homepage for this package.
+ "architecture": "A String", # The CPU architecture for which packages in this distribution
+ # channel were built
},
],
- "name": "A String", # The name of the package.
},
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
- # a filter in list requests.
- "relatedUrl": [ # URLs associated with this note
- { # Metadata for any related URL information
- "url": "A String", # Specific URL to associate with the note
- "label": "A String", # Label to describe usage of the URL
- },
- ],
- "longDescription": "A String", # A detailed description of this `Note`.
- "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For # A note describing an attestation role.
- # example, an organization might have one `AttestationAuthority` for "QA" and
- # one for "build". This Note is intended to act strictly as a grouping
- # mechanism for the attached Occurrences (Attestations). This grouping
- # mechanism also provides a security boundary, since IAM ACLs gate the ability
- # for a principle to attach an Occurrence to a given Note. It also provides a
- # single point of lookup to find all attached Attestation Occurrences, even if
- # they don't all live in the same project.
- "hint": { # This submessage provides human-readable hints about the purpose of the
- # AttestationAuthority. Because the name of a Note acts as its resource
- # reference, it is important to disambiguate the canonical name of the Note
- # (which might be a UUID for security purposes) from "readable" names more
- # suitable for debug output. Note that these hints should NOT be used to
- # look up AttestationAuthorities in security sensitive contexts, such as when
- # looking up Attestations to verify.
- "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa".
- },
- },
- "baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
- # relationship. Linked occurrences are derived from this or an
- # equivalent image via:
- # FROM <Basis.resource_url>
- # Or an equivalent reference, e.g. a tag of the resource_url.
- "resourceUrl": "A String", # The resource_url for the resource representing the basis of
- # associated occurrence images.
- "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image.
- "v1Name": "A String", # The layer-id of the final layer in the Docker image's v1
- # representation.
- # This field can be used as a filter in list requests.
- "v2Blob": [ # The ordered list of v2 blobs that represent a given image.
- "A String",
- ],
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
- # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
- # Only the name of the final blob is kept.
- # This field can be used as a filter in list requests.
- },
- },
- "expirationTime": "A String", # Time of expiration for this note, null if note does not expire.
- "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
- "resourceUri": [ # Resource URI for the artifact being deployed.
- "A String",
- ],
- },
- "shortDescription": "A String", # A one sentence description of this `Note`.
- "createTime": "A String", # Output only. The time this note was created. This field can be used as a
+ "createTime": "A String", # Output only. The time this note was created. This field can be used as a
# filter in list requests.
- "discovery": { # A note that indicates a type of analysis a provider would perform. This note # A note describing a provider/analysis type.
- # exists in a provider's project. A `Discovery` occurrence is created in a
- # consumer's project at the start of analysis. The occurrence's operation will
+ "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
+ # a filter in list requests.
+ "discovery": { # A note that indicates a type of analysis a provider would perform. This note # A note describing a provider/analysis type.
+ # exists in a provider's project. A `Discovery` occurrence is created in a
+ # consumer's project at the start of analysis. The occurrence's operation will
# indicate the status of the analysis. Absence of an occurrence linked to this
- # note for a resource indicates that analysis hasn't started.
- "analysisKind": "A String", # The kind of analysis that is handled by this discovery.
+ # note for a resource indicates that analysis hasn't started.
+ "analysisKind": "A String", # The kind of analysis that is handled by this discovery.
},
}</pre>
</div>
@@ -854,9 +854,9 @@
The object takes the form of:
{ # Request message for `GetIamPolicy` method.
- "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to
+ "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to
# `GetIamPolicy`.
- "requestedPolicyVersion": 42, # Optional. The policy format version to be returned.
+ "requestedPolicyVersion": 42, # Optional. The policy format version to be returned.
#
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
# rejected.
@@ -864,6 +864,10 @@
# Requests for policies with any conditional bindings must specify version 3.
# Policies without any conditional bindings may specify any valid value or
# leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
},
}
@@ -885,36 +889,40 @@
# permissions; each `role` can be an IAM predefined role or a user-created
# custom role.
#
- # Optionally, a `binding` can specify a `condition`, which is a logical
- # expression that allows access to a resource only if the expression evaluates
- # to `true`. A condition can add constraints based on attributes of the
- # request, the resource, or both.
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
# **JSON example:**
#
# {
- # "bindings": [
+ # "bindings": [
# {
- # "role": "roles/resourcemanager.organizationAdmin",
- # "members": [
- # "user:mike@example.com",
- # "group:admins@example.com",
- # "domain:google.com",
- # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
- # "role": "roles/resourcemanager.organizationViewer",
- # "members": ["user:eve@example.com"],
- # "condition": {
- # "title": "expirable access",
- # "description": "Does not grant access after Sep 2020",
- # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": [
+ # "user:eve@example.com"
+ # ],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
# }
# }
# ],
- # "etag": "BwWWja0YfJA=",
- # "version": 3
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
# **YAML example:**
@@ -932,19 +940,105 @@
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the members in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
+ #
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ },
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
@@ -987,121 +1081,84 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
- "A String",
+ "A String",
],
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
- # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
- # are documented at https://github.com/google/cel-spec.
- #
- # Example (Comparison):
- #
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
- #
- # Example (Equality):
- #
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
- #
- # Example (Logic):
- #
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
- #
- # Example (Data Manipulation):
- #
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
- #
- # The exact variables and functions that may be referenced within an expression
- # are determined by the service that evaluates it. See the service
- # documentation for additional information.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
- # its purpose. This can be used e.g. in UIs which allow to enter the
- # expression.
- },
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
- # prevent simultaneous updates of a policy from overwriting each other.
- # It is strongly suggested that systems make use of the `etag` in the
- # read-modify-write cycle to perform policy updates in order to avoid race
- # conditions: An `etag` is returned in the response to `getIamPolicy`, and
- # systems are expected to put that etag in the request to `setIamPolicy` to
- # ensure that their change will be applied to the same version of the policy.
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, name=None, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
+ <code class="details" id="list">list(parent, filter=None, name=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>Lists all `Notes` for a given project.
Args:
- parent: string, This field contains the project Id for example: "projects/{PROJECT_ID}". (required)
+ parent: string, This field contains the project Id for example: "projects/{PROJECT_ID}". (required)
+ filter: string, The filter expression.
name: string, The name field will contain the project Id for example:
-"providers/{provider_id}
+"providers/{provider_id}
@Deprecated
pageToken: string, Token to provide to skip to a particular spot in the list.
+ pageSize: integer, Number of notes to return in the list.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- pageSize: integer, Number of notes to return in the list.
- filter: string, The filter expression.
Returns:
An object of the form:
{ # Response including listed notes.
- "nextPageToken": "A String", # The next pagination token in the list response. It should be used as
- # page_token for the following request. An empty value means no more result.
- "notes": [ # The occurrences requested
+ "notes": [ # The occurrences requested
{ # Provides a detailed description of a `Note`.
- "buildType": { # Note holding the version of the provider's builder and the signature of # Build provenance type for a verifiable build.
+ "relatedUrl": [ # URLs associated with this note
+ { # Metadata for any related URL information
+ "url": "A String", # Specific URL to associate with the note
+ "label": "A String", # Label to describe usage of the URL
+ },
+ ],
+ "expirationTime": "A String", # Time of expiration for this note, null if note does not expire.
+ "baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
+ # relationship. Linked occurrences are derived from this or an
+ # equivalent image via:
+ # FROM <Basis.resource_url>
+ # Or an equivalent reference, e.g. a tag of the resource_url.
+ "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image.
+ "v2Blob": [ # The ordered list of v2 blobs that represent a given image.
+ "A String",
+ ],
+ "v1Name": "A String", # The layer-id of the final layer in the Docker image's v1
+ # representation.
+ # This field can be used as a filter in list requests.
+ "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
+ # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
+ # Only the name of the final blob is kept.
+ # This field can be used as a filter in list requests.
+ },
+ "resourceUrl": "A String", # The resource_url for the resource representing the basis of
+ # associated occurrence images.
+ },
+ "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This
+ # field can be used as a filter in list requests.
+ "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
+ "resourceUri": [ # Resource URI for the artifact being deployed.
+ "A String",
+ ],
+ },
+ "buildType": { # Note holding the version of the provider's builder and the signature of # Build provenance type for a verifiable build.
# the provenance message in linked BuildDetails.
- "builderVersion": "A String", # Version of the builder which produced this Note.
- "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this
+ "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this
# `BuilderDetails`.
- "publicKey": "A String", # Public key of the builder which can be used to verify that the related
+ "keyId": "A String", # An Id for the key used to sign. This could be either an Id for the key
+ # stored in `public_key` (such as the Id or fingerprint for a PGP key, or the
+ # CN for a cert), or a reference to an external key (such as a reference to a
+ # key in Cloud Key Management Service).
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
+ # `key_id`
+ "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string.
+ "publicKey": "A String", # Public key of the builder which can be used to verify that the related
# findings are valid and unchanged. If `key_type` is empty, this defaults
# to PEM encoded public keys.
#
@@ -1114,207 +1171,169 @@
# from `BuildDetails` are base64-decoded into a binary representation in
# signed.bin. OpenSSL can then verify the signature:
# `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
- # `key_id`
- "keyId": "A String", # An Id for the key used to sign. This could be either an Id for the key
- # stored in `public_key` (such as the Id or fingerprint for a PGP key, or the
- # CN for a cert), or a reference to an external key (such as a reference to a
- # key in Cloud Key Management Service).
- "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string.
+ },
+ "builderVersion": "A String", # Version of the builder which produced this Note.
+ },
+ "longDescription": "A String", # A detailed description of this `Note`.
+ "shortDescription": "A String", # A one sentence description of this `Note`.
+ "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For # A note describing an attestation role.
+ # example, an organization might have one `AttestationAuthority` for "QA" and
+ # one for "build". This Note is intended to act strictly as a grouping
+ # mechanism for the attached Occurrences (Attestations). This grouping
+ # mechanism also provides a security boundary, since IAM ACLs gate the ability
+ # for a principle to attach an Occurrence to a given Note. It also provides a
+ # single point of lookup to find all attached Attestation Occurrences, even if
+ # they don't all live in the same project.
+ "hint": { # This submessage provides human-readable hints about the purpose of the
+ # AttestationAuthority. Because the name of a Note acts as its resource
+ # reference, it is important to disambiguate the canonical name of the Note
+ # (which might be a UUID for security purposes) from "readable" names more
+ # suitable for debug output. Note that these hints should NOT be used to
+ # look up AttestationAuthorities in security sensitive contexts, such as when
+ # looking up Attestations to verify.
+ "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa".
},
},
- "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This
- # field can be used as a filter in list requests.
- "upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given # A note describing an upgrade.
- # version. For each package version combination (i.e. bash 4.0, bash 4.1,
- # bash 4.1.2), there will be a Upgrade Note.
- "version": { # Version contains structured information about the version of the package. # Required - The version of the package in machine + human readable form.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "distributions": [ # Metadata about the upgrade for each specific operating system.
- { # The Upgrade Distribution represents metadata about the Upgrade for each
- # operating system (CPE). Some distributions have additional metadata around
- # updates, classifying them into various categories and severities.
- "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
- # https://cpe.mitre.org/specification/.
- "cve": [ # The cve that would be resolved by this upgrade.
- "A String",
- ],
- "severity": "A String", # The severity as specified by the upstream operating system.
- "classification": "A String", # The operating system classification of this Upgrade, as specified by the
- # upstream operating system upgrade feed.
- },
- ],
- "package": "A String", # Required - The package this Upgrade is for.
- },
- "name": "A String", # The name of the note in the form
- # "projects/{provider_project_id}/notes/{NOTE_ID}"
- "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
- "cvssScore": 3.14, # The CVSS score for this Vulnerability.
- "severity": "A String", # Note provider assigned impact of the vulnerability
- "details": [ # All information about the package to specifically identify this
+ "name": "A String", # The name of the note in the form
+ # "projects/{provider_project_id}/notes/{NOTE_ID}"
+ "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
+ "cvssScore": 3.14, # The CVSS score for this Vulnerability.
+ "severity": "A String", # Note provider assigned impact of the vulnerability
+ "details": [ # All information about the package to specifically identify this
# vulnerability. One entry per (version range and cpe_uri) the
# package vulnerability has manifested in.
{ # Identifies all occurrences of this vulnerability in the package for a
# specific distro/location
# For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in
- # which the vulnerability manifests. Examples include distro or storage
- # location for vulnerable jar.
- # This field can be used as a filter in list requests.
- "description": "A String", # A vendor-specific description of this note.
- "minAffectedVersion": { # Version contains structured information about the version of the package. # The min version of the package in which the vulnerability exists.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "package": "A String", # The name of the package where the vulnerability was found.
- # This field can be used as a filter in list requests.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems,
- # node.js packages etc)
- "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to
+ "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to
# obsolete details.
- "maxAffectedVersion": { # Version contains structured information about the version of the package. # The max version of the package in which the vulnerability exists.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "fixedLocation": { # The location of the vulnerability # The fix for this specific package version.
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
+ "fixedLocation": { # The location of the vulnerability # The fix for this specific package version.
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
# format. Examples include distro or storage location for vulnerable jar.
# This field can be used as a filter in list requests.
- "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
+ "package": "A String", # The package being described.
+ "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
# filter in list requests.
# For a discussion of this in Debian/Ubuntu:
# http://serverfault.com/questions/604541/debian-packages-version-convention
# For a discussion of this in Redhat/Fedora/Centos:
# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
# If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
},
- "package": "A String", # The package being described.
+ },
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems,
+ # node.js packages etc)
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in
+ # which the vulnerability manifests. Examples include distro or storage
+ # location for vulnerable jar.
+ # This field can be used as a filter in list requests.
+ "description": "A String", # A vendor-specific description of this note.
+ "minAffectedVersion": { # Version contains structured information about the version of the package. # The min version of the package in which the vulnerability exists.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
+ "package": "A String", # The name of the package where the vulnerability was found.
+ # This field can be used as a filter in list requests.
+ "maxAffectedVersion": { # Version contains structured information about the version of the package. # The max version of the package in which the vulnerability exists.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
},
},
],
},
- "package": { # This represents a particular package that is distributed over # A note describing a package hosted by various package managers.
+ "upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given # A note describing an upgrade.
+ # version. For each package version combination (i.e. bash 4.0, bash 4.1,
+ # bash 4.1.2), there will be a Upgrade Note.
+ "package": "A String", # Required - The package this Upgrade is for.
+ "version": { # Version contains structured information about the version of the package. # Required - The version of the package in machine + human readable form.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "distributions": [ # Metadata about the upgrade for each specific operating system.
+ { # The Upgrade Distribution represents metadata about the Upgrade for each
+ # operating system (CPE). Some distributions have additional metadata around
+ # updates, classifying them into various categories and severities.
+ "cve": [ # The cve that would be resolved by this upgrade.
+ "A String",
+ ],
+ "classification": "A String", # The operating system classification of this Upgrade, as specified by the
+ # upstream operating system upgrade feed.
+ "severity": "A String", # The severity as specified by the upstream operating system.
+ "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
+ # https://cpe.mitre.org/specification/.
+ },
+ ],
+ },
+ "package": { # This represents a particular package that is distributed over # A note describing a package hosted by various package managers.
# various channels.
# e.g. glibc (aka libc6) is distributed by many, at various versions.
- "distribution": [ # The various channels by which a package is distributed.
+ "name": "A String", # The name of the package.
+ "distribution": [ # The various channels by which a package is distributed.
{ # This represents a particular channel of distribution for a given package.
- # e.g. Debian's jessie-backports dpkg mirror
- "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)
- # denoting the package manager version distributing a package.
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
- "description": "A String", # The distribution channel-specific description of this package.
- "url": "A String", # The distribution channel-specific homepage for this package.
- "architecture": "A String", # The CPU architecture for which packages in this distribution
- # channel were built
- "latestVersion": { # Version contains structured information about the version of the package. # The latest available version of this package in
+ # e.g. Debian's jessie-backports dpkg mirror
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
+ "latestVersion": { # Version contains structured information about the version of the package. # The latest available version of this package in
# this distribution channel.
# For a discussion of this in Debian/Ubuntu:
# http://serverfault.com/questions/604541/debian-packages-version-convention
# For a discussion of this in Redhat/Fedora/Centos:
# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
# If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
},
+ "description": "A String", # The distribution channel-specific description of this package.
+ "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)
+ # denoting the package manager version distributing a package.
+ "url": "A String", # The distribution channel-specific homepage for this package.
+ "architecture": "A String", # The CPU architecture for which packages in this distribution
+ # channel were built
},
],
- "name": "A String", # The name of the package.
},
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
- # a filter in list requests.
- "relatedUrl": [ # URLs associated with this note
- { # Metadata for any related URL information
- "url": "A String", # Specific URL to associate with the note
- "label": "A String", # Label to describe usage of the URL
- },
- ],
- "longDescription": "A String", # A detailed description of this `Note`.
- "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For # A note describing an attestation role.
- # example, an organization might have one `AttestationAuthority` for "QA" and
- # one for "build". This Note is intended to act strictly as a grouping
- # mechanism for the attached Occurrences (Attestations). This grouping
- # mechanism also provides a security boundary, since IAM ACLs gate the ability
- # for a principle to attach an Occurrence to a given Note. It also provides a
- # single point of lookup to find all attached Attestation Occurrences, even if
- # they don't all live in the same project.
- "hint": { # This submessage provides human-readable hints about the purpose of the
- # AttestationAuthority. Because the name of a Note acts as its resource
- # reference, it is important to disambiguate the canonical name of the Note
- # (which might be a UUID for security purposes) from "readable" names more
- # suitable for debug output. Note that these hints should NOT be used to
- # look up AttestationAuthorities in security sensitive contexts, such as when
- # looking up Attestations to verify.
- "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa".
- },
- },
- "baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
- # relationship. Linked occurrences are derived from this or an
- # equivalent image via:
- # FROM <Basis.resource_url>
- # Or an equivalent reference, e.g. a tag of the resource_url.
- "resourceUrl": "A String", # The resource_url for the resource representing the basis of
- # associated occurrence images.
- "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image.
- "v1Name": "A String", # The layer-id of the final layer in the Docker image's v1
- # representation.
- # This field can be used as a filter in list requests.
- "v2Blob": [ # The ordered list of v2 blobs that represent a given image.
- "A String",
- ],
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
- # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
- # Only the name of the final blob is kept.
- # This field can be used as a filter in list requests.
- },
- },
- "expirationTime": "A String", # Time of expiration for this note, null if note does not expire.
- "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
- "resourceUri": [ # Resource URI for the artifact being deployed.
- "A String",
- ],
- },
- "shortDescription": "A String", # A one sentence description of this `Note`.
- "createTime": "A String", # Output only. The time this note was created. This field can be used as a
+ "createTime": "A String", # Output only. The time this note was created. This field can be used as a
# filter in list requests.
- "discovery": { # A note that indicates a type of analysis a provider would perform. This note # A note describing a provider/analysis type.
- # exists in a provider's project. A `Discovery` occurrence is created in a
- # consumer's project at the start of analysis. The occurrence's operation will
+ "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
+ # a filter in list requests.
+ "discovery": { # A note that indicates a type of analysis a provider would perform. This note # A note describing a provider/analysis type.
+ # exists in a provider's project. A `Discovery` occurrence is created in a
+ # consumer's project at the start of analysis. The occurrence's operation will
# indicate the status of the analysis. Absence of an occurrence linked to this
- # note for a resource indicates that analysis hasn't started.
- "analysisKind": "A String", # The kind of analysis that is handled by this discovery.
+ # note for a resource indicates that analysis hasn't started.
+ "analysisKind": "A String", # The kind of analysis that is handled by this discovery.
},
},
],
+ "nextPageToken": "A String", # The next pagination token in the list response. It should be used as
+ # page_token for the following request. An empty value means no more result.
}</pre>
</div>
@@ -1327,7 +1346,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -1338,17 +1357,57 @@
Args:
name: string, The name of the note.
-Should be of the form "projects/{provider_id}/notes/{note_id}". (required)
+Should be of the form "projects/{provider_id}/notes/{note_id}". (required)
body: object, The request body.
The object takes the form of:
{ # Provides a detailed description of a `Note`.
- "buildType": { # Note holding the version of the provider's builder and the signature of # Build provenance type for a verifiable build.
+ "relatedUrl": [ # URLs associated with this note
+ { # Metadata for any related URL information
+ "url": "A String", # Specific URL to associate with the note
+ "label": "A String", # Label to describe usage of the URL
+ },
+ ],
+ "expirationTime": "A String", # Time of expiration for this note, null if note does not expire.
+ "baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
+ # relationship. Linked occurrences are derived from this or an
+ # equivalent image via:
+ # FROM <Basis.resource_url>
+ # Or an equivalent reference, e.g. a tag of the resource_url.
+ "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image.
+ "v2Blob": [ # The ordered list of v2 blobs that represent a given image.
+ "A String",
+ ],
+ "v1Name": "A String", # The layer-id of the final layer in the Docker image's v1
+ # representation.
+ # This field can be used as a filter in list requests.
+ "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
+ # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
+ # Only the name of the final blob is kept.
+ # This field can be used as a filter in list requests.
+ },
+ "resourceUrl": "A String", # The resource_url for the resource representing the basis of
+ # associated occurrence images.
+ },
+ "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This
+ # field can be used as a filter in list requests.
+ "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
+ "resourceUri": [ # Resource URI for the artifact being deployed.
+ "A String",
+ ],
+ },
+ "buildType": { # Note holding the version of the provider's builder and the signature of # Build provenance type for a verifiable build.
# the provenance message in linked BuildDetails.
- "builderVersion": "A String", # Version of the builder which produced this Note.
- "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this
+ "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this
# `BuilderDetails`.
- "publicKey": "A String", # Public key of the builder which can be used to verify that the related
+ "keyId": "A String", # An Id for the key used to sign. This could be either an Id for the key
+ # stored in `public_key` (such as the Id or fingerprint for a PGP key, or the
+ # CN for a cert), or a reference to an external key (such as a reference to a
+ # key in Cloud Key Management Service).
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
+ # `key_id`
+ "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string.
+ "publicKey": "A String", # Public key of the builder which can be used to verify that the related
# findings are valid and unchanged. If `key_type` is empty, this defaults
# to PEM encoded public keys.
#
@@ -1361,204 +1420,164 @@
# from `BuildDetails` are base64-decoded into a binary representation in
# signed.bin. OpenSSL can then verify the signature:
# `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
- # `key_id`
- "keyId": "A String", # An Id for the key used to sign. This could be either an Id for the key
- # stored in `public_key` (such as the Id or fingerprint for a PGP key, or the
- # CN for a cert), or a reference to an external key (such as a reference to a
- # key in Cloud Key Management Service).
- "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string.
+ },
+ "builderVersion": "A String", # Version of the builder which produced this Note.
+ },
+ "longDescription": "A String", # A detailed description of this `Note`.
+ "shortDescription": "A String", # A one sentence description of this `Note`.
+ "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For # A note describing an attestation role.
+ # example, an organization might have one `AttestationAuthority` for "QA" and
+ # one for "build". This Note is intended to act strictly as a grouping
+ # mechanism for the attached Occurrences (Attestations). This grouping
+ # mechanism also provides a security boundary, since IAM ACLs gate the ability
+ # for a principle to attach an Occurrence to a given Note. It also provides a
+ # single point of lookup to find all attached Attestation Occurrences, even if
+ # they don't all live in the same project.
+ "hint": { # This submessage provides human-readable hints about the purpose of the
+ # AttestationAuthority. Because the name of a Note acts as its resource
+ # reference, it is important to disambiguate the canonical name of the Note
+ # (which might be a UUID for security purposes) from "readable" names more
+ # suitable for debug output. Note that these hints should NOT be used to
+ # look up AttestationAuthorities in security sensitive contexts, such as when
+ # looking up Attestations to verify.
+ "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa".
},
},
- "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This
- # field can be used as a filter in list requests.
- "upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given # A note describing an upgrade.
- # version. For each package version combination (i.e. bash 4.0, bash 4.1,
- # bash 4.1.2), there will be a Upgrade Note.
- "version": { # Version contains structured information about the version of the package. # Required - The version of the package in machine + human readable form.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "distributions": [ # Metadata about the upgrade for each specific operating system.
- { # The Upgrade Distribution represents metadata about the Upgrade for each
- # operating system (CPE). Some distributions have additional metadata around
- # updates, classifying them into various categories and severities.
- "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
- # https://cpe.mitre.org/specification/.
- "cve": [ # The cve that would be resolved by this upgrade.
- "A String",
- ],
- "severity": "A String", # The severity as specified by the upstream operating system.
- "classification": "A String", # The operating system classification of this Upgrade, as specified by the
- # upstream operating system upgrade feed.
- },
- ],
- "package": "A String", # Required - The package this Upgrade is for.
- },
- "name": "A String", # The name of the note in the form
- # "projects/{provider_project_id}/notes/{NOTE_ID}"
- "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
- "cvssScore": 3.14, # The CVSS score for this Vulnerability.
- "severity": "A String", # Note provider assigned impact of the vulnerability
- "details": [ # All information about the package to specifically identify this
+ "name": "A String", # The name of the note in the form
+ # "projects/{provider_project_id}/notes/{NOTE_ID}"
+ "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
+ "cvssScore": 3.14, # The CVSS score for this Vulnerability.
+ "severity": "A String", # Note provider assigned impact of the vulnerability
+ "details": [ # All information about the package to specifically identify this
# vulnerability. One entry per (version range and cpe_uri) the
# package vulnerability has manifested in.
{ # Identifies all occurrences of this vulnerability in the package for a
# specific distro/location
# For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in
- # which the vulnerability manifests. Examples include distro or storage
- # location for vulnerable jar.
- # This field can be used as a filter in list requests.
- "description": "A String", # A vendor-specific description of this note.
- "minAffectedVersion": { # Version contains structured information about the version of the package. # The min version of the package in which the vulnerability exists.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "package": "A String", # The name of the package where the vulnerability was found.
- # This field can be used as a filter in list requests.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems,
- # node.js packages etc)
- "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to
+ "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to
# obsolete details.
- "maxAffectedVersion": { # Version contains structured information about the version of the package. # The max version of the package in which the vulnerability exists.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "fixedLocation": { # The location of the vulnerability # The fix for this specific package version.
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
+ "fixedLocation": { # The location of the vulnerability # The fix for this specific package version.
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
# format. Examples include distro or storage location for vulnerable jar.
# This field can be used as a filter in list requests.
- "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
+ "package": "A String", # The package being described.
+ "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
# filter in list requests.
# For a discussion of this in Debian/Ubuntu:
# http://serverfault.com/questions/604541/debian-packages-version-convention
# For a discussion of this in Redhat/Fedora/Centos:
# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
# If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
},
- "package": "A String", # The package being described.
+ },
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems,
+ # node.js packages etc)
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in
+ # which the vulnerability manifests. Examples include distro or storage
+ # location for vulnerable jar.
+ # This field can be used as a filter in list requests.
+ "description": "A String", # A vendor-specific description of this note.
+ "minAffectedVersion": { # Version contains structured information about the version of the package. # The min version of the package in which the vulnerability exists.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
+ "package": "A String", # The name of the package where the vulnerability was found.
+ # This field can be used as a filter in list requests.
+ "maxAffectedVersion": { # Version contains structured information about the version of the package. # The max version of the package in which the vulnerability exists.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
},
},
],
},
- "package": { # This represents a particular package that is distributed over # A note describing a package hosted by various package managers.
+ "upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given # A note describing an upgrade.
+ # version. For each package version combination (i.e. bash 4.0, bash 4.1,
+ # bash 4.1.2), there will be a Upgrade Note.
+ "package": "A String", # Required - The package this Upgrade is for.
+ "version": { # Version contains structured information about the version of the package. # Required - The version of the package in machine + human readable form.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "distributions": [ # Metadata about the upgrade for each specific operating system.
+ { # The Upgrade Distribution represents metadata about the Upgrade for each
+ # operating system (CPE). Some distributions have additional metadata around
+ # updates, classifying them into various categories and severities.
+ "cve": [ # The cve that would be resolved by this upgrade.
+ "A String",
+ ],
+ "classification": "A String", # The operating system classification of this Upgrade, as specified by the
+ # upstream operating system upgrade feed.
+ "severity": "A String", # The severity as specified by the upstream operating system.
+ "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
+ # https://cpe.mitre.org/specification/.
+ },
+ ],
+ },
+ "package": { # This represents a particular package that is distributed over # A note describing a package hosted by various package managers.
# various channels.
# e.g. glibc (aka libc6) is distributed by many, at various versions.
- "distribution": [ # The various channels by which a package is distributed.
+ "name": "A String", # The name of the package.
+ "distribution": [ # The various channels by which a package is distributed.
{ # This represents a particular channel of distribution for a given package.
- # e.g. Debian's jessie-backports dpkg mirror
- "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)
- # denoting the package manager version distributing a package.
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
- "description": "A String", # The distribution channel-specific description of this package.
- "url": "A String", # The distribution channel-specific homepage for this package.
- "architecture": "A String", # The CPU architecture for which packages in this distribution
- # channel were built
- "latestVersion": { # Version contains structured information about the version of the package. # The latest available version of this package in
+ # e.g. Debian's jessie-backports dpkg mirror
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
+ "latestVersion": { # Version contains structured information about the version of the package. # The latest available version of this package in
# this distribution channel.
# For a discussion of this in Debian/Ubuntu:
# http://serverfault.com/questions/604541/debian-packages-version-convention
# For a discussion of this in Redhat/Fedora/Centos:
# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
# If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
},
+ "description": "A String", # The distribution channel-specific description of this package.
+ "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)
+ # denoting the package manager version distributing a package.
+ "url": "A String", # The distribution channel-specific homepage for this package.
+ "architecture": "A String", # The CPU architecture for which packages in this distribution
+ # channel were built
},
],
- "name": "A String", # The name of the package.
},
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
- # a filter in list requests.
- "relatedUrl": [ # URLs associated with this note
- { # Metadata for any related URL information
- "url": "A String", # Specific URL to associate with the note
- "label": "A String", # Label to describe usage of the URL
- },
- ],
- "longDescription": "A String", # A detailed description of this `Note`.
- "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For # A note describing an attestation role.
- # example, an organization might have one `AttestationAuthority` for "QA" and
- # one for "build". This Note is intended to act strictly as a grouping
- # mechanism for the attached Occurrences (Attestations). This grouping
- # mechanism also provides a security boundary, since IAM ACLs gate the ability
- # for a principle to attach an Occurrence to a given Note. It also provides a
- # single point of lookup to find all attached Attestation Occurrences, even if
- # they don't all live in the same project.
- "hint": { # This submessage provides human-readable hints about the purpose of the
- # AttestationAuthority. Because the name of a Note acts as its resource
- # reference, it is important to disambiguate the canonical name of the Note
- # (which might be a UUID for security purposes) from "readable" names more
- # suitable for debug output. Note that these hints should NOT be used to
- # look up AttestationAuthorities in security sensitive contexts, such as when
- # looking up Attestations to verify.
- "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa".
- },
- },
- "baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
- # relationship. Linked occurrences are derived from this or an
- # equivalent image via:
- # FROM <Basis.resource_url>
- # Or an equivalent reference, e.g. a tag of the resource_url.
- "resourceUrl": "A String", # The resource_url for the resource representing the basis of
- # associated occurrence images.
- "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image.
- "v1Name": "A String", # The layer-id of the final layer in the Docker image's v1
- # representation.
- # This field can be used as a filter in list requests.
- "v2Blob": [ # The ordered list of v2 blobs that represent a given image.
- "A String",
- ],
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
- # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
- # Only the name of the final blob is kept.
- # This field can be used as a filter in list requests.
- },
- },
- "expirationTime": "A String", # Time of expiration for this note, null if note does not expire.
- "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
- "resourceUri": [ # Resource URI for the artifact being deployed.
- "A String",
- ],
- },
- "shortDescription": "A String", # A one sentence description of this `Note`.
- "createTime": "A String", # Output only. The time this note was created. This field can be used as a
+ "createTime": "A String", # Output only. The time this note was created. This field can be used as a
# filter in list requests.
- "discovery": { # A note that indicates a type of analysis a provider would perform. This note # A note describing a provider/analysis type.
- # exists in a provider's project. A `Discovery` occurrence is created in a
- # consumer's project at the start of analysis. The occurrence's operation will
+ "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
+ # a filter in list requests.
+ "discovery": { # A note that indicates a type of analysis a provider would perform. This note # A note describing a provider/analysis type.
+ # exists in a provider's project. A `Discovery` occurrence is created in a
+ # consumer's project at the start of analysis. The occurrence's operation will
# indicate the status of the analysis. Absence of an occurrence linked to this
- # note for a resource indicates that analysis hasn't started.
- "analysisKind": "A String", # The kind of analysis that is handled by this discovery.
+ # note for a resource indicates that analysis hasn't started.
+ "analysisKind": "A String", # The kind of analysis that is handled by this discovery.
},
}
@@ -1572,12 +1591,52 @@
An object of the form:
{ # Provides a detailed description of a `Note`.
- "buildType": { # Note holding the version of the provider's builder and the signature of # Build provenance type for a verifiable build.
+ "relatedUrl": [ # URLs associated with this note
+ { # Metadata for any related URL information
+ "url": "A String", # Specific URL to associate with the note
+ "label": "A String", # Label to describe usage of the URL
+ },
+ ],
+ "expirationTime": "A String", # Time of expiration for this note, null if note does not expire.
+ "baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
+ # relationship. Linked occurrences are derived from this or an
+ # equivalent image via:
+ # FROM <Basis.resource_url>
+ # Or an equivalent reference, e.g. a tag of the resource_url.
+ "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image.
+ "v2Blob": [ # The ordered list of v2 blobs that represent a given image.
+ "A String",
+ ],
+ "v1Name": "A String", # The layer-id of the final layer in the Docker image's v1
+ # representation.
+ # This field can be used as a filter in list requests.
+ "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
+ # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
+ # Only the name of the final blob is kept.
+ # This field can be used as a filter in list requests.
+ },
+ "resourceUrl": "A String", # The resource_url for the resource representing the basis of
+ # associated occurrence images.
+ },
+ "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This
+ # field can be used as a filter in list requests.
+ "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
+ "resourceUri": [ # Resource URI for the artifact being deployed.
+ "A String",
+ ],
+ },
+ "buildType": { # Note holding the version of the provider's builder and the signature of # Build provenance type for a verifiable build.
# the provenance message in linked BuildDetails.
- "builderVersion": "A String", # Version of the builder which produced this Note.
- "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this
+ "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this
# `BuilderDetails`.
- "publicKey": "A String", # Public key of the builder which can be used to verify that the related
+ "keyId": "A String", # An Id for the key used to sign. This could be either an Id for the key
+ # stored in `public_key` (such as the Id or fingerprint for a PGP key, or the
+ # CN for a cert), or a reference to an external key (such as a reference to a
+ # key in Cloud Key Management Service).
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
+ # `key_id`
+ "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string.
+ "publicKey": "A String", # Public key of the builder which can be used to verify that the related
# findings are valid and unchanged. If `key_type` is empty, this defaults
# to PEM encoded public keys.
#
@@ -1590,204 +1649,164 @@
# from `BuildDetails` are base64-decoded into a binary representation in
# signed.bin. OpenSSL can then verify the signature:
# `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
- # `key_id`
- "keyId": "A String", # An Id for the key used to sign. This could be either an Id for the key
- # stored in `public_key` (such as the Id or fingerprint for a PGP key, or the
- # CN for a cert), or a reference to an external key (such as a reference to a
- # key in Cloud Key Management Service).
- "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string.
+ },
+ "builderVersion": "A String", # Version of the builder which produced this Note.
+ },
+ "longDescription": "A String", # A detailed description of this `Note`.
+ "shortDescription": "A String", # A one sentence description of this `Note`.
+ "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For # A note describing an attestation role.
+ # example, an organization might have one `AttestationAuthority` for "QA" and
+ # one for "build". This Note is intended to act strictly as a grouping
+ # mechanism for the attached Occurrences (Attestations). This grouping
+ # mechanism also provides a security boundary, since IAM ACLs gate the ability
+ # for a principle to attach an Occurrence to a given Note. It also provides a
+ # single point of lookup to find all attached Attestation Occurrences, even if
+ # they don't all live in the same project.
+ "hint": { # This submessage provides human-readable hints about the purpose of the
+ # AttestationAuthority. Because the name of a Note acts as its resource
+ # reference, it is important to disambiguate the canonical name of the Note
+ # (which might be a UUID for security purposes) from "readable" names more
+ # suitable for debug output. Note that these hints should NOT be used to
+ # look up AttestationAuthorities in security sensitive contexts, such as when
+ # looking up Attestations to verify.
+ "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa".
},
},
- "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This
- # field can be used as a filter in list requests.
- "upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given # A note describing an upgrade.
- # version. For each package version combination (i.e. bash 4.0, bash 4.1,
- # bash 4.1.2), there will be a Upgrade Note.
- "version": { # Version contains structured information about the version of the package. # Required - The version of the package in machine + human readable form.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "distributions": [ # Metadata about the upgrade for each specific operating system.
- { # The Upgrade Distribution represents metadata about the Upgrade for each
- # operating system (CPE). Some distributions have additional metadata around
- # updates, classifying them into various categories and severities.
- "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
- # https://cpe.mitre.org/specification/.
- "cve": [ # The cve that would be resolved by this upgrade.
- "A String",
- ],
- "severity": "A String", # The severity as specified by the upstream operating system.
- "classification": "A String", # The operating system classification of this Upgrade, as specified by the
- # upstream operating system upgrade feed.
- },
- ],
- "package": "A String", # Required - The package this Upgrade is for.
- },
- "name": "A String", # The name of the note in the form
- # "projects/{provider_project_id}/notes/{NOTE_ID}"
- "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
- "cvssScore": 3.14, # The CVSS score for this Vulnerability.
- "severity": "A String", # Note provider assigned impact of the vulnerability
- "details": [ # All information about the package to specifically identify this
+ "name": "A String", # The name of the note in the form
+ # "projects/{provider_project_id}/notes/{NOTE_ID}"
+ "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
+ "cvssScore": 3.14, # The CVSS score for this Vulnerability.
+ "severity": "A String", # Note provider assigned impact of the vulnerability
+ "details": [ # All information about the package to specifically identify this
# vulnerability. One entry per (version range and cpe_uri) the
# package vulnerability has manifested in.
{ # Identifies all occurrences of this vulnerability in the package for a
# specific distro/location
# For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in
- # which the vulnerability manifests. Examples include distro or storage
- # location for vulnerable jar.
- # This field can be used as a filter in list requests.
- "description": "A String", # A vendor-specific description of this note.
- "minAffectedVersion": { # Version contains structured information about the version of the package. # The min version of the package in which the vulnerability exists.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "package": "A String", # The name of the package where the vulnerability was found.
- # This field can be used as a filter in list requests.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems,
- # node.js packages etc)
- "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to
+ "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to
# obsolete details.
- "maxAffectedVersion": { # Version contains structured information about the version of the package. # The max version of the package in which the vulnerability exists.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "fixedLocation": { # The location of the vulnerability # The fix for this specific package version.
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
+ "fixedLocation": { # The location of the vulnerability # The fix for this specific package version.
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
# format. Examples include distro or storage location for vulnerable jar.
# This field can be used as a filter in list requests.
- "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
+ "package": "A String", # The package being described.
+ "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
# filter in list requests.
# For a discussion of this in Debian/Ubuntu:
# http://serverfault.com/questions/604541/debian-packages-version-convention
# For a discussion of this in Redhat/Fedora/Centos:
# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
# If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
},
- "package": "A String", # The package being described.
+ },
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems,
+ # node.js packages etc)
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in
+ # which the vulnerability manifests. Examples include distro or storage
+ # location for vulnerable jar.
+ # This field can be used as a filter in list requests.
+ "description": "A String", # A vendor-specific description of this note.
+ "minAffectedVersion": { # Version contains structured information about the version of the package. # The min version of the package in which the vulnerability exists.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
+ "package": "A String", # The name of the package where the vulnerability was found.
+ # This field can be used as a filter in list requests.
+ "maxAffectedVersion": { # Version contains structured information about the version of the package. # The max version of the package in which the vulnerability exists.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
},
},
],
},
- "package": { # This represents a particular package that is distributed over # A note describing a package hosted by various package managers.
+ "upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given # A note describing an upgrade.
+ # version. For each package version combination (i.e. bash 4.0, bash 4.1,
+ # bash 4.1.2), there will be a Upgrade Note.
+ "package": "A String", # Required - The package this Upgrade is for.
+ "version": { # Version contains structured information about the version of the package. # Required - The version of the package in machine + human readable form.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "distributions": [ # Metadata about the upgrade for each specific operating system.
+ { # The Upgrade Distribution represents metadata about the Upgrade for each
+ # operating system (CPE). Some distributions have additional metadata around
+ # updates, classifying them into various categories and severities.
+ "cve": [ # The cve that would be resolved by this upgrade.
+ "A String",
+ ],
+ "classification": "A String", # The operating system classification of this Upgrade, as specified by the
+ # upstream operating system upgrade feed.
+ "severity": "A String", # The severity as specified by the upstream operating system.
+ "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
+ # https://cpe.mitre.org/specification/.
+ },
+ ],
+ },
+ "package": { # This represents a particular package that is distributed over # A note describing a package hosted by various package managers.
# various channels.
# e.g. glibc (aka libc6) is distributed by many, at various versions.
- "distribution": [ # The various channels by which a package is distributed.
+ "name": "A String", # The name of the package.
+ "distribution": [ # The various channels by which a package is distributed.
{ # This represents a particular channel of distribution for a given package.
- # e.g. Debian's jessie-backports dpkg mirror
- "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)
- # denoting the package manager version distributing a package.
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
- "description": "A String", # The distribution channel-specific description of this package.
- "url": "A String", # The distribution channel-specific homepage for this package.
- "architecture": "A String", # The CPU architecture for which packages in this distribution
- # channel were built
- "latestVersion": { # Version contains structured information about the version of the package. # The latest available version of this package in
+ # e.g. Debian's jessie-backports dpkg mirror
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
+ "latestVersion": { # Version contains structured information about the version of the package. # The latest available version of this package in
# this distribution channel.
# For a discussion of this in Debian/Ubuntu:
# http://serverfault.com/questions/604541/debian-packages-version-convention
# For a discussion of this in Redhat/Fedora/Centos:
# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
# If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "revision": "A String", # The iteration of the package build from the above version.
},
+ "description": "A String", # The distribution channel-specific description of this package.
+ "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)
+ # denoting the package manager version distributing a package.
+ "url": "A String", # The distribution channel-specific homepage for this package.
+ "architecture": "A String", # The CPU architecture for which packages in this distribution
+ # channel were built
},
],
- "name": "A String", # The name of the package.
},
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
- # a filter in list requests.
- "relatedUrl": [ # URLs associated with this note
- { # Metadata for any related URL information
- "url": "A String", # Specific URL to associate with the note
- "label": "A String", # Label to describe usage of the URL
- },
- ],
- "longDescription": "A String", # A detailed description of this `Note`.
- "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For # A note describing an attestation role.
- # example, an organization might have one `AttestationAuthority` for "QA" and
- # one for "build". This Note is intended to act strictly as a grouping
- # mechanism for the attached Occurrences (Attestations). This grouping
- # mechanism also provides a security boundary, since IAM ACLs gate the ability
- # for a principle to attach an Occurrence to a given Note. It also provides a
- # single point of lookup to find all attached Attestation Occurrences, even if
- # they don't all live in the same project.
- "hint": { # This submessage provides human-readable hints about the purpose of the
- # AttestationAuthority. Because the name of a Note acts as its resource
- # reference, it is important to disambiguate the canonical name of the Note
- # (which might be a UUID for security purposes) from "readable" names more
- # suitable for debug output. Note that these hints should NOT be used to
- # look up AttestationAuthorities in security sensitive contexts, such as when
- # looking up Attestations to verify.
- "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa".
- },
- },
- "baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
- # relationship. Linked occurrences are derived from this or an
- # equivalent image via:
- # FROM <Basis.resource_url>
- # Or an equivalent reference, e.g. a tag of the resource_url.
- "resourceUrl": "A String", # The resource_url for the resource representing the basis of
- # associated occurrence images.
- "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image.
- "v1Name": "A String", # The layer-id of the final layer in the Docker image's v1
- # representation.
- # This field can be used as a filter in list requests.
- "v2Blob": [ # The ordered list of v2 blobs that represent a given image.
- "A String",
- ],
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
- # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
- # Only the name of the final blob is kept.
- # This field can be used as a filter in list requests.
- },
- },
- "expirationTime": "A String", # Time of expiration for this note, null if note does not expire.
- "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
- "resourceUri": [ # Resource URI for the artifact being deployed.
- "A String",
- ],
- },
- "shortDescription": "A String", # A one sentence description of this `Note`.
- "createTime": "A String", # Output only. The time this note was created. This field can be used as a
+ "createTime": "A String", # Output only. The time this note was created. This field can be used as a
# filter in list requests.
- "discovery": { # A note that indicates a type of analysis a provider would perform. This note # A note describing a provider/analysis type.
- # exists in a provider's project. A `Discovery` occurrence is created in a
- # consumer's project at the start of analysis. The occurrence's operation will
+ "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
+ # a filter in list requests.
+ "discovery": { # A note that indicates a type of analysis a provider would perform. This note # A note describing a provider/analysis type.
+ # exists in a provider's project. A `Discovery` occurrence is created in a
+ # consumer's project at the start of analysis. The occurrence's operation will
# indicate the status of the analysis. Absence of an occurrence linked to this
- # note for a resource indicates that analysis hasn't started.
- "analysisKind": "A String", # The kind of analysis that is handled by this discovery.
+ # note for a resource indicates that analysis hasn't started.
+ "analysisKind": "A String", # The kind of analysis that is handled by this discovery.
},
}</pre>
</div>
@@ -1814,7 +1833,7 @@
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
- "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of
+ "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of
# the policy is limited to a few 10s of KB. An empty policy is a
# valid policy but certain Cloud Platform services (such as Projects)
# might reject them.
@@ -1827,36 +1846,40 @@
# permissions; each `role` can be an IAM predefined role or a user-created
# custom role.
#
- # Optionally, a `binding` can specify a `condition`, which is a logical
- # expression that allows access to a resource only if the expression evaluates
- # to `true`. A condition can add constraints based on attributes of the
- # request, the resource, or both.
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
# **JSON example:**
#
# {
- # "bindings": [
+ # "bindings": [
# {
- # "role": "roles/resourcemanager.organizationAdmin",
- # "members": [
- # "user:mike@example.com",
- # "group:admins@example.com",
- # "domain:google.com",
- # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
- # "role": "roles/resourcemanager.organizationViewer",
- # "members": ["user:eve@example.com"],
- # "condition": {
- # "title": "expirable access",
- # "description": "Does not grant access after Sep 2020",
- # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": [
+ # "user:eve@example.com"
+ # ],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
# }
# }
# ],
- # "etag": "BwWWja0YfJA=",
- # "version": 3
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
# **YAML example:**
@@ -1874,19 +1897,105 @@
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the members in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
+ #
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ },
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
@@ -1929,87 +2038,12 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
- "A String",
+ "A String",
],
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
- # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
- # are documented at https://github.com/google/cel-spec.
- #
- # Example (Comparison):
- #
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
- #
- # Example (Equality):
- #
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
- #
- # Example (Logic):
- #
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
- #
- # Example (Data Manipulation):
- #
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
- #
- # The exact variables and functions that may be referenced within an expression
- # are determined by the service that evaluates it. See the service
- # documentation for additional information.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
- # its purpose. This can be used e.g. in UIs which allow to enter the
- # expression.
- },
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
- # prevent simultaneous updates of a policy from overwriting each other.
- # It is strongly suggested that systems make use of the `etag` in the
- # read-modify-write cycle to perform policy updates in order to avoid race
- # conditions: An `etag` is returned in the response to `getIamPolicy`, and
- # systems are expected to put that etag in the request to `setIamPolicy` to
- # ensure that their change will be applied to the same version of the policy.
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
},
}
@@ -2031,36 +2065,40 @@
# permissions; each `role` can be an IAM predefined role or a user-created
# custom role.
#
- # Optionally, a `binding` can specify a `condition`, which is a logical
- # expression that allows access to a resource only if the expression evaluates
- # to `true`. A condition can add constraints based on attributes of the
- # request, the resource, or both.
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
# **JSON example:**
#
# {
- # "bindings": [
+ # "bindings": [
# {
- # "role": "roles/resourcemanager.organizationAdmin",
- # "members": [
- # "user:mike@example.com",
- # "group:admins@example.com",
- # "domain:google.com",
- # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
- # "role": "roles/resourcemanager.organizationViewer",
- # "members": ["user:eve@example.com"],
- # "condition": {
- # "title": "expirable access",
- # "description": "Does not grant access after Sep 2020",
- # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": [
+ # "user:eve@example.com"
+ # ],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
# }
# }
# ],
- # "etag": "BwWWja0YfJA=",
- # "version": 3
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
# **YAML example:**
@@ -2078,19 +2116,105 @@
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the members in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
+ #
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ },
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
@@ -2133,87 +2257,12 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
- "A String",
+ "A String",
],
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
- # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
- # are documented at https://github.com/google/cel-spec.
- #
- # Example (Comparison):
- #
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
- #
- # Example (Equality):
- #
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
- #
- # Example (Logic):
- #
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
- #
- # Example (Data Manipulation):
- #
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
- #
- # The exact variables and functions that may be referenced within an expression
- # are determined by the service that evaluates it. See the service
- # documentation for additional information.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
- # its purpose. This can be used e.g. in UIs which allow to enter the
- # expression.
- },
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
- # prevent simultaneous updates of a policy from overwriting each other.
- # It is strongly suggested that systems make use of the `etag` in the
- # read-modify-write cycle to perform policy updates in order to avoid race
- # conditions: An `etag` is returned in the response to `getIamPolicy`, and
- # systems are expected to put that etag in the request to `setIamPolicy` to
- # ensure that their change will be applied to the same version of the policy.
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
}</pre>
</div>
@@ -2221,7 +2270,7 @@
<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
<pre>Returns the permissions that a caller has on the specified note or
occurrence resource. Requires list permission on the project (for example,
-"storage.objects.list" on the containing bucket for testing permission of
+"storage.objects.list" on the containing bucket for testing permission of
an object). Attempting to call this method on a non-existent resource will
result in a `NOT_FOUND` error if the user has list permission on the
project, or a `PERMISSION_DENIED` error otherwise. The resource takes the
@@ -2235,11 +2284,11 @@
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
- "permissions": [ # The set of permissions to check for the `resource`. Permissions with
- # wildcards (such as '*' or 'storage.*') are not allowed. For more
+ "permissions": [ # The set of permissions to check for the `resource`. Permissions with
+ # wildcards (such as '*' or 'storage.*') are not allowed. For more
# information see
# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
- "A String",
+ "A String",
],
}
@@ -2252,9 +2301,9 @@
An object of the form:
{ # Response message for `TestIamPermissions` method.
- "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
# allowed.
- "A String",
+ "A String",
],
}</pre>
</div>