-
Notifications
You must be signed in to change notification settings - Fork 329
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
864 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
122 changes: 122 additions & 0 deletions
122
docs/docs/cmd/spo/tenant/tenant-site-membership-list.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,122 @@ | ||
import Global from '/docs/cmd/_global.mdx'; | ||
import Tabs from '@theme/Tabs'; | ||
import TabItem from '@theme/TabItem'; | ||
|
||
# spo tenant site membership list | ||
|
||
Retrieve information about default site groups' membership | ||
|
||
## Usage | ||
|
||
```sh | ||
m365 spo tenant site membership list [options] | ||
``` | ||
|
||
## Options | ||
|
||
```md definition-list | ||
`-u, --siteUrl <siteUrl>` | ||
: The URL of the site. | ||
|
||
`-r, --role [role]` | ||
: Filter the results to include only users with the specified roles: `Owner`, `Member`, or `Visitor`. | ||
``` | ||
|
||
<Global /> | ||
|
||
## Remarks | ||
|
||
:::info | ||
|
||
To use this command, you must be a Global or SharePoint administrator. | ||
|
||
::: | ||
|
||
For other scenarios, refer to the [spo web get --withGroups](../web/web-get.mdx) and [spo group member list](../group/group-member-list.mdx) commands. | ||
|
||
## Examples | ||
|
||
Retrieve information about default site groups' owners, members, and visitors of the site. | ||
|
||
```sh | ||
m365 spo tenant site membership list --siteUrl https://contoso.sharepoint.com | ||
``` | ||
|
||
Retrieve information about site owners. | ||
|
||
```sh | ||
m365 spo tenant site membership list --siteUrl https://contoso.sharepoint.com --role Owner | ||
``` | ||
|
||
## Response | ||
|
||
<Tabs> | ||
<TabItem value="JSON"> | ||
|
||
```json | ||
{ | ||
"AssociatedOwnerGroup": [ | ||
{ | ||
"email": "[email protected]", | ||
"loginName": "i:0#.f|membership|[email protected]", | ||
"name": "John Doe", | ||
"userPrincipalName": "[email protected]" | ||
} | ||
], | ||
"AssociatedMemberGroup": [ | ||
{ | ||
"email": "[email protected]", | ||
"loginName": "i:0#.f|membership|[email protected]", | ||
"name": "Adele Vance", | ||
"userPrincipalName": "[email protected]" | ||
} | ||
], | ||
"AssociatedVisitorGroup": [ | ||
{ | ||
"email": "", | ||
"loginName": "c:0-.f|rolemanager|spo-grid-all-users/dc109ffd-4298-487e-9cbc-6b9b1a2cd3e2", | ||
"name": "Everyone except external users", | ||
"userPrincipalName": null | ||
} | ||
] | ||
} | ||
``` | ||
</TabItem> | ||
<TabItem value="Text"> | ||
|
||
```text | ||
email name userPrincipalName associatedGroupType | ||
-------------------------------- ------------------------------ -------------------------------- ------------------- | ||
[email protected] John Doe [email protected] Owner | ||
``` | ||
|
||
</TabItem> | ||
<TabItem value="CSV"> | ||
|
||
```csv | ||
email,loginName,name,userPrincipalName,associatedGroupType | ||
[email protected],i:0#.f|membership|[email protected],John Doe,[email protected],Owner | ||
``` | ||
|
||
</TabItem> | ||
<TabItem value="Markdown"> | ||
|
||
```md | ||
# spo tenant site membership list --siteUrl "https://contoso.sharepoint.com/sites/AudienceTest" | ||
|
||
Date: 11/08/2024 | ||
|
||
## John Doe | ||
|
||
Property | Value | ||
---------|------- | ||
email | [email protected] | ||
loginName | i:0#.f\|membership\|[email protected] | ||
name | John Doe | ||
userPrincipalName | [email protected] | ||
associatedGroupType | Owner | ||
|
||
``` | ||
|
||
</TabItem> | ||
</Tabs> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.