Cancel the dependents management intent

Cancels the dependents_management_intent in case an employee decides not to proceed with changes to their dependents. Canceling is only allowed from action_required status. If the intent is already canceled, the operation succeeds without changes. After canceling, a new dependents management intent can be created from the parent intent.

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path parameters

dependents_management_intent_idstringRequiredformat: "dmi_.+"

Response

OK
idstringformat: "dmi_.+"

Unique identifier for the dependents management intent. Prefixed with dmi_.

parent_intent_idstring

The parent intent ID (e.g. Policy Amendment Intent ID). Prefixed based on type.

parent_intent_typeenum
The type of parent intent.
Allowed values:
statusenum
Current status of the dependents management intent.
Allowed values:
dependentslist of objects
List of dependents being managed.
objectstring or null
Object type identifier.

Errors