Reset user credentials via REST API

Products

• Clarity PPM On Premise
• Clarity PPM SaaS

Issue/Introduction

When attempting to reset a user's credentials using the ppm/rest/v1/auth/userCredentials endpoint, the system may return a 400 error response displaying: "errorMessage":"API-1086 : Missing or invalid configuration." and "errorCode":"api.invalidConfiguration". Additionally, the functional access rights referenced in the documentation "Administration - Service Account" and "Administration - Service Account Manager" are not visible in the UI.

Environment

v16.2.2 and above

Resolution

This error occurs because the credential reset feature is not enabled by default. To resolve this, the feature must be toggled on using the following command:

admin toggle-feature F31678_API_UPDATE_USER_PASSWORD 1

Once the command has been successfully run, either flush the server-side cache or restart the services to apply the changes.

Note: SaaS customers will need to open a Support ticket to request that this feature to be enabled.

Additional Information

Refer to the documentation for usage details.