/
session_password_reset()

session_password_reset()

Owned by Alexey Kapitula (Unlicensed)
Last updated: Feb 02, 2024 by Pedro Jose Sanchez Luling
3 min read

Function prototype

session_password_reset(id, [option], [message], [lang], [country_code] )

API Version

All

Supported interfaces

SOAP, REST (from API Version 2.7.32)

Description

Allows to reset the password of an exiting account

This function should be called in a 2-step process:

  1. In the first call, leave the option parameter empty to obtain a list of the different options to request the password reset. Each option is a communication channel that can be used to send the instructions to reset the password.

  2. In the second call, fill the option parameter with one of the options retrieved from the first call.

The list of available options depends on the following factors:

  • The communication channels associated to the account for which the password needs to be reseted. For example, if the account has an email address and a phone number, then those communication channels can be used to send the instructions to reset the password.

  • The available communication channels configured in the platform. For example, if there is no provider configured to send email notifications, the the option to reset the password by email will be available (even if the account has a valid email address)

Input parameters:

  • id: username, email, phone number or any unique IDENTIFIER of the user. When using a phone number it is necessary to include the country preffix unless the country_code parameter is provided.

  • option: method (communication channel). Send an empty string to obtain the list of communication channels available.

  • message: Only used when the option parameter indicated is “TECH_SUPPORT”. In this parameter you should include a text explaining the reason of the password reset request.

  • lang: (optional, default="EN") Preferred language code in 2-letter ISO format used (e.g. "en")

  • country_code: (optional) 2-letter ISO Country Code. If provided, the id can be a phone number without the preffix (the country preffix can be deduced from the country code). Introduced in API Version 2.7.24

Output parameters:

  • result: Depends on the value of the option parameter

    • When option is empty, the result will contain a list of available communication channels that can be used to request the password reset. The list of communication channels contains the preferred email address and phone number (for SMS notification) of the user identified by the parameter id. Each option contains:

      • id: Identifier of the communication channel. You can use this value in a second invocation to session_password_reset() to indicate the specific channel than should be used to send the instructions to reset the password

      • type: type of communication channel (EMAIL, SMS or TECH_SUPPORT)

      • description: Description of the communication channel in the session’s active language

    • When the value of option is one of the valid communication channels available to request the password reset, the result will be empty, and a notification with instructions will be sent to the communication channel indicated in option

  • ErrorMsg: If any error occurs, then this value contains a description of the error translated to the current language

  • ErrorCode: If any error occurs, then this value contains any of the standard ERROR CODES

Request examples

session_password_reset( "john.doe@linkcare.es"); session_password_reset( "john.doe@linkcare.es", ”MAIL|1”);

In the first example, the option parameter is not provided, and the function will return the list of communication channels available to request the password reset.

In the second example, the option parameter has value “MAIL|1”, and the execution will trigger the reset password process by sending a notification with instructions by the communication channel identified by “MAIL|1”

Response

The response format is XML when the function has been invoked via the SOAP API, and JSON when it has been invoked via the REST API.

The following response corresponds to the first request example explained before, where the option parameter is null to request the list of communication channels available:

Return Error codes

ERROR CODE

 

ERROR CODE

 

USER.NOT_FOUND

The account identified by id was not found

 

 

Related content