Skip to main content

Steps

Generated file. Do not edit by hand. Source: tools/Generate-IdleStepReference.ps1

Step TypeModuleSynopsis
IdLE.Step.CreateIdentityIdLE.Steps.CommonCreates a new identity in the target system.
IdLE.Step.DeleteIdentityIdLE.Steps.CommonDeletes an identity from the target system.
IdLE.Step.DisableIdentityIdLE.Steps.CommonDisables an identity in the target system.
IdLE.Step.EmitEventIdLE.Steps.CommonEmits a custom event (demo step).
IdLE.Step.EnableIdentityIdLE.Steps.CommonEnables an identity in the target system.
IdLE.Step.EnsureAttributesIdLE.Steps.CommonEnsures that multiple identity attributes match their desired values.
IdLE.Step.EnsureEntitlementIdLE.Steps.CommonEnsures that an entitlement assignment is present or absent for an identity.
IdLE.Step.Mailbox.EnsureOutOfOfficeIdLE.Steps.MailboxEnsures that a mailbox Out of Office (OOF) configuration matches the desired state.
IdLE.Step.Mailbox.EnsurePermissionsIdLE.Steps.MailboxEnsures that mailbox delegate permissions match the desired state.
IdLE.Step.Mailbox.EnsureTypeIdLE.Steps.MailboxEnsures that a mailbox is of the desired type (User, Shared, Room, Equipment).
IdLE.Step.Mailbox.GetInfoIdLE.Steps.MailboxRetrieves mailbox details and returns a structured report.
IdLE.Step.MoveIdentityIdLE.Steps.CommonMoves an identity to a different container/OU in the target system.
IdLE.Step.PruneEntitlementsIdLE.Steps.CommonRemoves all non-kept entitlements of a given kind from an identity. Remove-only — does not grant anything.
IdLE.Step.PruneEntitlementsEnsureKeepIdLE.Steps.CommonRemoves all non-kept entitlements and GUARANTEES explicit Keep entries are present (grants if missing).
IdLE.Step.RevokeIdentitySessionsIdLE.Steps.CommonRevokes all active sign-in sessions for an identity in the target system.
IdLE.Step.TriggerDirectorySyncIdLE.Steps.DirectorySyncTriggers a directory sync cycle and optionally waits for completion.