Usage
m365 viva engage community user list [options]
Description
Lists all users within a specified Microsoft 365 Viva Engage community
Options
| Option |
Description |
-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. |
-r, --role [role] |
Filter the results to only users with the given role: Admin, Member. |
Examples
List all users from a community specified by ID.
m365 viva engage community user list --communityId eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiIzNjAyMDAxMTAwOSJ9
List all admins from a community specified by display name.
m365 viva engage community user list --communityDisplayName "All company" --role Admin
List all members from a community specified by group ID.
m365 viva engage community user list --entraGroupId a03c0c35-ef9a-419b-8cab-f89e0a8d2d2a --role Member
Default properties
- id
- displayName
- userPrincipalName
- roles
Additional Info
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:
Usage
m365 viva engage community user list [options]
Description
Lists all users within a specified Microsoft 365 Viva Engage community
Options
-i, --communityId [communityId]communityId,communityDisplayNameorentraGroupId.-n, --communityDisplayName [communityDisplayName]communityId,communityDisplayNameorentraGroupId.--entraGroupId [entraGroupId]communityId,communityDisplayNameorentraGroupId.-r, --role [role]Admin,Member.Examples
List all users from a community specified by ID.
List all admins from a community specified by display name.
m365 viva engage community user list --communityDisplayName "All company" --role AdminList all members from a community specified by group ID.
Default properties
Additional Info
The role
adminis essentially the same asowner, but the documentation refers to them asadmininstead ofownerfor a community.The endpoints you should look into for this scenario: