Resetting the password of a user account¶

Note

Authentication using an API key, signature, or API token is not supported for this endpoint.

Sends a POST request to the endpoint /user/password/reset.

Description¶

The Reset-Password request resets the password of a user account of the organisation.

Requirements¶

Values of the request: none

Objects: ResetPasswordVO

Request¶

To reset the password of a user account, no additional information needs to be added to the path of the request.

For a detailed specification of which information is required to reset the password for a user account, the object ResetPasswordVO with the following attributes needs to be defined in the body:

Attributes	Description	Values
`email`	The email address of the user account for which the password is to be reset.	`string`

The system only returns a 200 HTTP code in response to the successful request.

The user account owner will receive an email to reset the password.

Example¶

Example request body:

{
  "email": "string"
}

Responses¶

The following responses are available:

STATUS CODE	DESCRIPTION
201	The request has succeeded and a new object has been created.
400	The request was unsuccessful. The request was invalid or information is missing.
401	The request has not succeeded because the user authentication was incorrect.
403	The request has not succeeded because the user does not have the right permissions.