Method: projects.locations.caPools.certificateAuthorities.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/*}/certificateAuthorities
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The resource name of the CaPool associated with the CertificateAuthorities, in the format projects/*/locations/*/caPools/*.
Authorization requires the following IAM permission on the specified resource parent:
privateca.certificateAuthorities.list
|
Query parameters
| Parameters |
pageSize |
integer
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 |
string
Optional. Pagination token, returned earlier via ListCertificateAuthoritiesResponse.next_page_token.
|
filter |
string
Optional. Only include resources that match the filter in the response.
|
orderBy |
string
Optional. Specify how the results should be sorted.
|
Request body
The request body must be empty.
Response body
Response message for CertificateAuthorityService.ListCertificateAuthorities.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"certificateAuthorities": [
{
object (CertificateAuthority)
}
],
"nextPageToken": string,
"unreachable": [
string
]
} |
| Fields |
certificateAuthorities[] |
object (CertificateAuthority)
The list of CertificateAuthorities.
|
nextPageToken |
string
A token to retrieve next page of results. Pass this value in ListCertificateAuthoritiesRequest.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 document describes how to list Certificate Authorities within a specified CaPool using a GET request to the provided URL."],["The `parent` path parameter, formatted as `projects/*/locations/*/caPools/*`, is mandatory and requires the `privateca.certificateAuthorities.list` IAM permission."],["Optional query parameters such as `pageSize`, `pageToken`, `filter`, and `orderBy` can be used to manage the number, filtering, and ordering of listed Certificate Authorities."],["The response body, in JSON format, contains a list of `certificateAuthorities`, a `nextPageToken` for pagination, and a list of `unreachable` locations."],["The request requires an empty request body, while authorization needs the `https://www.googleapis.com/auth/cloud-platform` OAuth scope."]]],[]]
