Identity and Access Management SAML API, REST: Federation.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
Field |
Description |
federationId |
string Required field. ID of the federation to return. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"name": "string",
"description": "string",
"createdAt": "string",
"cookieMaxAge": "string",
"autoCreateAccountOnLogin": "boolean",
"issuer": "string",
"ssoBinding": "string",
"ssoUrl": "string",
"securitySettings": {
"encryptedAssertions": "boolean"
},
"caseInsensitiveNameIds": "boolean"
}
A federation.
For more information, see SAML-compatible identity federations.
Field |
Description |
id |
string Required field. ID of the federation. |
folderId |
string Required field. ID of the folder 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 To work with values in this field, use the APIs described in the |
cookieMaxAge |
string (duration) Browser cookie lifetime in seconds. |
autoCreateAccountOnLogin |
boolean Add new users automatically on successful authentication. If the value is |
issuer |
string Required field. ID of the IdP server to be used for authentication. |
ssoBinding |
enum (BindingType) Single sign-on endpoint binding type. Most Identity Providers support the SAML Binding is a mapping of a SAML protocol message onto standard messaging
|
ssoUrl |
string Required field. Single sign-on endpoint URL. |
securitySettings |
Federation security settings. |
caseInsensitiveNameIds |
boolean Use case insensitive Name IDs. |
FederationSecuritySettings
Federation security settings.
Field |
Description |
encryptedAssertions |
boolean Enable encrypted assertions. |