Skip to content

New command: break role inheritance on list/lib #3198

@Adam-it

Description

@Adam-it

Usage

m365 spo list roleinheritance break

Description

break inheritance on list or library. Keeping existing permissions is the default behavior.

Options

Option Description
-u, --webUrl <webUrl> URL of the site where the list to retrieve is located
-i, --listId [listId] ID of the list to retrieve information for. Specify either id or title but not both
-t, --listTitle [listTitle] Title of the list to retrieve information for. Specify either id or title but not both
-c --clearExistingPermissions Flag if used clears all roles from the list

Additional Info

breaking role inheritance is the first step before we start adding some commands which will allow to manage permissions on items (add/remove roles etc.) which is what I would like to aim as described here #3184.

I did some research and for this command we may use the POST request

_api/web/lists/getbytitle('${ListTileHere}')/breakroleinheritance(${TrueOrFalseHere})

also when user will define list Id not Title we may just use the getbyid() instead of getbytitle

as checked this is the behavior we get with using this endpoint

permission I had on list before running any command
image

after running with true
image
we see the inheritance was broken but we still all roles persist

if we run
image
we see the inheritance was broken and all roles were cleared.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions