Skip to content

Add Permissions sections to entra user commands#7155

Merged
milanholemans merged 2 commits intopnp:mainfrom
AlejandroGispert:docs/entra-user-permissions
Mar 7, 2026
Merged

Add Permissions sections to entra user commands#7155
milanholemans merged 2 commits intopnp:mainfrom
AlejandroGispert:docs/entra-user-permissions

Conversation

@AlejandroGispert
Copy link
Copy Markdown
Contributor

@AlejandroGispert AlejandroGispert commented Mar 4, 2026

Author: Alejandro Gispert  
Third-time contributor to cli-microsoft365


## Summary

Closes #6952

Adds Permissions sections to all six entra user commands (add, get, hibp, list, remove, set) per #6952. Documents the minimal delegated and application permissions required to run each command.

Commands updated

Command Delegated Application
entra user add User.ReadWrite.All User.ReadWrite.All
entra user get User.Read.All User.Read.All
entra user list User.Read.All User.Read.All
entra user remove User.ReadWrite.All User.ReadWrite.All
entra user set User.ReadWrite.All User.ReadWrite.All
entra user hibp No Microsoft Graph (HIBP API only) Same

Conventions

  • Permissions section placed before Examples in each doc
  • entra user hibp documented as using Have I Been Pwned API (no Graph permissions)
  • Admin role notes retained for add/remove commands

Permission rationale

Dev Proxy reports User.ReadBasic.All as minimal for basic get/list usage. We documented User.Read.All instead to align with the writing-the-docs requirement that permissions support any combination of options. User.ReadBasic.All can fail for --withManager and custom --properties; User.Read.All covers all documented scenarios.

Additional changes

  • Added contributor Alejandro Gispert (AG-SOUND) to team page and package.json

@AlejandroGispert AlejandroGispert force-pushed the docs/entra-user-permissions branch from 9edbedc to 1de53b9 Compare March 4, 2026 17:51
@AlejandroGispert
Copy link
Copy Markdown
Contributor Author

Hi @MartinM85, this is ready for review when you have time.

@milanholemans
Copy link
Copy Markdown
Contributor

Thanks, we'll try to review it ASAP.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds the required Permissions sections to the entra user command documentation to align with the repo’s documentation standards (per #6952), and updates contributor attribution.

Changes:

  • Added a new Permissions section (placed before Examples) to the docs for entra user add/get/hibp/list/remove/set, documenting minimal delegated and application permissions (or no Graph permissions for HIBP).
  • Updated docs to use Docusaurus <Tabs> / <TabItem> where needed for delegated vs application permission presentation.
  • Added the contributor to package.json and the docs team page.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
package.json Adds the contributor to the package metadata contributors list.
docs/docs/cmd/entra/user/user-add.mdx Adds Permissions section for entra user add (delegated/app).
docs/docs/cmd/entra/user/user-get.mdx Adds Permissions section for entra user get (delegated/app).
docs/docs/cmd/entra/user/user-hibp.mdx Adds Permissions section clarifying HIBP uses no Microsoft Graph permissions.
docs/docs/cmd/entra/user/user-list.mdx Adds Permissions section for entra user list (delegated/app).
docs/docs/cmd/entra/user/user-remove.mdx Adds Permissions section for entra user remove (delegated/app).
docs/docs/cmd/entra/user/user-set.mdx Adds Permissions section for entra user set (delegated/app).
docs/docs/about/team.mdx Adds the contributor to the public team/contributors list in docs.

Comment thread docs/docs/cmd/entra/user/user-add.mdx
Comment thread docs/docs/cmd/entra/user/user-remove.mdx
@milanholemans milanholemans self-assigned this Mar 4, 2026
Copy link
Copy Markdown
Contributor

@milanholemans milanholemans left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work @AlejandroGispert, I think we should make a few changes before we merge it. Could you have a look at them, please? Also, check the feedback from Copilot.

Comment thread docs/docs/about/team.mdx Outdated
Comment thread docs/docs/cmd/entra/user/user-add.mdx Outdated
Comment thread docs/docs/cmd/entra/user/user-add.mdx Outdated
Comment thread docs/docs/cmd/entra/user/user-add.mdx Outdated
Comment thread docs/docs/cmd/entra/user/user-get.mdx
Comment thread docs/docs/cmd/entra/user/user-list.mdx
Comment thread docs/docs/cmd/entra/user/user-remove.mdx
Comment thread docs/docs/cmd/entra/user/user-remove.mdx Outdated
Comment thread docs/docs/cmd/entra/user/user-set.mdx
Comment thread docs/docs/cmd/entra/user/user-set.mdx Outdated
@milanholemans milanholemans marked this pull request as draft March 4, 2026 22:53
@AlejandroGispert AlejandroGispert force-pushed the docs/entra-user-permissions branch 2 times, most recently from 0a9c2aa to 4881db8 Compare March 5, 2026 20:44
Updates team member list by adding Alejandro Gispert alphabetically
Corrects capitalization of "Global administrator"
Removes redundant information about user retrieval methods in user-get documentation for clarity
Removes redundant tab structure in user-hibp documentation for improved clarity
Clarifies permissions section in user-hibp documentation
Enhances table formatting
@AlejandroGispert AlejandroGispert force-pushed the docs/entra-user-permissions branch from 4881db8 to 179d2d9 Compare March 5, 2026 20:55
@AlejandroGispert
Copy link
Copy Markdown
Contributor Author

Hi @milanholemans, I have implemented the modifications you suggested. Please take another look when you have a chance.

@milanholemans
Copy link
Copy Markdown
Contributor

@AlejandroGispert nice! When ready, you can mark the PR as ready for review.

@AlejandroGispert AlejandroGispert marked this pull request as ready for review March 5, 2026 21:19
@AlejandroGispert
Copy link
Copy Markdown
Contributor Author

@milanholemans done

Copy link
Copy Markdown
Contributor

@milanholemans milanholemans left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Almost there @AlejandroGispert, let's do some final changes.

Comment thread package.json Outdated
Comment thread docs/docs/cmd/entra/user/user-add.mdx
Comment thread docs/docs/cmd/entra/user/user-add.mdx
@milanholemans milanholemans marked this pull request as draft March 5, 2026 21:59
…ical order. Enhances documentation for the user-add command by moving and clarifying the permissions requirements.
@AlejandroGispert AlejandroGispert marked this pull request as ready for review March 6, 2026 07:26
@AlejandroGispert
Copy link
Copy Markdown
Contributor Author

Hi @milanholemans it should be correct now

Copy link
Copy Markdown
Contributor

@milanholemans milanholemans left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nothing more to add!

@milanholemans milanholemans merged commit 527730a into pnp:main Mar 7, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Minimal permissions for 'entra user' commands

3 participants