Class FederationParameters
- java.lang.Object
-
- software.amazon.awssdk.services.finspace.model.FederationParameters
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<FederationParameters.Builder,FederationParameters>
@Generated("software.amazon.awssdk:codegen") public final class FederationParameters extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FederationParameters.Builder,FederationParameters>
Configuration information when authentication mode is FEDERATED.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceFederationParameters.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringapplicationCallBackURL()The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).Map<String,String>attributeMap()SAML attribute name and value.static FederationParameters.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfederationProviderName()Name of the identity provider (IdP).StringfederationURN()The Uniform Resource Name (URN).<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAttributeMap()For responses, this returns true if the service returned a value for the AttributeMap property.inthashCode()StringsamlMetadataDocument()SAML 2.0 Metadata document from identity provider (IdP).StringsamlMetadataURL()Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends FederationParameters.Builder>serializableBuilderClass()FederationParameters.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
samlMetadataDocument
public final String samlMetadataDocument()
SAML 2.0 Metadata document from identity provider (IdP).
- Returns:
- SAML 2.0 Metadata document from identity provider (IdP).
-
samlMetadataURL
public final String samlMetadataURL()
Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
- Returns:
- Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
-
applicationCallBackURL
public final String applicationCallBackURL()
The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
- Returns:
- The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
-
federationURN
public final String federationURN()
The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
- Returns:
- The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
-
federationProviderName
public final String federationProviderName()
Name of the identity provider (IdP).
- Returns:
- Name of the identity provider (IdP).
-
hasAttributeMap
public final boolean hasAttributeMap()
For responses, this returns true if the service returned a value for the AttributeMap property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
attributeMap
public final Map<String,String> attributeMap()
SAML attribute name and value. The name must always be
Emailand the value should be set to the attribute definition in which user email is set. For example, name would beEmailand valuehttp://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAttributeMap()method.- Returns:
- SAML attribute name and value. The name must always be
Emailand the value should be set to the attribute definition in which user email is set. For example, name would beEmailand valuehttp://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.
-
toBuilder
public FederationParameters.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<FederationParameters.Builder,FederationParameters>
-
builder
public static FederationParameters.Builder builder()
-
serializableBuilderClass
public static Class<? extends FederationParameters.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-