Skip to main content

Get Lifecycle State

GET 

/identity-profiles/:identity-profile-id/lifecycle-states/:lifecycle-state-id

Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID.

A token with ORG_ADMIN or API authority is required to call this API.

Request

Path Parameters

    identity-profile-id stringrequired

    Identity Profile ID.

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

    Lifecycle State ID.

    Example: ef38f94347e94562b5bb8424a56397d8

Responses

Requested lifecycle state.

Schema
    id string

    Lifecycle state ID.

    name string

    Lifecycle state name.

    technicalName string

    Lifecycle state technical name. This is for internal use.

    description string

    Lifecycle state description.

    created date-time

    Lifecycle state created date.

    modified date-time

    Lifecycle state modified date.

    enabled boolean

    Default value: false

    Indicates whether the lifecycle state is enabled or disabled.

    identityCount int32

    Number of identities that have the lifecycle state.

    emailNotificationOption object
    notifyManagers boolean

    Default value: false

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

    notifyAllAdmins boolean

    Default value: false

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

    notifySpecificUsers boolean

    Default value: false

    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 source IDs. The sources must have the ENABLE feature or flat file source. See "/sources" endpoint for source features.

  • ]
  • accessProfileIds string[]

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

Loading...