Wiki
Clone wikiNumera.LibrisAPI / identity.reset_password
Home > API Reference Documentation > identity.reset_password
identity.reset_password
The identity.reset_password action is used to reset the password of a current user, only if their security provider == "Numera.NIS". This will only work for users with the role of Agent Supervisor or above.
Input Parameters
| Property | Required | Description |
|---|---|---|
account_id | yes | The account_id of the user to change |
password | yes | The new password to use for this user |
Output
There will be no result populated as part of this action, only the status code will tell you if it succeeded or there was an issue.
Possible Status Codes
| Status Code | Reason | Description |
|---|---|---|
1000 | NOT_IN_REALM | If the current user is not a Superuser, and their realm does not match the realm of the user they are trying to update, then the request will fail. |
1001 | API_EXCEPTION | The api_status_code, api_reason property of the result object will contain the code returned by Numera.Net if there was some type of API exception, if there was an http issue, the http_response_code will have the status code |
1002 | INVALID_PROVIDER | If the user you are trying to reset does not use NIS, you will receive this exception because we can not update the credentials of other providers |
1003 | INVALID_USER | We could not locate a user with the account_id you provided |
Updated