| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="containeranalysis_v1alpha1.html">Container Analysis API</a> . <a href="containeranalysis_v1alpha1.providers.html">providers</a> . <a href="containeranalysis_v1alpha1.providers.notes.html">notes</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="containeranalysis_v1alpha1.providers.notes.occurrences.html">occurrences()</a></code> |
| </p> |
| <p class="firstline">Returns the occurrences Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="#create">create(name, body=None, noteId=None, parent=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a new `Note`.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes the given `Note` from the system.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns the requested `Note`.</p> |
| <p class="toc_element"> |
| <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(name, pageToken=None, pageSize=None, filter=None, parent=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> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates an existing `Note`.</p> |
| <p class="toc_element"> |
| <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Sets the access control policy on the specified `Note` or `Occurrence`.</p> |
| <p class="toc_element"> |
| <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns the permissions that a caller has on the specified note or</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="create">create(name, body=None, noteId=None, parent=None, x__xgafv=None)</code> |
| <pre>Creates a new `Note`. |
| |
| Args: |
| name: string, The name of the project. |
| Should be of the form "providers/{provider_id}". |
| @Deprecated (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Provides a detailed description of a `Note`. |
| "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. |
| { # This represents a particular channel of distribution for a given package. |
| # e.g. Debian's jessie-backports dpkg mirror |
| "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/ |
| "name": "A String", # The main part of the version name. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "maintainer": "A String", # A freeform string denoting the maintainer of this package. |
| "architecture": "A String", # The CPU architecture for which packages in this distribution |
| # channel were built |
| "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. |
| }, |
| ], |
| "name": "A String", # The name of the package. |
| }, |
| "name": "A String", # The name of the note in the form |
| # "projects/{provider_project_id}/notes/{NOTE_ID}" |
| "relatedUrl": [ # URLs associated with this note |
| { # Metadata for any related URL information |
| "label": "A String", # Label to describe usage of the URL |
| "url": "A String", # Specific URL to associate with the note |
| }, |
| ], |
| "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. |
| "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. |
| "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. |
| "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. |
| }, |
| }, |
| "createTime": "A String", # Output only. The time this note was created. This field can be used as a |
| # filter in list requests. |
| "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note. |
| "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 |
| "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to |
| # obsolete details. |
| "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. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "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. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "packageType": "A String", # The type of package; whether native or non native(ruby gems, |
| # node.js packages etc) |
| "fixedLocation": { # The location of the vulnerability # The fix for this specific package version. |
| "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/ |
| "name": "A String", # The main part of the version name. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "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. |
| "package": "A String", # The package being described. |
| }, |
| "description": "A String", # A vendor-specific description of this note. |
| "package": "A String", # The name of the package where the vulnerability was found. |
| # This field can be used as a filter in list requests. |
| "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. |
| }, |
| ], |
| "severity": "A String", # Note provider assigned impact of the vulnerability |
| "cvssScore": 3.14, # The CVSS score for this Vulnerability. |
| }, |
| "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. |
| "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this |
| # `BuilderDetails`. |
| "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. |
| "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in |
| # `key_id` |
| "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. |
| # |
| # This field may be empty if `key_id` references an external key. |
| # |
| # For Cloud Build based signatures, this is a PEM encoded public |
| # key. To verify the Cloud Build signature, place the contents of |
| # this field into a file (public.pem). The signature field is base64-decoded |
| # into its binary representation in signature.bin, and the provenance bytes |
| # 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` |
| }, |
| "builderVersion": "A String", # Version of the builder which produced this Note. |
| }, |
| "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. |
| "longDescription": "A String", # A detailed description of this `Note`. |
| "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", |
| ], |
| }, |
| "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as |
| # a filter in list requests. |
| "shortDescription": "A String", # A one sentence description of this `Note`. |
| "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. |
| }, |
| "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". |
| }, |
| }, |
| "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. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "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. |
| "classification": "A String", # The operating system classification of this Upgrade, as specified by the |
| # upstream operating system upgrade feed. |
| "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See |
| # https://cpe.mitre.org/specification/. |
| "severity": "A String", # The severity as specified by the upstream operating system. |
| "cve": [ # The cve that would be resolved by this upgrade. |
| "A String", |
| ], |
| }, |
| ], |
| }, |
| } |
| |
| noteId: string, The ID to use for this note. |
| parent: string, This field contains the project Id for example: |
| "projects/{project_id} |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Provides a detailed description of a `Note`. |
| "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. |
| { # This represents a particular channel of distribution for a given package. |
| # e.g. Debian's jessie-backports dpkg mirror |
| "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/ |
| "name": "A String", # The main part of the version name. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "maintainer": "A String", # A freeform string denoting the maintainer of this package. |
| "architecture": "A String", # The CPU architecture for which packages in this distribution |
| # channel were built |
| "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. |
| }, |
| ], |
| "name": "A String", # The name of the package. |
| }, |
| "name": "A String", # The name of the note in the form |
| # "projects/{provider_project_id}/notes/{NOTE_ID}" |
| "relatedUrl": [ # URLs associated with this note |
| { # Metadata for any related URL information |
| "label": "A String", # Label to describe usage of the URL |
| "url": "A String", # Specific URL to associate with the note |
| }, |
| ], |
| "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. |
| "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. |
| "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. |
| "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. |
| }, |
| }, |
| "createTime": "A String", # Output only. The time this note was created. This field can be used as a |
| # filter in list requests. |
| "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note. |
| "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 |
| "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to |
| # obsolete details. |
| "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. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "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. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "packageType": "A String", # The type of package; whether native or non native(ruby gems, |
| # node.js packages etc) |
| "fixedLocation": { # The location of the vulnerability # The fix for this specific package version. |
| "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/ |
| "name": "A String", # The main part of the version name. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "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. |
| "package": "A String", # The package being described. |
| }, |
| "description": "A String", # A vendor-specific description of this note. |
| "package": "A String", # The name of the package where the vulnerability was found. |
| # This field can be used as a filter in list requests. |
| "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. |
| }, |
| ], |
| "severity": "A String", # Note provider assigned impact of the vulnerability |
| "cvssScore": 3.14, # The CVSS score for this Vulnerability. |
| }, |
| "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. |
| "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this |
| # `BuilderDetails`. |
| "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. |
| "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in |
| # `key_id` |
| "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. |
| # |
| # This field may be empty if `key_id` references an external key. |
| # |
| # For Cloud Build based signatures, this is a PEM encoded public |
| # key. To verify the Cloud Build signature, place the contents of |
| # this field into a file (public.pem). The signature field is base64-decoded |
| # into its binary representation in signature.bin, and the provenance bytes |
| # 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` |
| }, |
| "builderVersion": "A String", # Version of the builder which produced this Note. |
| }, |
| "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. |
| "longDescription": "A String", # A detailed description of this `Note`. |
| "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", |
| ], |
| }, |
| "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as |
| # a filter in list requests. |
| "shortDescription": "A String", # A one sentence description of this `Note`. |
| "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. |
| }, |
| "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". |
| }, |
| }, |
| "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. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "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. |
| "classification": "A String", # The operating system classification of this Upgrade, as specified by the |
| # upstream operating system upgrade feed. |
| "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See |
| # https://cpe.mitre.org/specification/. |
| "severity": "A String", # The severity as specified by the upstream operating system. |
| "cve": [ # The cve that would be resolved by this upgrade. |
| "A String", |
| ], |
| }, |
| ], |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Deletes the given `Note` from the system. |
| |
| Args: |
| name: string, The name of the note in the form of |
| "providers/{provider_id}/notes/{NOTE_ID}" (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated |
| # empty messages in your APIs. A typical example is to use it as the request |
| # or the response type of an API method. For instance: |
| # |
| # service Foo { |
| # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| # } |
| # |
| # The JSON representation for `Empty` is empty JSON object `{}`. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Returns the requested `Note`. |
| |
| Args: |
| name: string, The name of the note in the form of |
| "providers/{provider_id}/notes/{NOTE_ID}" (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Provides a detailed description of a `Note`. |
| "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. |
| { # This represents a particular channel of distribution for a given package. |
| # e.g. Debian's jessie-backports dpkg mirror |
| "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/ |
| "name": "A String", # The main part of the version name. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "maintainer": "A String", # A freeform string denoting the maintainer of this package. |
| "architecture": "A String", # The CPU architecture for which packages in this distribution |
| # channel were built |
| "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. |
| }, |
| ], |
| "name": "A String", # The name of the package. |
| }, |
| "name": "A String", # The name of the note in the form |
| # "projects/{provider_project_id}/notes/{NOTE_ID}" |
| "relatedUrl": [ # URLs associated with this note |
| { # Metadata for any related URL information |
| "label": "A String", # Label to describe usage of the URL |
| "url": "A String", # Specific URL to associate with the note |
| }, |
| ], |
| "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. |
| "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. |
| "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. |
| "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. |
| }, |
| }, |
| "createTime": "A String", # Output only. The time this note was created. This field can be used as a |
| # filter in list requests. |
| "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note. |
| "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 |
| "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to |
| # obsolete details. |
| "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. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "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. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "packageType": "A String", # The type of package; whether native or non native(ruby gems, |
| # node.js packages etc) |
| "fixedLocation": { # The location of the vulnerability # The fix for this specific package version. |
| "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/ |
| "name": "A String", # The main part of the version name. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "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. |
| "package": "A String", # The package being described. |
| }, |
| "description": "A String", # A vendor-specific description of this note. |
| "package": "A String", # The name of the package where the vulnerability was found. |
| # This field can be used as a filter in list requests. |
| "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. |
| }, |
| ], |
| "severity": "A String", # Note provider assigned impact of the vulnerability |
| "cvssScore": 3.14, # The CVSS score for this Vulnerability. |
| }, |
| "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. |
| "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this |
| # `BuilderDetails`. |
| "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. |
| "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in |
| # `key_id` |
| "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. |
| # |
| # This field may be empty if `key_id` references an external key. |
| # |
| # For Cloud Build based signatures, this is a PEM encoded public |
| # key. To verify the Cloud Build signature, place the contents of |
| # this field into a file (public.pem). The signature field is base64-decoded |
| # into its binary representation in signature.bin, and the provenance bytes |
| # 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` |
| }, |
| "builderVersion": "A String", # Version of the builder which produced this Note. |
| }, |
| "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. |
| "longDescription": "A String", # A detailed description of this `Note`. |
| "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", |
| ], |
| }, |
| "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as |
| # a filter in list requests. |
| "shortDescription": "A String", # A one sentence description of this `Note`. |
| "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. |
| }, |
| "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". |
| }, |
| }, |
| "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. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "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. |
| "classification": "A String", # The operating system classification of this Upgrade, as specified by the |
| # upstream operating system upgrade feed. |
| "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See |
| # https://cpe.mitre.org/specification/. |
| "severity": "A String", # The severity as specified by the upstream operating system. |
| "cve": [ # The cve that would be resolved by this upgrade. |
| "A String", |
| ], |
| }, |
| ], |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code> |
| <pre>Gets the access control policy for a note or an `Occurrence` resource. |
| Requires `containeranalysis.notes.setIamPolicy` or |
| `containeranalysis.occurrences.setIamPolicy` permission if the resource is |
| a note or occurrence, respectively. |
| Attempting to call this method on a resource without the required |
| permission will result in a `PERMISSION_DENIED` error. 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 following formats: |
| `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for occurrences and |
| projects/{PROJECT_ID}/notes/{NOTE_ID} for notes |
| |
| Args: |
| resource: string, REQUIRED: The resource for which the policy is being requested. |
| See the operation documentation for the appropriate value for this field. (required) |
| body: object, The request body. |
| 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 |
| # `GetIamPolicy`. |
| "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. |
| # |
| # 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). |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # An Identity and Access Management (IAM) policy, which specifies access |
| # controls for Google Cloud resources. |
| # |
| # |
| # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| # `members` to a single `role`. Members can be user accounts, service accounts, |
| # Google groups, and domains (such as G Suite). A `role` is a named list of |
| # permissions; each `role` can be an IAM predefined role or a user-created |
| # custom role. |
| # |
| # 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": [ |
| # { |
| # "role": "roles/resourcemanager.organizationAdmin", |
| # "members": [ |
| # "user:mike@example.com", |
| # "group:admins@example.com", |
| # "domain:google.com", |
| # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| # ] |
| # }, |
| # { |
| # "role": "roles/resourcemanager.organizationViewer", |
| # "members": [ |
| # "user:eve@example.com" |
| # ], |
| # "condition": { |
| # "title": "expirable access", |
| # "description": "Does not grant access after Sep 2020", |
| # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| # } |
| # } |
| # ], |
| # "etag": "BwWWja0YfJA=", |
| # "version": 3 |
| # } |
| # |
| # **YAML example:** |
| # |
| # bindings: |
| # - members: |
| # - user:mike@example.com |
| # - group:admins@example.com |
| # - domain:google.com |
| # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| # role: roles/resourcemanager.organizationAdmin |
| # - members: |
| # - user:eve@example.com |
| # role: roles/resourcemanager.organizationViewer |
| # condition: |
| # title: expirable access |
| # description: Does not grant access after Sep 2020 |
| # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| # - etag: BwWWja0YfJA= |
| # - version: 3 |
| # |
| # For a description of IAM and its features, see the |
| # [IAM documentation](https://cloud.google.com/iam/docs/). |
| "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`. |
| "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. |
| "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. |
| "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. |
| "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 |
| # on the internet; with or without a Google account. |
| # |
| # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| # who is authenticated with a Google account or a service account. |
| # |
| # * `user:{emailid}`: An email address that represents a specific Google |
| # account. For example, `alice@example.com` . |
| # |
| # |
| # * `serviceAccount:{emailid}`: An email address that represents a service |
| # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| # |
| # * `group:{emailid}`: An email address that represents a Google group. |
| # For example, `admins@example.com`. |
| # |
| # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a user that has been recently deleted. For |
| # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| # recovered, this value reverts to `user:{emailid}` and the recovered user |
| # retains the role in the binding. |
| # |
| # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| # unique identifier) representing a service account that has been recently |
| # deleted. For example, |
| # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| # If the service account is undeleted, this value reverts to |
| # `serviceAccount:{emailid}` and the undeleted service account retains the |
| # role in the binding. |
| # |
| # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a Google group that has been recently |
| # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| # the group is recovered, this value reverts to `group:{emailid}` and the |
| # recovered group retains the role in the binding. |
| # |
| # |
| # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| # users of that domain. For example, `google.com` or `example.com`. |
| # |
| "A String", |
| ], |
| "role": "A String", # Role that is assigned to `members`. |
| # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| }, |
| ], |
| "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). |
| "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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(name, pageToken=None, pageSize=None, filter=None, parent=None, x__xgafv=None)</code> |
| <pre>Lists all `Notes` for a given project. |
| |
| Args: |
| name: string, The name field will contain the project Id for example: |
| "providers/{provider_id} |
| @Deprecated (required) |
| pageToken: string, Token to provide to skip to a particular spot in the list. |
| pageSize: integer, Number of notes to return in the list. |
| filter: string, The filter expression. |
| parent: string, This field contains the project Id for example: "projects/{PROJECT_ID}". |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response including listed notes. |
| "notes": [ # The occurrences requested |
| { # Provides a detailed description of a `Note`. |
| "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. |
| { # This represents a particular channel of distribution for a given package. |
| # e.g. Debian's jessie-backports dpkg mirror |
| "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/ |
| "name": "A String", # The main part of the version name. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "maintainer": "A String", # A freeform string denoting the maintainer of this package. |
| "architecture": "A String", # The CPU architecture for which packages in this distribution |
| # channel were built |
| "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. |
| }, |
| ], |
| "name": "A String", # The name of the package. |
| }, |
| "name": "A String", # The name of the note in the form |
| # "projects/{provider_project_id}/notes/{NOTE_ID}" |
| "relatedUrl": [ # URLs associated with this note |
| { # Metadata for any related URL information |
| "label": "A String", # Label to describe usage of the URL |
| "url": "A String", # Specific URL to associate with the note |
| }, |
| ], |
| "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. |
| "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. |
| "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. |
| "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. |
| }, |
| }, |
| "createTime": "A String", # Output only. The time this note was created. This field can be used as a |
| # filter in list requests. |
| "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note. |
| "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 |
| "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to |
| # obsolete details. |
| "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. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "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. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "packageType": "A String", # The type of package; whether native or non native(ruby gems, |
| # node.js packages etc) |
| "fixedLocation": { # The location of the vulnerability # The fix for this specific package version. |
| "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/ |
| "name": "A String", # The main part of the version name. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "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. |
| "package": "A String", # The package being described. |
| }, |
| "description": "A String", # A vendor-specific description of this note. |
| "package": "A String", # The name of the package where the vulnerability was found. |
| # This field can be used as a filter in list requests. |
| "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. |
| }, |
| ], |
| "severity": "A String", # Note provider assigned impact of the vulnerability |
| "cvssScore": 3.14, # The CVSS score for this Vulnerability. |
| }, |
| "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. |
| "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this |
| # `BuilderDetails`. |
| "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. |
| "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in |
| # `key_id` |
| "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. |
| # |
| # This field may be empty if `key_id` references an external key. |
| # |
| # For Cloud Build based signatures, this is a PEM encoded public |
| # key. To verify the Cloud Build signature, place the contents of |
| # this field into a file (public.pem). The signature field is base64-decoded |
| # into its binary representation in signature.bin, and the provenance bytes |
| # 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` |
| }, |
| "builderVersion": "A String", # Version of the builder which produced this Note. |
| }, |
| "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. |
| "longDescription": "A String", # A detailed description of this `Note`. |
| "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", |
| ], |
| }, |
| "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as |
| # a filter in list requests. |
| "shortDescription": "A String", # A one sentence description of this `Note`. |
| "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. |
| }, |
| "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". |
| }, |
| }, |
| "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. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "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. |
| "classification": "A String", # The operating system classification of this Upgrade, as specified by the |
| # upstream operating system upgrade feed. |
| "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See |
| # https://cpe.mitre.org/specification/. |
| "severity": "A String", # The severity as specified by the upstream operating system. |
| "cve": [ # The cve that would be resolved by this upgrade. |
| "A String", |
| ], |
| }, |
| ], |
| }, |
| }, |
| ], |
| "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> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| 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 |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Updates an existing `Note`. |
| |
| Args: |
| name: string, The name of the note. |
| 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`. |
| "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. |
| { # This represents a particular channel of distribution for a given package. |
| # e.g. Debian's jessie-backports dpkg mirror |
| "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/ |
| "name": "A String", # The main part of the version name. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "maintainer": "A String", # A freeform string denoting the maintainer of this package. |
| "architecture": "A String", # The CPU architecture for which packages in this distribution |
| # channel were built |
| "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. |
| }, |
| ], |
| "name": "A String", # The name of the package. |
| }, |
| "name": "A String", # The name of the note in the form |
| # "projects/{provider_project_id}/notes/{NOTE_ID}" |
| "relatedUrl": [ # URLs associated with this note |
| { # Metadata for any related URL information |
| "label": "A String", # Label to describe usage of the URL |
| "url": "A String", # Specific URL to associate with the note |
| }, |
| ], |
| "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. |
| "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. |
| "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. |
| "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. |
| }, |
| }, |
| "createTime": "A String", # Output only. The time this note was created. This field can be used as a |
| # filter in list requests. |
| "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note. |
| "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 |
| "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to |
| # obsolete details. |
| "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. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "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. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "packageType": "A String", # The type of package; whether native or non native(ruby gems, |
| # node.js packages etc) |
| "fixedLocation": { # The location of the vulnerability # The fix for this specific package version. |
| "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/ |
| "name": "A String", # The main part of the version name. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "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. |
| "package": "A String", # The package being described. |
| }, |
| "description": "A String", # A vendor-specific description of this note. |
| "package": "A String", # The name of the package where the vulnerability was found. |
| # This field can be used as a filter in list requests. |
| "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. |
| }, |
| ], |
| "severity": "A String", # Note provider assigned impact of the vulnerability |
| "cvssScore": 3.14, # The CVSS score for this Vulnerability. |
| }, |
| "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. |
| "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this |
| # `BuilderDetails`. |
| "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. |
| "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in |
| # `key_id` |
| "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. |
| # |
| # This field may be empty if `key_id` references an external key. |
| # |
| # For Cloud Build based signatures, this is a PEM encoded public |
| # key. To verify the Cloud Build signature, place the contents of |
| # this field into a file (public.pem). The signature field is base64-decoded |
| # into its binary representation in signature.bin, and the provenance bytes |
| # 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` |
| }, |
| "builderVersion": "A String", # Version of the builder which produced this Note. |
| }, |
| "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. |
| "longDescription": "A String", # A detailed description of this `Note`. |
| "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", |
| ], |
| }, |
| "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as |
| # a filter in list requests. |
| "shortDescription": "A String", # A one sentence description of this `Note`. |
| "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. |
| }, |
| "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". |
| }, |
| }, |
| "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. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "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. |
| "classification": "A String", # The operating system classification of this Upgrade, as specified by the |
| # upstream operating system upgrade feed. |
| "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See |
| # https://cpe.mitre.org/specification/. |
| "severity": "A String", # The severity as specified by the upstream operating system. |
| "cve": [ # The cve that would be resolved by this upgrade. |
| "A String", |
| ], |
| }, |
| ], |
| }, |
| } |
| |
| updateMask: string, The fields to update. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Provides a detailed description of a `Note`. |
| "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. |
| { # This represents a particular channel of distribution for a given package. |
| # e.g. Debian's jessie-backports dpkg mirror |
| "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/ |
| "name": "A String", # The main part of the version name. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "maintainer": "A String", # A freeform string denoting the maintainer of this package. |
| "architecture": "A String", # The CPU architecture for which packages in this distribution |
| # channel were built |
| "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. |
| }, |
| ], |
| "name": "A String", # The name of the package. |
| }, |
| "name": "A String", # The name of the note in the form |
| # "projects/{provider_project_id}/notes/{NOTE_ID}" |
| "relatedUrl": [ # URLs associated with this note |
| { # Metadata for any related URL information |
| "label": "A String", # Label to describe usage of the URL |
| "url": "A String", # Specific URL to associate with the note |
| }, |
| ], |
| "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. |
| "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. |
| "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. |
| "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. |
| }, |
| }, |
| "createTime": "A String", # Output only. The time this note was created. This field can be used as a |
| # filter in list requests. |
| "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note. |
| "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 |
| "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to |
| # obsolete details. |
| "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. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "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. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "packageType": "A String", # The type of package; whether native or non native(ruby gems, |
| # node.js packages etc) |
| "fixedLocation": { # The location of the vulnerability # The fix for this specific package version. |
| "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/ |
| "name": "A String", # The main part of the version name. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "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. |
| "package": "A String", # The package being described. |
| }, |
| "description": "A String", # A vendor-specific description of this note. |
| "package": "A String", # The name of the package where the vulnerability was found. |
| # This field can be used as a filter in list requests. |
| "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. |
| }, |
| ], |
| "severity": "A String", # Note provider assigned impact of the vulnerability |
| "cvssScore": 3.14, # The CVSS score for this Vulnerability. |
| }, |
| "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. |
| "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this |
| # `BuilderDetails`. |
| "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. |
| "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in |
| # `key_id` |
| "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. |
| # |
| # This field may be empty if `key_id` references an external key. |
| # |
| # For Cloud Build based signatures, this is a PEM encoded public |
| # key. To verify the Cloud Build signature, place the contents of |
| # this field into a file (public.pem). The signature field is base64-decoded |
| # into its binary representation in signature.bin, and the provenance bytes |
| # 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` |
| }, |
| "builderVersion": "A String", # Version of the builder which produced this Note. |
| }, |
| "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. |
| "longDescription": "A String", # A detailed description of this `Note`. |
| "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", |
| ], |
| }, |
| "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as |
| # a filter in list requests. |
| "shortDescription": "A String", # A one sentence description of this `Note`. |
| "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. |
| }, |
| "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". |
| }, |
| }, |
| "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. |
| "revision": "A String", # The iteration of the package build from the above version. |
| "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. |
| }, |
| "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. |
| "classification": "A String", # The operating system classification of this Upgrade, as specified by the |
| # upstream operating system upgrade feed. |
| "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See |
| # https://cpe.mitre.org/specification/. |
| "severity": "A String", # The severity as specified by the upstream operating system. |
| "cve": [ # The cve that would be resolved by this upgrade. |
| "A String", |
| ], |
| }, |
| ], |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code> |
| <pre>Sets the access control policy on the specified `Note` or `Occurrence`. |
| Requires `containeranalysis.notes.setIamPolicy` or |
| `containeranalysis.occurrences.setIamPolicy` permission if the resource is |
| a `Note` or an `Occurrence`, respectively. |
| Attempting to call this method without these permissions will result in a ` |
| `PERMISSION_DENIED` error. |
| Attempting to call this method on a non-existent resource will result in a |
| `NOT_FOUND` error if the user has `containeranalysis.notes.list` permission |
| on a `Note` or `containeranalysis.occurrences.list` on an `Occurrence`, or |
| a `PERMISSION_DENIED` error otherwise. The resource takes the following |
| formats: `projects/{projectid}/occurrences/{occurrenceid}` for occurrences |
| and projects/{projectid}/notes/{noteid} for notes |
| |
| Args: |
| resource: string, REQUIRED: The resource for which the policy is being specified. |
| See the operation documentation for the appropriate value for this field. (required) |
| body: object, The request body. |
| 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 |
| # 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. |
| # controls for Google Cloud resources. |
| # |
| # |
| # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| # `members` to a single `role`. Members can be user accounts, service accounts, |
| # Google groups, and domains (such as G Suite). A `role` is a named list of |
| # permissions; each `role` can be an IAM predefined role or a user-created |
| # custom role. |
| # |
| # 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": [ |
| # { |
| # "role": "roles/resourcemanager.organizationAdmin", |
| # "members": [ |
| # "user:mike@example.com", |
| # "group:admins@example.com", |
| # "domain:google.com", |
| # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| # ] |
| # }, |
| # { |
| # "role": "roles/resourcemanager.organizationViewer", |
| # "members": [ |
| # "user:eve@example.com" |
| # ], |
| # "condition": { |
| # "title": "expirable access", |
| # "description": "Does not grant access after Sep 2020", |
| # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| # } |
| # } |
| # ], |
| # "etag": "BwWWja0YfJA=", |
| # "version": 3 |
| # } |
| # |
| # **YAML example:** |
| # |
| # bindings: |
| # - members: |
| # - user:mike@example.com |
| # - group:admins@example.com |
| # - domain:google.com |
| # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| # role: roles/resourcemanager.organizationAdmin |
| # - members: |
| # - user:eve@example.com |
| # role: roles/resourcemanager.organizationViewer |
| # condition: |
| # title: expirable access |
| # description: Does not grant access after Sep 2020 |
| # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| # - etag: BwWWja0YfJA= |
| # - version: 3 |
| # |
| # For a description of IAM and its features, see the |
| # [IAM documentation](https://cloud.google.com/iam/docs/). |
| "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`. |
| "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. |
| "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. |
| "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. |
| "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 |
| # on the internet; with or without a Google account. |
| # |
| # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| # who is authenticated with a Google account or a service account. |
| # |
| # * `user:{emailid}`: An email address that represents a specific Google |
| # account. For example, `alice@example.com` . |
| # |
| # |
| # * `serviceAccount:{emailid}`: An email address that represents a service |
| # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| # |
| # * `group:{emailid}`: An email address that represents a Google group. |
| # For example, `admins@example.com`. |
| # |
| # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a user that has been recently deleted. For |
| # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| # recovered, this value reverts to `user:{emailid}` and the recovered user |
| # retains the role in the binding. |
| # |
| # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| # unique identifier) representing a service account that has been recently |
| # deleted. For example, |
| # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| # If the service account is undeleted, this value reverts to |
| # `serviceAccount:{emailid}` and the undeleted service account retains the |
| # role in the binding. |
| # |
| # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a Google group that has been recently |
| # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| # the group is recovered, this value reverts to `group:{emailid}` and the |
| # recovered group retains the role in the binding. |
| # |
| # |
| # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| # users of that domain. For example, `google.com` or `example.com`. |
| # |
| "A String", |
| ], |
| "role": "A String", # Role that is assigned to `members`. |
| # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| }, |
| ], |
| "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). |
| "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. |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # An Identity and Access Management (IAM) policy, which specifies access |
| # controls for Google Cloud resources. |
| # |
| # |
| # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| # `members` to a single `role`. Members can be user accounts, service accounts, |
| # Google groups, and domains (such as G Suite). A `role` is a named list of |
| # permissions; each `role` can be an IAM predefined role or a user-created |
| # custom role. |
| # |
| # 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": [ |
| # { |
| # "role": "roles/resourcemanager.organizationAdmin", |
| # "members": [ |
| # "user:mike@example.com", |
| # "group:admins@example.com", |
| # "domain:google.com", |
| # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| # ] |
| # }, |
| # { |
| # "role": "roles/resourcemanager.organizationViewer", |
| # "members": [ |
| # "user:eve@example.com" |
| # ], |
| # "condition": { |
| # "title": "expirable access", |
| # "description": "Does not grant access after Sep 2020", |
| # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| # } |
| # } |
| # ], |
| # "etag": "BwWWja0YfJA=", |
| # "version": 3 |
| # } |
| # |
| # **YAML example:** |
| # |
| # bindings: |
| # - members: |
| # - user:mike@example.com |
| # - group:admins@example.com |
| # - domain:google.com |
| # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| # role: roles/resourcemanager.organizationAdmin |
| # - members: |
| # - user:eve@example.com |
| # role: roles/resourcemanager.organizationViewer |
| # condition: |
| # title: expirable access |
| # description: Does not grant access after Sep 2020 |
| # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| # - etag: BwWWja0YfJA= |
| # - version: 3 |
| # |
| # For a description of IAM and its features, see the |
| # [IAM documentation](https://cloud.google.com/iam/docs/). |
| "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`. |
| "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. |
| "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. |
| "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. |
| "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 |
| # on the internet; with or without a Google account. |
| # |
| # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| # who is authenticated with a Google account or a service account. |
| # |
| # * `user:{emailid}`: An email address that represents a specific Google |
| # account. For example, `alice@example.com` . |
| # |
| # |
| # * `serviceAccount:{emailid}`: An email address that represents a service |
| # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| # |
| # * `group:{emailid}`: An email address that represents a Google group. |
| # For example, `admins@example.com`. |
| # |
| # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a user that has been recently deleted. For |
| # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| # recovered, this value reverts to `user:{emailid}` and the recovered user |
| # retains the role in the binding. |
| # |
| # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| # unique identifier) representing a service account that has been recently |
| # deleted. For example, |
| # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| # If the service account is undeleted, this value reverts to |
| # `serviceAccount:{emailid}` and the undeleted service account retains the |
| # role in the binding. |
| # |
| # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a Google group that has been recently |
| # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| # the group is recovered, this value reverts to `group:{emailid}` and the |
| # recovered group retains the role in the binding. |
| # |
| # |
| # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| # users of that domain. For example, `google.com` or `example.com`. |
| # |
| "A String", |
| ], |
| "role": "A String", # Role that is assigned to `members`. |
| # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| }, |
| ], |
| "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). |
| "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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <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 |
| 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 |
| following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for |
| `Occurrences` and `projects/{PROJECT_ID}/notes/{NOTE_ID}` for `Notes` |
| |
| Args: |
| resource: string, REQUIRED: The resource for which the policy detail is being requested. |
| See the operation documentation for the appropriate value for this field. (required) |
| body: object, The request body. |
| 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 |
| # information see |
| # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). |
| "A String", |
| ], |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for `TestIamPermissions` method. |
| "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is |
| # allowed. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| </body></html> |
