C# Класс Amazon.SecurityToken.SAML.StoredProfileSAMLCredentials

Наследование: Amazon.Runtime.RefreshingAWSCredentials
Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
MaximumCredentialTimespan System.TimeSpan
MinimumCredentialTimespan System.TimeSpan

Открытые методы

Метод Описание
StoredProfileSAMLCredentials ( ) : System

Constructs an instance of StoredProfileSAMLCredentials. This constructor searches for details of the role to assume, and optional credentials to use with the endpoint, using the profile name specified in the App.config.

StoredProfileSAMLCredentials ( string profileName, string profilesLocation ) : System

Constructs an instance of StoredProfileSAMLCredentials. After construction call one of the Authenticate methods to authenticate the user/process and obtain temporary AWS credentials.

For users who are domain joined (the role profile does not contain user identity information) the temporary credentials will be refreshed automatically as needed. Non domain-joined users (those with user identity data in the profile) are required to re-authenticate when credential refresh is required. An exception is thrown when attempt is made to refresh credentials in this scenario. The consuming code of this class should catch the exception and prompt the user for credentials, then call Authenticate to re-initialize with a new set of temporary AWS credentials.

The ini-format credentials file is not currently supported.

Защищенные методы

Метод Описание
GenerateNewCredentials ( ) : CredentialsRefreshState

Refresh credentials after expiry. If the role profile is configured to not use the default user identity, an exception is thrown if the UserAuthenticationCallback property has not been set.

Validate ( ) : void

If non-default credentials are to be used for authentication, validates that the authentication required callback has been populated.

Приватные методы

Метод Описание
Authenticate ( ICredentials userCredential, System.TimeSpan credentialDuration ) : CredentialsRefreshState

Описание методов

GenerateNewCredentials() защищенный Метод

Refresh credentials after expiry. If the role profile is configured to not use the default user identity, an exception is thrown if the UserAuthenticationCallback property has not been set.
protected GenerateNewCredentials ( ) : CredentialsRefreshState
Результат CredentialsRefreshState

StoredProfileSAMLCredentials() публичный Метод

Constructs an instance of StoredProfileSAMLCredentials. This constructor searches for details of the role to assume, and optional credentials to use with the endpoint, using the profile name specified in the App.config.
public StoredProfileSAMLCredentials ( ) : System
Результат System

StoredProfileSAMLCredentials() публичный Метод

Constructs an instance of StoredProfileSAMLCredentials. After construction call one of the Authenticate methods to authenticate the user/process and obtain temporary AWS credentials.

For users who are domain joined (the role profile does not contain user identity information) the temporary credentials will be refreshed automatically as needed. Non domain-joined users (those with user identity data in the profile) are required to re-authenticate when credential refresh is required. An exception is thrown when attempt is made to refresh credentials in this scenario. The consuming code of this class should catch the exception and prompt the user for credentials, then call Authenticate to re-initialize with a new set of temporary AWS credentials.

The ini-format credentials file is not currently supported.
public StoredProfileSAMLCredentials ( string profileName, string profilesLocation ) : System
profileName string /// The name of the profile holding the necessary role data to enable authentication and credential generation. ///
profilesLocation string Reserved for future use.
Результат System

Validate() защищенный Метод

If non-default credentials are to be used for authentication, validates that the authentication required callback has been populated.
protected Validate ( ) : void
Результат void

Описание свойств

MaximumCredentialTimespan публичное статическое свойство

The maximum allowed timespan for generated credentials, per STS documentation.
public static TimeSpan,System MaximumCredentialTimespan
Результат System.TimeSpan

MinimumCredentialTimespan публичное статическое свойство

The minimum allowed timespan for generated credentials, per STS documentation.
public static TimeSpan,System MinimumCredentialTimespan
Результат System.TimeSpan