Skip to content

New command: viva engage community user remove #6296

@Jwaegebaert

Description

@Jwaegebaert

Usage

m365 viva engage community user remove [options]

Description

Removes a specified user from a Microsoft 365 Viva Engage community

Options

Option Description
--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 [groupId] The ID of the Microsoft 365 group. Specify communityId, communityDisplayName or entraGroupId.
--id [id] Microsoft Entra IDs of the user. Specify either id or userName but not both.
--userName [userName] The user principal names 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.

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 [email protected] --force

Additional Info

Warning

Be cautious when removing admin users, as your community must always have at least one admin. You won't be able to remove the last remaining admin user.

The role admin is essentially the same as owner, but the documentation refers to them as admin instead of owner for a community.

The endpoints you should look into for this scenario:

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions