Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

First, the API has to be called (http://api.erecruiter.net/Help/Api/POST-Api-Applicant-RequestPassword_email_url_culture)

Code Block
titleRequest a password
POST Api/Applicant/RequestPassword?email={email}&url={url}&culture={culture}

This requires an existing eMail-adressapplicant's email address, the Portalportal-URL and Culture culture are optional. The server will generate and return a reset-password-URL and also send an eMail email to the Applicant applicant containing an the generated reset-password-URL. This url URL will lead either to the provided URL or the first URL of the default Portal portal in case , the current URL is not provided. However, the generated Route is

...

route to reset the password is

Code Block
titleGenerated reset password URL for the applicant portal
{portalUrl}/Password?email={email}&code={token}

and has to be handled by the Portalapplicant portal.

Step 2 - Test Token and load Applicant Profile

When the applicant navigates to that link, the applicant can be loaded by the generated token. At this point, the portal is either able to continue with Step 3 directly, or perform an early test of the token to retrieve the applicant profile using the eMailemail-adress address and the generated token. The profile can be loaded with the following request (http://api.erecruiter.net/Help/Api/GET-Api-Applicant_email_code)

Code Block
titleFetch applicant profile identified by a "I forgot my password" token.
GET Api/Applicant?email={email}&code={code}

This request succeeds for the duration, the token is valid. Currently for it is valid for 2 days.

...

This step contains the actual change of the password. Therefore, the following API Request can be executed(http://api.erecruiter.net/Help/Api/POST-Api-Applicant-SetPassword) can be executed

Code Block
titleSet a password to an applicant
POST Api/Applicant/SetPassword

This call requires the eMailapplicant's email, token, new password and the current URL to reset the password. Note, the password has to match the password policy in order to apply it to set it. Furthermore, the token again is valid for 2 days from its creation until it expires.