SecurityTokenProvider.RenewToken(TimeSpan, SecurityToken) Method

Definition

Renews a security token.

public:
 System::IdentityModel::Tokens::SecurityToken ^ RenewToken(TimeSpan timeout, System::IdentityModel::Tokens::SecurityToken ^ tokenToBeRenewed);
public System.IdentityModel.Tokens.SecurityToken RenewToken (TimeSpan timeout, System.IdentityModel.Tokens.SecurityToken tokenToBeRenewed);
member this.RenewToken : TimeSpan * System.IdentityModel.Tokens.SecurityToken -> System.IdentityModel.Tokens.SecurityToken
Public Function RenewToken (timeout As TimeSpan, tokenToBeRenewed As SecurityToken) As 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 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 RenewToken method calls the RenewTokenCore method.

Applies to