RapidIdentity Product Guide

Alternate Change Password Action

This alternate action is used to bypass built-in RapidIdentity Portal logic and instead allow an arbitrary RapidIdentity Connect Action Set to provide Update Password functionality. RapidIdentity Portal performs the necessary authentication/authorization/validation on the request then invokes the pre-defined Action Set on the configured RapidIdentity Connect instance.

Action Set Parameters
Table 314. Parameters

Parameter

Description

target_dn

The DN of the target of the operation (whose password is being changed)

perp_dn

The DN of the perpetrator of the operation (who's performing the operation)

audit_event_id

An audit event ID which may be used to correlate any audit log events from invoked Action Set to the audit log event generated by the call to the RapidIdentity Portal API

newPassword

The new password for the target

currentPassword

The current password for the user. This will only be supplied if the perpetrator is also the target. i.e. a user is changing their own password.

mustUpdate

This is a boolean value indicating whether the operation should require the user to update their password at next login. This will only be included if the perpetrator is not the target. i.e. a delegated password update.



Action Set Return Value

{"success":"<boolean>", "message":"<string>"}

Table 315. Return Fields

Field

Description

Required

success

Whether RapidIdentity Portal should consider the action as successful

no, defaults to false

message

Optional message which will be passed through to the API response and ultimately to the UI.

no



Example

{"success": false, "message": "The password change failed"}

{"success": true, "message": "Your password was changed successfully"}