AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

C#
public class SAMLEndpointSettings : ProfileSettingsBase

The SAMLEndpointSettings type exposes the following members

Properties

NameTypeDescription
Public Property AuthenticationType System.String

The authentication type to use when calling the endpoint.

Public Property Endpoint System.Uri

The authentication endpoint which must be a HTTPS scheme.

Public Property Name System.String Inherited from Amazon.Util.ProfileSettingsBase.
Public Property 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.

NameDescription
Public Method Static Method CanCreateFrom(string)

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

Public Method Static Method CanCreateFrom(SettingsCollection.ObjectSettings)

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

Public Method Static Method LoadFrom(string)

Instantiates an instance from settings stored with the specified name.

Public Method Static Method LoadFrom(SettingsCollection.ObjectSettings)

Instantiates an instance from the supplied settings.

Public Method Persist()

Persists the settings to the storage file.

Public Method Static Method 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 Method Static Method Validate(string)

Validates the contents of the specified endpoint settings.

Fields

NameTypeDescription
Field Static Field DefaultAuthenticationType System.String

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

Version Information

.NET Standard:
Supported in: 1.3

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