AWS SDK Version 4 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.

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

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.7.2 or higher.

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

Syntax

C# 
public Task<SAMLAssertion> GetSAMLAssertionAsync(
         Uri identityProviderUrl,
         ICredentials credentials,
         String authenticationType
)

Parameters

identityProviderUrl
Type: System.Uri

The authentication endpoint to be called.

credentials
Type: System.Net.ICredentials

Credentials for the call. If null, the users default network credentials will be used in a temporary impersonation context.

authenticationType
Type: System.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 Value


Type: Task<SAMLAssertion>
SAMLAssertion instance wrapping the returned document on successful authentication.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer