Class: Aws::Finspace::Types::FederationParameters

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-finspace/types.rb

Overview

Configuration information when authentication mode is FEDERATED.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_call_back_url ⇒ String

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

Returns:

  • (String) 


1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
 
# File 'lib/aws-sdk-finspace/types.rb', line 1907

class FederationParameters < Struct.new(
  :saml_metadata_document,
  :saml_metadata_url,
  :application_call_back_url,
  :federation_urn,
  :federation_provider_name,
  :attribute_map)
  SENSITIVE = []
  include Aws::Structure
end

#attribute_map ⇒ Hash<String,String>

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 `schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress`. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.

Returns:

  • (Hash<String,String>) 


1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
 
# File 'lib/aws-sdk-finspace/types.rb', line 1907

class FederationParameters < Struct.new(
  :saml_metadata_document,
  :saml_metadata_url,
  :application_call_back_url,
  :federation_urn,
  :federation_provider_name,
  :attribute_map)
  SENSITIVE = []
  include Aws::Structure
end

#federation_provider_name ⇒ String

Name of the identity provider (IdP).

Returns:

  • (String) 


1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
 
# File 'lib/aws-sdk-finspace/types.rb', line 1907

class FederationParameters < Struct.new(
  :saml_metadata_document,
  :saml_metadata_url,
  :application_call_back_url,
  :federation_urn,
  :federation_provider_name,
  :attribute_map)
  SENSITIVE = []
  include Aws::Structure
end

#federation_urn ⇒ String

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

Returns:

  • (String) 


1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
 
# File 'lib/aws-sdk-finspace/types.rb', line 1907

class FederationParameters < Struct.new(
  :saml_metadata_document,
  :saml_metadata_url,
  :application_call_back_url,
  :federation_urn,
  :federation_provider_name,
  :attribute_map)
  SENSITIVE = []
  include Aws::Structure
end

#saml_metadata_document ⇒ String

SAML 2.0 Metadata document from identity provider (IdP).

Returns:

  • (String) 


1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
 
# File 'lib/aws-sdk-finspace/types.rb', line 1907

class FederationParameters < Struct.new(
  :saml_metadata_document,
  :saml_metadata_url,
  :application_call_back_url,
  :federation_urn,
  :federation_provider_name,
  :attribute_map)
  SENSITIVE = []
  include Aws::Structure
end

#saml_metadata_url ⇒ String

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

Returns:

  • (String) 


1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
 
# File 'lib/aws-sdk-finspace/types.rb', line 1907

class FederationParameters < Struct.new(
  :saml_metadata_document,
  :saml_metadata_url,
  :application_call_back_url,
  :federation_urn,
  :federation_provider_name,
  :attribute_map)
  SENSITIVE = []
  include Aws::Structure
end