Skip to main content

Update Lifecycle State



This endpoint updates individual Lifecycle State fields using the JSON Patch standard. A token with ORG_ADMIN or API authority is required to call this API.


Path Parameters

    identity-profile-id stringrequired

    Identity Profile ID

    Example: 2b838de9-db9b-abcf-e646-d4f274ad4238
    lifecycle-state-id stringrequired

    Lifecycle State ID

    Example: ef38f94347e94562b5bb8424a56397d8



A list of lifecycle state update operations according to the JSON Patch standard.

The following fields can be updated:

  • enabled
  • description
  • accountActions
  • accessProfileIds
  • emailNotificationOption
  • Array [
  • op stringrequired

    Possible values: [add, remove, replace, move, copy, test]

    The operation to be performed

    path stringrequired

    A string JSON Pointer representing the target path to an element to be affected by the operation

    value object

    The value to be used for the operation, required for "add" and "replace" operations



  • ]


The LifecycleState was successfully updated.

    id string

    System-generated unique ID of the Object

    name stringrequired

    Name of the Object

    created date-time

    Creation date of the Object

    modified date-time

    Last modification date of the Object

    enabled boolean

    Whether the lifecycle state is enabled or disabled.

    technicalName stringrequired

    The technical name for lifecycle state. This is for internal use.

    description string

    Lifecycle state description.

    identityCount int32

    Number of identities that have the lifecycle state.

    emailNotificationOption object

    This is used for representing email configuration for a lifecycle state

    notifyManagers boolean

    If true, then the manager is notified of the lifecycle state change.

    notifyAllAdmins boolean

    If true, then all the admins are notified of the lifecycle state change.

    notifySpecificUsers boolean

    If true, then the users specified in "emailAddressList" below are notified of lifecycle state change.

    emailAddressList string[]

    List of user email addresses. If "notifySpecificUsers" option is true, then these users are notified of lifecycle state change.

    accountActions object[]
  • Array [
  • action string

    Possible values: [ENABLE, DISABLE]

    Describes if action will be enabled or disabled

    sourceIds string[]

    List of unique source IDs. The sources must have the ENABLE feature or flat file source. See "/sources" endpoint for source features.

  • ]
  • accessProfileIds string[]

    List of unique access-profile IDs that are associated with the lifecycle state.