pnp/cli-microsoft365

New command: `spo folder roleassignment list`

Open

#6,190 opened on Jul 27, 2024

View on GitHub
 (2 comments) (0 reactions) (0 assignees)TypeScript (399 forks)auto 404
good first issuehelp wantedkeep-opennew feature

Repository metrics

Stars
 (1,390 stars)
PR merge metrics
 (PR metrics pending)

Description

Usage

m365 spo folder roleassignment list [options]

Description

Lists all role assignments from a specific folder

Options

Option Description
-u, --webUrl <webUrl> URL of the site where the folder is located.
--folderUrl [folderUrl] The server- or site-relative decoded URL of the folder. Specify either folderUrl or folderId but not both.
-i, --folderId [folderId] The UniqueId (GUID) of the folder. Specify either folderUrl or folderId but not both.

Examples

List all role assignments of a folder specified by URL

m365 spo folder roleassignment list --webUrl "https://contoso.sharepoint.com/sites/Marketing" --folderUrl "/Branding/Logos"

List all role assignments of a folder specified by ID

m365 spo folder roleassignment list --webUrl "https://contoso.sharepoint.com/sites/Marketing" --folderId "04796e10-cb5f-4aa3-a438-bc06028a9073"

Default properties

  • PrincipalId
  • Member/Title
  • RoledefinitionBindings/Name (comma-separated)

Additional Info

API request

GET https://contoso.sharepoint.com/sites/Marketing/_api/Web/GetFolderByServerRelativePath(decodedUrl='/sites/Marketing/Branding/Logos')/ListItemAllFields/RoleAssignments?$expand=Member,RoleDefinitionBindings&$select=*,Member,RoleDefinitionBindings

Contributor guide

Research direction
Study the existing 'spo folder roleassignment' commands and the pattern for adding new commands. Implement the API call to SharePoint's RoleAssignments endpoint as specified.
Tech stack
typescriptnodejsrest api
Domain
cliapibackend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitTypeScriptNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80