Skip to main content

IdLE.Step.EnsureEntitlement

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

Summary​

  • Step Type: IdLE.Step.EnsureEntitlement
  • Module: IdLE.Steps.Common
  • Implementation: Invoke-IdleStepEnsureEntitlement
  • Idempotent: Yes

Synopsis​

Ensures that an entitlement assignment is present or absent for an identity.

Description​

This provider-agnostic step uses entitlement provider contracts to converge an assignment to the desired state. The host must supply a provider instance via Context.Providers[<ProviderAlias>] that implements:

  • ListEntitlements(identityKey)

  • GrantEntitlement(identityKey, entitlement)

  • RevokeEntitlement(identityKey, entitlement)

The step is idempotent and only calls Grant/Revoke when the assignment needs to change.

Authentication:

  • If With.AuthSessionName is present, the step acquires an auth session via Context.AcquireAuthSession(Name, Options) and passes it to the provider methods if the provider supports an AuthSession parameter.

  • With.AuthSessionOptions (optional, hashtable) is passed to the broker for session selection (e.g., @{ Role = 'Tier0' }).

  • ScriptBlocks in AuthSessionOptions are rejected (security boundary).

Inputs (With.*)​

The following keys are required in the step's With configuration:

KeyRequiredDescription
EntitlementYesEntitlement identifier or object
IdentityKeyYesUnique identifier for the identity
StateYesDesired state for the entitlement

Example​

@{
  Name = 'IdLE.Step.EnsureEntitlement Example'
  Type = 'IdLE.Step.EnsureEntitlement'
  With = @{
    Entitlement          = @{ Kind = 'Group'; Id = 'GroupId' }
    IdentityKey          = 'user.name'
    State                = 'Present'
  }
}

See Also​