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.

Helper class to perform SAML authentication negotiation for an identity provider and relying party combination. Yields a SAMLAssertion instance that can be used to retrieve temporary, auto-refreshing AWS credentials.

Inheritance Hierarchy

System.Object
  Amazon.SecurityToken.SAML.SAMLAuthenticationController

Namespace: Amazon.SecurityToken.SAML
Assembly: AWSSDK.SecurityToken.dll
Version: 3.x.y.z

Syntax

C#
public class SAMLAuthenticationController

The SAMLAuthenticationController type exposes the following members

Constructors

NameDescription
Public Method SAMLAuthenticationController()

Instantiates a controller instance configured to use the built-in AD FS classes to authenticate and parse the responses.

Public Method SAMLAuthenticationController(WebProxy)

Instantiates a controller instance configured to use the built-in AD FS classes to authenticate and parse the responses. The supplied proxy settings will be used in the HTTPS calls to the authentication endpoint.

Public Method SAMLAuthenticationController(IAuthenticationController, IAuthenticationResponseParser, WebProxy)

Instantiates the controller to use the specified instances to perform authentication and response parsing.

Properties

NameTypeDescription
Public Property AuthenticationController Amazon.SecurityToken.SAML.IAuthenticationController

Handler that will be called to perform the authentication process to a defined endpoint.

Public Property ProxySettings System.Net.WebProxy

Proxy details if required for communication with the authentication endpoint.

Public Property ResponseParser Amazon.SecurityToken.SAML.IAuthenticationResponseParser

Handler that will be called to parse the response from a succesful authentication request.

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 GetSAMLAssertion(string, ICredentials, string)

Authenticates the specified network credentials with a provider endpoint and returns the SAML assertion data from which temporary AWS credentials can be obtained.

Public Method GetSAMLAssertion(Uri, ICredentials, string)

Authenticates the specified network credentials with a provider endpoint and returns the SAML assertion data from which temporary AWS credentials can be obtained.

Version Information

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