Method: projects.locations.caPools.certificates.list
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://privateca.googleapis.com/v1/{parent=projects/*/locations/*/caPools/*}/certificates
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The resource name of the location associated with the Certificates, in the format projects/*/locations/*/caPools/*.
Authorization requires the following IAM permission on the specified resource parent:
privateca.certificates.list
|
Query parameters
| Parameters |
pageSize |
integer
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.
|
pageToken |
string
Optional. Pagination token, returned earlier via ListCertificatesResponse.next_page_token.
|
filter |
string
Optional. Only include resources that match the filter in the response. For details on supported filters and syntax, see Certificates Filtering documentation.
|
orderBy |
string
Optional. Specify how the results should be sorted. For details on supported fields and syntax, see Certificates Sorting documentation.
|
Request body
The request body must be empty.
Response body
Response message for CertificateAuthorityService.ListCertificates.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"certificates": [
{
object (Certificate)
}
],
"nextPageToken": string,
"unreachable": [
string
]
} |
| Fields |
certificates[] |
object (Certificate)
The list of Certificates.
|
nextPageToken |
string
A token to retrieve next page of results. Pass this value in ListCertificatesRequest.page_token to retrieve the next page of results.
|
unreachable[] |
string
A list of locations (e.g. "us-west1") that could not be reached.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-06 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-06 UTC."],[[["This webpage details how to list Certificates using the `GET` method through an HTTP request to the specified URL: `https://privateca.googleapis.com/v1/{parent=projects/*/locations/*/caPools/*}/certificates`."],["The request requires a `parent` path parameter, which is a string representing the location of the Certificates and requires the `privateca.certificates.list` IAM permission."],["Optional query parameters such as `pageSize`, `pageToken`, `filter`, and `orderBy` are available to customize the list, offering options to limit results, paginate, filter, and sort the Certificates."],["The request body must be empty, and a successful response includes a list of Certificate objects, a token for the next page of results, and a list of unreachable locations, all within a JSON formatted response body."],["To access this information, you must have the `https://www.googleapis.com/auth/cloud-platform` OAuth scope."]]],[]]
