Reset Password

Reset Password
Reset another local user's password (administrator only)

Sets a new password for a local user without requiring their current password. Use this when a local user has forgotten their password; use POST /iam/change-password for the self-service case where the old password is known.

Notes:

  • Requires the enterprise_admin role.
  • Remote (LDAP) users do not have a local password and cannot be targeted by this API - their password is managed by the identity provider.
Request
URI
POST
https://{api_host}/https://{api_host}:{port}/lh-appliance/iam/reset-password
COPY
Request Body
ResetPasswordRequest of type(s) application/json
Required

Show optional properties

{
    "user_name": "string",
    "new_password": "string"
}
{
    "user_name": "audit",
    "new_password": "********"
}
string
user_name
Required

The local user whose password is being reset. Remote (LDAP) users cannot be targeted, since their password is not managed by Installer.

string
new_password
Required

The password to set for user_name. Must satisfy the configured password policy, or the request is rejected with 400.

Authentication
This operation uses the following authentication methods.
Responses
204

The password was reset successfully.

Operation doesn't return any data structure

400

The user does not exist, is not a local user, or the new password does not meet the password policy.

Returns Error of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


401

Unauthorized

Returns Unauthorized of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


403

Forbidden

Returns Forbidden of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


412

Precondition Failed

Returns PreconditionFailed of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


428

Precondition Required

Returns PreconditionRequired of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


429

Too Many Requests

Returns TooManyRequests of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


default

4XX and 5XX type errors with appropriate message

Returns Error of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"user_name":"string","new_password":"string"}' https://{api_host}/https://{api_host}:{port}/lh-appliance/iam/reset-password
On This Page
User Management Operations
POST
Login
POST
Logout
POST
Change Password
POST
Reset Password
GET
Get Current User Info
GET
Get All Users Info
GET
Get All Roles Info
GET
Get All Role Bindings
POST
Bind Roles To Entity
GET
Get Role Binding
PUT
Update Roles To Entity
DELETE
Delete Roles To Entity
GET
Get All Ldap Identity Sources
POST
Create Ldap Identity Source
GET
Get Ldap Identity Source
PUT
Update Ldap Identity Source
DELETE
Delete Ldap Identity Source
GET
Search Ldap Identity Source