WebSecurity.ConfirmAccount Method (String)

Confirms that an account is valid and activates the account.

Namespace:  WebMatrix.WebData
Assembly:  WebMatrix.WebData (in WebMatrix.WebData.dll)

Syntax

'Declaration
Public Shared Function ConfirmAccount ( _
    accountConfirmationToken As String _
) As Boolean
'Usage
Dim accountConfirmationToken As String 
Dim returnValue As Boolean 

returnValue = WebSecurity.ConfirmAccount(accountConfirmationToken)
public static bool ConfirmAccount(
    string accountConfirmationToken
)
public:
static bool ConfirmAccount(
    String^ accountConfirmationToken
)
static member ConfirmAccount : 
        accountConfirmationToken:string -> bool
public static function ConfirmAccount(
    accountConfirmationToken : String
) : boolean

Parameters

  • accountConfirmationToken
    Type: System.String
    A confirmation token to pass to the authentication provider.

Return Value

Type: System.Boolean
true if the account is confirmed; otherwise, false.

Exceptions

Exception Condition
InvalidOperationException

The SimpleMembershipProvider.Initialize(String, NameValueCollection) method was not called.

-or-

The InitializeDatabaseConnection() method was not called.

-or-

The SimpleMembershipProvider membership provider is not registered in the configuration of your site. For more information, contact your site's system administrator.

Remarks

The confirmation token is generated by the CreateAccount(String, String, Boolean), CreateUserAndAccount(String, String, Object, Boolean), and GeneratePasswordResetToken(String, Int32) methods. The token is ordinarily sent to the user as a link in an email message, and the user clicks the link in order to verify his or her identity.

For an example of how to use the ConfirmAccount(String) method, see the Confirm.cshtml file in the Starter Site template.

See Also

Reference

WebSecurity Class

ConfirmAccount Overload

WebMatrix.WebData Namespace

Other Resources

Using the confirmation feature for ASP.NET Web Pages security