SAML Federation API, REST: Federation.List

Field

Description

organizationId

string

Required field. ID of the organization to list federations in.
To get the organization ID, make a yandex.cloud.organizationmanager.v1.OrganizationService.List request.

pageSize

string (int64)

The maximum number of results per page to return. If the number of available
results is larger than pageSize,
the service returns a ListFederationsResponse.nextPageToken
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 pageToken
to the ListFederationsResponse.nextPageToken
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].

Field

Description

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.pageSize, use
the nextPageToken as the value
for the ListFederationsRequest.pageToken query parameter
in the next list request. Each subsequent list request will have its own
nextPageToken to continue paging through the results.

Field

Description

id

string

Required field. ID of the federation.

organizationId

string

ID of the organization that the federation belongs to.

name

string

Required field. Name of the federation.

description

string

Description of the federation.

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

cookieMaxAge

string (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

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.

issuer

string

Required field. 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

enum (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.

• BINDING_TYPE_UNSPECIFIED
• POST: HTTP POST binding.
• REDIRECT: HTTP redirect binding.
• ARTIFACT: HTTP artifact binding.

ssoUrl

string

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

securitySettings

FederationSecuritySettings

Federation security settings.

caseInsensitiveNameIds

boolean

Use case insensitive Name IDs.

labels

object (map<string, string>)

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

Field

Description

encryptedAssertions

boolean

Enable encrypted assertions.

forceAuthn

boolean

Value parameter ForceAuthn in SAMLRequest.