Skip to main content

Lists LifecycleStates

GET 

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

Use this endpoint to list all lifecycle states by their associated identity profiles. A token with API, or ORG_ADMIN authority is required to call this API.

Request

Path Parameters

    identity-profile-id stringrequired

    Identity profile ID.

    Example: 2b838de9-db9b-abcf-e646-d4f274ad4238

Query Parameters

    limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
    offset int32

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

    Example: 0
    count boolean

    If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

    Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

    See V3 API Standard Collection Parameters for more information.

    Example: true
    sorters comma-separated

    Sort results using the standard syntax described in V3 API Standard Collection Parameters

    Sorting is supported for the following fields: created, modified

    Example: created,modified

Responses

List of LifecycleState objects.

Schema
  • Array [
  • 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

    Default value: false

    Indicates whether the lifecycle state is enabled or disabled.

    technicalName stringrequired

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

    description string

    Lifecycle state's 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

    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 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.

    identityState stringnullable

    The lifecycle state's associated identity state. This field is generally 'null'.

  • ]
Loading...