Class CfnEnvironment.FederationParametersProperty
Configuration information when authentication mode is FEDERATED.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.FinSpace
Assembly: Amazon.CDK.AWS.FinSpace.dll
Syntax (csharp)
public class FederationParametersProperty : Object, CfnEnvironment.IFederationParametersProperty
Syntax (vb)
Public Class FederationParametersProperty
Inherits Object
Implements CfnEnvironment.IFederationParametersProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.FinSpace;
var federationParametersProperty = new FederationParametersProperty {
ApplicationCallBackUrl = "applicationCallBackUrl",
AttributeMap = new [] { new AttributeMapItemsProperty {
Key = "key",
Value = "value"
} },
FederationProviderName = "federationProviderName",
FederationUrn = "federationUrn",
SamlMetadataDocument = "samlMetadataDocument",
SamlMetadataUrl = "samlMetadataUrl"
};
Synopsis
Constructors
FederationParametersProperty() |
Properties
ApplicationCallBackUrl | The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP). |
AttributeMap | SAML attribute name and value. |
FederationProviderName | Name of the identity provider (IdP). |
FederationUrn | The Uniform Resource Name (URN). |
SamlMetadataDocument | SAML 2.0 Metadata document from identity provider (IdP). |
SamlMetadataUrl | Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP). |
Constructors
FederationParametersProperty()
public FederationParametersProperty()
Properties
ApplicationCallBackUrl
The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
public string ApplicationCallBackUrl { get; set; }
Property Value
System.String
Remarks
AttributeMap
SAML attribute name and value.
public object AttributeMap { get; set; }
Property Value
System.Object
Remarks
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.
FederationProviderName
Name of the identity provider (IdP).
public string FederationProviderName { get; set; }
Property Value
System.String
Remarks
FederationUrn
The Uniform Resource Name (URN).
public string FederationUrn { get; set; }
Property Value
System.String
Remarks
Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
SamlMetadataDocument
SAML 2.0 Metadata document from identity provider (IdP).
public string SamlMetadataDocument { get; set; }
Property Value
System.String
Remarks
SamlMetadataUrl
Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
public string SamlMetadataUrl { get; set; }
Property Value
System.String