Skip to main content

List

Retrieves the list of federated credentials for the specified service account.

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

const ListFederatedCredentialsRequest =
cloudApi.iam.workload_federated_credential_service
.ListFederatedCredentialsRequest;

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

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

ListFederatedCredentialsRequest

serviceAccountId : string

ID of the service account to list federated credentials for. To get the the service account ID make a yandex.cloud.iam.v1.ServiceAccountService.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 ListFederatedCredentialsResponse.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 ListFederatedCredentialsResponse.next_page_token returned by a previous list request.

ListFederatedCredentialsResponse

federatedCredentials : FederatedCredential

List of federated credentials.

nextPageToken : string

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

FederatedCredential

A federated credential.

id : string

Id of the federated credential.

serviceAccountId : string

Id of the service account that the federated credential belongs to.

federationId : string

ID of the workload identity federation which is used for authentication.

externalSubjectId : string

Id of the external subject.

createdAt : google.protobuf.Timestamp

Creation timestamp.