Catalyst Fire Ignition Documentation
Net
Attempts to authenticate a customer using a one-time-use authentication (xws) token.
If the customer is successfully authenticated, the authentication token will be automatically invalidated.
This method can be used with the 'Single Sign-On With eWeb - eWeb Login' login flow at wiki.avectra.com/sso
Definition
Namespace: Ignition.Crm.AccountManagement
Assembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.3454
Whether the lookup was successful
Assembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.3454
C#
public bool AuthenticateCustomer(
Guid authenticationToken,
out AuthenticatedCustomer authenticatedCustomer
)VB
Public Function AuthenticateCustomer (
authenticationToken As Guid,
<OutAttribute> ByRef authenticatedCustomer As AuthenticatedCustomer
) As BooleanC++
public:
virtual bool AuthenticateCustomer(
Guid authenticationToken,
[OutAttribute] AuthenticatedCustomer^% authenticatedCustomer
) sealedF#
abstract AuthenticateCustomer :
authenticationToken : Guid *
authenticatedCustomer : AuthenticatedCustomer byref -> bool
override AuthenticateCustomer :
authenticationToken : Guid *
authenticatedCustomer : AuthenticatedCustomer byref -> bool Parameters
- authenticationToken Guid
- Authentication token
- authenticatedCustomer AuthenticatedCustomer
- Will contain the retrieved customer if the lookup was successful, otherwise null
Return Value
BooleanWhether the lookup was successful
Remarks
Once a token has been used successfully, it is immediately invalidated.
As such, subsequent calls to this method with the same authenticationToken will always return false