SAMLEndpointSettings Class | AWS SDK for .NET V3

The persisted data for a SAML endpoint. One or more role profiles will reference this to obtain the common endpoint and other data needed to perform authentication with a set of user credentials.

Inheritance Hierarchy

System.Object
Amazon.Util.ProfileSettingsBase
Amazon.Util.SAMLEndpointSettings

Namespace: Amazon.Util
Assembly: AWSSDK.Core.dll
Version: 3.x.y.z

Syntax

[Obsolete("This class is obsolete and will be removed in a future release. Please use Amazon.Runtime.CredentialManagement.SAMLEndpoint.  Visit http://docs.aws.amazon.com/sdk-for-net/v3/developer-guide/net-dg-config-creds.html for further details.")]
public class SAMLEndpointSettings : ProfileSettingsBase

The SAMLEndpointSettings type exposes the following members

Properties

Name	Type	Description
AuthenticationType	System.String	The authentication type to use when calling the endpoint.
Endpoint	System.Uri	The authentication endpoint which must be a HTTPS scheme.
Name	System.String	Inherited from Amazon.Util.ProfileSettingsBase.
UniqueId	System.String	Inherited from Amazon.Util.ProfileSettingsBase.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

	Name	Description
	CanCreateFrom(string)	Tests if a SAMLEndpointSettings instance could be instantiated from the persisted settings data.
	CanCreateFrom(SettingsCollection.ObjectSettings)	Tests if a SAMLEndpointSettings instance could be instantiated from the persisted settings data.
	LoadFrom(string)	Instantiates an instance from settings stored with the specified name.
	LoadFrom(SettingsCollection.ObjectSettings)	Instantiates an instance from the supplied settings.
	Persist()	Persists the settings to the storage file.
	Persist(string, Uri, string)	Creates or updates the settings data for a SAML endpoint in the backing store file. An error is thrown if the scheme for the endpoint is not https.
	Validate(string)	Validates the contents of the specified endpoint settings.

Fields

	Name	Type	Description
	DefaultAuthenticationType	System.String	The default authentication type to use when attempting to perform an authentication call against the configured endpoint.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5