pnp/cli-microsoft365

New command: `spo listitem roleassignment list`

Open

#6,189 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 listitem roleassignment list [options]

Description

Lists all role assignments from a specific list item

Options

Option Description
-u, --webUrl <webUrl> URL of the site where the list item is located.
-i, --listId [listId] ID of the list. Specify either listId, listTitle, or listUrl but not multiple.
-t, --listTitle [listTitle] Title of the list. Specify either listId, listTitle, or listUrl but not multiple.
--listUrl [listUrl] Relative URL of the list. Specify either listId, listTitle, or listUrl but not multiple.
--listItemId <listItemId> ID of the list item to remove the role from.

Examples

Lists all role assignments of a list item in a list specified by title

m365 spo listitem roleassignment list --webUrl "https://contoso.sharepoint.com/sites/Marketing" --listTitle "Branding" --listItemId 125

Lists all role assignments of a list item in a list specified by ID

m365 spo listitem roleassignment list --webUrl "https://contoso.sharepoint.com/sites/Marketing" --listId a2baa9d6-ef21-4208-8753-342893c4f0d9 --listItemId 125

Lists all role assignments of a list item in a list specified by URL

m365 spo listitem roleassignment list --webUrl "https://contoso.sharepoint.com/sites/Marketing" --listUrl "/Branding" --listItemId 125

Default properties

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

Additional Info

API request

GET https://contoso.sharepoint.com/sites/Marketing/_api/Web/Lists/GetByTitle('Testlib')/Items(125)/RoleAssignments?$expand=Member,RoleDefinitionBindings&$select=*,Member,RoleDefinitionBindings

Contributor guide

Research direction
Look at existing commands like 'spo listitem roleassignment add' and 'spo list roleassignment list' as templates. Understand the CLI Microsoft365 command structure, then use the SharePoint REST API endpoint provided in the issue to fetch role assignments. Implement the command following the project's patterns.
Tech stack
typescriptnodejs
Domain
cliapi
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.
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
GitNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70