@pnp/cli-microsoft365 10.11.0-beta.c2217b6 → 11.0.0-beta.1f852eb

package/docs/docs/cmd/viva/engage/engage-role-member-list.mdx

@@ -0,0 +1,118 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# viva engage role member list
+
+Lists all users assigned to a Viva Engage role
+
+## Usage
+
+```sh
+m365 viva engage role member list [options]
+```
+
+## Options
+
+```md definition-list
+`-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.
+```
+
+<Global />
+
+## 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
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource        | Permissions             |
+  |-----------------|-------------------------|
+  | Microsoft Graph | EngagementRole.Read.All |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource        | Permissions             |
+  |-----------------|-------------------------|
+  | Microsoft Graph | EngagementRole.Read.All |
+
+  </TabItem>
+</Tabs>
+
+## Examples
+
+Get all users assigned to a Viva Engage role specified by id
+
+```sh
+m365 viva engage role member list --roleId 77aa47ad-96fe-4ecc-8024-fd1ac5e28f17
+```
+
+Get all users assigned to a Viva Engage role specified by name
+
+```sh
+m365 viva engage role member list --roleName 'Verified Admin'
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "id": "1f5595b2-aa07-445d-9801-a45ea18160b2",
+      "createdDateTime": "2024-05-22T15:43:08.368Z",
+      "userId": "1f5595b2-aa07-445d-9801-a45ea18160b2"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  id                                    userId
+  ------------------------------------  ------------------------------------
+  1f5595b2-aa07-445d-9801-a45ea18160b2  1f5595b2-aa07-445d-9801-a45ea18160b2
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,createdDateTime,userId
+  1f5595b2-aa07-445d-9801-a45ea18160b2,2024-05-22T15:43:08.406Z,1f5595b2-aa07-445d-9801-a45ea18160b2
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # viva engage role member list --roleId "966b8ec4-6457-4f22-bd3c-5a2520e98f4a"
+
+  Date: 8/1/2025
+
+  ## 1f5595b2-aa07-445d-9801-a45ea18160b2
+
+  Property | Value
+  ---------|-------
+  id | 1f5595b2-aa07-445d-9801-a45ea18160b2
+  createdDateTime | 2024-05-22T15:43:08.406Z
+  userId | 1f5595b2-aa07-445d-9801-a45ea18160b2
+  ```
+
+  </TabItem>
+</Tabs>