Public API v1 → Reset Passwords Endpoint
About the /users/resetPasswords endpoint
The /users/resetPasswords endpoint resets the password of all Incorta authenticated active users in the tenant.
For information about how to get started with Public API v1, refer to References → Public API v1.
Note
Use the HTTPS or HTTP scheme according to your installation.
Request URL
https://<cluster_URL>/incorta/api/v1/users/resetPasswordshttps://<server address>:<port>/incorta/api/v1/users/resetPasswords
HTTP method
PATCH
Request headers
{"Authorization": "Bearer {access_token}"}
Warning
You must use a valid access token of the Super User or a User Manager user, otherwise, the request would fail.
For information about how to create an access token, refer to Public API v1→ Create Token Endpoint.
Endpoint response
| Code | Description | Payload Response | Comments |
|---|---|---|---|
| 200 | OK | The endpoint has successfully reset the passwords of all Incorta authenticated users. Each user must define a new password after providing the current one, just as a new user has to do when signing in to Incorta for the first time. | |
| 403 | Forbidden | {"message": "string"} Example: {"message": "INC_09030101: Invalid access token or access token may have expired."} | The endpoint could not reset the passwords of all Incorta authenticated users. There are several reasons that may result in this response, for example, an invalid or expired access token or insufficient rights to manage security. |