Class SAMLEndpointSettings

Namespace

Amazon.Util

Assembly

AWSSDK.Core.dll

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.

[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

Inheritance

object

ProfileSettingsBase

SAMLEndpointSettings

Inherited Members

ProfileSettingsBase.LoadCredentialsProfile(string)

ProfileSettingsBase.Name

ProfileSettingsBase.UniqueId

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Fields

DefaultAuthenticationType

The default authentication type to use when attempting to perform an authentication call against the configured endpoint.

public static readonly string DefaultAuthenticationType

Field Value

string

Properties

AuthenticationType

The authentication type to use when calling the endpoint.

public string AuthenticationType { get; }

Property Value

string

Endpoint

The authentication endpoint which must be a HTTPS scheme.

public Uri Endpoint { get; }

Property Value

Uri

Methods

CanCreateFrom(ObjectSettings)

Tests if a SAMLEndpointSettings instance could be instantiated from the persisted settings data.

public static bool CanCreateFrom(SettingsCollection.ObjectSettings os)

Parameters

os SettingsCollection.ObjectSettings

The persisted settings.

Returns

bool

True if the settings are compatible.

CanCreateFrom(string)

Tests if a SAMLEndpointSettings instance could be instantiated from the persisted settings data.

public static bool CanCreateFrom(string endpointName)

Parameters

endpointName string

The name given to the persisted settings.

Returns

bool

True if the settings are compatible.

LoadFrom(ObjectSettings)

Instantiates an instance from the supplied settings.

public static SAMLEndpointSettings LoadFrom(SettingsCollection.ObjectSettings os)

Parameters

os SettingsCollection.ObjectSettings

The persisted settings.

Returns

SAMLEndpointSettings

Profile instance or an exception if the profile data is invalid.

LoadFrom(string)

Instantiates an instance from settings stored with the specified name.

public static SAMLEndpointSettings LoadFrom(string endpointName)

Parameters

endpointName string

The name of the endpoint settings in the store.

Returns

SAMLEndpointSettings

Profile instance or an exception if the profile data does not exist/contains invalid data.

Persist()

Persists the settings to the storage file.

public override string Persist()

Returns

string

The unique id assigned to the profile

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.

public static string Persist(string settingsName, Uri endpoint, string authenticationType)

Parameters

settingsName string

The name of the settings to create or update

endpoint Uri

The authentication endpoint

authenticationType string

Optional authentication type to use when performing calls against the endpoint

Returns

string

The unique id assigned to the profile

Validate(string)

Validates the contents of the specified endpoint settings.

public static void Validate(string endpointName)

Parameters

endpointName string

The name of the SAML endpoint settings to validate.

Exceptions

InvalidDataException

Thrown if the settings fail to validate.