| yoshi-code-bot | 31fbcc0 | 2021-06-02 00:52:03 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="privateca_v1.html">Certificate Authority API</a> . <a href="privateca_v1.projects.html">projects</a> . <a href="privateca_v1.projects.locations.html">locations</a> . <a href="privateca_v1.projects.locations.caPools.html">caPools</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="privateca_v1.projects.locations.caPools.certificateAuthorities.html">certificateAuthorities()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the certificateAuthorities Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| yoshi-code-bot | 8759538 | 2021-06-05 00:38:05 -0700 | [diff] [blame] | 83 | <code><a href="privateca_v1.projects.locations.caPools.certificates.html">certificates()</a></code> |
| 84 | </p> |
| 85 | <p class="firstline">Returns the certificates Resource.</p> |
| 86 | |
| 87 | <p class="toc_element"> |
| yoshi-code-bot | 31fbcc0 | 2021-06-02 00:52:03 -0700 | [diff] [blame] | 88 | <code><a href="#close">close()</a></code></p> |
| 89 | <p class="firstline">Close httplib2 connections.</p> |
| 90 | <p class="toc_element"> |
| yoshi-code-bot | 8759538 | 2021-06-05 00:38:05 -0700 | [diff] [blame] | 91 | <code><a href="#create">create(parent, body=None, caPoolId=None, requestId=None, x__xgafv=None)</a></code></p> |
| 92 | <p class="firstline">Create a CaPool.</p> |
| 93 | <p class="toc_element"> |
| 94 | <code><a href="#delete">delete(name, requestId=None, x__xgafv=None)</a></code></p> |
| 95 | <p class="firstline">Delete a CaPool.</p> |
| 96 | <p class="toc_element"> |
| 97 | <code><a href="#fetchCaCerts">fetchCaCerts(caPool, body=None, x__xgafv=None)</a></code></p> |
| 98 | <p class="firstline">FetchCaCerts returns the current trust anchor for the CaPool. This will include CA certificate chains for all ACTIVE CertificateAuthority resources in the CaPool.</p> |
| 99 | <p class="toc_element"> |
| 100 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 101 | <p class="firstline">Returns a CaPool.</p> |
| 102 | <p class="toc_element"> |
| yoshi-code-bot | 31fbcc0 | 2021-06-02 00:52:03 -0700 | [diff] [blame] | 103 | <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p> |
| 104 | <p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p> |
| 105 | <p class="toc_element"> |
| yoshi-code-bot | 8759538 | 2021-06-05 00:38:05 -0700 | [diff] [blame] | 106 | <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 107 | <p class="firstline">Lists CaPools.</p> |
| 108 | <p class="toc_element"> |
| 109 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 110 | <p class="firstline">Retrieves the next page of results.</p> |
| 111 | <p class="toc_element"> |
| 112 | <code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 113 | <p class="firstline">Update a CaPool.</p> |
| 114 | <p class="toc_element"> |
| yoshi-code-bot | 31fbcc0 | 2021-06-02 00:52:03 -0700 | [diff] [blame] | 115 | <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> |
| 116 | <p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.</p> |
| 117 | <p class="toc_element"> |
| 118 | <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p> |
| 119 | <p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p> |
| 120 | <h3>Method Details</h3> |
| 121 | <div class="method"> |
| 122 | <code class="details" id="close">close()</code> |
| 123 | <pre>Close httplib2 connections.</pre> |
| 124 | </div> |
| 125 | |
| 126 | <div class="method"> |
| yoshi-code-bot | 8759538 | 2021-06-05 00:38:05 -0700 | [diff] [blame] | 127 | <code class="details" id="create">create(parent, body=None, caPoolId=None, requestId=None, x__xgafv=None)</code> |
| 128 | <pre>Create a CaPool. |
| 129 | |
| 130 | Args: |
| 131 | parent: string, Required. The resource name of the location associated with the CaPool, in the format `projects/*/locations/*`. (required) |
| 132 | body: object, The request body. |
| 133 | The object takes the form of: |
| 134 | |
| 135 | { # A CaPool represents a group of CertificateAuthorities that form a trust anchor. A CaPool can be used to manage issuance policies for one or more CertificateAuthority resources and to rotate CA certificates in and out of the trust anchor. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame^] | 136 | "createTime": "A String", # Output only. The time at which this CaPool was created. |
| yoshi-code-bot | 8759538 | 2021-06-05 00:38:05 -0700 | [diff] [blame] | 137 | "issuancePolicy": { # Defines controls over all certificate issuance within a CaPool. # Optional. The IssuancePolicy to control how Certificates will be issued from this CaPool. |
| 138 | "allowedIssuanceModes": { # IssuanceModes specifies the allowed ways in which Certificates may be requested from this CaPool. # Optional. If specified, then only methods allowed in the IssuanceModes may be used to issue Certificates. |
| 139 | "allowConfigBasedIssuance": True or False, # Optional. When true, allows callers to create Certificates by specifying a CertificateConfig. |
| 140 | "allowCsrBasedIssuance": True or False, # Optional. When true, allows callers to create Certificates by specifying a CSR. |
| 141 | }, |
| 142 | "allowedKeyTypes": [ # Optional. If any AllowedKeyType is specified, then the certificate request's public key must match one of the key types listed here. Otherwise, any key may be used. |
| 143 | { # Describes a "type" of key that may be used in a Certificate issued from a CaPool. Note that a single AllowedKeyType may refer to either a fully-qualified key algorithm, such as RSA 4096, or a family of key algorithms, such as any RSA key. |
| 144 | "ellipticCurve": { # Describes an Elliptic Curve key that may be used in a Certificate issued from a CaPool. # Represents an allowed Elliptic Curve key type. |
| 145 | "signatureAlgorithm": "A String", # Optional. A signature algorithm that must be used. If this is omitted, any EC-based signature algorithm will be allowed. |
| 146 | }, |
| 147 | "rsa": { # Describes an RSA key that may be used in a Certificate issued from a CaPool. # Represents an allowed RSA key type. |
| yoshi-code-bot | 9d63883 | 2021-10-05 00:20:14 -0700 | [diff] [blame] | 148 | "maxModulusSize": "A String", # Optional. The maximum allowed RSA modulus size (inclusive), in bits. If this is not set, or if set to zero, the service will not enforce an explicit upper bound on RSA modulus sizes. |
| 149 | "minModulusSize": "A String", # Optional. The minimum allowed RSA modulus size (inclusive), in bits. If this is not set, or if set to zero, the service-level min RSA modulus size will continue to apply. |
| yoshi-code-bot | 8759538 | 2021-06-05 00:38:05 -0700 | [diff] [blame] | 150 | }, |
| 151 | }, |
| 152 | ], |
| 153 | "baselineValues": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Optional. A set of X.509 values that will be applied to all certificates issued through this CaPool. If a certificate request includes conflicting values for the same properties, they will be overwritten by the values defined here. If a certificate request uses a CertificateTemplate that defines conflicting predefined_values for the same properties, the certificate issuance request will fail. |
| 154 | "additionalExtensions": [ # Optional. Describes custom X.509 extensions. |
| 155 | { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. |
| 156 | "critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error). |
| 157 | "objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension. |
| 158 | "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 159 | 42, |
| 160 | ], |
| 161 | }, |
| 162 | "value": "A String", # Required. The value of this X.509 extension. |
| 163 | }, |
| 164 | ], |
| 165 | "aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. |
| 166 | "A String", |
| 167 | ], |
| 168 | "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. |
| 169 | "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. |
| 170 | "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. |
| 171 | }, |
| 172 | "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. |
| 173 | "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. |
| 174 | "certSign": True or False, # The key may be used to sign certificates. |
| 175 | "contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation". |
| 176 | "crlSign": True or False, # The key may be used sign certificate revocation lists. |
| 177 | "dataEncipherment": True or False, # The key may be used to encipher data. |
| 178 | "decipherOnly": True or False, # The key may be used to decipher only. |
| 179 | "digitalSignature": True or False, # The key may be used for digital signatures. |
| 180 | "encipherOnly": True or False, # The key may be used to encipher only. |
| 181 | "keyAgreement": True or False, # The key may be used in a key agreement protocol. |
| 182 | "keyEncipherment": True or False, # The key may be used to encipher other keys. |
| 183 | }, |
| 184 | "extendedKeyUsage": { # KeyUsage.ExtendedKeyUsageOptions has fields that correspond to certain common OIDs that could be specified as an extended key usage value. # Detailed scenarios in which a key may be used. |
| 185 | "clientAuth": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.2. Officially described as "TLS WWW client authentication", though regularly used for non-WWW TLS. |
| 186 | "codeSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as "Signing of downloadable executable code client authentication". |
| 187 | "emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection". |
| 188 | "ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses". |
| 189 | "serverAuth": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.1. Officially described as "TLS WWW server authentication", though regularly used for non-WWW TLS. |
| 190 | "timeStamping": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as "Binding the hash of an object to a time". |
| 191 | }, |
| 192 | "unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message. |
| 193 | { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. |
| 194 | "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 195 | 42, |
| 196 | ], |
| 197 | }, |
| 198 | ], |
| 199 | }, |
| 200 | "policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4. |
| 201 | { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. |
| 202 | "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 203 | 42, |
| 204 | ], |
| 205 | }, |
| 206 | ], |
| 207 | }, |
| 208 | "identityConstraints": { # Describes constraints on a Certificate's Subject and SubjectAltNames. # Optional. Describes constraints on identities that may appear in Certificates issued through this CaPool. If this is omitted, then this CaPool will not add restrictions on a certificate's identity. |
| 209 | "allowSubjectAltNamesPassthrough": True or False, # Required. If this is true, the SubjectAltNames extension may be copied from a certificate request into the signed certificate. Otherwise, the requested SubjectAltNames will be discarded. |
| 210 | "allowSubjectPassthrough": True or False, # Required. If this is true, the Subject field may be copied from a certificate request into the signed certificate. Otherwise, the requested Subject will be discarded. |
| yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 211 | "celExpression": { # Represents a textual expression in the Common Expression Language (CEL) 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. # Optional. A CEL expression that may be used to validate the resolved X.509 Subject and/or Subject Alternative Name before a certificate is signed. To see the full allowed syntax and some examples, see https://cloud.google.com/certificate-authority-service/docs/using-cel |
| yoshi-code-bot | 8759538 | 2021-06-05 00:38:05 -0700 | [diff] [blame] | 212 | "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. |
| 213 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 214 | "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. |
| 215 | "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. |
| 216 | }, |
| 217 | }, |
| 218 | "maximumLifetime": "A String", # Optional. The maximum lifetime allowed for issued Certificates. Note that if the issuing CertificateAuthority expires before a Certificate's requested maximum_lifetime, the effective lifetime will be explicitly truncated to match it. |
| 219 | "passthroughExtensions": { # Describes a set of X.509 extensions that may be part of some certificate issuance controls. # Optional. Describes the set of X.509 extensions that may appear in a Certificate issued through this CaPool. If a certificate request sets extensions that don't appear in the passthrough_extensions, those extensions will be dropped. If a certificate request uses a CertificateTemplate with predefined_values that don't appear here, the certificate issuance request will fail. If this is omitted, then this CaPool will not add restrictions on a certificate's X.509 extensions. These constraints do not apply to X.509 extensions set in this CaPool's baseline_values. |
| 220 | "additionalExtensions": [ # Optional. A set of ObjectIds identifying custom X.509 extensions. Will be combined with known_extensions to determine the full set of X.509 extensions. |
| 221 | { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. |
| 222 | "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 223 | 42, |
| 224 | ], |
| 225 | }, |
| 226 | ], |
| 227 | "knownExtensions": [ # Optional. A set of named X.509 extensions. Will be combined with additional_extensions to determine the full set of X.509 extensions. |
| 228 | "A String", |
| 229 | ], |
| 230 | }, |
| 231 | }, |
| 232 | "labels": { # Optional. Labels with user-defined metadata. |
| 233 | "a_key": "A String", |
| 234 | }, |
| 235 | "name": "A String", # Output only. The resource name for this CaPool in the format `projects/*/locations/*/caPools/*`. |
| 236 | "publishingOptions": { # Options relating to the publication of each CertificateAuthority's CA certificate and CRLs and their inclusion as extensions in issued Certificates. The options set here apply to certificates issued by any CertificateAuthority in the CaPool. # Optional. The PublishingOptions to follow when issuing Certificates from any CertificateAuthority in this CaPool. |
| 237 | "publishCaCert": True or False, # Optional. When true, publishes each CertificateAuthority's CA certificate and includes its URL in the "Authority Information Access" X.509 extension in all issued Certificates. If this is false, the CA certificate will not be published and the corresponding X.509 extension will not be written in issued certificates. |
| 238 | "publishCrl": True or False, # Optional. When true, publishes each CertificateAuthority's CRL and includes its URL in the "CRL Distribution Points" X.509 extension in all issued Certificates. If this is false, CRLs will not be published and the corresponding X.509 extension will not be written in issued certificates. CRLs will expire 7 days from their creation. However, we will rebuild daily. CRLs are also rebuilt shortly after a certificate is revoked. |
| 239 | }, |
| 240 | "tier": "A String", # Required. Immutable. The Tier of this CaPool. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame^] | 241 | "updateTime": "A String", # Output only. The time at which this CaPool was last updated. |
| yoshi-code-bot | 8759538 | 2021-06-05 00:38:05 -0700 | [diff] [blame] | 242 | } |
| 243 | |
| 244 | caPoolId: string, Required. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}` |
| 245 | requestId: string, Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| 246 | x__xgafv: string, V1 error format. |
| 247 | Allowed values |
| 248 | 1 - v1 error format |
| 249 | 2 - v2 error format |
| 250 | |
| 251 | Returns: |
| 252 | An object of the form: |
| 253 | |
| 254 | { # This resource represents a long-running operation that is the result of a network API call. |
| 255 | "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| 256 | "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| 257 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 258 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 259 | { |
| 260 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 261 | }, |
| 262 | ], |
| 263 | "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| 264 | }, |
| 265 | "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| 266 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 267 | }, |
| 268 | "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| 269 | "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| 270 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 271 | }, |
| 272 | }</pre> |
| 273 | </div> |
| 274 | |
| 275 | <div class="method"> |
| 276 | <code class="details" id="delete">delete(name, requestId=None, x__xgafv=None)</code> |
| 277 | <pre>Delete a CaPool. |
| 278 | |
| 279 | Args: |
| 280 | name: string, Required. The resource name for this CaPool in the format `projects/*/locations/*/caPools/*`. (required) |
| 281 | requestId: string, Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| 282 | x__xgafv: string, V1 error format. |
| 283 | Allowed values |
| 284 | 1 - v1 error format |
| 285 | 2 - v2 error format |
| 286 | |
| 287 | Returns: |
| 288 | An object of the form: |
| 289 | |
| 290 | { # This resource represents a long-running operation that is the result of a network API call. |
| 291 | "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| 292 | "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| 293 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 294 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 295 | { |
| 296 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 297 | }, |
| 298 | ], |
| 299 | "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| 300 | }, |
| 301 | "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| 302 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 303 | }, |
| 304 | "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| 305 | "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| 306 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 307 | }, |
| 308 | }</pre> |
| 309 | </div> |
| 310 | |
| 311 | <div class="method"> |
| 312 | <code class="details" id="fetchCaCerts">fetchCaCerts(caPool, body=None, x__xgafv=None)</code> |
| 313 | <pre>FetchCaCerts returns the current trust anchor for the CaPool. This will include CA certificate chains for all ACTIVE CertificateAuthority resources in the CaPool. |
| 314 | |
| 315 | Args: |
| 316 | caPool: string, Required. The resource name for the CaPool in the format `projects/*/locations/*/caPools/*`. (required) |
| 317 | body: object, The request body. |
| 318 | The object takes the form of: |
| 319 | |
| 320 | { # Request message for CertificateAuthorityService.FetchCaCerts. |
| 321 | "requestId": "A String", # Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| 322 | } |
| 323 | |
| 324 | x__xgafv: string, V1 error format. |
| 325 | Allowed values |
| 326 | 1 - v1 error format |
| 327 | 2 - v2 error format |
| 328 | |
| 329 | Returns: |
| 330 | An object of the form: |
| 331 | |
| 332 | { # Response message for CertificateAuthorityService.FetchCaCerts. |
| 333 | "caCerts": [ # The PEM encoded CA certificate chains of all ACTIVE CertificateAuthority resources in this CaPool. |
| 334 | { |
| 335 | "certificates": [ # The certificates that form the CA chain, from leaf to root order. |
| 336 | "A String", |
| 337 | ], |
| 338 | }, |
| 339 | ], |
| 340 | }</pre> |
| 341 | </div> |
| 342 | |
| 343 | <div class="method"> |
| 344 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 345 | <pre>Returns a CaPool. |
| 346 | |
| 347 | Args: |
| 348 | name: string, Required. The name of the CaPool to get. (required) |
| 349 | x__xgafv: string, V1 error format. |
| 350 | Allowed values |
| 351 | 1 - v1 error format |
| 352 | 2 - v2 error format |
| 353 | |
| 354 | Returns: |
| 355 | An object of the form: |
| 356 | |
| 357 | { # A CaPool represents a group of CertificateAuthorities that form a trust anchor. A CaPool can be used to manage issuance policies for one or more CertificateAuthority resources and to rotate CA certificates in and out of the trust anchor. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame^] | 358 | "createTime": "A String", # Output only. The time at which this CaPool was created. |
| yoshi-code-bot | 8759538 | 2021-06-05 00:38:05 -0700 | [diff] [blame] | 359 | "issuancePolicy": { # Defines controls over all certificate issuance within a CaPool. # Optional. The IssuancePolicy to control how Certificates will be issued from this CaPool. |
| 360 | "allowedIssuanceModes": { # IssuanceModes specifies the allowed ways in which Certificates may be requested from this CaPool. # Optional. If specified, then only methods allowed in the IssuanceModes may be used to issue Certificates. |
| 361 | "allowConfigBasedIssuance": True or False, # Optional. When true, allows callers to create Certificates by specifying a CertificateConfig. |
| 362 | "allowCsrBasedIssuance": True or False, # Optional. When true, allows callers to create Certificates by specifying a CSR. |
| 363 | }, |
| 364 | "allowedKeyTypes": [ # Optional. If any AllowedKeyType is specified, then the certificate request's public key must match one of the key types listed here. Otherwise, any key may be used. |
| 365 | { # Describes a "type" of key that may be used in a Certificate issued from a CaPool. Note that a single AllowedKeyType may refer to either a fully-qualified key algorithm, such as RSA 4096, or a family of key algorithms, such as any RSA key. |
| 366 | "ellipticCurve": { # Describes an Elliptic Curve key that may be used in a Certificate issued from a CaPool. # Represents an allowed Elliptic Curve key type. |
| 367 | "signatureAlgorithm": "A String", # Optional. A signature algorithm that must be used. If this is omitted, any EC-based signature algorithm will be allowed. |
| 368 | }, |
| 369 | "rsa": { # Describes an RSA key that may be used in a Certificate issued from a CaPool. # Represents an allowed RSA key type. |
| yoshi-code-bot | 9d63883 | 2021-10-05 00:20:14 -0700 | [diff] [blame] | 370 | "maxModulusSize": "A String", # Optional. The maximum allowed RSA modulus size (inclusive), in bits. If this is not set, or if set to zero, the service will not enforce an explicit upper bound on RSA modulus sizes. |
| 371 | "minModulusSize": "A String", # Optional. The minimum allowed RSA modulus size (inclusive), in bits. If this is not set, or if set to zero, the service-level min RSA modulus size will continue to apply. |
| yoshi-code-bot | 8759538 | 2021-06-05 00:38:05 -0700 | [diff] [blame] | 372 | }, |
| 373 | }, |
| 374 | ], |
| 375 | "baselineValues": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Optional. A set of X.509 values that will be applied to all certificates issued through this CaPool. If a certificate request includes conflicting values for the same properties, they will be overwritten by the values defined here. If a certificate request uses a CertificateTemplate that defines conflicting predefined_values for the same properties, the certificate issuance request will fail. |
| 376 | "additionalExtensions": [ # Optional. Describes custom X.509 extensions. |
| 377 | { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. |
| 378 | "critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error). |
| 379 | "objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension. |
| 380 | "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 381 | 42, |
| 382 | ], |
| 383 | }, |
| 384 | "value": "A String", # Required. The value of this X.509 extension. |
| 385 | }, |
| 386 | ], |
| 387 | "aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. |
| 388 | "A String", |
| 389 | ], |
| 390 | "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. |
| 391 | "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. |
| 392 | "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. |
| 393 | }, |
| 394 | "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. |
| 395 | "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. |
| 396 | "certSign": True or False, # The key may be used to sign certificates. |
| 397 | "contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation". |
| 398 | "crlSign": True or False, # The key may be used sign certificate revocation lists. |
| 399 | "dataEncipherment": True or False, # The key may be used to encipher data. |
| 400 | "decipherOnly": True or False, # The key may be used to decipher only. |
| 401 | "digitalSignature": True or False, # The key may be used for digital signatures. |
| 402 | "encipherOnly": True or False, # The key may be used to encipher only. |
| 403 | "keyAgreement": True or False, # The key may be used in a key agreement protocol. |
| 404 | "keyEncipherment": True or False, # The key may be used to encipher other keys. |
| 405 | }, |
| 406 | "extendedKeyUsage": { # KeyUsage.ExtendedKeyUsageOptions has fields that correspond to certain common OIDs that could be specified as an extended key usage value. # Detailed scenarios in which a key may be used. |
| 407 | "clientAuth": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.2. Officially described as "TLS WWW client authentication", though regularly used for non-WWW TLS. |
| 408 | "codeSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as "Signing of downloadable executable code client authentication". |
| 409 | "emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection". |
| 410 | "ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses". |
| 411 | "serverAuth": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.1. Officially described as "TLS WWW server authentication", though regularly used for non-WWW TLS. |
| 412 | "timeStamping": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as "Binding the hash of an object to a time". |
| 413 | }, |
| 414 | "unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message. |
| 415 | { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. |
| 416 | "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 417 | 42, |
| 418 | ], |
| 419 | }, |
| 420 | ], |
| 421 | }, |
| 422 | "policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4. |
| 423 | { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. |
| 424 | "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 425 | 42, |
| 426 | ], |
| 427 | }, |
| 428 | ], |
| 429 | }, |
| 430 | "identityConstraints": { # Describes constraints on a Certificate's Subject and SubjectAltNames. # Optional. Describes constraints on identities that may appear in Certificates issued through this CaPool. If this is omitted, then this CaPool will not add restrictions on a certificate's identity. |
| 431 | "allowSubjectAltNamesPassthrough": True or False, # Required. If this is true, the SubjectAltNames extension may be copied from a certificate request into the signed certificate. Otherwise, the requested SubjectAltNames will be discarded. |
| 432 | "allowSubjectPassthrough": True or False, # Required. If this is true, the Subject field may be copied from a certificate request into the signed certificate. Otherwise, the requested Subject will be discarded. |
| yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 433 | "celExpression": { # Represents a textual expression in the Common Expression Language (CEL) 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. # Optional. A CEL expression that may be used to validate the resolved X.509 Subject and/or Subject Alternative Name before a certificate is signed. To see the full allowed syntax and some examples, see https://cloud.google.com/certificate-authority-service/docs/using-cel |
| yoshi-code-bot | 8759538 | 2021-06-05 00:38:05 -0700 | [diff] [blame] | 434 | "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. |
| 435 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 436 | "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. |
| 437 | "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. |
| 438 | }, |
| 439 | }, |
| 440 | "maximumLifetime": "A String", # Optional. The maximum lifetime allowed for issued Certificates. Note that if the issuing CertificateAuthority expires before a Certificate's requested maximum_lifetime, the effective lifetime will be explicitly truncated to match it. |
| 441 | "passthroughExtensions": { # Describes a set of X.509 extensions that may be part of some certificate issuance controls. # Optional. Describes the set of X.509 extensions that may appear in a Certificate issued through this CaPool. If a certificate request sets extensions that don't appear in the passthrough_extensions, those extensions will be dropped. If a certificate request uses a CertificateTemplate with predefined_values that don't appear here, the certificate issuance request will fail. If this is omitted, then this CaPool will not add restrictions on a certificate's X.509 extensions. These constraints do not apply to X.509 extensions set in this CaPool's baseline_values. |
| 442 | "additionalExtensions": [ # Optional. A set of ObjectIds identifying custom X.509 extensions. Will be combined with known_extensions to determine the full set of X.509 extensions. |
| 443 | { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. |
| 444 | "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 445 | 42, |
| 446 | ], |
| 447 | }, |
| 448 | ], |
| 449 | "knownExtensions": [ # Optional. A set of named X.509 extensions. Will be combined with additional_extensions to determine the full set of X.509 extensions. |
| 450 | "A String", |
| 451 | ], |
| 452 | }, |
| 453 | }, |
| 454 | "labels": { # Optional. Labels with user-defined metadata. |
| 455 | "a_key": "A String", |
| 456 | }, |
| 457 | "name": "A String", # Output only. The resource name for this CaPool in the format `projects/*/locations/*/caPools/*`. |
| 458 | "publishingOptions": { # Options relating to the publication of each CertificateAuthority's CA certificate and CRLs and their inclusion as extensions in issued Certificates. The options set here apply to certificates issued by any CertificateAuthority in the CaPool. # Optional. The PublishingOptions to follow when issuing Certificates from any CertificateAuthority in this CaPool. |
| 459 | "publishCaCert": True or False, # Optional. When true, publishes each CertificateAuthority's CA certificate and includes its URL in the "Authority Information Access" X.509 extension in all issued Certificates. If this is false, the CA certificate will not be published and the corresponding X.509 extension will not be written in issued certificates. |
| 460 | "publishCrl": True or False, # Optional. When true, publishes each CertificateAuthority's CRL and includes its URL in the "CRL Distribution Points" X.509 extension in all issued Certificates. If this is false, CRLs will not be published and the corresponding X.509 extension will not be written in issued certificates. CRLs will expire 7 days from their creation. However, we will rebuild daily. CRLs are also rebuilt shortly after a certificate is revoked. |
| 461 | }, |
| 462 | "tier": "A String", # Required. Immutable. The Tier of this CaPool. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame^] | 463 | "updateTime": "A String", # Output only. The time at which this CaPool was last updated. |
| yoshi-code-bot | 8759538 | 2021-06-05 00:38:05 -0700 | [diff] [blame] | 464 | }</pre> |
| 465 | </div> |
| 466 | |
| 467 | <div class="method"> |
| yoshi-code-bot | 31fbcc0 | 2021-06-02 00:52:03 -0700 | [diff] [blame] | 468 | <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code> |
| 469 | <pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. |
| 470 | |
| 471 | Args: |
| 472 | resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) |
| 473 | options_requestedPolicyVersion: integer, 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). |
| 474 | x__xgafv: string, V1 error format. |
| 475 | Allowed values |
| 476 | 1 - v1 error format |
| 477 | 2 - v2 error format |
| 478 | |
| 479 | Returns: |
| 480 | An object of the form: |
| 481 | |
| yoshi-code-bot | f4773f6 | 2021-10-19 00:22:31 -0700 | [diff] [blame] | 482 | { # 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`, or principals, to a single `role`. Principals 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/). |
| yoshi-code-bot | 31fbcc0 | 2021-06-02 00:52:03 -0700 | [diff] [blame] | 483 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| 484 | { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. |
| 485 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| 486 | { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. |
| 487 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. |
| 488 | "A String", |
| 489 | ], |
| 490 | "logType": "A String", # The log type that this config enables. |
| 491 | }, |
| 492 | ], |
| 493 | "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. |
| 494 | }, |
| 495 | ], |
| yoshi-code-bot | f4773f6 | 2021-10-19 00:22:31 -0700 | [diff] [blame] | 496 | "bindings": [ # Associates a list of `members`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. |
| 497 | { # Associates `members`, or principals, with a `role`. |
| 498 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) 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. # 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 principals 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). |
| yoshi-code-bot | 31fbcc0 | 2021-06-02 00:52:03 -0700 | [diff] [blame] | 499 | "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. |
| 500 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 501 | "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. |
| 502 | "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. |
| 503 | }, |
| yoshi-code-bot | f4773f6 | 2021-10-19 00:22:31 -0700 | [diff] [blame] | 504 | "members": [ # Specifies the principals 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`. |
| yoshi-code-bot | 31fbcc0 | 2021-06-02 00:52:03 -0700 | [diff] [blame] | 505 | "A String", |
| 506 | ], |
| yoshi-code-bot | f4773f6 | 2021-10-19 00:22:31 -0700 | [diff] [blame] | 507 | "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| yoshi-code-bot | 31fbcc0 | 2021-06-02 00:52:03 -0700 | [diff] [blame] | 508 | }, |
| 509 | ], |
| 510 | "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. |
| 511 | "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). |
| 512 | }</pre> |
| 513 | </div> |
| 514 | |
| 515 | <div class="method"> |
| yoshi-code-bot | 8759538 | 2021-06-05 00:38:05 -0700 | [diff] [blame] | 516 | <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 517 | <pre>Lists CaPools. |
| 518 | |
| 519 | Args: |
| 520 | parent: string, Required. The resource name of the location associated with the CaPools, in the format `projects/*/locations/*`. (required) |
| 521 | filter: string, Optional. Only include resources that match the filter in the response. |
| 522 | orderBy: string, Optional. Specify how the results should be sorted. |
| 523 | pageSize: integer, Optional. Limit on the number of CaPools to include in the response. Further CaPools can subsequently be obtained by including the ListCaPoolsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. |
| 524 | pageToken: string, Optional. Pagination token, returned earlier via ListCaPoolsResponse.next_page_token. |
| 525 | x__xgafv: string, V1 error format. |
| 526 | Allowed values |
| 527 | 1 - v1 error format |
| 528 | 2 - v2 error format |
| 529 | |
| 530 | Returns: |
| 531 | An object of the form: |
| 532 | |
| 533 | { # Response message for CertificateAuthorityService.ListCaPools. |
| 534 | "caPools": [ # The list of CaPools. |
| 535 | { # A CaPool represents a group of CertificateAuthorities that form a trust anchor. A CaPool can be used to manage issuance policies for one or more CertificateAuthority resources and to rotate CA certificates in and out of the trust anchor. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame^] | 536 | "createTime": "A String", # Output only. The time at which this CaPool was created. |
| yoshi-code-bot | 8759538 | 2021-06-05 00:38:05 -0700 | [diff] [blame] | 537 | "issuancePolicy": { # Defines controls over all certificate issuance within a CaPool. # Optional. The IssuancePolicy to control how Certificates will be issued from this CaPool. |
| 538 | "allowedIssuanceModes": { # IssuanceModes specifies the allowed ways in which Certificates may be requested from this CaPool. # Optional. If specified, then only methods allowed in the IssuanceModes may be used to issue Certificates. |
| 539 | "allowConfigBasedIssuance": True or False, # Optional. When true, allows callers to create Certificates by specifying a CertificateConfig. |
| 540 | "allowCsrBasedIssuance": True or False, # Optional. When true, allows callers to create Certificates by specifying a CSR. |
| 541 | }, |
| 542 | "allowedKeyTypes": [ # Optional. If any AllowedKeyType is specified, then the certificate request's public key must match one of the key types listed here. Otherwise, any key may be used. |
| 543 | { # Describes a "type" of key that may be used in a Certificate issued from a CaPool. Note that a single AllowedKeyType may refer to either a fully-qualified key algorithm, such as RSA 4096, or a family of key algorithms, such as any RSA key. |
| 544 | "ellipticCurve": { # Describes an Elliptic Curve key that may be used in a Certificate issued from a CaPool. # Represents an allowed Elliptic Curve key type. |
| 545 | "signatureAlgorithm": "A String", # Optional. A signature algorithm that must be used. If this is omitted, any EC-based signature algorithm will be allowed. |
| 546 | }, |
| 547 | "rsa": { # Describes an RSA key that may be used in a Certificate issued from a CaPool. # Represents an allowed RSA key type. |
| yoshi-code-bot | 9d63883 | 2021-10-05 00:20:14 -0700 | [diff] [blame] | 548 | "maxModulusSize": "A String", # Optional. The maximum allowed RSA modulus size (inclusive), in bits. If this is not set, or if set to zero, the service will not enforce an explicit upper bound on RSA modulus sizes. |
| 549 | "minModulusSize": "A String", # Optional. The minimum allowed RSA modulus size (inclusive), in bits. If this is not set, or if set to zero, the service-level min RSA modulus size will continue to apply. |
| yoshi-code-bot | 8759538 | 2021-06-05 00:38:05 -0700 | [diff] [blame] | 550 | }, |
| 551 | }, |
| 552 | ], |
| 553 | "baselineValues": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Optional. A set of X.509 values that will be applied to all certificates issued through this CaPool. If a certificate request includes conflicting values for the same properties, they will be overwritten by the values defined here. If a certificate request uses a CertificateTemplate that defines conflicting predefined_values for the same properties, the certificate issuance request will fail. |
| 554 | "additionalExtensions": [ # Optional. Describes custom X.509 extensions. |
| 555 | { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. |
| 556 | "critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error). |
| 557 | "objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension. |
| 558 | "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 559 | 42, |
| 560 | ], |
| 561 | }, |
| 562 | "value": "A String", # Required. The value of this X.509 extension. |
| 563 | }, |
| 564 | ], |
| 565 | "aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. |
| 566 | "A String", |
| 567 | ], |
| 568 | "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. |
| 569 | "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. |
| 570 | "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. |
| 571 | }, |
| 572 | "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. |
| 573 | "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. |
| 574 | "certSign": True or False, # The key may be used to sign certificates. |
| 575 | "contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation". |
| 576 | "crlSign": True or False, # The key may be used sign certificate revocation lists. |
| 577 | "dataEncipherment": True or False, # The key may be used to encipher data. |
| 578 | "decipherOnly": True or False, # The key may be used to decipher only. |
| 579 | "digitalSignature": True or False, # The key may be used for digital signatures. |
| 580 | "encipherOnly": True or False, # The key may be used to encipher only. |
| 581 | "keyAgreement": True or False, # The key may be used in a key agreement protocol. |
| 582 | "keyEncipherment": True or False, # The key may be used to encipher other keys. |
| 583 | }, |
| 584 | "extendedKeyUsage": { # KeyUsage.ExtendedKeyUsageOptions has fields that correspond to certain common OIDs that could be specified as an extended key usage value. # Detailed scenarios in which a key may be used. |
| 585 | "clientAuth": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.2. Officially described as "TLS WWW client authentication", though regularly used for non-WWW TLS. |
| 586 | "codeSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as "Signing of downloadable executable code client authentication". |
| 587 | "emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection". |
| 588 | "ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses". |
| 589 | "serverAuth": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.1. Officially described as "TLS WWW server authentication", though regularly used for non-WWW TLS. |
| 590 | "timeStamping": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as "Binding the hash of an object to a time". |
| 591 | }, |
| 592 | "unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message. |
| 593 | { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. |
| 594 | "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 595 | 42, |
| 596 | ], |
| 597 | }, |
| 598 | ], |
| 599 | }, |
| 600 | "policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4. |
| 601 | { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. |
| 602 | "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 603 | 42, |
| 604 | ], |
| 605 | }, |
| 606 | ], |
| 607 | }, |
| 608 | "identityConstraints": { # Describes constraints on a Certificate's Subject and SubjectAltNames. # Optional. Describes constraints on identities that may appear in Certificates issued through this CaPool. If this is omitted, then this CaPool will not add restrictions on a certificate's identity. |
| 609 | "allowSubjectAltNamesPassthrough": True or False, # Required. If this is true, the SubjectAltNames extension may be copied from a certificate request into the signed certificate. Otherwise, the requested SubjectAltNames will be discarded. |
| 610 | "allowSubjectPassthrough": True or False, # Required. If this is true, the Subject field may be copied from a certificate request into the signed certificate. Otherwise, the requested Subject will be discarded. |
| yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 611 | "celExpression": { # Represents a textual expression in the Common Expression Language (CEL) 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. # Optional. A CEL expression that may be used to validate the resolved X.509 Subject and/or Subject Alternative Name before a certificate is signed. To see the full allowed syntax and some examples, see https://cloud.google.com/certificate-authority-service/docs/using-cel |
| yoshi-code-bot | 8759538 | 2021-06-05 00:38:05 -0700 | [diff] [blame] | 612 | "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. |
| 613 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 614 | "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. |
| 615 | "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. |
| 616 | }, |
| 617 | }, |
| 618 | "maximumLifetime": "A String", # Optional. The maximum lifetime allowed for issued Certificates. Note that if the issuing CertificateAuthority expires before a Certificate's requested maximum_lifetime, the effective lifetime will be explicitly truncated to match it. |
| 619 | "passthroughExtensions": { # Describes a set of X.509 extensions that may be part of some certificate issuance controls. # Optional. Describes the set of X.509 extensions that may appear in a Certificate issued through this CaPool. If a certificate request sets extensions that don't appear in the passthrough_extensions, those extensions will be dropped. If a certificate request uses a CertificateTemplate with predefined_values that don't appear here, the certificate issuance request will fail. If this is omitted, then this CaPool will not add restrictions on a certificate's X.509 extensions. These constraints do not apply to X.509 extensions set in this CaPool's baseline_values. |
| 620 | "additionalExtensions": [ # Optional. A set of ObjectIds identifying custom X.509 extensions. Will be combined with known_extensions to determine the full set of X.509 extensions. |
| 621 | { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. |
| 622 | "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 623 | 42, |
| 624 | ], |
| 625 | }, |
| 626 | ], |
| 627 | "knownExtensions": [ # Optional. A set of named X.509 extensions. Will be combined with additional_extensions to determine the full set of X.509 extensions. |
| 628 | "A String", |
| 629 | ], |
| 630 | }, |
| 631 | }, |
| 632 | "labels": { # Optional. Labels with user-defined metadata. |
| 633 | "a_key": "A String", |
| 634 | }, |
| 635 | "name": "A String", # Output only. The resource name for this CaPool in the format `projects/*/locations/*/caPools/*`. |
| 636 | "publishingOptions": { # Options relating to the publication of each CertificateAuthority's CA certificate and CRLs and their inclusion as extensions in issued Certificates. The options set here apply to certificates issued by any CertificateAuthority in the CaPool. # Optional. The PublishingOptions to follow when issuing Certificates from any CertificateAuthority in this CaPool. |
| 637 | "publishCaCert": True or False, # Optional. When true, publishes each CertificateAuthority's CA certificate and includes its URL in the "Authority Information Access" X.509 extension in all issued Certificates. If this is false, the CA certificate will not be published and the corresponding X.509 extension will not be written in issued certificates. |
| 638 | "publishCrl": True or False, # Optional. When true, publishes each CertificateAuthority's CRL and includes its URL in the "CRL Distribution Points" X.509 extension in all issued Certificates. If this is false, CRLs will not be published and the corresponding X.509 extension will not be written in issued certificates. CRLs will expire 7 days from their creation. However, we will rebuild daily. CRLs are also rebuilt shortly after a certificate is revoked. |
| 639 | }, |
| 640 | "tier": "A String", # Required. Immutable. The Tier of this CaPool. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame^] | 641 | "updateTime": "A String", # Output only. The time at which this CaPool was last updated. |
| yoshi-code-bot | 8759538 | 2021-06-05 00:38:05 -0700 | [diff] [blame] | 642 | }, |
| 643 | ], |
| 644 | "nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in ListCertificateAuthoritiesRequest.next_page_token to retrieve the next page of results. |
| 645 | "unreachable": [ # A list of locations (e.g. "us-west1") that could not be reached. |
| 646 | "A String", |
| 647 | ], |
| 648 | }</pre> |
| 649 | </div> |
| 650 | |
| 651 | <div class="method"> |
| 652 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 653 | <pre>Retrieves the next page of results. |
| 654 | |
| 655 | Args: |
| 656 | previous_request: The request for the previous page. (required) |
| 657 | previous_response: The response from the request for the previous page. (required) |
| 658 | |
| 659 | Returns: |
| 660 | A request object that you can call 'execute()' on to request the next |
| 661 | page. Returns None if there are no more items in the collection. |
| 662 | </pre> |
| 663 | </div> |
| 664 | |
| 665 | <div class="method"> |
| 666 | <code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code> |
| 667 | <pre>Update a CaPool. |
| 668 | |
| 669 | Args: |
| 670 | name: string, Output only. The resource name for this CaPool in the format `projects/*/locations/*/caPools/*`. (required) |
| 671 | body: object, The request body. |
| 672 | The object takes the form of: |
| 673 | |
| 674 | { # A CaPool represents a group of CertificateAuthorities that form a trust anchor. A CaPool can be used to manage issuance policies for one or more CertificateAuthority resources and to rotate CA certificates in and out of the trust anchor. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame^] | 675 | "createTime": "A String", # Output only. The time at which this CaPool was created. |
| yoshi-code-bot | 8759538 | 2021-06-05 00:38:05 -0700 | [diff] [blame] | 676 | "issuancePolicy": { # Defines controls over all certificate issuance within a CaPool. # Optional. The IssuancePolicy to control how Certificates will be issued from this CaPool. |
| 677 | "allowedIssuanceModes": { # IssuanceModes specifies the allowed ways in which Certificates may be requested from this CaPool. # Optional. If specified, then only methods allowed in the IssuanceModes may be used to issue Certificates. |
| 678 | "allowConfigBasedIssuance": True or False, # Optional. When true, allows callers to create Certificates by specifying a CertificateConfig. |
| 679 | "allowCsrBasedIssuance": True or False, # Optional. When true, allows callers to create Certificates by specifying a CSR. |
| 680 | }, |
| 681 | "allowedKeyTypes": [ # Optional. If any AllowedKeyType is specified, then the certificate request's public key must match one of the key types listed here. Otherwise, any key may be used. |
| 682 | { # Describes a "type" of key that may be used in a Certificate issued from a CaPool. Note that a single AllowedKeyType may refer to either a fully-qualified key algorithm, such as RSA 4096, or a family of key algorithms, such as any RSA key. |
| 683 | "ellipticCurve": { # Describes an Elliptic Curve key that may be used in a Certificate issued from a CaPool. # Represents an allowed Elliptic Curve key type. |
| 684 | "signatureAlgorithm": "A String", # Optional. A signature algorithm that must be used. If this is omitted, any EC-based signature algorithm will be allowed. |
| 685 | }, |
| 686 | "rsa": { # Describes an RSA key that may be used in a Certificate issued from a CaPool. # Represents an allowed RSA key type. |
| yoshi-code-bot | 9d63883 | 2021-10-05 00:20:14 -0700 | [diff] [blame] | 687 | "maxModulusSize": "A String", # Optional. The maximum allowed RSA modulus size (inclusive), in bits. If this is not set, or if set to zero, the service will not enforce an explicit upper bound on RSA modulus sizes. |
| 688 | "minModulusSize": "A String", # Optional. The minimum allowed RSA modulus size (inclusive), in bits. If this is not set, or if set to zero, the service-level min RSA modulus size will continue to apply. |
| yoshi-code-bot | 8759538 | 2021-06-05 00:38:05 -0700 | [diff] [blame] | 689 | }, |
| 690 | }, |
| 691 | ], |
| 692 | "baselineValues": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Optional. A set of X.509 values that will be applied to all certificates issued through this CaPool. If a certificate request includes conflicting values for the same properties, they will be overwritten by the values defined here. If a certificate request uses a CertificateTemplate that defines conflicting predefined_values for the same properties, the certificate issuance request will fail. |
| 693 | "additionalExtensions": [ # Optional. Describes custom X.509 extensions. |
| 694 | { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. |
| 695 | "critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error). |
| 696 | "objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension. |
| 697 | "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 698 | 42, |
| 699 | ], |
| 700 | }, |
| 701 | "value": "A String", # Required. The value of this X.509 extension. |
| 702 | }, |
| 703 | ], |
| 704 | "aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. |
| 705 | "A String", |
| 706 | ], |
| 707 | "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. |
| 708 | "isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate. |
| 709 | "maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate. |
| 710 | }, |
| 711 | "keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate. |
| 712 | "baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used. |
| 713 | "certSign": True or False, # The key may be used to sign certificates. |
| 714 | "contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation". |
| 715 | "crlSign": True or False, # The key may be used sign certificate revocation lists. |
| 716 | "dataEncipherment": True or False, # The key may be used to encipher data. |
| 717 | "decipherOnly": True or False, # The key may be used to decipher only. |
| 718 | "digitalSignature": True or False, # The key may be used for digital signatures. |
| 719 | "encipherOnly": True or False, # The key may be used to encipher only. |
| 720 | "keyAgreement": True or False, # The key may be used in a key agreement protocol. |
| 721 | "keyEncipherment": True or False, # The key may be used to encipher other keys. |
| 722 | }, |
| 723 | "extendedKeyUsage": { # KeyUsage.ExtendedKeyUsageOptions has fields that correspond to certain common OIDs that could be specified as an extended key usage value. # Detailed scenarios in which a key may be used. |
| 724 | "clientAuth": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.2. Officially described as "TLS WWW client authentication", though regularly used for non-WWW TLS. |
| 725 | "codeSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as "Signing of downloadable executable code client authentication". |
| 726 | "emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection". |
| 727 | "ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses". |
| 728 | "serverAuth": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.1. Officially described as "TLS WWW server authentication", though regularly used for non-WWW TLS. |
| 729 | "timeStamping": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as "Binding the hash of an object to a time". |
| 730 | }, |
| 731 | "unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message. |
| 732 | { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. |
| 733 | "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 734 | 42, |
| 735 | ], |
| 736 | }, |
| 737 | ], |
| 738 | }, |
| 739 | "policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4. |
| 740 | { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. |
| 741 | "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 742 | 42, |
| 743 | ], |
| 744 | }, |
| 745 | ], |
| 746 | }, |
| 747 | "identityConstraints": { # Describes constraints on a Certificate's Subject and SubjectAltNames. # Optional. Describes constraints on identities that may appear in Certificates issued through this CaPool. If this is omitted, then this CaPool will not add restrictions on a certificate's identity. |
| 748 | "allowSubjectAltNamesPassthrough": True or False, # Required. If this is true, the SubjectAltNames extension may be copied from a certificate request into the signed certificate. Otherwise, the requested SubjectAltNames will be discarded. |
| 749 | "allowSubjectPassthrough": True or False, # Required. If this is true, the Subject field may be copied from a certificate request into the signed certificate. Otherwise, the requested Subject will be discarded. |
| yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 750 | "celExpression": { # Represents a textual expression in the Common Expression Language (CEL) 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. # Optional. A CEL expression that may be used to validate the resolved X.509 Subject and/or Subject Alternative Name before a certificate is signed. To see the full allowed syntax and some examples, see https://cloud.google.com/certificate-authority-service/docs/using-cel |
| yoshi-code-bot | 8759538 | 2021-06-05 00:38:05 -0700 | [diff] [blame] | 751 | "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. |
| 752 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 753 | "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. |
| 754 | "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. |
| 755 | }, |
| 756 | }, |
| 757 | "maximumLifetime": "A String", # Optional. The maximum lifetime allowed for issued Certificates. Note that if the issuing CertificateAuthority expires before a Certificate's requested maximum_lifetime, the effective lifetime will be explicitly truncated to match it. |
| 758 | "passthroughExtensions": { # Describes a set of X.509 extensions that may be part of some certificate issuance controls. # Optional. Describes the set of X.509 extensions that may appear in a Certificate issued through this CaPool. If a certificate request sets extensions that don't appear in the passthrough_extensions, those extensions will be dropped. If a certificate request uses a CertificateTemplate with predefined_values that don't appear here, the certificate issuance request will fail. If this is omitted, then this CaPool will not add restrictions on a certificate's X.509 extensions. These constraints do not apply to X.509 extensions set in this CaPool's baseline_values. |
| 759 | "additionalExtensions": [ # Optional. A set of ObjectIds identifying custom X.509 extensions. Will be combined with known_extensions to determine the full set of X.509 extensions. |
| 760 | { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. |
| 761 | "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. |
| 762 | 42, |
| 763 | ], |
| 764 | }, |
| 765 | ], |
| 766 | "knownExtensions": [ # Optional. A set of named X.509 extensions. Will be combined with additional_extensions to determine the full set of X.509 extensions. |
| 767 | "A String", |
| 768 | ], |
| 769 | }, |
| 770 | }, |
| 771 | "labels": { # Optional. Labels with user-defined metadata. |
| 772 | "a_key": "A String", |
| 773 | }, |
| 774 | "name": "A String", # Output only. The resource name for this CaPool in the format `projects/*/locations/*/caPools/*`. |
| 775 | "publishingOptions": { # Options relating to the publication of each CertificateAuthority's CA certificate and CRLs and their inclusion as extensions in issued Certificates. The options set here apply to certificates issued by any CertificateAuthority in the CaPool. # Optional. The PublishingOptions to follow when issuing Certificates from any CertificateAuthority in this CaPool. |
| 776 | "publishCaCert": True or False, # Optional. When true, publishes each CertificateAuthority's CA certificate and includes its URL in the "Authority Information Access" X.509 extension in all issued Certificates. If this is false, the CA certificate will not be published and the corresponding X.509 extension will not be written in issued certificates. |
| 777 | "publishCrl": True or False, # Optional. When true, publishes each CertificateAuthority's CRL and includes its URL in the "CRL Distribution Points" X.509 extension in all issued Certificates. If this is false, CRLs will not be published and the corresponding X.509 extension will not be written in issued certificates. CRLs will expire 7 days from their creation. However, we will rebuild daily. CRLs are also rebuilt shortly after a certificate is revoked. |
| 778 | }, |
| 779 | "tier": "A String", # Required. Immutable. The Tier of this CaPool. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame^] | 780 | "updateTime": "A String", # Output only. The time at which this CaPool was last updated. |
| yoshi-code-bot | 8759538 | 2021-06-05 00:38:05 -0700 | [diff] [blame] | 781 | } |
| 782 | |
| 783 | requestId: string, Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| 784 | updateMask: string, Required. A list of fields to be updated in this request. |
| 785 | x__xgafv: string, V1 error format. |
| 786 | Allowed values |
| 787 | 1 - v1 error format |
| 788 | 2 - v2 error format |
| 789 | |
| 790 | Returns: |
| 791 | An object of the form: |
| 792 | |
| 793 | { # This resource represents a long-running operation that is the result of a network API call. |
| 794 | "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| 795 | "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| 796 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 797 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 798 | { |
| 799 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 800 | }, |
| 801 | ], |
| 802 | "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| 803 | }, |
| 804 | "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| 805 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 806 | }, |
| 807 | "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| 808 | "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| 809 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 810 | }, |
| 811 | }</pre> |
| 812 | </div> |
| 813 | |
| 814 | <div class="method"> |
| yoshi-code-bot | 31fbcc0 | 2021-06-02 00:52:03 -0700 | [diff] [blame] | 815 | <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code> |
| 816 | <pre>Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. |
| 817 | |
| 818 | Args: |
| 819 | resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required) |
| 820 | body: object, The request body. |
| 821 | The object takes the form of: |
| 822 | |
| 823 | { # Request message for `SetIamPolicy` method. |
| yoshi-code-bot | f4773f6 | 2021-10-19 00:22:31 -0700 | [diff] [blame] | 824 | "policy": { # 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`, or principals, to a single `role`. Principals 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/). # 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. |
| yoshi-code-bot | 31fbcc0 | 2021-06-02 00:52:03 -0700 | [diff] [blame] | 825 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| 826 | { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. |
| 827 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| 828 | { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. |
| 829 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. |
| 830 | "A String", |
| 831 | ], |
| 832 | "logType": "A String", # The log type that this config enables. |
| 833 | }, |
| 834 | ], |
| 835 | "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. |
| 836 | }, |
| 837 | ], |
| yoshi-code-bot | f4773f6 | 2021-10-19 00:22:31 -0700 | [diff] [blame] | 838 | "bindings": [ # Associates a list of `members`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. |
| 839 | { # Associates `members`, or principals, with a `role`. |
| 840 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) 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. # 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 principals 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). |
| yoshi-code-bot | 31fbcc0 | 2021-06-02 00:52:03 -0700 | [diff] [blame] | 841 | "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. |
| 842 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 843 | "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. |
| 844 | "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. |
| 845 | }, |
| yoshi-code-bot | f4773f6 | 2021-10-19 00:22:31 -0700 | [diff] [blame] | 846 | "members": [ # Specifies the principals 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`. |
| yoshi-code-bot | 31fbcc0 | 2021-06-02 00:52:03 -0700 | [diff] [blame] | 847 | "A String", |
| 848 | ], |
| yoshi-code-bot | f4773f6 | 2021-10-19 00:22:31 -0700 | [diff] [blame] | 849 | "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| yoshi-code-bot | 31fbcc0 | 2021-06-02 00:52:03 -0700 | [diff] [blame] | 850 | }, |
| 851 | ], |
| 852 | "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. |
| 853 | "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). |
| 854 | }, |
| 855 | "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"` |
| 856 | } |
| 857 | |
| 858 | x__xgafv: string, V1 error format. |
| 859 | Allowed values |
| 860 | 1 - v1 error format |
| 861 | 2 - v2 error format |
| 862 | |
| 863 | Returns: |
| 864 | An object of the form: |
| 865 | |
| yoshi-code-bot | f4773f6 | 2021-10-19 00:22:31 -0700 | [diff] [blame] | 866 | { # 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`, or principals, to a single `role`. Principals 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/). |
| yoshi-code-bot | 31fbcc0 | 2021-06-02 00:52:03 -0700 | [diff] [blame] | 867 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| 868 | { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. |
| 869 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| 870 | { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. |
| 871 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. |
| 872 | "A String", |
| 873 | ], |
| 874 | "logType": "A String", # The log type that this config enables. |
| 875 | }, |
| 876 | ], |
| 877 | "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. |
| 878 | }, |
| 879 | ], |
| yoshi-code-bot | f4773f6 | 2021-10-19 00:22:31 -0700 | [diff] [blame] | 880 | "bindings": [ # Associates a list of `members`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. |
| 881 | { # Associates `members`, or principals, with a `role`. |
| 882 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) 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. # 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 principals 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). |
| yoshi-code-bot | 31fbcc0 | 2021-06-02 00:52:03 -0700 | [diff] [blame] | 883 | "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. |
| 884 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 885 | "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. |
| 886 | "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. |
| 887 | }, |
| yoshi-code-bot | f4773f6 | 2021-10-19 00:22:31 -0700 | [diff] [blame] | 888 | "members": [ # Specifies the principals 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`. |
| yoshi-code-bot | 31fbcc0 | 2021-06-02 00:52:03 -0700 | [diff] [blame] | 889 | "A String", |
| 890 | ], |
| yoshi-code-bot | f4773f6 | 2021-10-19 00:22:31 -0700 | [diff] [blame] | 891 | "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| yoshi-code-bot | 31fbcc0 | 2021-06-02 00:52:03 -0700 | [diff] [blame] | 892 | }, |
| 893 | ], |
| 894 | "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. |
| 895 | "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). |
| 896 | }</pre> |
| 897 | </div> |
| 898 | |
| 899 | <div class="method"> |
| 900 | <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code> |
| 901 | <pre>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. |
| 902 | |
| 903 | Args: |
| 904 | 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) |
| 905 | body: object, The request body. |
| 906 | The object takes the form of: |
| 907 | |
| 908 | { # Request message for `TestIamPermissions` method. |
| 909 | "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). |
| 910 | "A String", |
| 911 | ], |
| 912 | } |
| 913 | |
| 914 | x__xgafv: string, V1 error format. |
| 915 | Allowed values |
| 916 | 1 - v1 error format |
| 917 | 2 - v2 error format |
| 918 | |
| 919 | Returns: |
| 920 | An object of the form: |
| 921 | |
| 922 | { # Response message for `TestIamPermissions` method. |
| 923 | "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. |
| 924 | "A String", |
| 925 | ], |
| 926 | }</pre> |
| 927 | </div> |
| 928 | |
| 929 | </body></html> |