Change User Password
POST/changePassword
This API reset the password for a user in EIC. Considering the input parameters, the value of the new password should be supplied as Password and the Username should correspond to the user whose password is being reset.
The Authorization must have a Bearer
followed by a Token
.
Mandatory Parameters:
username
: Specify the name of the user for whom you need to change the password. -password
: Type your new password.
Optional Parameters:
changePasswordAssociatedAccounts
: Once the change password request is initiated, you can specifytrue
to create the corresponding Change Password task. You can specifyfalse
to only update the user password. The default value istrue
. -endpoint
: If thechangePasswordAssociatedAccounts
parameter is set totrue
then specify the list of endpoints (comma-separated). -validateagainstpolicy
: SpecifyY
to ensure that your new password conforms to the USER scope password policy. If you do not want to apply the password policy, then specifyN
. The default value isY
.updateUserPassword
: If thechangePasswordAssociatedAccounts
parameter is set totrue
then specify true to update the user password and create the corresponding Change Password task. Specifyfalse
to create only the Change Password task. The default value istrue
. -setarstasksource
- Specifytrue
to set the source column in the arstasks table with thechangeOwnPasswordFromAPI
value. When the source column in arstasks table is set to thechangeOwnPasswordFromAPI
value then the pwdLastSet parameter is not set to 0 for Active Directory (AD). The default value isfalse
.
Note: If your AD password has expired (pwdLastSet = 0), you are forced to choose a new password in EIC on the next login.
Request
- application/x-www-form-urlencoded
Body
changePasswordAssociatedAccounts string
endpoint string
password string
setarstasksource string
updateUserPassword string
username string
validateagainstpolicy string
Responses
- 200
Change User Password 2
Response Headers
Access-Control-Allow-Credentials
string
Access-Control-Allow-Origin
string
Cache-Control
string
Date
string
Expires
string
Referrer-Policy
string
Server
string
Set-Cookie
string
Strict-Transport-Security
string
X-Content-Type-Options
string
X-Frame-Options
string
- application/json
- Schema
- Example (from schema)
- Change User Password 2
Schema
Status string
TaskIDs number[]
errorCode string
message string
{
"Status": "Success",
"TaskIDs": [
79
],
"errorCode": "0",
"message": "Password updated successfully"
}
{
"Status": "Success",
"TaskIDs": [
79
],
"errorCode": "0",
"message": "Password updated successfully"
}
Loading...