Method: projects.locations.caPools.certificates.list

Lists Certificates.

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.next_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.