Skip to main content

viva engage role member list

Lists all users assigned to a Viva Engage role

Usage​

m365 viva engage role member list [options]

Options​

-i, --roleId [roleId]

The id of the Viva Engage role. Specify either roleId or roleName, but not both.

-n, --roleName [roleName]

The name of the Viva Engage role. Specify either roleId or roleName, 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.

Remarks​

warning

This command is based on an API that is currently in preview and is subject to change once the API reaches general availability.

Permissions​

ResourcePermissions
Microsoft GraphEngagementRole.Read.All

Examples​

Get all users assigned to a Viva Engage role specified by id

m365 viva engage role member list --roleId 77aa47ad-96fe-4ecc-8024-fd1ac5e28f17

Get all users assigned to a Viva Engage role specified by name

m365 viva engage role member list --roleName 'Verified Admin'

Response​

[
  {
    "id": "1f5595b2-aa07-445d-9801-a45ea18160b2",
    "createdDateTime": "2024-05-22T15:43:08.368Z",
    "userId": "1f5595b2-aa07-445d-9801-a45ea18160b2"
  }
]