ValidateUser Method

Validate the credentials of the connecitng user/password combination.

Syntax

string ValidateUser( 
   string username,
   string password,
   string authToken,
   Guid clientToken
)

Parameters

username: the username from the client. This will be blank for an anonymous connection.
password: The password from the client. This will be blank for an anonymous connection.
authToken: When using authorization tokens the client token will be passed here.
clientToken: The unique ID of the connecting client.

Return Value

The method should return a null/Empty string for success or the exception to be thrown on the client

Remarks

The implementing code should validate the passed in username/password combination or the authorization token and return either a null/empty string for a valid conneciton or a string containing the exceuption to be raised on the client. A non-empty string will result in the declining of the requested connection/operation.

A blank username/password/auth token indicates that an anonymous connection has been initiated. Anonymous connections can only occur from a web API connection where the username/password in not mandetory.

The implementing method should record the passed in clientToken as this will be passed in to other authentication routines to prevent the username/password combination being used.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

ISymphonyAuthentication Interface
ISymphonyAuthentication Members