Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 26 additions & 7 deletions docs/reference/steps/step-create-identity.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,15 @@
- **Module**: `IdLE.Steps.Common`
- **Implementation**: `Invoke-IdleStepCreateIdentity`
- **Idempotent**: `Yes`
- **Contracts**: `Unknown`
- **Events**: Unknown
- **Required Capabilities**: `IdLE.Identity.Create`

## Synopsis

Creates a new identity in the target system.

## Description

This is a provider-agnostic step. The host must supply a provider instance via
The host must supply a provider instance via
Context.Providers[<ProviderAlias>] that implements CreateIdentity(identityKey, attributes)
and returns an object with properties 'IdentityKey' and 'Changed'.

Expand All @@ -38,7 +37,27 @@ Authentication:

## Inputs (With.*)

| Key | Required |
| --- | --- |
| IdentityKey | Yes |
| Attributes | Yes |
The following keys are required in the step's ``With`` configuration:

| Key | Required | Description |
| --- | --- | --- |
| `Attributes` | Yes | Hashtable of attributes to set |
| `IdentityKey` | Yes | Unique identifier for the identity |

## Example

```powershell
@{
Name = 'CreateIdentity Example'
Type = 'IdLE.Step.CreateIdentity'
With = @{
Attributes = @{ GivenName = 'First'; Surname = 'Last' }
IdentityKey = 'user.name'
}
}
```

## See Also

- [Capabilities Reference](../capabilities.md) - Details on required capabilities
- [Providers](../providers.md) - Available provider implementations
28 changes: 24 additions & 4 deletions docs/reference/steps/step-delete-identity.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,15 @@
- **Module**: `IdLE.Steps.Common`
- **Implementation**: `Invoke-IdleStepDeleteIdentity`
- **Idempotent**: `Yes`
- **Contracts**: `Unknown`
- **Events**: Unknown
- **Required Capabilities**: `IdLE.Identity.Delete`

## Synopsis

Deletes an identity from the target system.

## Description

This is a provider-agnostic step. The host must supply a provider instance via
The host must supply a provider instance via
Context.Providers[<ProviderAlias>] that implements DeleteIdentity(identityKey)
and returns an object with properties 'IdentityKey' and 'Changed'.

Expand All @@ -42,4 +41,25 @@ Authentication:

## Inputs (With.*)

_Unknown (not detected automatically). Document required With.* keys in the step help and/or use a supported pattern._
The following keys are required in the step's ``With`` configuration:

| Key | Required | Description |
| --- | --- | --- |
| `IdentityKey` | Yes | Unique identifier for the identity |

Comment thread
blindzero marked this conversation as resolved.
## Example

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

## See Also

- [Capabilities Reference](../capabilities.md) - Details on required capabilities
- [Providers](../providers.md) - Available provider implementations
28 changes: 24 additions & 4 deletions docs/reference/steps/step-disable-identity.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,15 @@
- **Module**: `IdLE.Steps.Common`
- **Implementation**: `Invoke-IdleStepDisableIdentity`
- **Idempotent**: `Yes`
- **Contracts**: `Unknown`
- **Events**: Unknown
- **Required Capabilities**: `IdLE.Identity.Disable`

## Synopsis

Disables an identity in the target system.

## Description

This is a provider-agnostic step. The host must supply a provider instance via
The host must supply a provider instance via
Context.Providers[<ProviderAlias>] that implements DisableIdentity(identityKey)
and returns an object with properties 'IdentityKey' and 'Changed'.

Expand All @@ -38,4 +37,25 @@ Authentication:

## Inputs (With.*)

_Unknown (not detected automatically). Document required With.* keys in the step help and/or use a supported pattern._
The following keys are required in the step's ``With`` configuration:

| Key | Required | Description |
| --- | --- | --- |
| `IdentityKey` | Yes | Unique identifier for the identity |

Comment thread
blindzero marked this conversation as resolved.
## Example

```powershell
@{
Name = 'DisableIdentity Example'
Type = 'IdLE.Step.DisableIdentity'
With = @{
IdentityKey = 'user.name'
}
}
```

## See Also

- [Capabilities Reference](../capabilities.md) - Details on required capabilities
- [Providers](../providers.md) - Available provider implementations
22 changes: 19 additions & 3 deletions docs/reference/steps/step-emit-event.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@
- **Module**: `IdLE.Steps.Common`
- **Implementation**: `Invoke-IdleStepEmitEvent`
- **Idempotent**: `Unknown`
- **Contracts**: `Unknown`
- **Events**: Unknown

## Synopsis

Expand All @@ -24,4 +22,22 @@ to write structured events.

## Inputs (With.*)

_Unknown (not detected automatically). Document required With.* keys in the step help and/or use a supported pattern._
The required input keys could not be detected automatically.
Please refer to the step description and examples for usage details.

## Example
Comment thread
blindzero marked this conversation as resolved.

```powershell
@{
Name = 'EmitEvent Example'
Type = 'IdLE.Step.EmitEvent'
With = @{
# See step description for available options
}
}
```

## See Also

- [Capabilities Reference](../capabilities.md) - Overview of IdLE capabilities
- [Providers](../providers.md) - Available provider implementations
28 changes: 24 additions & 4 deletions docs/reference/steps/step-enable-identity.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,15 @@
- **Module**: `IdLE.Steps.Common`
- **Implementation**: `Invoke-IdleStepEnableIdentity`
- **Idempotent**: `Yes`
- **Contracts**: `Unknown`
- **Events**: Unknown
- **Required Capabilities**: `IdLE.Identity.Enable`

## Synopsis

Enables an identity in the target system.

## Description

This is a provider-agnostic step. The host must supply a provider instance via
The host must supply a provider instance via
Context.Providers[<ProviderAlias>] that implements EnableIdentity(identityKey)
and returns an object with properties 'IdentityKey' and 'Changed'.

Expand All @@ -38,4 +37,25 @@ Authentication:

## Inputs (With.*)

_Unknown (not detected automatically). Document required With.* keys in the step help and/or use a supported pattern._
The following keys are required in the step's ``With`` configuration:

| Key | Required | Description |
| --- | --- | --- |
| `IdentityKey` | Yes | Unique identifier for the identity |

Comment thread
blindzero marked this conversation as resolved.
## Example

```powershell
@{
Name = 'EnableIdentity Example'
Type = 'IdLE.Step.EnableIdentity'
With = @{
IdentityKey = 'user.name'
}
}
```

## See Also

- [Capabilities Reference](../capabilities.md) - Details on required capabilities
- [Providers](../providers.md) - Available provider implementations
36 changes: 28 additions & 8 deletions docs/reference/steps/step-ensure-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,15 @@
- **Module**: `IdLE.Steps.Common`
- **Implementation**: `Invoke-IdleStepEnsureAttribute`
- **Idempotent**: `Yes`
- **Contracts**: `Provider must implement method: EnsureAttribute`
- **Events**: Unknown
- **Required Capabilities**: `IdLE.Identity.Attribute.Ensure`

## Synopsis

Ensures that an identity attribute matches the desired value.

## Description

This is a provider-agnostic step. The host must supply a provider instance via
The host must supply a provider instance via
Context.Providers[<ProviderAlias>]. The provider must implement an EnsureAttribute
method with the signature (IdentityKey, Name, Value) and return an object that
contains a boolean property 'Changed'.
Expand All @@ -38,8 +37,29 @@ Authentication:

## Inputs (With.*)

| Key | Required |
| --- | --- |
| IdentityKey | Yes |
| Name | Yes |
| Value | Yes |
The following keys are required in the step's ``With`` configuration:

| Key | Required | Description |
| --- | --- | --- |
| `IdentityKey` | Yes | Unique identifier for the identity |
| `Name` | Yes | Name of the attribute or property |
| `Value` | Yes | Desired value to set |

## Example

```powershell
@{
Name = 'EnsureAttribute Example'
Type = 'IdLE.Step.EnsureAttribute'
With = @{
IdentityKey = 'user.name'
Name = 'AttributeName'
Value = 'AttributeValue'
}
}
```

## See Also

- [Capabilities Reference](../capabilities.md) - Details on required capabilities
- [Providers](../providers.md) - Available provider implementations
34 changes: 27 additions & 7 deletions docs/reference/steps/step-ensure-entitlement.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@
- **Module**: `IdLE.Steps.Common`
- **Implementation**: `Invoke-IdleStepEnsureEntitlement`
- **Idempotent**: `Yes`
- **Contracts**: `Unknown`
- **Events**: Unknown
- **Required Capabilities**: `IdLE.Entitlement.List`, `IdLE.Entitlement.Grant`, `IdLE.Entitlement.Revoke`

## Synopsis

Expand Down Expand Up @@ -44,8 +43,29 @@ Authentication:

## Inputs (With.*)

| Key | Required |
| --- | --- |
| IdentityKey | Yes |
| Entitlement | Yes |
| State | Yes |
The following keys are required in the step's ``With`` configuration:

| Key | Required | Description |
| --- | --- | --- |
| `Entitlement` | Yes | Entitlement identifier or object |
| `IdentityKey` | Yes | Unique identifier for the identity |
| `State` | Yes | Desired state for the entitlement |

## Example

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

## See Also

- [Capabilities Reference](../capabilities.md) - Details on required capabilities
- [Providers](../providers.md) - Available provider implementations
33 changes: 26 additions & 7 deletions docs/reference/steps/step-move-identity.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,15 @@
- **Module**: `IdLE.Steps.Common`
- **Implementation**: `Invoke-IdleStepMoveIdentity`
- **Idempotent**: `Yes`
- **Contracts**: `Unknown`
- **Events**: Unknown
- **Required Capabilities**: `IdLE.Identity.Move`

## Synopsis

Moves an identity to a different container/OU in the target system.

## Description

This is a provider-agnostic step. The host must supply a provider instance via
The host must supply a provider instance via
Context.Providers[<ProviderAlias>] that implements MoveIdentity(identityKey, targetContainer)
and returns an object with properties 'IdentityKey' and 'Changed'.

Expand All @@ -38,7 +37,27 @@ Authentication:

## Inputs (With.*)

| Key | Required |
| --- | --- |
| IdentityKey | Yes |
| TargetContainer | Yes |
The following keys are required in the step's ``With`` configuration:

| Key | Required | Description |
| --- | --- | --- |
| `IdentityKey` | Yes | Unique identifier for the identity |
| `TargetContainer` | Yes | See step description for details |

## Example

```powershell
@{
Name = 'MoveIdentity Example'
Type = 'IdLE.Step.MoveIdentity'
With = @{
IdentityKey = 'user.name'
TargetContainer = '<value>'
}
}
```

## See Also

- [Capabilities Reference](../capabilities.md) - Details on required capabilities
- [Providers](../providers.md) - Available provider implementations
Loading
Loading