Skip to main content

List

Retrieves the list of federations in the specified organization.

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);
})();

ListFederationsRequest​

organizationId : string​

ID of the organization to list federations in. To get the organization ID, make a yandex.cloud.organizationmanager.v1.OrganizationService.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.

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 the Federation.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].

ListFederationsResponse​

federations : Federation​

List of 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 federation. For more information, see SAML-compatible identity federations.

id : string​

ID of the federation.

organizationId : string​

ID of the organization that the federation belongs to.

name : string​

Name of the federation.

description : string​

Description of the federation.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

cookieMaxAge : google.protobuf.Duration​

Browser cookie lifetime in seconds. If the cookie is still valid, the management console authenticates the user immediately and redirects them to the home page.

autoCreateAccountOnLogin : bool​

Add new users automatically on successful authentication. The user becomes member of the organization automatically, but you need to grant other roles to them.

If the value is false, users who aren't added to the organization can't log in, even if they have authenticated on your server.

issuer : string​

ID of the IdP server to be used for authentication. The IdP server also responds to IAM with this ID after the user authenticates.

ssoBinding : BindingType​

Single sign-on endpoint binding type. Most Identity Providers support the POST binding type.

SAML Binding is a mapping of a SAML protocol message onto standard messaging formats and/or communications protocols.

ssoUrl : string​

Single sign-on endpoint URL. Specify the link to the IdP login page here.

securitySettings : FederationSecuritySettings​

Federation security settings.

caseInsensitiveNameIds : bool​

Use case insensitive Name IDs.

labels : string​

Resource labels as key:value pairs. Maximum of 64 per resource.

FederationSecuritySettings​

Federation security settings.

encryptedAssertions : bool​

Enable encrypted assertions.

forceAuthn : bool​

Value parameter ForceAuthn in SAMLRequest.