Skip to content

Latest commit

 

History

History
60 lines (43 loc) · 1.99 KB

step-delete-identity.md

File metadata and controls

60 lines (43 loc) · 1.99 KB

IdLE.Step.DeleteIdentity

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

Summary

  • Step Type: IdLE.Step.DeleteIdentity
  • Module: IdLE.Steps.Common
  • Implementation: Invoke-IdleStepDeleteIdentity
  • Idempotent: Yes
  • Required Capabilities: IdLE.Identity.Delete

Synopsis

Deletes an identity from the target system.

Description

The engine passes the provider resolved from With.Provider (default 'Identity') as -Provider. The provider implements DeleteIdentity(identityKey) and returns an object with properties 'IdentityKey' and 'Changed'.

The step is idempotent by design: if the identity is already deleted, the provider should return Changed = $false.

IMPORTANT: This step requires the provider to advertise the IdLE.Identity.Delete capability, which is typically opt-in for safety. The provider must be configured to allow deletion (e.g., AllowDelete = $true for AD provider).

Authentication is handled by the engine: With.AuthSessionName and With.AuthSessionOptions select the auth session passed to provider methods that declare an AuthSession parameter.

Inputs (With.*)

Validated at plan time against the step's WithSchema (see Step metadata contract).

Key Type Required Default Notes
IdentityKey String Yes
AuthSessionName String No broker default session Auth session routing key for the AuthSessionBroker.
AuthSessionOptions Hashtable No Data-only options passed to the AuthSessionBroker.
Provider String No Identity Provider alias in Providers.

Example

@{
  Name = 'IdLE.Step.DeleteIdentity Example'
  Type = 'IdLE.Step.DeleteIdentity'
  With = @{
    IdentityKey          = 'user.name'
  }
}

See Also