Skip to main content

LifecycleState

Properties

NameTypeDescriptionNotes
IdStringSystem-generated unique ID of the Object[optional] [readonly]
NameStringName of the Object[required]
CreatedSystem.DateTimeCreation date of the Object[optional] [readonly]
ModifiedSystem.DateTimeLast modification date of the Object[optional] [readonly]
EnabledBooleanIndicates whether the lifecycle state is enabled or disabled.[optional] [default to $false]
TechnicalNameStringThe lifecycle state's technical name. This is for internal use.[required]
DescriptionStringLifecycle state's description.[optional]
IdentityCountInt32Number of identities that have the lifecycle state.[optional] [readonly]
EmailNotificationOptionEmailNotificationOption[optional]
AccountActions[]AccountAction[optional]
AccessProfileIds[]StringList of unique access-profile IDs that are associated with the lifecycle state.[optional]
IdentityStateEnum [ "ACTIVE", "INACTIVE_SHORT_TERM", "INACTIVE_LONG_TERM" ]The lifecycle state's associated identity state. This field is generally 'null'.[optional]
AccessActionConfigurationAccessActionConfiguration[optional]
PriorityInt32Priority level used to determine which profile to assign when a user exists in multiple profiles. Lower numeric values have higher priority. By default, new profiles are assigned the lowest priority. The assigned profile also controls access granted or removed during provisioning based on lifecycle state changes.[optional]

Examples

  • Prepare the resource
$LifecycleState = Initialize-V2025LifecycleState  -Id id12345 `
-Name aName `
-Created 2015-05-28T14:07:17Z `
-Modified 2015-05-28T14:07:17Z `
-Enabled true `
-TechnicalName Technical Name `
-Description Lifecycle description `
-IdentityCount 42 `
-EmailNotificationOption null `
-AccountActions null `
-AccessProfileIds [2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500] `
-IdentityState INACTIVE_LONG_TERM `
-AccessActionConfiguration null `
-Priority 10
  • Convert the resource to JSON
$LifecycleState | ConvertTo-JSON

[Back to top]