2023-02-08
▼ ▲ privateca.projects.locations.certificateAuthorities.certificateRevocationLists.list
Path: v1beta1/{+parent}/certificateRevocationLists
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}/certificateRevocationLists
HTTP Method: GET
Parameters:
pageToken
Location: query
Description: Optional. Pagination token, returned earlier via ListCertificateRevocationListsResponse.next_page_token.
Type: string
pageSize
Type: integer
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
Location: query
filter
Location: query
Type: string
Description: Optional. Only include resources that match the filter in the response.
orderBy
Location: query
Type: string
Description: Optional. Specify how the results should be sorted.
parent
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$
Description: Required. The resource name of the location associated with the CertificateRevocationLists, in the format `projects/*/locations/*/certificateauthorities/*`.
Location: path
Type: string
Description: Lists CertificateRevocationLists.
▼ ▲ privateca.projects.locations.certificateAuthorities.certificateRevocationLists.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Returns a CertificateRevocationList.
Path: v1beta1/{+name}
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}/certificateRevocationLists/{certificateRevocationListsId}
Parameters:
name
Description: Required. The name of the CertificateRevocationList to get.
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+/certificateRevocationLists/[^/]+$
Type: string
Required: Yes
Location: path
HTTP Method: GET
▼ ▲ privateca.projects.locations.certificateAuthorities.certificateRevocationLists.patch
Parameter Order: name
Description: Update a CertificateRevocationList.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
updateMask
Type: string
Description: Required. A list of fields to be updated in this request.
Format: google-fieldmask
Location: query
name
Description: Output only. The resource path for this CertificateRevocationList in the format `projects/*/locations/*/certificateAuthorities/*/ certificateRevocationLists/*`.
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+/certificateRevocationLists/[^/]+$
Location: path
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
Path: v1beta1/{+name}
HTTP Method: PATCH
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}/certificateRevocationLists/{certificateRevocationListsId}
▼ ▲ privateca.projects.locations.certificateAuthorities.certificates.get
Path: v1beta1/{+name}
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}/certificates/{certificatesId}
HTTP Method: GET
Description: Returns a Certificate.
Parameters:
name
Required: Yes
Description: Required. The name of the Certificate to get.
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+/certificates/[^/]+$
Location: path
Type: string
▼ ▲ privateca.projects.locations.certificateAuthorities.certificates.list
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}/certificates
Description: Lists Certificates.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+parent}/certificates
Parameter Order: parent
Parameters:
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
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
Description: Required. The resource name of the location associated with the Certificates, in the format `projects/*/locations/*/certificateauthorities/*`.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$
Required: Yes
Location: path
pageToken
Description: Optional. Pagination token, returned earlier via ListCertificatesResponse.next_page_token.
Location: query
Type: string
orderBy
Location: query
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).
Type: string
▼ ▲ privateca.projects.locations.certificateAuthorities.certificates.patch
HTTP Method: PATCH
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}/certificates/{certificatesId}
Description: Update a Certificate. Currently, the only field you can update is the labels field.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+/certificates/[^/]+$
Required: Yes
Description: Output only. The resource path for this Certificate in the format `projects/*/locations/*/certificateAuthorities/*/certificates/*`.
Location: path
Type: string
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
updateMask
Type: string
Format: google-fieldmask
Description: Required. A list of fields to be updated in this request.
Location: query
Parameter Order: name
▼ ▲ privateca.projects.locations.certificateAuthorities.certificates.revoke
Parameters:
name
Required: Yes
Description: Required. The resource name for this Certificate in the format `projects/*/locations/*/certificateAuthorities/*/certificates/*`.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+/certificates/[^/]+$
Type: string
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}/certificates/{certificatesId}:revoke
Parameter Order: name
Path: v1beta1/{+name}:revoke
HTTP Method: POST
Description: Revoke a Certificate.
▼ ▲ privateca.projects.locations.certificateAuthorities.certificates.create
Parameter Order: parent
Parameters:
parent
Type: string
Required: Yes
Location: path
Description: Required. The resource name of the location and CertificateAuthority associated with the Certificate, in the format `projects/*/locations/*/certificateAuthorities/*`.
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$
certificateId
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.
Type: string
Location: query
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).
Type: string
Location: query
Path: v1beta1/{+parent}/certificates
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Create a new Certificate in a given Project, Location from a particular CertificateAuthority.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}/certificates
▼ ▲ privateca.projects.locations.certificateAuthorities.enable
Parameters:
name
Required: Yes
Location: path
Type: string
Description: Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/certificateAuthorities/*`.
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$
HTTP Method: POST
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}:enable
Path: v1beta1/{+name}:enable
Description: Enable a CertificateAuthority.
▼ ▲ privateca.projects.locations.certificateAuthorities.get
Parameters:
name
Required: Yes
Description: Required. The name of the CertificateAuthority to get.
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$
Description: Returns a CertificateAuthority.
HTTP Method: GET
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ privateca.projects.locations.certificateAuthorities.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Update a CertificateAuthority.
HTTP Method: PATCH
Parameter Order: name
Parameters:
updateMask
Format: google-fieldmask
Location: query
Description: Required. A list of fields to be updated in this request.
Type: string
name
Type: string
Required: Yes
Location: path
Description: Output only. The resource name for this CertificateAuthority in the format `projects/*/locations/*/certificateAuthorities/*`.
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$
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
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}
▼ ▲ privateca.projects.locations.certificateAuthorities.disable
Parameters:
name
Description: Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/certificateAuthorities/*`.
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$
Type: string
Location: path
Required: Yes
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}:disable
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Disable a CertificateAuthority.
Path: v1beta1/{+name}:disable
▼ ▲ privateca.projects.locations.certificateAuthorities.create
Path: v1beta1/{+parent}/certificateAuthorities
Description: Create a new CertificateAuthority in a given Project and Location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities
HTTP Method: POST
Parameter Order: parent
Parameters:
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
certificateAuthorityId
Type: string
Description: Required. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}`
Location: query
parent
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Description: Required. The resource name of the location associated with the CertificateAuthorities, in the format `projects/*/locations/*`.
▼ ▲ privateca.projects.locations.certificateAuthorities.list
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities
Path: v1beta1/{+parent}/certificateAuthorities
Parameters:
orderBy
Type: string
Location: query
Description: Optional. Specify how the results should be sorted.
pageSize
Location: query
Format: int32
Type: integer
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.
pageToken
Description: Optional. Pagination token, returned earlier via ListCertificateAuthoritiesResponse.next_page_token.
Type: string
Location: query
filter
Description: Optional. Only include resources that match the filter in the response.
Location: query
Type: string
parent
Type: string
Description: Required. The resource name of the location associated with the CertificateAuthorities, in the format `projects/*/locations/*`.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Description: Lists CertificateAuthorities.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameter Order: parent
▼ ▲ privateca.projects.locations.certificateAuthorities.scheduleDelete
Path: v1beta1/{+name}:scheduleDelete
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
Parameter Order: name
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}:scheduleDelete
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Schedule a CertificateAuthority for deletion.
HTTP Method: POST
▼ ▲ privateca.projects.locations.certificateAuthorities.activate
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}:activate
Parameter Order: name
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/[^/]+$
Path: v1beta1/{+name}:activate
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.
HTTP Method: POST
▼ ▲ privateca.projects.locations.certificateAuthorities.restore
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
name
Description: Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/certificateAuthorities/*`.
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$
Path: v1beta1/{+name}:restore
HTTP Method: POST
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/certificateAuthorities/{certificateAuthoritiesId}:restore
Description: Restore a CertificateAuthority that is scheduled for deletion.
▼ ▲ privateca.projects.locations.certificateAuthorities.fetch
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.
Parameter Order: name
Path: v1beta1/{+name}:fetch
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$
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}:fetch
▼ ▲ privateca.projects.locations.reusableConfigs.get
Description: Returns a ReusableConfig.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/reusableConfigs/{reusableConfigsId}
Parameter Order: name
Path: v1beta1/{+name}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/reusableConfigs/[^/]+$
Location: path
Type: string
Description: Required. The name of the ReusableConfigs to get.
Required: Yes
▼ ▲ privateca.projects.locations.reusableConfigs.list
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/reusableConfigs
Path: v1beta1/{+parent}/reusableConfigs
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
orderBy
Description: Optional. Specify how the results should be sorted.
Location: query
Type: string
pageSize
Type: integer
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.
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Description: Required. The resource name of the location associated with the ReusableConfigs, in the format `projects/*/locations/*`.
Required: Yes
Location: path
filter
Description: Optional. Only include resources that match the filter in the response.
Type: string
Location: query
pageToken
Location: query
Description: Optional. Pagination token, returned earlier via ListReusableConfigsResponse.next_page_token.
Type: string
Parameter Order: parent
HTTP Method: GET
Description: Lists ReusableConfigs.