Skip to content

Latest commit

 

History

History
56 lines (40 loc) · 1.77 KB

step-enable-identity.md

File metadata and controls

56 lines (40 loc) · 1.77 KB

IdLE.Step.EnableIdentity

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

Summary

  • Step Type: IdLE.Step.EnableIdentity
  • Module: IdLE.Steps.Common
  • Implementation: Invoke-IdleStepEnableIdentity
  • Idempotent: Yes
  • Required Capabilities: IdLE.Identity.Enable

Synopsis

Enables an identity in the target system.

Description

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

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

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.EnableIdentity Example'
  Type = 'IdLE.Step.EnableIdentity'
  With = @{
    IdentityKey          = 'user.name'
  }
}

See Also