Service: ContactAuthenticationPublicService

Version: 2_22 (other versions, change log, ZUMSTEIN_V4.1-SNAPSHOT) Active version. This version can be subject to minor retro-compatible changes without warnings.

SOAP Demo endpoint: https://myinstit.ws.secutix.com/tnco/external-remoting/com.secutix.service.contact.v2_22.ContactAuthenticationPublicService.webservice?wsdl

REST Demo endpoint (only POST): https://myinstit.ws.secutix.com/tnco/backend-apis/contactAuthenticationPublicService/v2_22/{methodName} Replace {methodName} for the desired method name as shown below.

To get the endpoint for your own institution, replace "myinstit" (just after https://) in the url by your own institution code.

For further documentation and examples, please check in Platform Website.

Methods:

• authenticate: This method is used to authenticate a contact or an operator (if attributes operatorLogin = true) based on his login and password and more attributes available from ContactAuthenticationData.
• changePassword: This method allows to modify the current password of a contact identified by its contact number.
• listAuthorizedPOS: This method can accept two different kind of values for the parameter contactNumber: 1.
• recoverPassword: This method allows a contact identified by the given email address to request a new randomly generated password for authentication.
• resetPassword: This method allows to reset the current password of contact by new password and identified contact by token which is already sent by secure one-time reset link
• validateResetPasswordToken: This method is used to validate secure one-time reset link is not expired by token

authenticate

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method is used to authenticate a contact or an operator (if attributes operatorLogin = true) based on his login and password and more attributes available from ContactAuthenticationData.

Authentication can be based either on login+password, either on a anterior authentication having generated a unique identifier rememberMe.

During a login/password authentication, boolean remmemberMe allows to decide wether such a token must be generated. A rememberMe token is valid during one month max.

If authentication is done through a token, a NEW token + identifier are generated, invalidating the other ones.

This method takes into account parametrization of point of sales. In case of B2B sales, it checks wether the contact is authorized to log on the given point of sales.

Parameters

contactAuthenticationData

ContactAuthenticationData

ContactAuthenticationData
contactNumber	String (20)
contactTypeScope	(INDIVIDUAL|STRUCTURE| ANY)
guestLogin	boolean
identification	String
identityProvider	String
ignoreGuestLoginCheck	boolean
isRequiredAccountVerificationEmail	Boolean	This field use to required perform action check account verification email. If not defined, set to false.
login	String
operatorLogin	boolean
password	String
pointOfSalesId	Long
providerUserReference	String
rememberMe	boolean
socialLogin	boolean
structureContactNumber	String (20)
targetContactNumber	String (20)
uniqueToken	String

Return value

ContactAuthenticationResult
contactNumber	String (20)
email	String
identification	String
uniqueToken	String
requestId	Integer
statusCode	String (8)
statusDetail	String

changePassword

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method allows to modify the current password of a contact identified by its contact number.

Parameters

contactNumber	String (20)	Mandatory number of the contact to alter its password; mandatory.
currentPassword	String	Mandatory current contact password; mandatory;
newPassword	String	Mandatory new password if the existing password match; mandatory.

Return value

WebMethodResult
requestId	Integer
statusCode	String (8)
statusDetail	String

listAuthorizedPOS

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method can accept two different kind of values for the parameter contactNumber:

• 1. a contact number
• 2. an email address

If a contact number is passed (case 1.), it must be the one of a relay contact or the public contact number of a structure. In that case, the method will return the list of point of sales explicitly associated to those contacts.
If an email address is passed (case 2.), the method will implicitly list all contacts having this email address, and it will list all point of sales associated to those contacts in case of relays and structures, and all public point of sales if the contact is a public individual.

Parameters

contactNumber

String (20)

- a contatc number or an email address.

Return value

ListAuthorizedPOSResult
pointOfSales	List of PosSummary
requestId	Integer
statusCode	String (8)
statusDetail	String

PosSummary
pointOfSalesId	Long
url	String (255)

recoverPassword

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method allows a contact identified by the given email address to request a new randomly generated password for authentication. The old password is automatically invalidated.

Parameters

email	String	Mandatory Mandatory, email of the contact
contactNumber	String (20)	Mandatory Only mandatory and to be considered for relay contacts.(STX-5744) Since the email is not unique and this function can used for individual contact and structure contact, we add a new parameter contactNumber to help identify the right contact to modify.
contactTypeScope	(INDIVIDUAL|STRUCTURE| ANY)
passwordGenerationPolicy	(GENERATE_NEW_PASSWORD| KEEP_PASSWORD)	The enum use to define contact's password should be generated new or keep as the old one and change later.

Return value

PasswordRecoveryResult
contactNumber	String (20)
email	String
requestId	Integer
statusCode	String (8)
statusDetail	String

resetPassword

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method allows to reset the current password of contact by new password and identified contact by token which is already sent by secure one-time reset link

Parameters

token	String	Mandatory requested reset password token to validate and identified contact, mandatory
newPassword	String	Mandatory new password to updated for contact which is identified by token, mandatory

Return value

PasswordRecoveryResult

validateResetPasswordToken

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method is used to validate secure one-time reset link is not expired by token

Parameters

token

String

Mandatory requested reset password token, mandatory

Return value

WebMethodResult