Creating a new password for a user account¶

Note

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

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

Description¶

The New-Password request creates a new password for a user account of the organisation.

Requirements¶

Values of the request: none

Objects: PasswordVO

Request¶

To create a new password for 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 create a new password for a user account, the object PasswordVO with the following attributes needs to be defined in the body:

Attributes	Description	Values
`newPassword`	The new password to be created.	`string`
`confirmPassword`	Confirmation of the new password.	`string`
`token`	The alphanumeric token from the password reset email, found after `/new-password/`.	`string`

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

The user account owner will receive an email confirming the password change.

Example¶

Example request body:

{
  "newPassword": "string",
  "confirmPassword": "string",
  "token": "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.