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