Alternate Expire Action
This alternate action is used to bypass built-in RapidIdentity Portal logic and instead allow an arbitrary RapidIdentity Connect Action Set to provide Expire Sponsored Account 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.
Without this alternate action enabled, RapidIdentity Portal will both disable as well as set the expiration date on the account. Therefore the RapidIdentity Connect Action Set is expected to perform both of these tasks at a minimum
Action Set Parameters
Parameter | Description |
|---|---|
target_dn | The DN of the target of the operation (whose profile is being expired) |
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 |
record_string | A JSON object containing the expiration date attribute and its new value |
Example
The following example shows a record_string value indicating that the expiration date attribute is idautoPersonEndDate and the new value should be 20110308191013Z
{"idautoPersonEndDate": "20110308191013Z"}
Action Set Return Value
{ "success": <boolean>, "message": <string> }
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 operation failed because...."}
{"success": true, "message": "The operation was successful"}