API - Reset Password

API - Reset Password

Process

The password reset process is basically devided into three parts.

Step 1 - Trigger "I-Forget-My-Password"-Token

Request a password
POST Api/Applicant/RequestPassword?email={email}&url={url}&culture={culture}
This requires an existing applicant's email address, the portal-URL and culture are optional. The server will generate and return a reset-password-URL and also send an email to the applicant containing the generated reset-password-URL. This URL will lead either to the provided URL or the first URL of the default portal in case the current URL is not provided. However, the generated route to reset the password is 
Generated reset password URL for the applicant portal
{portalUrl}/Password?email={email}&code={token}
and has to be handled by the applicant 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 email-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 )
Fetch 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.

Step 3 - Actual change of password

This step contains the actual change of the password. Therefore, the following API Request ( http://api.erecruiter.net/Help/Api/POST-Api-Applicant-SetPassword ) can be executed
Set a password to an applicant
POST Api/Applicant/SetPassword
This call requires the applicant'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.

    • Related Articles

    • API - Auto-LogOn-URL

      The Auto-LogOn-URL is provided to applicants (on the applicant portal) and contacts (on the customer portal) to automatically log in at their portal. The Auto-LogOn-URL can be used in several mail templates in the eRecruiter web-application and is ...

    • API - Questionnaires

      The eRecuiter application allows recruiters to create questionnaires to create questions for jobs. Questionnaires describes applicant information, that can be provided for that job during the application process. For all possible questions, an API ...

    • API - Applicant

      Prerequisites It's required to be authenticated to use the following methods. Furthermore, an API token with "Applicants" access level is mandatory. Applicant profile Essentially an applicant profile consists of basic  claim data . More Data can be ...

    • API - Application

      Prerequisites It's assumed that the requesting user is authenticated and there is an existing job on which an applicant wants to apply. The following actions could be performed for an application: Apply for an existing job Apply again for an existing ...

    • API - CV Parsing

      Prerequisites The CV parser service does not rely on any access level restrictions for the eRecruiter API. If an applicant portal is configured for CV parsing services (in eRecruiter Administration area), it can be used after successful ...