# REST Resource: projects.locations.certificateAuthorities

- [Resource: CertificateAuthority](https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority)
  - [JSON representation](https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority.SCHEMA_REPRESENTATION)
- [Type](https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#Type)
- [Tier](https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#Tier)
- [KeyVersionSpec](https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#KeyVersionSpec)
  - [JSON representation](https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#KeyVersionSpec.SCHEMA_REPRESENTATION)
- [SignHashAlgorithm](https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#SignHashAlgorithm)
- [CertificateAuthorityPolicy](https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthorityPolicy)
  - [JSON representation](https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthorityPolicy.SCHEMA_REPRESENTATION)
- [AllowedConfigList](https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#AllowedConfigList)
  - [JSON representation](https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#AllowedConfigList.SCHEMA_REPRESENTATION)
- [AllowedSubjectAltNames](https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#AllowedSubjectAltNames)
  - [JSON representation](https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#AllowedSubjectAltNames.SCHEMA_REPRESENTATION)
- [IssuanceModes](https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#IssuanceModes)
  - [JSON representation](https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#IssuanceModes.SCHEMA_REPRESENTATION)
- [IssuingOptions](https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#IssuingOptions)
  - [JSON representation](https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#IssuingOptions.SCHEMA_REPRESENTATION)
- [SubordinateConfig](https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#SubordinateConfig)
  - [JSON representation](https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#SubordinateConfig.SCHEMA_REPRESENTATION)
- [SubordinateConfigChain](https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#SubordinateConfigChain)
  - [JSON representation](https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#SubordinateConfigChain.SCHEMA_REPRESENTATION)
- [State](https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#State)
- [AccessUrls](https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#AccessUrls)
  - [JSON representation](https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#AccessUrls.SCHEMA_REPRESENTATION)
- [Methods](https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#METHODS_SUMMARY)

## Resource: CertificateAuthority

A `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority` represents an individual Certificate Authority. A `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority` can be used to create `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities.certificates#Certificate`.

| JSON representation ||
|---|---|
| ``` { "name": string, "type": enum (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#Type`), "tier": enum (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#Tier`), "config": { object (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/CertificateConfig`) }, "lifetime": string, "keySpec": { object (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#KeyVersionSpec`) }, "certificatePolicy": { object (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthorityPolicy`) }, "issuingOptions": { object (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#IssuingOptions`) }, "subordinateConfig": { object (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#SubordinateConfig`) }, "state": enum (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#State`), "pemCaCertificates": [ string ], "caCertificateDescriptions": [ { object (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/CertificateDescription`) } ], "gcsBucket": string, "accessUrls": { object (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#AccessUrls`) }, "createTime": string, "updateTime": string, "deleteTime": string, "labels": { string: string, ... } } ``` |

| Fields ||
|---|---|
| `name` | `string` Output only. The resource name for this `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority` in the format `projects/*/locations/*/certificateAuthorities/*`. |
| `type` | ``enum (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#Type`)`` Required. Immutable. The `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#Type` of this `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`. |
| `tier` | ``enum (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#Tier`)`` Required. Immutable. The `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#Tier` of this `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`. |
| `config` | ``object (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/CertificateConfig`)`` Required. Immutable. The config used to create a self-signed X.509 certificate or CSR. |
| `lifetime` | ``string (`https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration` format)`` Required. The desired lifetime of the CA certificate. Used to create the "notBeforeTime" and "notAfterTime" fields inside an X.509 certificate. A duration in seconds with up to nine fractional digits, terminated by '`s`'. Example: `"3.5s"`. |
| `keySpec` | ``object (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#KeyVersionSpec`)`` Required. Immutable. Used when issuing certificates for this `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`. If this `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority` is a self-signed CertificateAuthority, this key is also used to sign the self-signed CA certificate. Otherwise, it is used to sign a CSR. |
| `certificatePolicy` | ``object (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthorityPolicy`)`` Optional. The `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthorityPolicy` to enforce when issuing `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities.certificates#Certificate` from this `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`. |
| `issuingOptions` | ``object (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#IssuingOptions`)`` Optional. The `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#IssuingOptions` to follow when issuing `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities.certificates#Certificate` from this `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`. |
| `subordinateConfig` | ``object (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#SubordinateConfig`)`` Optional. If this is a subordinate `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`, this field will be set with the subordinate configuration, which describes its issuers. This may be updated, but this `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority` must continue to validate. |
| `state` | ``enum (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#State`)`` Output only. The `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#State` for this `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`. |
| `pemCaCertificates[]` | `string` Output only. This `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`'s certificate chain, including the current `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`'s certificate. Ordered such that the root issuer is the final element (consistent with RFC 5246). For a self-signed CA, this will only list the current `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`'s certificate. |
| `caCertificateDescriptions[]` | ``object (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/CertificateDescription`)`` Output only. A structured description of this `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`'s CA certificate and its issuers. Ordered as self-to-root. |
| `gcsBucket` | `string` Immutable. The name of a Cloud Storage bucket where this `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority` will publish content, such as the CA certificate and CRLs. This must be a bucket name, without any prefixes (such as `gs://`) or suffixes (such as `.googleapis.com`). For example, to use a bucket named `my-bucket`, you would simply specify `my-bucket`. If not specified, a managed bucket will be created. |
| `accessUrls` | ``object (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#AccessUrls`)`` Output only. URLs for accessing content published by this CA, such as the CA certificate and CRLs. |
| `createTime` | ``string (`https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp` format)`` Output only. The time at which this `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority` was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`. |
| `updateTime` | ``string (`https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp` format)`` Output only. The time at which this `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority` was updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`. |
| `deleteTime` | ``string (`https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp` format)`` Output only. The time at which this `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority` will be deleted, if scheduled for deletion. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`. |
| `labels` | `map (key: string, value: string)` Optional. Labels with user-defined metadata. An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. |

## Type

The type of a `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`, indicating its issuing chain.

| Enums ||
|---|---|
| `TYPE_UNSPECIFIED` | Not specified. |
| `SELF_SIGNED` | Self-signed CA. |
| `SUBORDINATE` | Subordinate CA. Could be issued by a Private CA `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority` or an unmanaged CA. |

## Tier

The tier of a `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`, indicating its supported functionality and/or billing SKU.

| Enums ||
|---|---|
| `TIER_UNSPECIFIED` | Not specified. |
| `ENTERPRISE` | Enterprise tier. |
| `DEVOPS` | DevOps tier. |

## KeyVersionSpec

A Cloud KMS key configuration that a `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority` will use.

| JSON representation ||
|---|---|
| ``` { // Union field `KeyVersion` can be only one of the following: "cloudKmsKeyVersion": string, "algorithm": enum (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#SignHashAlgorithm`) // End of list of possible types for union field `KeyVersion`. } ``` |

| Fields ||
|---|---|---|
| Union field `KeyVersion`. `KeyVersion` can be only one of the following: |||
| `cloudKmsKeyVersion` | `string` Required. The resource name for an existing Cloud KMS CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. This option enables full flexibility in the key's capabilities and properties. |
| `algorithm` | ``enum (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#SignHashAlgorithm`)`` Required. The algorithm to use for creating a managed Cloud KMS key for a for a simplified experience. All managed keys will be have their \[ProtectionLevel\]\[google.cloud.kms.v1.ProtectionLevel\] as `HSM`. |

## SignHashAlgorithm

The algorithm of a Cloud KMS CryptoKeyVersion of a \[CryptoKey\]\[google.cloud.kms.v1.CryptoKey\] with the \[CryptoKeyPurpose\]\[google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose\] value `ASYMMETRIC_SIGN`. These values correspond to the \[CryptoKeyVersionAlgorithm\]\[google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm\] values. For RSA signing algorithms, the PSS algorithms should be preferred, use PKCS1 algorithms if required for compatibility. For further recommandations, see <https://cloud.google.com/kms/docs/algorithms#algorithm_recommendations>.

| Enums ||
|---|---|
| `SIGN_HASH_ALGORITHM_UNSPECIFIED` | Not specified. |
| `RSA_PSS_2048_SHA256` | maps to CryptoKeyVersionAlgorithm.RSA_SIGN_PSS_2048_SHA256 |
| `RSA_PSS_3072_SHA256` | maps to CryptoKeyVersionAlgorithm. RSA_SIGN_PSS_3072_SHA256 |
| `RSA_PSS_4096_SHA256` | maps to CryptoKeyVersionAlgorithm.RSA_SIGN_PSS_4096_SHA256 |
| `RSA_PKCS1_2048_SHA256` | maps to CryptoKeyVersionAlgorithm.RSA_SIGN_PKCS1_2048_SHA256 |
| `RSA_PKCS1_3072_SHA256` | maps to CryptoKeyVersionAlgorithm.RSA_SIGN_PKCS1_3072_SHA256 |
| `RSA_PKCS1_4096_SHA256` | maps to CryptoKeyVersionAlgorithm.RSA_SIGN_PKCS1_4096_SHA256 |
| `EC_P256_SHA256` | maps to CryptoKeyVersionAlgorithm.EC_SIGN_P256_SHA256 |
| `EC_P384_SHA384` | maps to CryptoKeyVersionAlgorithm.EC_SIGN_P384_SHA384 |

## CertificateAuthorityPolicy

The issuing policy for a `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`. `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities.certificates#Certificate` will not be successfully issued from this `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority` if they violate the policy.

| JSON representation ||
|---|---|
| ``` { "allowedLocationsAndOrganizations": [ { object (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/Subject`) } ], "allowedCommonNames": [ string ], "allowedSans": { object (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#AllowedSubjectAltNames`) }, "maximumLifetime": string, "allowedIssuanceModes": { object (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#IssuanceModes`) }, // Union field `config_policy` can be only one of the following: "allowedConfigList": { object (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#AllowedConfigList`) }, "overwriteConfigValues": { object (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/ReusableConfigWrapper`) } // End of list of possible types for union field `config_policy`. } ``` |

| Fields ||
|---|---|---|
| `allowedLocationsAndOrganizations[]` | ``object (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/Subject`)`` Optional. If any `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/Subject` is specified here, then all `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities.certificates#Certificate` issued by the `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority` must match at least one listed `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/Subject`. If a `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/Subject` has an empty field, any value will be allowed for that field. |
| `allowedCommonNames[]` | `string` Optional. If any value is specified here, then all `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities.certificates#Certificate` issued by the `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority` must match at least one listed value. If no value is specified, all values will be allowed for this fied. Glob patterns are also supported. |
| `allowedSans` | ``object (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#AllowedSubjectAltNames`)`` Optional. If a `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#AllowedSubjectAltNames` is specified here, then all `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities.certificates#Certificate` issued by the `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority` must match `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#AllowedSubjectAltNames`. If no value or an empty value is specified, any value will be allowed for the `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/SubjectAltNames` field. |
| `maximumLifetime` | ``string (`https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration` format)`` Optional. The maximum lifetime allowed by the `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`. Note that if the any part if the issuing chain expires before a `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities.certificates#Certificate`'s requested maximumLifetime, the effective lifetime will be explicitly truncated. A duration in seconds with up to nine fractional digits, terminated by '`s`'. Example: `"3.5s"`. |
| `allowedIssuanceModes` | ``object (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#IssuanceModes`)`` Optional. If specified, then only methods allowed in the `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#IssuanceModes` may be used to issue `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities.certificates#Certificate`. |
| Union field `config_policy`. Allowed configurations or a single configuration for all issued certificates. `config_policy` can be only one of the following: |||
| `allowedConfigList` | ``object (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#AllowedConfigList`)`` Optional. All `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities.certificates#Certificate` issued by the `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority` must match at least one listed `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/ReusableConfigWrapper` in the list. |
| `overwriteConfigValues` | ``object (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/ReusableConfigWrapper`)`` Optional. All `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities.certificates#Certificate` issued by the `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority` will use the provided configuration values, overwriting any requested configuration values. |

## AllowedConfigList

| JSON representation ||
|---|---|
| ``` { "allowedConfigValues": [ { object (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/ReusableConfigWrapper`) } ] } ``` |

| Fields ||
|---|---|
| `allowedConfigValues[]` | ``object (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/ReusableConfigWrapper`)`` Required. All `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities.certificates#Certificate` issued by the `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority` must match at least one listed `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/ReusableConfigWrapper`. If a `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/ReusableConfigWrapper` has an empty field, any value will be allowed for that field. |

## AllowedSubjectAltNames

`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#AllowedSubjectAltNames` specifies the allowed values for `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/SubjectAltNames` by the `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority` when issuing `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities.certificates#Certificate`.

| JSON representation ||
|---|---|
| ``` { "allowedDnsNames": [ string ], "allowedUris": [ string ], "allowedEmailAddresses": [ string ], "allowedIps": [ string ], "allowGlobbingDnsWildcards": boolean, "allowCustomSans": boolean } ``` |

| Fields ||
|---|---|
| `allowedDnsNames[]` | `string` Optional. Contains valid, fully-qualified host names. Glob patterns are also supported. To allow an explicit wildcard certificate, escape with backlash (i.e. "\*"). E.g. for globbed entries: '\*bar.com' will allow 'foo.bar.com', but not '\*.bar.com', unless the `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#AllowedSubjectAltNames.FIELDS.allow_globbing_dns_wildcards` field is set. E.g. for wildcard entries: '\*.bar.com' will allow '\*.bar.com', but not 'foo.bar.com'. |
| `allowedUris[]` | `string` Optional. Contains valid RFC 3986 URIs. Glob patterns are also supported. To match across path seperators (i.e. '/') use the double star glob pattern (i.e. '\*\*'). |
| `allowedEmailAddresses[]` | `string` Optional. Contains valid RFC 2822 E-mail addresses. Glob patterns are also supported. |
| `allowedIps[]` | `string` Optional. Contains valid 32-bit IPv4 addresses and subnet ranges or RFC 4291 IPv6 addresses and subnet ranges. Subnet ranges are specified using the '/' notation (e.g. 10.0.0.0/8, 2001:700:300:1800::/64). Glob patterns are supported only for ip address entries (i.e. not for subnet ranges). |
| `allowGlobbingDnsWildcards` | `boolean` Optional. Specifies if glob patterns used for `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#AllowedSubjectAltNames.FIELDS.allowed_dns_names` allow wildcard certificates. If this is set, certificate requests with wildcard domains will be permitted to match a glob pattern specified in `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#AllowedSubjectAltNames.FIELDS.allowed_dns_names`. Otherwise, certificate requests with wildcard domains will be permitted only if `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#AllowedSubjectAltNames.FIELDS.allowed_dns_names` contains a literal wildcard. |
| `allowCustomSans` | `boolean` Optional. Specifies if to allow custom X509Extension values. |

## IssuanceModes

`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#IssuanceModes` specifies the allowed ways in which `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities.certificates#Certificate` may be requested from this `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`.

| JSON representation ||
|---|---|
| ``` { "allowCsrBasedIssuance": boolean, "allowConfigBasedIssuance": boolean } ``` |

| Fields ||
|---|---|
| `allowCsrBasedIssuance` | `boolean` Required. When true, allows callers to create `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities.certificates#Certificate` by specifying a CSR. |
| `allowConfigBasedIssuance` | `boolean` Required. When true, allows callers to create `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities.certificates#Certificate` by specifying a `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/CertificateConfig`. |

## IssuingOptions

Options that affect all certificates issued by a `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`.

| JSON representation ||
|---|---|
| ``` { "includeCaCertUrl": boolean, "includeCrlAccessUrl": boolean } ``` |

| Fields ||
|---|---|
| `includeCaCertUrl` | `boolean` Required. When true, includes a URL to the issuing CA certificate in the "authority information access" X.509 extension. |
| `includeCrlAccessUrl` | `boolean` Required. When true, includes a URL to the CRL corresponding to certificates issued from a `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`. CRLs will expire 7 days from their creation. However, we will rebuild daily. CRLs are also rebuilt shortly after a certificate is revoked. |

## SubordinateConfig

Describes a subordinate CA's issuers. This is either a resource path to a known issuing `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`, or a PEM issuer certificate chain.

| JSON representation ||
|---|---|
| ``` { // Union field `subordinate_config` can be only one of the following: "certificateAuthority": string, "pemIssuerChain": { object (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#SubordinateConfigChain`) } // End of list of possible types for union field `subordinate_config`. } ``` |

| Fields ||
|---|---|---|
| Union field `subordinate_config`. `subordinate_config` can be only one of the following: |||
| `certificateAuthority` | `string` Required. This can refer to a `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority` in the same project that was used to create a subordinate `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`. This field is used for information and usability purposes only. The resource name is in the format `projects/*/locations/*/certificateAuthorities/*`. |
| `pemIssuerChain` | ``object (`https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#SubordinateConfigChain`)`` Required. Contains the PEM certificate chain for the issuers of this `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`, but not pem certificate for this CA itself. |

## SubordinateConfigChain

This message describes a subordinate CA's issuer certificate chain. This wrapper exists for compatibility reasons.

| JSON representation ||
|---|---|
| ``` { "pemCertificates": [ string ] } ``` |

| Fields ||
|---|---|
| `pemCertificates[]` | `string` Required. Expected to be in leaf-to-root order according to RFC 5246. |

## State

The state of a `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`, indicating if it can be used.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | Not specified. |
| `ENABLED` | Certificates can be issued from this CA. CRLs will be generated for this CA. |
| `DISABLED` | Certificates cannot be issued from this CA. CRLs will still be generated. |
| `PENDING_ACTIVATION` | Certificates cannot be issued from this CA. CRLs will not be generated. |
| `PENDING_DELETION` | Certificates cannot be issued from this CA. CRLs will not be generated. |

## AccessUrls

URLs where a `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority` will publish content.

| JSON representation ||
|---|---|
| ``` { "caCertificateAccessUrl": string, "crlAccessUrl": string } ``` |

| Fields ||
|---|---|
| `caCertificateAccessUrl` | `string` The URL where this `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`'s CA certificate is published. This will only be set for CAs that have been activated. |
| `crlAccessUrl` | `string` The URL where this `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`'s CRLs are published. This will only be set for CAs that have been activated. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities/activate` | Activate a `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority` that is in state `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#State.ENUM_VALUES.PENDING_ACTIVATION` and is of type `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#Type.ENUM_VALUES.SUBORDINATE`. |
| ### `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities/create` | Create a new `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority` in a given Project and Location. |
| ### `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities/disable` | Disable a `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`. |
| ### `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities/enable` | Enable a `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`. |
| ### `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities/fetch` | Fetch a certificate signing request (CSR) from a `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority` that is in state `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#State.ENUM_VALUES.PENDING_ACTIVATION` and is of type `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#Type.ENUM_VALUES.SUBORDINATE`. |
| ### `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities/get` | Returns a `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`. |
| ### `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities/getIamPolicy` | Gets the access control policy for a resource. |
| ### `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities/list` | Lists `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`. |
| ### `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities/patch` | Update a `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority`. |
| ### `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities/restore` | Restore a `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority` that is scheduled for deletion. |
| ### `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities/scheduleDelete` | Schedule a `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities#CertificateAuthority` for deletion. |
| ### `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities/setIamPolicy` | Sets the access control policy on the specified resource. |
| ### `https://docs.cloud.google.com/certificate-authority-service/docs/reference/rest/v1beta1/projects.locations.certificateAuthorities/testIamPermissions` | Returns permissions that a caller has on the specified resource. |