pnp / pnp/cli-microsoft365

Minimal Permissions for all commands

Open
#6,918 5 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

epic
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:

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.All instead of Group.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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.