2023-02-05
▼ ▲ privateca.projects.locations.reusableConfigs.list
Parameters:
parent
Description: Required. The resource name of the location associated with the ReusableConfigs, in the format `projects/*/locations/*`.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Type: string
Required: Yes
pageSize
Format: int32
Location: query
Description: Optional. Limit on the number of ReusableConfigs to include in the response. Further ReusableConfigs can subsequently be obtained by including the ListReusableConfigsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
Type: integer
orderBy
Description: Optional. Specify how the results should be sorted.
Location: query
Type: string
filter
Location: query
Type: string
Description: Optional. Only include resources that match the filter in the response.
pageToken
Description: Optional. Pagination token, returned earlier via ListReusableConfigsResponse.next_page_token.
Location: query
Type: string
Path: v1beta1/{+parent}/reusableConfigs
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/reusableConfigs
Description: Lists ReusableConfigs.
Parameter Order: parent
▼ ▲ privateca.projects.locations.reusableConfigs.get
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/reusableConfigs/[^/]+$
Required: Yes
Type: string
Location: path
Description: Required. The name of the ReusableConfigs to get.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/reusableConfigs/{reusableConfigsId}
Parameter Order: name
Path: v1beta1/{+name}
Description: Returns a ReusableConfig.
HTTP Method: GET
▼ ▲ privateca.projects.locations.certificateAuthorities.certificateRevocationLists.patch
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}/certificateRevocationLists/{certificateRevocationListsId}
Description: Update a CertificateRevocationList.
Parameter Order: name
HTTP Method: PATCH
Path: v1beta1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Required: Yes
Description: Output only. The resource path for this CertificateRevocationList in the format `projects/*/locations/*/certificateAuthorities/*/ certificateRevocationLists/*`.
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+/certificateRevocationLists/[^/]+$
requestId
Type: string
Description: 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).
Location: query
updateMask
Type: string
Description: Required. A list of fields to be updated in this request.
Location: query
Format: google-fieldmask
▼ ▲ privateca.projects.locations.certificateAuthorities.certificateRevocationLists.get
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}/certificateRevocationLists/{certificateRevocationListsId}
Parameters:
name
Required: Yes
Description: Required. The name of the CertificateRevocationList to get.
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+/certificateRevocationLists/[^/]+$
Description: Returns a CertificateRevocationList.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}
HTTP Method: GET
▼ ▲ privateca.projects.locations.certificateAuthorities.certificateRevocationLists.list
HTTP Method: GET
Parameter Order: parent
Description: Lists CertificateRevocationLists.
Parameters:
parent
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$
Location: path
Description: Required. The resource name of the location associated with the CertificateRevocationLists, in the format `projects/*/locations/*/certificateauthorities/*`.
Required: Yes
pageToken
Type: string
Location: query
Description: Optional. Pagination token, returned earlier via ListCertificateRevocationListsResponse.next_page_token.
orderBy
Type: string
Description: Optional. Specify how the results should be sorted.
Location: query
filter
Location: query
Type: string
Description: Optional. Only include resources that match the filter in the response.
pageSize
Type: integer
Location: query
Description: Optional. Limit on the number of CertificateRevocationLists to include in the response. Further CertificateRevocationLists can subsequently be obtained by including the ListCertificateRevocationListsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
Format: int32
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}/certificateRevocationLists
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+parent}/certificateRevocationLists
▼ ▲ privateca.projects.locations.certificateAuthorities.certificates.revoke
Path: v1beta1/{+name}:revoke
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+/certificates/[^/]+$
Required: Yes
Description: Required. The resource name for this Certificate in the format `projects/*/locations/*/certificateAuthorities/*/certificates/*`.
Type: string
Location: path
HTTP Method: POST
Description: Revoke a Certificate.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}/certificates/{certificatesId}:revoke
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ privateca.projects.locations.certificateAuthorities.certificates.list
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}/certificates
Path: v1beta1/{+parent}/certificates
Parameters:
filter
Type: string
Description: Optional. Only include resources that match the filter in the response. For details on supported filters and syntax, see [Certificates Filtering documentation](https://cloud.google.com/certificate-authority-service/docs/sorting-filtering-certificates#filtering_support).
Location: query
parent
Location: path
Description: Required. The resource name of the location associated with the Certificates, in the format `projects/*/locations/*/certificateauthorities/*`.
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$
Required: Yes
Type: string
pageSize
Type: integer
Description: Optional. Limit on the number of Certificates to include in the response. Further Certificates can subsequently be obtained by including the ListCertificatesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
Format: int32
Location: query
pageToken
Type: string
Description: Optional. Pagination token, returned earlier via ListCertificatesResponse.next_page_token.
Location: query
orderBy
Type: string
Description: Optional. Specify how the results should be sorted. For details on supported fields and syntax, see [Certificates Sorting documentation](https://cloud.google.com/certificate-authority-service/docs/sorting-filtering-certificates#sorting_support).
Location: query
Description: Lists Certificates.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
HTTP Method: GET
▼ ▲ privateca.projects.locations.certificateAuthorities.certificates.patch
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+/certificates/[^/]+$
Type: string
Required: Yes
Description: Output only. The resource path for this Certificate in the format `projects/*/locations/*/certificateAuthorities/*/certificates/*`.
requestId
Type: string
Location: query
Description: 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).
updateMask
Format: google-fieldmask
Type: string
Description: Required. A list of fields to be updated in this request.
Location: query
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: PATCH
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}/certificates/{certificatesId}
Parameter Order: name
Description: Update a Certificate. Currently, the only field you can update is the labels field.
Path: v1beta1/{+name}
▼ ▲ privateca.projects.locations.certificateAuthorities.certificates.get
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}
Description: Returns a Certificate.
Parameters:
name
Location: path
Description: Required. The name of the Certificate to get.
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+/certificates/[^/]+$
Type: string
Required: Yes
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}/certificates/{certificatesId}
Parameter Order: name
▼ ▲ privateca.projects.locations.certificateAuthorities.certificates.create
Parameters:
parent
Required: Yes
Type: string
Description: Required. The resource name of the location and CertificateAuthority associated with the Certificate, in the format `projects/*/locations/*/certificateAuthorities/*`.
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$
Location: path
certificateId
Type: string
Location: query
Description: Optional. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}`. This field is required when using a CertificateAuthority in the Enterprise CertificateAuthority.Tier, but is optional and its value is ignored otherwise.
requestId
Description: 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).
Location: query
Type: string
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}/certificates
Description: Create a new Certificate in a given Project, Location from a particular CertificateAuthority.
Path: v1beta1/{+parent}/certificates
▼ ▲ privateca.projects.locations.certificateAuthorities.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+parent}/certificateAuthorities
HTTP Method: POST
Parameters:
certificateAuthorityId
Description: Required. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}`
Location: query
Type: string
parent
Type: string
Required: Yes
Location: path
Description: Required. The resource name of the location associated with the CertificateAuthorities, in the format `projects/*/locations/*`.
Pattern: ^projects/[^/]+/locations/[^/]+$
requestId
Location: query
Description: 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).
Type: string
Parameter Order: parent
Description: Create a new CertificateAuthority in a given Project and Location.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities
▼ ▲ privateca.projects.locations.certificateAuthorities.activate
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}:activate
Parameters:
name
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$
Description: Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/certificateAuthorities/*`.
Location: path
Path: v1beta1/{+name}:activate
Parameter Order: name
Description: Activate a CertificateAuthority that is in state PENDING_ACTIVATION and is of type SUBORDINATE. After the parent Certificate Authority signs a certificate signing request from FetchCertificateAuthorityCsr, this method can complete the activation process.
▼ ▲ privateca.projects.locations.certificateAuthorities.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}
Parameter Order: name
Parameters:
name
Required: Yes
Description: Output only. The resource name for this CertificateAuthority in the format `projects/*/locations/*/certificateAuthorities/*`.
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$
requestId
Type: string
Description: 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).
Location: query
updateMask
Format: google-fieldmask
Type: string
Location: query
Description: Required. A list of fields to be updated in this request.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}
HTTP Method: PATCH
Description: Update a CertificateAuthority.
▼ ▲ privateca.projects.locations.certificateAuthorities.restore
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}:restore
Description: Restore a CertificateAuthority that is scheduled for deletion.
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1beta1/{+name}:restore
Parameters:
name
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$
Description: Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/certificateAuthorities/*`.
▼ ▲ privateca.projects.locations.certificateAuthorities.list
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities
Parameter Order: parent
Description: Lists CertificateAuthorities.
Parameters:
pageSize
Format: int32
Description: Optional. Limit on the number of CertificateAuthorities to include in the response. Further CertificateAuthorities can subsequently be obtained by including the ListCertificateAuthoritiesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
Type: integer
Location: query
parent
Location: path
Required: Yes
Description: Required. The resource name of the location associated with the CertificateAuthorities, in the format `projects/*/locations/*`.
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
pageToken
Type: string
Description: Optional. Pagination token, returned earlier via ListCertificateAuthoritiesResponse.next_page_token.
Location: query
orderBy
Location: query
Type: string
Description: Optional. Specify how the results should be sorted.
filter
Type: string
Location: query
Description: Optional. Only include resources that match the filter in the response.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v1beta1/{+parent}/certificateAuthorities
▼ ▲ privateca.projects.locations.certificateAuthorities.fetch
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1beta1/{+name}:fetch
HTTP Method: GET
Description: Fetch a certificate signing request (CSR) from a CertificateAuthority that is in state PENDING_ACTIVATION and is of type SUBORDINATE. The CSR must then be signed by the desired parent Certificate Authority, which could be another CertificateAuthority resource, or could be an on-prem certificate authority. See also ActivateCertificateAuthority.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}:fetch
Parameters:
name
Required: Yes
Location: path
Description: Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/certificateAuthorities/*`.
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$
Type: string
▼ ▲ privateca.projects.locations.certificateAuthorities.disable
Parameter Order: name
Path: v1beta1/{+name}:disable
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}:disable
Description: Disable a CertificateAuthority.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Location: path
Required: Yes
Description: Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/certificateAuthorities/*`.
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$
HTTP Method: POST
▼ ▲ privateca.projects.locations.certificateAuthorities.scheduleDelete
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Location: path
Required: Yes
Description: Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/certificateAuthorities/*`.
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$
Type: string
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}:scheduleDelete
Parameter Order: name
Description: Schedule a CertificateAuthority for deletion.
Path: v1beta1/{+name}:scheduleDelete
HTTP Method: POST
▼ ▲ privateca.projects.locations.certificateAuthorities.get
Parameter Order: name
Description: Returns a CertificateAuthority.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$
Required: Yes
Location: path
Description: Required. The name of the CertificateAuthority to get.
Type: string
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
▼ ▲ privateca.projects.locations.certificateAuthorities.enable
Description: Enable a CertificateAuthority.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Path: v1beta1/{+name}:enable
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$
Type: string
Location: path
Required: Yes
Description: Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/certificateAuthorities/*`.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}:enable