viva engage community user remove

Removes a specified user from a Microsoft 365 Viva Engage community

Usage

m365 viva engage community user remove [options]

Options

-i, --communityId [communityId]

The ID of the Viva Engage community. Specify communityId, communityDisplayName or entraGroupId.

-n, --communityDisplayName [communityDisplayName]

The display name of the Viva Engage community. Specify communityId, communityDisplayName or entraGroupId.

--entraGroupId [entraGroupId]

The ID of the Microsoft 365 group. Specify communityId, communityDisplayName or entraGroupId.

--id [id]

Microsoft Entra ID of the user. Specify either id or userName but not both.

--userName [userName]

The user principal name of the user. Specify either id or userName but not both.

-f, --force

Don't prompt for confirming removing the user from the specified Viva Engage community.

-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.

Permissions

Delegated

Resource	Permissions
Microsoft Graph	GroupMember.ReadWrite.All

Application

Resource	Permissions
Microsoft Graph	GroupMember.ReadWrite.All

Examples

Remove a user specified by ID as a member from a community specified by display name.

m365 viva engage community user remove --communityDisplayName "All company" --id 098b9f52-f48c-4401-819f-29c33794c3f5

Remove a user specified by UPN from a community specified by its group ID without confirmation.

m365 viva engage community user remove --entraGroupId a03c0c35-ef9a-419b-8cab-f89e0a8d2d2a --userName john.doe@contoso.com --force

Response

The command won't return a response on success.