Method get
Returns the specified federation.
To get the list of available federations, make a list request.
HTTP request
GET https://iam.api.cloud.yandex.net/iam/v1/saml/federations/{federationId}
Path parameters
| Parameter | Description |
|---|---|
| federationId | ID of the federation to return. To get the federation ID, make a list request. The maximum string length in characters is 50. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"name": "string",
"description": "string",
"createdAt": "string",
"cookieMaxAge": "string",
"autoCreateAccountOnLogin": true,
"issuer": "string",
"ssoBinding": "string",
"ssoUrl": "string",
"securitySettings": {
"encryptedAssertions": true
},
"caseInsensitiveNameIds": true
}
A federation.
For more information, see SAML-compatible identity federations.
| Field | Description |
|---|---|
| id | string Required. ID of the federation. The maximum string length in characters is 50. |
| folderId | string Required. ID of the folder that the federation belongs to. The maximum string length in characters is 50. |
| name | string Required. Name of the federation. Value must match the regular expression |
| description | string Description of the federation. The maximum string length in characters is 256. |
| createdAt | string (date-time) Creation timestamp. String in RFC3339 text format. |
| 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. |
| autoCreateAccountOnLogin | boolean (boolean) Add new users automatically on successful authentication. The user will get the If the value is |
| 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. |
| ssoBinding | string Single sign-on endpoint binding type. Most Identity Providers support the SAML Binding is a mapping of a SAML protocol message onto standard messaging formats and/or communications protocols.
|
| 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. |
| securitySettings | object Federation security settings. Federation security settings. |
| securitySettings. encryptedAssertions |
boolean (boolean) Enable encrypted assertions. |
| caseInsensitiveNameIds | boolean (boolean) Use case insensitive Name IDs. |