You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<pre>Creates a new CertificateIssuanceConfig in a given project and location.
104
+
105
+
Args:
106
+
parent: string, Required. The parent resource of the certificate issuance config. Must be in the format `projects/*/locations/*`. (required)
107
+
body: object, The request body.
108
+
The object takes the form of:
109
+
110
+
{ # CertificateIssuanceConfig specifies how to issue and manage a certificate.
111
+
"certificateAuthorityConfig": { # The CA that issues the workload certificate. It includes CA address, type, authentication to CA service, etc. # Required. The CA that issues the workload certificate. It includes the CA address, type, authentication to CA service, etc.
112
+
"certificateAuthorityServiceConfig": { # Contains information required to contact CA service. # Defines a CertificateAuthorityServiceConfig.
113
+
"caPool": "A String", # Required. A CA pool resource used to issue a certificate. The CA pool string has a relative resource path following the form "projects/{project}/locations/{location}/caPools/{ca_pool}".
114
+
},
115
+
},
116
+
"createTime": "A String", # Output only. The creation timestamp of a CertificateIssuanceConfig.
117
+
"description": "A String", # One or more paragraphs of text description of a CertificateIssuanceConfig.
118
+
"keyAlgorithm": "A String", # Required. The key algorithm to use when generating the private key.
119
+
"labels": { # Set of labels associated with a CertificateIssuanceConfig.
"name": "A String", # A user-defined name of the certificate issuance config. CertificateIssuanceConfig names must be unique globally and match pattern `projects/*/locations/*/certificateIssuanceConfigs/*`.
124
+
"rotationWindowPercentage": 42, # Required. Specifies the percentage of elapsed time of the certificate lifetime to wait before renewing the certificate. Must be a number between 1-99, inclusive.
125
+
"updateTime": "A String", # Output only. The last update timestamp of a CertificateIssuanceConfig.
126
+
}
127
+
128
+
certificateIssuanceConfigId: string, Required. A user-provided name of the certificate config.
129
+
x__xgafv: string, V1 error format.
130
+
Allowed values
131
+
1 - v1 error format
132
+
2 - v2 error format
133
+
134
+
Returns:
135
+
An object of the form:
136
+
137
+
{ # This resource represents a long-running operation that is the result of a network API call.
138
+
"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.
139
+
"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.
140
+
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
141
+
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
142
+
{
143
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
144
+
},
145
+
],
146
+
"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.
147
+
},
148
+
"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.
149
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
150
+
},
151
+
"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}`.
152
+
"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`.
153
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
name: string, Required. A name of the certificate issuance config to delete. Must be in the format `projects/*/locations/*/certificateIssuanceConfigs/*`. (required)
164
+
x__xgafv: string, V1 error format.
165
+
Allowed values
166
+
1 - v1 error format
167
+
2 - v2 error format
168
+
169
+
Returns:
170
+
An object of the form:
171
+
172
+
{ # This resource represents a long-running operation that is the result of a network API call.
173
+
"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.
174
+
"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.
175
+
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
176
+
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
177
+
{
178
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
179
+
},
180
+
],
181
+
"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.
182
+
},
183
+
"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.
184
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
185
+
},
186
+
"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}`.
187
+
"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`.
188
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
<pre>Gets details of a single CertificateIssuanceConfig.
196
+
197
+
Args:
198
+
name: string, Required. A name of the certificate issuance config to describe. Must be in the format `projects/*/locations/*/certificateIssuanceConfigs/*`. (required)
199
+
x__xgafv: string, V1 error format.
200
+
Allowed values
201
+
1 - v1 error format
202
+
2 - v2 error format
203
+
204
+
Returns:
205
+
An object of the form:
206
+
207
+
{ # CertificateIssuanceConfig specifies how to issue and manage a certificate.
208
+
"certificateAuthorityConfig": { # The CA that issues the workload certificate. It includes CA address, type, authentication to CA service, etc. # Required. The CA that issues the workload certificate. It includes the CA address, type, authentication to CA service, etc.
209
+
"certificateAuthorityServiceConfig": { # Contains information required to contact CA service. # Defines a CertificateAuthorityServiceConfig.
210
+
"caPool": "A String", # Required. A CA pool resource used to issue a certificate. The CA pool string has a relative resource path following the form "projects/{project}/locations/{location}/caPools/{ca_pool}".
211
+
},
212
+
},
213
+
"createTime": "A String", # Output only. The creation timestamp of a CertificateIssuanceConfig.
214
+
"description": "A String", # One or more paragraphs of text description of a CertificateIssuanceConfig.
215
+
"keyAlgorithm": "A String", # Required. The key algorithm to use when generating the private key.
216
+
"labels": { # Set of labels associated with a CertificateIssuanceConfig.
"name": "A String", # A user-defined name of the certificate issuance config. CertificateIssuanceConfig names must be unique globally and match pattern `projects/*/locations/*/certificateIssuanceConfigs/*`.
221
+
"rotationWindowPercentage": 42, # Required. Specifies the percentage of elapsed time of the certificate lifetime to wait before renewing the certificate. Must be a number between 1-99, inclusive.
222
+
"updateTime": "A String", # Output only. The last update timestamp of a CertificateIssuanceConfig.
<pre>Lists CertificateIssuanceConfigs in a given project and location.
229
+
230
+
Args:
231
+
parent: string, Required. The project and location from which the certificate should be listed, specified in the format `projects/*/locations/*`. (required)
232
+
filter: string, Filter expression to restrict the Certificates Configs returned.
233
+
orderBy: string, A list of Certificate Config field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix " desc".
234
+
pageSize: integer, Maximum number of certificate configs to return per call.
235
+
pageToken: string, The value returned by the last `ListCertificateIssuanceConfigsResponse`. Indicates that this is a continuation of a prior `ListCertificateIssuanceConfigs` call, and that the system should return the next page of data.
236
+
x__xgafv: string, V1 error format.
237
+
Allowed values
238
+
1 - v1 error format
239
+
2 - v2 error format
240
+
241
+
Returns:
242
+
An object of the form:
243
+
244
+
{ # Response for the `ListCertificateIssuanceConfigs` method.
245
+
"certificateIssuanceConfigs": [ # A list of certificate configs for the parent resource.
246
+
{ # CertificateIssuanceConfig specifies how to issue and manage a certificate.
247
+
"certificateAuthorityConfig": { # The CA that issues the workload certificate. It includes CA address, type, authentication to CA service, etc. # Required. The CA that issues the workload certificate. It includes the CA address, type, authentication to CA service, etc.
248
+
"certificateAuthorityServiceConfig": { # Contains information required to contact CA service. # Defines a CertificateAuthorityServiceConfig.
249
+
"caPool": "A String", # Required. A CA pool resource used to issue a certificate. The CA pool string has a relative resource path following the form "projects/{project}/locations/{location}/caPools/{ca_pool}".
250
+
},
251
+
},
252
+
"createTime": "A String", # Output only. The creation timestamp of a CertificateIssuanceConfig.
253
+
"description": "A String", # One or more paragraphs of text description of a CertificateIssuanceConfig.
254
+
"keyAlgorithm": "A String", # Required. The key algorithm to use when generating the private key.
255
+
"labels": { # Set of labels associated with a CertificateIssuanceConfig.
"name": "A String", # A user-defined name of the certificate issuance config. CertificateIssuanceConfig names must be unique globally and match pattern `projects/*/locations/*/certificateIssuanceConfigs/*`.
260
+
"rotationWindowPercentage": 42, # Required. Specifies the percentage of elapsed time of the certificate lifetime to wait before renewing the certificate. Must be a number between 1-99, inclusive.
261
+
"updateTime": "A String", # Output only. The last update timestamp of a CertificateIssuanceConfig.
262
+
},
263
+
],
264
+
"nextPageToken": "A String", # If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.
265
+
"unreachable": [ # Locations that could not be reached.
Copy file name to clipboardexpand all lines: docs/dyn/certificatemanager_v1.projects.locations.certificates.html
+4
Original file line number
Diff line number
Diff line change
@@ -132,6 +132,7 @@ <h3>Method Details</h3>
132
132
"domains": [ # Immutable. The domains for which a managed SSL certificate will be generated. Wildcard domains are only supported with DNS challenge resolution.
133
133
"A String",
134
134
],
135
+
"issuanceConfig": "A String", # Immutable. The resource name for a CertificateIssuanceConfig used to configure private PKI certificates in the format `projects/*/locations/*/certificateIssuanceConfigs/*`. If this field is not set, the certificates will instead be publicly signed as documented at https://cloud.google.com/load-balancing/docs/ssl-certificates/google-managed-certs#caa.
135
136
"provisioningIssue": { # Information about issues with provisioning a Managed Certificate. # Output only. Information about issues with provisioning a Managed Certificate.
136
137
"details": "A String", # Output only. Human readable explanation about the issue. Provided to help address the configuration issues. Not guaranteed to be stable. For programmatic access use Reason enum.
137
138
"reason": "A String", # Output only. Reason for provisioning failures.
@@ -252,6 +253,7 @@ <h3>Method Details</h3>
252
253
"domains": [ # Immutable. The domains for which a managed SSL certificate will be generated. Wildcard domains are only supported with DNS challenge resolution.
253
254
"A String",
254
255
],
256
+
"issuanceConfig": "A String", # Immutable. The resource name for a CertificateIssuanceConfig used to configure private PKI certificates in the format `projects/*/locations/*/certificateIssuanceConfigs/*`. If this field is not set, the certificates will instead be publicly signed as documented at https://cloud.google.com/load-balancing/docs/ssl-certificates/google-managed-certs#caa.
255
257
"provisioningIssue": { # Information about issues with provisioning a Managed Certificate. # Output only. Information about issues with provisioning a Managed Certificate.
256
258
"details": "A String", # Output only. Human readable explanation about the issue. Provided to help address the configuration issues. Not guaranteed to be stable. For programmatic access use Reason enum.
257
259
"reason": "A String", # Output only. Reason for provisioning failures.
@@ -314,6 +316,7 @@ <h3>Method Details</h3>
314
316
"domains": [ # Immutable. The domains for which a managed SSL certificate will be generated. Wildcard domains are only supported with DNS challenge resolution.
315
317
"A String",
316
318
],
319
+
"issuanceConfig": "A String", # Immutable. The resource name for a CertificateIssuanceConfig used to configure private PKI certificates in the format `projects/*/locations/*/certificateIssuanceConfigs/*`. If this field is not set, the certificates will instead be publicly signed as documented at https://cloud.google.com/load-balancing/docs/ssl-certificates/google-managed-certs#caa.
317
320
"provisioningIssue": { # Information about issues with provisioning a Managed Certificate. # Output only. Information about issues with provisioning a Managed Certificate.
318
321
"details": "A String", # Output only. Human readable explanation about the issue. Provided to help address the configuration issues. Not guaranteed to be stable. For programmatic access use Reason enum.
319
322
"reason": "A String", # Output only. Reason for provisioning failures.
@@ -385,6 +388,7 @@ <h3>Method Details</h3>
385
388
"domains": [ # Immutable. The domains for which a managed SSL certificate will be generated. Wildcard domains are only supported with DNS challenge resolution.
386
389
"A String",
387
390
],
391
+
"issuanceConfig": "A String", # Immutable. The resource name for a CertificateIssuanceConfig used to configure private PKI certificates in the format `projects/*/locations/*/certificateIssuanceConfigs/*`. If this field is not set, the certificates will instead be publicly signed as documented at https://cloud.google.com/load-balancing/docs/ssl-certificates/google-managed-certs#caa.
388
392
"provisioningIssue": { # Information about issues with provisioning a Managed Certificate. # Output only. Information about issues with provisioning a Managed Certificate.
389
393
"details": "A String", # Output only. Human readable explanation about the issue. Provided to help address the configuration issues. Not guaranteed to be stable. For programmatic access use Reason enum.
390
394
"reason": "A String", # Output only. Reason for provisioning failures.
"description": "Required. A name of the certificate issuance config to delete. Must be in the format `projects/*/locations/*/certificateIssuanceConfigs/*`.",
"description": "Required. A name of the certificate issuance config to describe. Must be in the format `projects/*/locations/*/certificateIssuanceConfigs/*`.",
"description": "Filter expression to restrict the Certificates Configs returned.",
276
+
"location": "query",
277
+
"type": "string"
278
+
},
279
+
"orderBy": {
280
+
"description": "A list of Certificate Config field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix \" desc\".",
281
+
"location": "query",
282
+
"type": "string"
283
+
},
284
+
"pageSize": {
285
+
"description": "Maximum number of certificate configs to return per call.",
286
+
"format": "int32",
287
+
"location": "query",
288
+
"type": "integer"
289
+
},
290
+
"pageToken": {
291
+
"description": "The value returned by the last `ListCertificateIssuanceConfigsResponse`. Indicates that this is a continuation of a prior `ListCertificateIssuanceConfigs` call, and that the system should return the next page of data.",
292
+
"location": "query",
293
+
"type": "string"
294
+
},
295
+
"parent": {
296
+
"description": "Required. The project and location from which the certificate should be listed, specified in the format `projects/*/locations/*`.",
"description": "The CA that issues the workload certificate. It includes CA address, type, authentication to CA service, etc.",
1245
+
"id": "CertificateAuthorityConfig",
1246
+
"properties": {
1247
+
"certificateAuthorityServiceConfig": {
1248
+
"$ref": "CertificateAuthorityServiceConfig",
1249
+
"description": "Defines a CertificateAuthorityServiceConfig."
1250
+
}
1251
+
},
1252
+
"type": "object"
1253
+
},
1254
+
"CertificateAuthorityServiceConfig": {
1255
+
"description": "Contains information required to contact CA service.",
1256
+
"id": "CertificateAuthorityServiceConfig",
1257
+
"properties": {
1258
+
"caPool": {
1259
+
"description": "Required. A CA pool resource used to issue a certificate. The CA pool string has a relative resource path following the form \"projects/{project}/locations/{location}/caPools/{ca_pool}\".",
1260
+
"type": "string"
1261
+
}
1262
+
},
1263
+
"type": "object"
1264
+
},
1265
+
"CertificateIssuanceConfig": {
1266
+
"description": "CertificateIssuanceConfig specifies how to issue and manage a certificate.",
1267
+
"id": "CertificateIssuanceConfig",
1268
+
"properties": {
1269
+
"certificateAuthorityConfig": {
1270
+
"$ref": "CertificateAuthorityConfig",
1271
+
"description": "Required. The CA that issues the workload certificate. It includes the CA address, type, authentication to CA service, etc."
1272
+
},
1273
+
"createTime": {
1274
+
"description": "Output only. The creation timestamp of a CertificateIssuanceConfig.",
1275
+
"format": "google-datetime",
1276
+
"readOnly": true,
1277
+
"type": "string"
1278
+
},
1279
+
"description": {
1280
+
"description": "One or more paragraphs of text description of a CertificateIssuanceConfig.",
1281
+
"type": "string"
1282
+
},
1283
+
"keyAlgorithm": {
1284
+
"description": "Required. The key algorithm to use when generating the private key.",
1285
+
"enum": [
1286
+
"KEY_ALGORITHM_UNSPECIFIED",
1287
+
"RSA_2048",
1288
+
"ECDSA_P256"
1289
+
],
1290
+
"enumDescriptions": [
1291
+
"Unspecified key algorithm.",
1292
+
"Specifies RSA with a 2048-bit modulus.",
1293
+
"Specifies ECDSA with curve P256."
1294
+
],
1295
+
"type": "string"
1296
+
},
1297
+
"labels": {
1298
+
"additionalProperties": {
1299
+
"type": "string"
1300
+
},
1301
+
"description": "Set of labels associated with a CertificateIssuanceConfig.",
"description": "A user-defined name of the certificate issuance config. CertificateIssuanceConfig names must be unique globally and match pattern `projects/*/locations/*/certificateIssuanceConfigs/*`.",
1311
+
"type": "string"
1312
+
},
1313
+
"rotationWindowPercentage": {
1314
+
"description": "Required. Specifies the percentage of elapsed time of the certificate lifetime to wait before renewing the certificate. Must be a number between 1-99, inclusive.",
1315
+
"format": "int32",
1316
+
"type": "integer"
1317
+
},
1318
+
"updateTime": {
1319
+
"description": "Output only. The last update timestamp of a CertificateIssuanceConfig.",
1320
+
"format": "google-datetime",
1321
+
"readOnly": true,
1322
+
"type": "string"
1323
+
}
1324
+
},
1325
+
"type": "object"
1326
+
},
1110
1327
"CertificateMap": {
1111
1328
"description": "Defines a collection of certificate configurations.",
1112
1329
"id": "CertificateMap",
@@ -1338,6 +1555,31 @@
1338
1555
},
1339
1556
"type": "object"
1340
1557
},
1558
+
"ListCertificateIssuanceConfigsResponse": {
1559
+
"description": "Response for the `ListCertificateIssuanceConfigs` method.",
1560
+
"id": "ListCertificateIssuanceConfigsResponse",
1561
+
"properties": {
1562
+
"certificateIssuanceConfigs": {
1563
+
"description": "A list of certificate configs for the parent resource.",
1564
+
"items": {
1565
+
"$ref": "CertificateIssuanceConfig"
1566
+
},
1567
+
"type": "array"
1568
+
},
1569
+
"nextPageToken": {
1570
+
"description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.",
1571
+
"type": "string"
1572
+
},
1573
+
"unreachable": {
1574
+
"description": "Locations that could not be reached.",
1575
+
"items": {
1576
+
"type": "string"
1577
+
},
1578
+
"type": "array"
1579
+
}
1580
+
},
1581
+
"type": "object"
1582
+
},
1341
1583
"ListCertificateMapEntriesResponse": {
1342
1584
"description": "Response for the `ListCertificateMapEntries` method.",
1343
1585
"id": "ListCertificateMapEntriesResponse",
@@ -1534,6 +1776,10 @@
1534
1776
},
1535
1777
"type": "array"
1536
1778
},
1779
+
"issuanceConfig": {
1780
+
"description": "Immutable. The resource name for a CertificateIssuanceConfig used to configure private PKI certificates in the format `projects/*/locations/*/certificateIssuanceConfigs/*`. If this field is not set, the certificates will instead be publicly signed as documented at https://cloud.google.com/load-balancing/docs/ssl-certificates/google-managed-certs#caa.",
1781
+
"type": "string"
1782
+
},
1537
1783
"provisioningIssue": {
1538
1784
"$ref": "ProvisioningIssue",
1539
1785
"description": "Output only. Information about issues with provisioning a Managed Certificate.",
0 commit comments