Account Reset

The account reset feature is used to (1) onboard users by allowing them to activate their new account and (2) help existing users reset their password (self service password reset).

Start Reset Process

Use this function to start a password reset process. If successful, an e-mail is sent to the user with a process reset key (key). Please note that this function is not used to start an account onboarding process for a new user.

Request

Example

POST /v2/auth/reset

Parameters

Name	Description
identifier	Required Account name, official number or e-mail.
type	Required Use Email.

Response

Void if successful or even if an account cannot be resolved from the given identifier, if the account does not have a registered email address, etc.

Retrieve Reset Process Status

Use this function to retrieve information about and check the integrity of a reset process key.

Request

Example

GET /v2/auth/reset/process/{key}

Parameters

Name	Description
key	Required The reset process key provided to the user (e g in an e-mail) to be used when activating or resetting an account.

Response

Example

{
    "identifier": "MinKund01",
    "requireUsername": false,
    "usernameSuggestion": "my.name@test.test"
}

A standard error response is returned if the key has already been used, has expired or is invalid.

Parameters

Name	Description
identifier	Identifier to be entered by the user when logging in. If the system lacks a unique identifier then this value can be null, in that case "requireUsername" is true. Should be displayed to the user.
requireUsername	True if the user must enter a username upon activation. If false, then the user should not have the possibility to enter a username.
usernameSuggestion	Suggested username.

Complete Reset Process

Use this function to activate or change a users’ account credentials.

Request

Example

POST /v2/auth/reset/process/{key}/complete

{ 
    "username": "MyUsername",
    "password": "MyPassword"
}

Parameters

Name	Description
key	Required The reset process key provided to the user (e g in an e-mail) to be used when activating or resetting an account.
username	Required The proposed username to be entered by the user when logging in.
password	Required The proposed password to be entered by the user when logging in.

Response

Void