Skip to content

group-get.mdx

Latest commit

 

History

History
127 lines (97 loc) · 3.14 KB

group-get.mdx

File metadata and controls

127 lines (97 loc) · 3.14 KB

import Global from '../../_global.mdx'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

spo group get

Gets site group

Usage

m365 spo group get [options]

Options

`-u, --webUrl <webUrl>`
: URL of the site where the group is located.

`-i, --id [id]`
: ID of the site group to get. Use either `id`, `name` or `associatedGroup` but not multiple.

`--name [name]`
: Name of the site group to get. Use either `id`, `name` or `associatedGroup` but not multiple.

`--associatedGroup [associatedGroup]`
: Type of the associated group to get. Available values: `Owner`, `Member`, `Visitor`. Use either `id`, `name` or `associatedGroup` but not multiple.

Examples

Get group with ID for the specified web.

m365 spo group get --webUrl https://contoso.sharepoint.com/sites/project-x --id 7

Get group with name for the specified web.

m365 spo group get --webUrl https://contoso.sharepoint.com/sites/project-x --name "Team Site Members"

Get the associated owner group of a specified site.

m365 spo group get --webUrl https://contoso.sharepoint.com/sites/project-x --associatedGroup Owner

Response

{
  "Id": 40,
  "IsHiddenInUI": false,
  "LoginName": "Project leaders",
  "Title": "Project leaders",
  "PrincipalType": 8,
  "AllowMembersEditMembership": false,
  "AllowRequestToJoinLeave": false,
  "AutoAcceptRequestToJoinLeave": false,
  "Description": "This group contains all project leaders",
  "OnlyAllowMembersViewMembership": true,
  "OwnerTitle": "Jon Doe",
  "RequestToJoinLeaveEmailSetting": null
}
AllowMembersEditMembership    : false
AllowRequestToJoinLeave       : false
AutoAcceptRequestToJoinLeave  : false
Description                   : This group contains all project leaders
Id                            : 40
IsHiddenInUI                  : false
LoginName                     : Project leaders
OnlyAllowMembersViewMembership: true
OwnerTitle                    : Jon Doe
PrincipalType                 : 8
RequestToJoinLeaveEmailSetting: null
Title                         : Project leaders

Id,IsHiddenInUI,LoginName,Title,PrincipalType,AllowMembersEditMembership,AllowRequestToJoinLeave,AutoAcceptRequestToJoinLeave,Description,OnlyAllowMembersViewMembership,OwnerTitle
40,,Project leaders,Project leaders,8,,,,This group contains all project leaders,1,Jon Doe
# spo group get --webUrl "https://contoso.sharepoint.com/sites/project-x" --name "Project leaders"

Date: 10/3/2023

## Project leaders (40)

Property | Value
---------|-------
Id | 40
IsHiddenInUI | false
LoginName | Project leaders
Title | Project leaders
PrincipalType | 8
AllowMembersEditMembership | false
AllowRequestToJoinLeave | false
AutoAcceptRequestToJoinLeave | false
Description | This group contains all project leaders
OnlyAllowMembersViewMembership | true
OwnerTitle | Jon Doe