pnp/cli-microsoft365

New command: `spo file roleassignment list`

Open

#6,191 opened on Jul 27, 2024

View on GitHub
 (6 comments) (0 reactions) (1 assignee)TypeScript (399 forks)auto 404
good first issuekeep-opennew featurework in progress

Repository metrics

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

Description

Usage

m365 spo file roleassignment list [options]

Description

Lists all role assignments from a specific file

Options

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

Examples

List all role assignments of a file specified by URL

m365 spo file roleassignment list --webUrl "https://contoso.sharepoint.com/sites/Marketing" --fileUrl "/Branding/Logos/Contoso.jpg"

List all role assignments of a file specified by ID

m365 spo file roleassignment list --webUrl "https://contoso.sharepoint.com/sites/Marketing" --fileId "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/GetFileByServerRelativePath(decodedUrl='/sites/Marketing/Branding/Logos/Contoso.jpg')/ListItemAllFields/RoleAssignments?$expand=Member,RoleDefinitionBindings&$select=*,Member,RoleDefinitionBindings

Contributor guide

Research direction
Examine existing similar commands in the 'spo file roleassignment' group to understand the structure and then implement the list command accordingly.
Tech stack
typescript
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80