viva engage community user list
Lists all users within a specified Microsoft 365 Viva Engage community
Usage
m365 viva engage community user list [options]
Options
--communityId [communityId]
The ID of the Viva Engage community. Specify
communityId
,communityDisplayName
orentraGroupId
.-n, --communityDisplayName [communityDisplayName]
The display name of the Viva Engage community. Specify
communityId
,communityDisplayName
orentraGroupId
.--entraGroupId [entraGroupId]
The ID of the Microsoft 365 group. Specify
communityId
,communityDisplayName
orentraGroupId
.-r, --role [role]
Filter the results to only users with the given role:
Admin
,Member
.
-h, --help [help]
Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are
options
,examples
,remarks
,response
,full
. Default isoptions
.--query [query]
JMESPath query string. See http://jmespath.org/ for more information and examples.
-o, --output [output]
Output type.
json
,text
,csv
,md
,none
. Defaultjson
.--verbose
Runs command with verbose logging.
--debug
Runs command with debug logging.
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 b6c35b51-ebca-445c-885a-63a67d24cb53 --role Member
Response
Standard response
- JSON
- Text
- CSV
- Markdown
[
{
"id": "da634de7-d23c-4419-ab83-fcd395b4ebd0",
"businessPhones": [
"123-555-1215"
],
"displayName": "Anton Johansen",
"givenName": "Anton",
"jobTitle": "IT Manager",
"mail": null,
"mobilePhone": "123-555-6645",
"officeLocation": "123455",
"preferredLanguage": null,
"surname": "Johansen",
"userPrincipalName": "Anton.Johansen@contoso.onmicrosoft.com",
"roles": [
"Admin"
]
}
]
id displayName userPrincipalName roles
------------------------------------ ---------------- ----------------------------------------- ------
da634de7-d23c-4419-ab83-fcd395b4ebd0 Anton Johansen Anton.Johansen@contoso.onmicrosoft.com Admin
id,displayName,givenName,jobTitle,mail,mobilePhone,officeLocation,preferredLanguage,surname,userPrincipalName
da634de7-d23c-4419-ab83-fcd395b4ebd0,Anton Johansen,Anton,IT Manager,,123-555-6645,123455,,Johansen,Anton.Johansen@contoso.onmicrosoft.com
# viva engage community user list --entraGroupId "b6c35b51-ebca-445c-885a-63a67d24cb53"
Date: 19/9/2024
## Anton Johansen (da634de7-d23c-4419-ab83-fcd395b4ebd0)
Property | Value
---------|-------
id | da634de7-d23c-4419-ab83-fcd395b4ebd0
displayName | Anton Johansen
givenName | Anton
jobTitle | IT Manager
mobilePhone | 123-555-6645
officeLocation | 123455
surname | Johansen
userPrincipalName | Anton.Johansen@contoso.onmicrosoft.com