Catalyst Fire Ignition Documentation
Net
Validates a customer's password, identified by their primary email address
Definition
Namespace: Ignition.Crm.AccountManagement
Assembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.3454
Whether the customer was successfully authenticated
Assembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.3454
C#
public bool AuthenticateCustomerByPrimaryEmail(
string primaryEmailAddress,
string password,
out AuthenticatedCustomer authenticatedCustomer,
bool allowPasswordBasedDisambiguation = false
)VB
Public Function AuthenticateCustomerByPrimaryEmail (
primaryEmailAddress As String,
password As String,
<OutAttribute> ByRef authenticatedCustomer As AuthenticatedCustomer,
Optional allowPasswordBasedDisambiguation As Boolean = false
) As BooleanC++
public:
virtual bool AuthenticateCustomerByPrimaryEmail(
String^ primaryEmailAddress,
String^ password,
[OutAttribute] AuthenticatedCustomer^% authenticatedCustomer,
bool allowPasswordBasedDisambiguation = false
) sealedF#
abstract AuthenticateCustomerByPrimaryEmail :
primaryEmailAddress : string *
password : string *
authenticatedCustomer : AuthenticatedCustomer byref *
?allowPasswordBasedDisambiguation : bool
(* Defaults:
let _allowPasswordBasedDisambiguation = defaultArg allowPasswordBasedDisambiguation false
*)
-> bool
override AuthenticateCustomerByPrimaryEmail :
primaryEmailAddress : string *
password : string *
authenticatedCustomer : AuthenticatedCustomer byref *
?allowPasswordBasedDisambiguation : bool
(* Defaults:
let _allowPasswordBasedDisambiguation = defaultArg allowPasswordBasedDisambiguation false
*)
-> bool Parameters
- primaryEmailAddress String
- Primary email address of the customer
- password String
- Password to validate
- authenticatedCustomer AuthenticatedCustomer
- If authentication was successful, the customer authenticated; otherwise null
- allowPasswordBasedDisambiguation Boolean (Optional)
- Indicates if Ignition should attempt authentication of customers whose primaryEmailAddress is not unique, but whose password might be.
Return Value
BooleanWhether the customer was successfully authenticated
Remarks
If your netFORUM implementation allows customers to have duplicate primary email addresses, then by definition primary email address can not always be used
as a means of uniquely identifying a customer. This method will throw an InvalidOperationException exception if this ambiguity is encountered.
NetFORUM does support the use of passwords to differentiate between customers sharing a primary email address, but use of this feature opens
up a host of possible security problems and is not recommended.
If allowPasswordBasedDisambiguation is set to true and this ambiguity is encountered, Ignition will ask netFORUM
to check password against each account sharing the provided primaryEmailAddress and,
if exactly one successful match is found, this method return true, and populate authenticatedCustomer
with the appropriate customer. If more than one account sharing a primaryEmailAddress also shares the same password,
an exception will be thrown.