LifecycleStates

Use this API to implement and customize lifecycle state functionality. With this functionality in place, administrators can view 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 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 select the lifecycle state they want to modify.

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/beta

Method	HTTP request	Description
Get-BetaLifecycleStates	GET `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}`	Get Lifecycle State
Update-BetaLifecycleStates	PATCH `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}`	Update Lifecycle State

get-lifecycle-states

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.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	IdentityProfileId	String	True	Identity Profile ID.
Path	LifecycleStateId	String	True	Lifecycle State ID.

Return type

LifecycleState

Responses

Code	Description	Data Type
200	Requested lifecycle state.	LifecycleState
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessModelMetadataAttribute401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too 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.	ListAccessModelMetadataAttribute429Response
500	Internal 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-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId 
    
    # Below is a request that includes all optional parameters
    # Get-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLifecycleStates"
    Write-Host $_.ErrorDetails
}

[Back to top]

update-lifecycle-states

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

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

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	IdentityProfileId	String	True	Identity Profile ID.
Path	LifecycleStateId	String	True	Lifecycle State ID.
Body	JsonPatchOperation	[]JsonPatchOperation	True	A 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

Code	Description	Data Type
200	Updated lifecycle state.	LifecycleState
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessModelMetadataAttribute401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too 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.	ListAccessModelMetadataAttribute429Response
500	Internal 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-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -BetaJsonPatchOperation $Result 
    
    # Below is a request that includes all optional parameters
    # Update-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -BetaJsonPatchOperation $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaLifecycleStates"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-lifecycle-states​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

update-lifecycle-states​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-lifecycle-states

Parameters

Return type

Responses

HTTP request headers

Example

update-lifecycle-states

Parameters

Return type

Responses

HTTP request headers

Example