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

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

Overview

Note:

When making an API call, you may pass FederationParameters data as a hash:

{
  saml_metadata_document: "SamlMetadataDocument",
  saml_metadata_url: "url",
  application_call_back_url: "url",
  federation_urn: "urn",
  federation_provider_name: "FederationProviderName",
  attribute_map: {
    "FederationAttributeKey" => "url",
  },
}

Configuration information when authentication mode is FEDERATED.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_call_back_urlString

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

Returns:

  • (String)


255
256
257
258
259
260
261
262
263
264
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 255

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_mapHash<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 http://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>)


255
256
257
258
259
260
261
262
263
264
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 255

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_nameString

Name of the identity provider (IdP).

Returns:

  • (String)


255
256
257
258
259
260
261
262
263
264
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 255

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_urnString

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

Returns:

  • (String)


255
256
257
258
259
260
261
262
263
264
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 255

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_documentString

SAML 2.0 Metadata document from identity provider (IdP).

Returns:

  • (String)


255
256
257
258
259
260
261
262
263
264
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 255

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_urlString

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

Returns:

  • (String)


255
256
257
258
259
260
261
262
263
264
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 255

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