Skip to main content

LifecycleStates

Use this API to implement and customize lifecycle state functionality. With this functionality in place, administrators can create and configure custom lifecycle states for use across their organizations, which is key to controlling which users have access, when they have access, and the access they have.

A lifecycle state describes a user's status in a company. For example, two lifecycle states come by default with Identity Security Cloud: 'Active' and 'Inactive.' When an active employee takes an extended leave of absence from a company, his or her lifecycle state may change to 'Inactive,' for security purposes. The inactive employee would lose access to all the applications, sources, and sensitive data during the leave of absence, but when the employee returns and becomes active again, all that access would be restored. This saves administrators the time that would otherwise be spent provisioning the employee's access to each individual tool, reviewing the employee's certification history, etc.

Administrators can create a variety of custom lifecycle states. Refer to Planning New Lifecycle States for some custom lifecycle state ideas.

Administrators must define the criteria for being in each lifecycle state, and they must define how Identity Security Cloud manages users' access to apps and sources for each lifecycle state.

In Identity Security Cloud, administrators can manage lifecycle states by going to Admin > Identities > Identity Profile, selecting the identity profile whose lifecycle states they want to manage, selecting the 'Provisioning' tab, and using the left panel to either select the lifecycle state they want to modify or create a new lifecycle state.

In the 'Provisioning' tab, administrators can make the following access changes to an identity profile's lifecycle state:

  • Enable/disable the lifecycle state for the identity profile.

  • Enable/disable source accounts for the identity profile's lifecycle state.

  • Add existing access profiles to grant to the identity profiles in that lifecycle state.

  • Create a new access profile to grant to the identity profile in that lifecycle state.

Access profiles granted in a previous lifecycle state are automatically revoked when the identity moves to a new lifecycle state. To maintain access across multiple lifecycle states, administrators must grant the access profiles in each lifecycle state. For example, if an administrator wants users with the 'HR Employee' identity profile to maintain their building access in both the 'Active' and 'Leave of Absence' lifecycle states, the administrator must grant the access profile for that building access to both lifecycle states.

During scheduled refreshes, Identity Security Cloud evaluates lifecycle states to determine whether their assigned identities have the access defined in the lifecycle states' access profiles. If the identities are missing access, Identity Security Cloud provisions that access.

Administrators can also use the 'Provisioning' tab to configure email notifications for Identity Security Cloud to send whenever an identity with that identity profile has a lifecycle state change. Refer to Configuring Lifecycle State Notifications for more information on how to do so.

An identity's lifecycle state can have four different statuses: the lifecycle state's status can be 'Active,' it can be 'Not Set,' it can be 'Not Valid,' or it 'Does Not Match Technical Name Case.' Refer to Moving Identities into Lifecycle States for more information about these different lifecycle state statuses.

Refer to Setting Up Lifecycle States for more information about lifecycle states.

All URIs are relative to https://sailpoint.api.identitynow.com/v3

MethodHTTP requestDescription
New-LifecycleStatePOST /identity-profiles/{identity-profile-id}/lifecycle-statesCreate Lifecycle State
Remove-LifecycleStateDELETE /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}Delete Lifecycle State
Get-LifecycleStateGET /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}Get Lifecycle State
Get-LifecycleStatesGET /identity-profiles/{identity-profile-id}/lifecycle-statesLists LifecycleStates
Set-LifecycleStatePOST /identities/{identity-id}/set-lifecycle-stateSet Lifecycle State
Update-LifecycleStatesPATCH /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}Update Lifecycle State

create-lifecycle-state​

Use this endpoint to create a lifecycle state.

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription
PathIdentityProfileIdStringTrueIdentity profile ID.
BodyLifecycleStateLifecycleStateTrueLifecycle state to be created.

Return type​

LifecycleState

Responses​

CodeDescriptionData Type
201Created LifecycleState object.LifecycleState
400Client Error - Returned if the request body is invalid.ErrorResponseDto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessProfiles401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.ListAccessProfiles429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

Example​

$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID.
$LifecycleState = @"{
  "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ],
  "emailNotificationOption" : {
    "notifyManagers" : true,
    "notifySpecificUsers" : true,
    "emailAddressList" : [ "test@test.com", "test2@test.com" ],
    "notifyAllAdmins" : true
  },
  "created" : "2015-05-28T14:07:17Z",
  "name" : "aName",
  "modified" : "2015-05-28T14:07:17Z",
  "description" : "Lifecycle description",
  "accountActions" : [ {
    "action" : "ENABLE",
    "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ]
  }, {
    "action" : "ENABLE",
    "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ]
  } ],
  "id" : "id12345",
  "identityCount" : 42,
  "technicalName" : "Technical Name",
  "identityState" : "identityState",
  "enabled" : true
}"@

# Create Lifecycle State

try {
    $Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState
    New-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result 
    
    # Below is a request that includes all optional parameters
    # New-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-LifecycleState"
    Write-Host $_.ErrorDetails
}

[Back to top]

delete-lifecycle-state​

Use this endpoint to delete the lifecycle state by its ID.

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription
PathIdentityProfileIdStringTrueIdentity profile ID.
PathLifecycleStateIdStringTrueLifecycle state ID.

Return type​

LifecyclestateDeleted

Responses​

CodeDescriptionData Type
202The request was successfully accepted into the system.LifecyclestateDeleted
400Client Error - Returned if the request body is invalid.ErrorResponseDto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessProfiles401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.ListAccessProfiles429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

Example​

$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID.
$LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID.

# Delete Lifecycle State

try {
    Remove-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId 
    
    # Below is a request that includes all optional parameters
    # Remove-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-LifecycleState"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-lifecycle-state​

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

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription
PathIdentityProfileIdStringTrueIdentity profile ID.
PathLifecycleStateIdStringTrueLifecycle state ID.

Return type​

LifecycleState

Responses​

CodeDescriptionData Type
200The requested LifecycleState was successfully retrieved.LifecycleState
400Client Error - Returned if the request body is invalid.ErrorResponseDto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessProfiles401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.ListAccessProfiles429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

Example​

$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID.
$LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID.

# Get Lifecycle State

try {
    Get-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId 
    
    # Below is a request that includes all optional parameters
    # Get-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-LifecycleState"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-lifecycle-states​

Use this endpoint to list all lifecycle states by their associated identity profiles.

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription
PathIdentityProfileIdStringTrueIdentity profile ID.
QueryLimitInt32(optional) (default to 250)Max number of results to return. See V3 API Standard Collection Parameters for more information.
QueryOffsetInt32(optional) (default to 0)Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
QueryCountBoolean(optional) (default to $false)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.
QuerySortersString(optional)Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: created, modified

Return type​

LifecycleState[]

Responses​

CodeDescriptionData Type
200List of LifecycleState objects.LifecycleState[]
400Client Error - Returned if the request body is invalid.ErrorResponseDto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessProfiles401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.ListAccessProfiles429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

Example​

$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID.
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Sorters = "created,modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **created, modified** (optional)

# Lists LifecycleStates

try {
    Get-LifecycleStates -IdentityProfileId $IdentityProfileId 
    
    # Below is a request that includes all optional parameters
    # Get-LifecycleStates -IdentityProfileId $IdentityProfileId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-LifecycleStates"
    Write-Host $_.ErrorDetails
}

[Back to top]

set-lifecycle-state​

Use this API to set/update an identity's lifecycle state to the one provided and update the corresponding identity profile.

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription
PathIdentityIdStringTrueID of the identity to update.
BodySetLifecycleStateRequestSetLifecycleStateRequestTrue

Return type​

SetLifecycleState200Response

Responses​

CodeDescriptionData Type
200The request was successfully accepted into the system.SetLifecycleState200Response
400Client Error - Returned if the request body is invalid.ErrorResponseDto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessProfiles401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.ListAccessProfiles429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

Example​

$IdentityId = "2c9180857893f1290178944561990364" # String | ID of the identity to update.
$SetLifecycleStateRequest = @""@

# Set Lifecycle State

try {
    $Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest
    Set-LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result 
    
    # Below is a request that includes all optional parameters
    # Set-LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-LifecycleState"
    Write-Host $_.ErrorDetails
}

[Back to top]

update-lifecycle-states​

Use this endpoint to update individual lifecycle state fields, using the JSON Patch standard.

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription
PathIdentityProfileIdStringTrueIdentity profile ID.
PathLifecycleStateIdStringTrueLifecycle state ID.
BodyJsonPatchOperation[]JsonPatchOperationTrueA list of lifecycle state update operations according to the JSON Patch standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption

Return type​

LifecycleState

Responses​

CodeDescriptionData Type
200The LifecycleState was successfully updated.LifecycleState
400Client Error - Returned if the request body is invalid.ErrorResponseDto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessProfiles401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.ListAccessProfiles429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

  • Content-Type: application/json-patch+json
  • Accept: application/json

Example​

$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID.
$LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID.
 $JsonPatchOperation = @"{
  "op" : "replace",
  "path" : "/description",
  "value" : "New description"
}"@ # JsonPatchOperation[] | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.  The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption 
 

# Update Lifecycle State

try {
    $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
    Update-LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result 
    
    # Below is a request that includes all optional parameters
    # Update-LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-LifecycleStates"
    Write-Host $_.ErrorDetails
}

[Back to top]