C# Class Amazon.SecurityToken.SAML.SAMLAuthenticationController

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.
Show file Open project: aws/aws-sdk-net Class Usage Examples

Public Methods

Method Description
GetSAMLAssertion ( Uri identityProviderUrl, ICredentials credentials, string authenticationType ) : SAMLAssertion

Authenticates the specified network credentials with a provider endpoint and returns the SAML assertion data from which temporary AWS credentials can be obtained.
GetSAMLAssertion ( string identityProviderUrl, ICredentials credentials, string authenticationType ) : SAMLAssertion

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

Instantiates a controller instance configured to use the built-in AD FS classes to authenticate and parse the responses.
SAMLAuthenticationController ( IAuthenticationController authenticationController, IAuthenticationResponseParser responseParser, WebProxy proxySettings ) : System

Instantiates the controller to use the specified instances to perform authentication and response parsing.
SAMLAuthenticationController ( WebProxy proxySettings ) : System

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.

Method Details

GetSAMLAssertion() public method

Authenticates the specified network credentials with a provider endpoint and returns the SAML assertion data from which temporary AWS credentials can be obtained.
public GetSAMLAssertion ( Uri identityProviderUrl, ICredentials credentials, string authenticationType ) : SAMLAssertion
identityProviderUrl System.Uri The authentication endpoint to be called.
credentials ICredentials /// Credentials for the call. If null, the users default network credentials will be used /// in a temporary impersonation context. ///
authenticationType string /// The authentication type expected by the endpoint. The default value if not specified /// is 'Kerberos'. Valid values are 'NTLM', 'Digest', 'Kerberos' and 'Negotiate'. ///
return SAMLAssertion

GetSAMLAssertion() public method

Authenticates the specified network credentials with a provider endpoint and returns the SAML assertion data from which temporary AWS credentials can be obtained.
public GetSAMLAssertion ( string identityProviderUrl, ICredentials credentials, string authenticationType ) : SAMLAssertion
identityProviderUrl string The authentication endpoint to be called.
credentials ICredentials /// Credentials for the call. If null, the users default network credentials will be used /// in a temporary impersonation context. ///
authenticationType string /// The authentication type expected by the endpoint. The default value if not specified /// is 'Kerberos'. Valid values are 'NTLM', 'Digest', 'Kerberos' and 'Negotiate'. ///
return SAMLAssertion

SAMLAuthenticationController() public method

Instantiates a controller instance configured to use the built-in AD FS classes to authenticate and parse the responses.
public SAMLAuthenticationController ( ) : System
return System

SAMLAuthenticationController() public method

Instantiates the controller to use the specified instances to perform authentication and response parsing.
public SAMLAuthenticationController ( IAuthenticationController authenticationController, IAuthenticationResponseParser responseParser, WebProxy proxySettings ) : System
authenticationController IAuthenticationController /// Handler that will be called to perform authentication. ///
responseParser IAuthenticationResponseParser /// Handler that will be called to parse successful authentication responses ///
proxySettings System.Net.WebProxy /// Null or proxy settings that should be used when communicating with the authentication endpoint. ///
return System

SAMLAuthenticationController() public method

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 SAMLAuthenticationController ( WebProxy proxySettings ) : System
proxySettings System.Net.WebProxy
return System