Minimal Permissions for all commands
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.5k
- Forks
- 413
- Avg merge
- 5d 6h
- Merged PRs (30d)
- 21
Description
We want to add a new Permissions section to the documentation of all commands. This section lists the minimum permissions (both delegated and application) required to run the command successfully. By documenting only the minimal set of permissions, developers can more easily configure their own app registrations, which in turn simplifies running the CLI with application permissions.
We’ve already established the foundation for this work:
- Clear guide on how to add permissions to the docs: Writing docs page - Permissions
- Clear guidance on how to determine minimal permissions: How to document minimal permissions
- A concrete example of the final design in use:
Scope
- Add a Permissions section to each command page.
- Document only the minimal required permissions. When multiple permissions are possible, list only the most restrictive one (e.g.
GroupMember.Read.Allinstead ofGroup.ReadWrite.All). - Place the Permissions section right before the Examples section for consistency across all commands.
- If there are multiple resources, order them alphabetically
- If there are commands that only support one type of auth (like delegated or app-only), we have an example for that as well. E.g. m365 planner tenant settings list - Permissions
Commands to Update
We’ll update all commands, grouped by CRUD operations. Each group will be tracked in a separate issue, so folks can easily pick them up.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Writing docs page on Permissions and the guide for documenting minimal permissions, then compare the existing planner command pages linked in the issue. Update each command page with delegated and application permissions immediately before Examples, ordering multiple resources alphabetically. Done means every command page in the assigned group has a minimal Permissions section following the documented format.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100