List

Retrieves the list of OIDC workload identity federations in the specified folder.

TypeScript

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

const ListFederationsRequest =
  cloudApi.iam.workload_oidc_federation_service.ListFederationsRequest;

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

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

Python

import os
import grpc
import yandexcloud

from yandex.cloud.iam.v1.workload.oidc.federation_service_pb2_grpc import FederationServiceStub
from yandex.cloud.iam.v1.workload.oidc.federation_service_pb2 import ListFederationsRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(FederationServiceStub)
response = service.List(
    ListFederationsRequest(
        folder_id="folderId",
        # page_size = 0,
        # page_token = "pageToken"
    )
)
print(response)

ListFederationsRequest

folderId : string

ID of the folder to list OIDC workload identity federations in. To get the folder ID, make a yandex.cloud.resourcemanager.v1.FolderService.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 ListFederationsResponse.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 ListFederationsResponse.next_page_token returned by a previous list request.

ListFederationsResponse

federations : Federation

List of OIDC workload identity federations.

nextPageToken : string

This token allows you to get the next page of results for list requests. If the number of results is larger than ListFederationsRequest.page_size, use the next_page_token as the value for the ListFederationsRequest.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.

Federation

A OIDC workload identity federation.

id : string

Id of the OIDC workload identity federation.

name : string

Name of the OIDC workload identity federation The name is unique within the folder. 3-63 characters long.

folderId : string

ID of the folder that the OIDC workload identity federation belongs to.

description : string

Description of the service account. 0-256 characters long.

enabled : bool

True - the OIDC workload identity federation is enabled and can be used for authentication. False - the OIDC workload identity federation is disabled and cannot be used for authentication.

audiences : string

List of trusted values for aud claim.

issuer : string

URL of the external IdP server to be used for authentication.

jwksUrl : string

URL reference to trusted keys in format of JSON Web Key Set.

labels : string

Resource labels as key:value pairs

createdAt : google.protobuf.Timestamp

Creation timestamp.

---