Skip to main content

spo group set

Updates a group in the specified site

Usage​

m365 spo group set [options]

Options​

-u, --webUrl <webUrl>

URL of the site where the group is located.

-i, --id [id]

ID of the group to update. Specify either id or name but not both.

-n, --name [name]

Name of the group. Specify either id or name but not both.

--newName [newName]

New name for the group.

--description [description]

The description for the group.

--allowMembersEditMembership [allowMembersEditMembership]

Who can edit the membership of the group? When true members can edit membership, otherwise only owners can do this.

--onlyAllowMembersViewMembership [onlyAllowMembersViewMembership]

Who can view the membership of the group? When true only group members can view the membership, otherwise everyone can.

--allowRequestToJoinLeave [allowRequestToJoinLeave]

Specify whether to allow users to request membership in this group and allow users to request to leave the group.

--autoAcceptRequestToJoinLeave [autoAcceptRequestToJoinLeave]

If auto-accept is enabled, users will automatically be added or removed when they make a request.

--requestToJoinLeaveEmailSetting [requestToJoinLeaveEmailSetting]

All membership requests will be sent to the email address specified.

--ownerEmail [ownerEmail]

Set user with this email as owner of the group. Specify either ownerEmail or ownerUserName but not both.

--ownerUserName [ownerUserName]

Set user with this login name as owner of the group. Specify either ownerEmail or ownerUserName but not both.

-h, --help [help]

Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are options, examples, remarks, permissions, response, full. Default is options.

--query [query]

JMESPath query string. See http://jmespath.org/ for more information and examples.

-o, --output [output]

Output type. json, text, csv, md, none. Default json.

--verbose

Runs command with verbose logging.

--debug

Runs command with debug logging.

Examples​

Update group title and description.

m365 spo group set --webUrl https://contoso.sharepoint.com/sites/project-x --id 18 --newName "Project leaders" --description "This group contains all project leaders"

Update group with membership requests.

m365 spo group set --webUrl https://contoso.sharepoint.com/sites/project-x --name "Project leaders" --allowRequestToJoinLeave true --requestToJoinLeaveEmailSetting john.doe@contoso.com

Sets a specified user as group owner.

m365 spo group set --webUrl https://contoso.sharepoint.com/sites/project-x --id 18 --ownerEmail john.doe@contoso.com

Response​

The command won't return a response on success.