FederationParameters -

FederationParameters

Configuration information when authentication mode is FEDERATED.

Contents

Note

In the following list, the required parameters are described first.

applicationCallBackURL

The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: ^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]

Required: No

attributeMap

SAML attribute name and value. The name must always be Email and the value should be set to the attribute definition in which user email is set. For example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 32.

Key Pattern: .*

Value Length Constraints: Minimum length of 1. Maximum length of 1000.

Value Pattern: ^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]

Required: No

federationProviderName

Name of the identity provider (IdP).

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: [^_\p{Z}][\p{L}\p{M}\p{S}\p{N}\p{P}][^_\p{Z}]+

Required: No

federationURN

The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[A-Za-z0-9._\-:\/#\+]+$

Required: No

samlMetadataDocument

SAML 2.0 Metadata document from identity provider (IdP).

Type: String

Length Constraints: Minimum length of 1000. Maximum length of 10000000.

Pattern: .*

Required: No

samlMetadataURL

Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: ^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: