Edit

Share via


SecurityTokenProvider.RenewTokenAsync(TimeSpan, SecurityToken) Method

Definition

Renews a security token.

public:
 System::Threading::Tasks::Task<System::IdentityModel::Tokens::SecurityToken ^> ^ RenewTokenAsync(TimeSpan timeout, System::IdentityModel::Tokens::SecurityToken ^ tokenToBeRenewed);
public System.Threading.Tasks.Task<System.IdentityModel.Tokens.SecurityToken> RenewTokenAsync (TimeSpan timeout, System.IdentityModel.Tokens.SecurityToken tokenToBeRenewed);
member this.RenewTokenAsync : TimeSpan * System.IdentityModel.Tokens.SecurityToken -> System.Threading.Tasks.Task<System.IdentityModel.Tokens.SecurityToken>
Public Function RenewTokenAsync (timeout As TimeSpan, tokenToBeRenewed As SecurityToken) As Task(Of SecurityToken)

Parameters

timeout
TimeSpan

A TimeSpan that specifies the timeout value for the message that renews the security token.

tokenToBeRenewed
SecurityToken

The SecurityToken to renew.

Returns

The Task that represents the asynchronous read operation and wraps the SecurityToken that represents the security token that is renewed.

Remarks

An issued security token that is renewable allows a client to renew it when the security token is about to or has expired.

The RenewTokenAsync method calls the RenewTokenCoreAsync method.

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by RenewToken(TimeSpan, SecurityToken).

Applies to