List

Retrieves the list of certificates in the specified federation.

TypeScript

import { cloudApi, serviceClients, Session } from "@yandex-cloud/nodejs-sdk";

const CertificateView =
  cloudApi.certificatemanager.certificate_service.CertificateView;
const ListCertificatesRequest =
  cloudApi.certificatemanager.certificate_service.ListCertificatesRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.CertificateServiceClient);

  const result = await client.list(
    ListCertificatesRequest.fromPartial({
      folderId: "folderId",
      // pageSize: 0,
      // pageToken: "pageToken",
      // view: CertificateView.FULL
    })
  );
  console.log(result);
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.certificatemanager.v1.certificate_service_pb2_grpc import CertificateServiceStub
from yandex.cloud.certificatemanager.v1.certificate_service_pb2 import CertificateView
from yandex.cloud.certificatemanager.v1.certificate_service_pb2 import ListCertificatesRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(CertificateServiceStub)
response = service.List(
    ListCertificatesRequest(
        folder_id="folderId",
        # page_size = 0,
        # page_token = "pageToken",
        # view = CertificateView.FULL
    )
)
print(response)

ListCertificatesRequest

federationId : string

ID of the federation to list certificates in. To get the federation ID make a yandex.cloud.organizationmanager.v1.saml.FederationService.List request.

pageSize : int64

The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListCertificatesResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100.

pageToken : string

Page token. To get the next page of results, set page_token to the ListCertificatesResponse.next_page_token returned by a previous list request.

filter : string

A filter expression that filters resources listed in the response. The expression must specify:

1. The field name. Currently you can use filtering only on Certificate.name field.
2. An = operator.
3. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9].

ListCertificatesResponse

certificates : Certificate

List of certificates.

nextPageToken : string

This token allows you to get the next page of results for list requests. If the number of results is larger than ListCertificatesRequest.page_size, use the next_page_token as the value for the ListCertificatesRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

Certificate

A certificate.

id : string

ID of the certificate.

federationId : string

ID of the federation that the certificate belongs to.

name : string

Name of the certificate.

description : string

Description of the certificate.

createdAt : google.protobuf.Timestamp

Creation timestamp.

data : string

Certificate data in PEM format.

---