VerifyUserIdentityToken Method

Verifies a user identity token using the appropriate user manager.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Function VerifyUserIdentityToken( _
   ByVal userIdentityToken As IUserIdentityToken, _
   ByRef userIdentity As IUserIdentity _
) As UserVerificationOutcome

'Usage
 
Dim instance As UserManagers
Dim userIdentityToken As IUserIdentityToken
Dim userIdentity As IUserIdentity
Dim value As UserVerificationOutcome
 
value = instance.VerifyUserIdentityToken(userIdentityToken, userIdentity)

public UserVerificationOutcome VerifyUserIdentityToken( 
   IUserIdentityToken userIdentityToken,
   out IUserIdentity userIdentity
)

public:
UserVerificationOutcome VerifyUserIdentityToken( 
   IUserIdentityToken^ userIdentityToken,
   [Out] IUserIdentity^ userIdentity
)

Parameters

userIdentityToken: The user identity token to verify.
The value of this parameter cannot be null (Nothing in Visual Basic).
userIdentity: When this method returns UserVerificationOutcome.Success, contains the verified user identity if verification was successful; otherwise, it contains null.
The value of this parameter can be null (Nothing in Visual Basic).

Return Value

The outcome of the user verification.

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

System.ArgumentNullException

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

UserManagers Class
UserManagers Members

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.