The ProvisionControllerService web services provides operations that will let you change and reset passwords programatically. These operations will also synchronize the password changes across the relevant systems.
The difference between setPassword and resetPassword are described below.
Reset Password |
Set Password |
|---|---|
|
|
ProvisionControllerService Operations
|
Endpoint Address: |
Operation Name: resetPassword(PasswordSync passwordSync)
Parameters:
- PasswordSync passwordSync
Return:
- PasswordResponse- the returned object will contain success or failure. If its successful, it will also return the newly created password..
resetPassword allows you to reset the password associated with an identity. The operation allows you specify a new password or you can leave it blank. If its blank, then the system will auto-generate a new password based on the password policy that is in effect.
*Key Fields: PasswordSync *
Field Name |
Description |
|---|---|
securityDomain |
Required |
principal |
Required |
validateRequest |
Required. Set to True |
password |
Optional - Auto-generated if its ommited |
srcSystemId |
Optional - Id of the Application that is making the request. Will be used in the audit log |
requestorId |
Optional - Id of the person making the request. |
Sample Request:
Operation Name: setPassword(PasswordSync passwordSync)
Parameters:
- PasswordSync passwordSync
Return:
- Response - the returned object return success or failure
Valid Failure Codes |
|---|
PRINCIPAL_NOT_FOUND |
USER_NOT_FOUND |
USER_STATUS" |
FAIL_PASSWORD_POLICY |
setPassword allows you to change a users password. The most conform the password policy that is in place.
Key Fields: PasswordSync
Field Name |
Description |
|---|---|
securityDomain |
Required |
principal |
Required |
password |
Optional - Auto-generated if its ommited |
srcSystemId |
Optional - Id of the Application that is making the request. Will be used in the audit log |
requestorId |
Optional - Id of the person making the request. |
Sample Request: