-
Notifications
You must be signed in to change notification settings - Fork 0
feat: Add IdLE.Step.Mailbox.EnsurePermissions and ExchangeOnline provider support #227
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
d3b53d8
Initial plan
Copilot ac19609
feat: Add IdLE.Step.Mailbox.EnsurePermissions step and ExchangeOnline…
Copilot 7dc3881
Merge branch 'main' into copilot/add-mailbox-permissions-step
blindzero 20c9024
Merge branch 'main' into copilot/add-mailbox-permissions-step
blindzero 5841738
fix: add step registry entry, regenerate docs, update provider and RE…
Copilot eaee7ed
docs: add step-mailbox-ensure-permissions to sidebar navigation
Copilot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| # IdLE.Step.Mailbox.EnsurePermissions | ||
|
|
||
| > Generated file. Do not edit by hand. | ||
| > Source: tools/Generate-IdleStepReference.ps1 | ||
|
|
||
| ## Summary | ||
|
|
||
| - **Step Type**: `IdLE.Step.Mailbox.EnsurePermissions` | ||
| - **Module**: `IdLE.Steps.Mailbox` | ||
| - **Implementation**: `Invoke-IdleStepMailboxPermissionsEnsure` | ||
| - **Idempotent**: `Yes` | ||
|
|
||
| ## Synopsis | ||
|
|
||
| Ensures that mailbox delegate permissions match the desired state. | ||
|
|
||
| ## Description | ||
|
|
||
| The host must supply a provider instance via | ||
| Context.Providers[<ProviderAlias>]. The provider must implement an EnsureMailboxPermissions | ||
| method with the signature (IdentityKey, Permissions, AuthSession) and return an object | ||
| that contains a boolean property 'Changed'. | ||
|
|
||
| The step is idempotent by design: it converges mailbox delegate permissions to the desired | ||
| state by computing the delta between current and desired permissions and applying only the | ||
| necessary changes. | ||
|
|
||
| Supported rights (v1): | ||
|
|
||
| - FullAccess | ||
|
|
||
| - SendAs | ||
|
|
||
| - SendOnBehalf | ||
|
|
||
| Permissions array shape (data-only): | ||
| Each entry must be a hashtable with: | ||
|
|
||
| - AssignedUser: string (required) - UPN or SMTP address of the delegate | ||
|
|
||
| - Right: 'FullAccess' | 'SendAs' | 'SendOnBehalf' (required) | ||
|
|
||
| - Ensure: 'Present' | 'Absent' (required) | ||
|
|
||
| Authentication: | ||
|
|
||
| - If With.AuthSessionName is present, the step acquires an auth session via | ||
| Context.AcquireAuthSession(Name, Options) and passes it to the provider method. | ||
|
|
||
| - If With.AuthSessionName is absent, defaults to With.Provider value (e.g., 'ExchangeOnline'). | ||
|
|
||
| - With.AuthSessionOptions (optional, hashtable) is passed to the broker for | ||
| session selection (e.g., @\{ Role = 'Admin' \}). | ||
|
|
||
| ## Inputs (With.*) | ||
|
|
||
| The following keys are required in the step's ``With`` configuration: | ||
|
|
||
| | Key | Required | Description | | ||
| | --- | --- | --- | | ||
| | `IdentityKey` | Yes | Unique identifier for the identity | | ||
| | `Permissions` | Yes | See step description for details | | ||
|
|
||
| ## Example | ||
|
|
||
| ```powershell | ||
| @{ | ||
| Name = 'IdLE.Step.Mailbox.EnsurePermissions Example' | ||
| Type = 'IdLE.Step.Mailbox.EnsurePermissions' | ||
| With = @{ | ||
| IdentityKey = 'user.name' | ||
| Permissions = '<value>' | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## See Also | ||
|
|
||
| - [Capabilities Reference](../capabilities.md) - Overview of IdLE capabilities | ||
| - [Providers](../providers.md) - Available provider implementations |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.