1. Cloud
  2. Guides
  3. Tours
  4. Concepts
  5. Tools
  6. References
  7. Integrations
  8. Data applications
  9. Releases

Public API v2 → 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 v2, refer to References → Public API v2.

Note

You must use the HTTPS scheme to be able to successfully run the API endpoints. Additionally, you must specify the tenant name (case-sensitive) in the endpoint request URL starting with the 2023.7.0 release.

Request URL

https://<cluster_URL>/incorta/api/v2/{tenantName}/users/resetPasswords

Request URL Parameter

Field nameDescriptionTypeRequired
tenantNameThe tenant name (case-sensitive)StringRequired starting with 2023.7.0

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 v2 → Create an API access token.

Endpoint response

CodeDescriptionPayload Response
200OK
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.
401Unauthorized
The tenant name doesn’t match the tenant in the access token.		{"message": "string"}
403Forbidden
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.		{"message": "string"}
Example:
{"message": "INC_09030101: Invalid access token or access token may have expired."}
404Not Found
The tenant doesn't exist or is disabled.		{"message": "string"}