Get started
Yandex Cloud Organization

Cloud Organization SAML API, REST: Federation.list

Written by

Retrieves the list of federations in the specified organization.

HTTP request

GET https://organization-manager.api.cloud.yandex.net/organization-manager/v1/saml/federations

Query parameters

Parameter Description
organizationId

Required. ID of the organization to list federations in. To get the organization ID, make a list request.

The maximum string length in characters is 50.
pageSize

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

Acceptable values are 0 to 1000, inclusive.
pageToken

Page token. To get the next page of results, set pageToken to the nextPageToken returned by a previous list request.

The maximum string length in characters is 2000.
filter

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

The maximum string length in characters is 1000.

Response

HTTP Code: 200 - OK

{
  "federations": [
    {
      "id": "string",
      "organizationId": "string",
      "name": "string",
      "description": "string",
      "createdAt": "string",
      "cookieMaxAge": "string",
      "autoCreateAccountOnLogin": true,
      "issuer": "string",
      "ssoBinding": "string",
      "ssoUrl": "string",
      "securitySettings": {
        "encryptedAssertions": true
      },
      "caseInsensitiveNameIds": true,
      "labels": "object"
    }
  ],
  "nextPageToken": "string"
}
Field Description
federations[] object

List of federations.
federations[].
id		 string

Required. ID of the federation.

The maximum string length in characters is 50.
federations[].
organizationId		 string

ID of the organization that the federation belongs to.
federations[].
name		 string

Required. Name of the federation.

Value must match the regular expression |[a-z][-a-z0-9]{1,61}[a-z0-9].
federations[].
description		 string

Description of the federation.

The maximum string length in characters is 256.
federations[].
createdAt		 string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
federations[].
cookieMaxAge		 string

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.

Acceptable values are 600 seconds to 43200 seconds, inclusive.
federations[].
autoCreateAccountOnLogin		 boolean (boolean)

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.
federations[].
issuer		 string

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

The maximum string length in characters is 8000.
federations[].
ssoBinding		 string

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.

  • POST: HTTP POST binding.
  • REDIRECT: HTTP redirect binding.
  • ARTIFACT: HTTP artifact binding.
federations[].
ssoUrl		 string

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

The maximum string length in characters is 8000.
federations[].
securitySettings		 object

Federation security settings.

Federation security settings.
federations[].
securitySettings.
encryptedAssertions		 boolean (boolean)

Enable encrypted assertions.
federations[].
caseInsensitiveNameIds		 boolean (boolean)

Use case insensitive Name IDs.
federations[].
labels		 object

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

This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken query parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results.
In this article: