Skip to content

Commit

Permalink
New command: m365 spo folder sharinglink list. Closes #5961
Browse files Browse the repository at this point in the history
  • Loading branch information
Saurabh7019 committed Apr 24, 2024
1 parent cec4ca2 commit dc8dc00
Show file tree
Hide file tree
Showing 6 changed files with 634 additions and 1 deletion.
116 changes: 116 additions & 0 deletions docs/docs/cmd/spo/folder/folder-sharinglink-list.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
import Global from '/docs/cmd/_global.mdx';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# spo folder sharinglink list

Lists all the sharing links of a specific folder

## Usage

```sh
m365 spo folder sharinglink list [options]
```

## Options

```md definition-list
`-u, --webUrl <webUrl>`
: The 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.

`--folderId [folderId]`
: The UniqueId (GUID) of the folder. Specify either `folderUrl` or `folderId` but not both.

`-s, --scope [scope]`
: Filter the results to only sharing links of a given scope: `anonymous`, `users` or `organization`. By default all sharing links are listed.
```

<Global />

## Examples

List sharing links of a folder by id.

```sh
m365 spo folder sharinglink list --webUrl https://contoso.sharepoint.com/sites/demo --folderId daebb04b-a773-4baa-b1d1-3625418e3234
```

List sharing links of a folder by url.

```sh
m365 spo folder sharinglink list --webUrl https://contoso.sharepoint.com/sites/demo --folderUrl "/sites/demo/shared documents/folder"
```

List anonymous sharing links of a folder by url.

```sh
m365 spo folder sharinglink list --webUrl https://contoso.sharepoint.com/sites/demo --folderUrl "/sites/demo/shared documents/folder" --scope anonymous
```

## Response

<Tabs>
<TabItem value="JSON">

```json
[
{
"@deprecated.GrantedToIdentities": "GrantedToIdentities has been deprecated. Refer to GrantedToIdentitiesV2",
"id": "e6100f73-981c-4bde-986b-eed262f04659",
"roles": [
"write"
],
"shareId": "u!aHR0cHM6Ly83NTY2YXZhLnNoYXJlcG9pbnQuY29tLzpmOi9nL0V2QVFpdnpLV2ZoT3ZJOHJiNm1UVEhjQmQzUUxCOXVsUGIyQTQ1UG81ZmRuYWc",
"hasPassword": false,
"grantedToIdentitiesV2": [],
"grantedToIdentities": [],
"link": {
"scope": "anonymous",
"type": "edit",
"webUrl": "https://contoso.sharepoint.com/:f:/g/EvAQivzKWfhOvI8rb6mTTHcBd3QLB9ulPb2A45Po5fdnag",
"preventsDownload": false
}
}
]
```

</TabItem>
<TabItem value="Text">

```text
id scope roles link
------------------------------------ ------------ ----- -----------------------------------------------------------------------------------
e6100f73-981c-4bde-986b-eed262f04659 anonymous write https://contoso.sharepoint.com/:f:/g/EvAQivzKWfhOvI8rb6mTTHcBd3QLB9ulPb2A45Po5fdnag
```

</TabItem>
<TabItem value="CSV">

```csv
@deprecated.GrantedToIdentities,id,shareId,hasPassword
GrantedToIdentities has been deprecated. Refer to GrantedToIdentitiesV2,e6100f73-981c-4bde-986b-eed262f04659,u!aHR0cHM6Ly83NTY2YXZhLnNoYXJlcG9pbnQuY29tLzpmOi9nL0V2QVFpdnpLV2ZoT3ZJOHJiNm1UVEhjQmQzUUxCOXVsUGIyQTQ1UG81ZmRuYWc,
```

</TabItem>
<TabItem value="Markdown">

```md
# spo folder sharinglink list --webUrl "https://contoso.sharepoint.com/" --folderUrl "/shared documents/folder1"

Date: 24/04/2024

## e6100f73-981c-4bde-986b-eed262f04659

Property | Value
---------|-------
@deprecated.GrantedToIdentities | GrantedToIdentities has been deprecated. Refer to GrantedToIdentitiesV2
id | e6100f73-981c-4bde-986b-eed262f04659
shareId | u!aHR0cHM6Ly83NTY2YXZhLnNoYXJlcG9pbnQuY29tLzpmOi9nL0V2QVFpdnpLV2ZoT3ZJOHJiNm1UVEhjQmQzUUxCOXVsUGIyQTQ1UG81ZmRuYWc
hasPassword | false
```

</TabItem>
</Tabs>
5 changes: 5 additions & 0 deletions docs/src/config/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2506,6 +2506,11 @@ const sidebars: SidebarsConfig = {
type: 'doc',
label: 'folder roleinheritance reset',
id: 'cmd/spo/folder/folder-roleinheritance-reset'
},
{
type: 'doc',
label: 'folder sharinglink list',
id: 'cmd/spo/folder/folder-sharinglink-list'
}
]
},
Expand Down
1 change: 1 addition & 0 deletions src/m365/spo/commands.ts
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ export default {
FOLDER_ROLEASSIGNMENT_ADD: `${prefix} folder roleassignment add`,
FOLDER_ROLEINHERITANCE_BREAK: `${prefix} folder roleinheritance break`,
FOLDER_ROLEINHERITANCE_RESET: `${prefix} folder roleinheritance reset`,
FOLDER_SHARINGLINK_LIST: `${prefix} folder sharinglink list`,
GET: `${prefix} get`,
GROUP_ADD: `${prefix} group add`,
GROUP_GET: `${prefix} group get`,
Expand Down

0 comments on commit dc8dc00

Please sign in to comment.