Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds "aad group user list" command. Closes #5469 #5537

Closed
wants to merge 9 commits into from
Closed
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 119 additions & 0 deletions docs/docs/cmd/aad/group/group-user-list.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
import Global from '/docs/cmd/_global.mdx';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# aad group user list

Lists users of a specific Azure AD group

## Usage

```sh
m365 aad group user list [options]
```

## Options

```md definition-list
`-i, --groupId [groupId]`
: The ID of the Azure AD group. Specify `groupId` or `groupDisplayName` but not both.

`-n, --groupDisplayName [groupDisplayName]`
: The display name of the Azure AD group. Specify `groupId` or `groupDisplayName` but not both.

`-r, --role [role]`
: Filter the results to only users with the given role: `Owner`, `Member`.
```
nanddeepn marked this conversation as resolved.
Show resolved Hide resolved

`-p, --properties [properties]`
: Comma-separated list of properties to retrieve.

`-f, --filter [filter]`
: OData filter to use to query the list of users with.
<Global />

## Examples

List all group users from a group specified by ID.

```sh
m365 aad group user list --groupId 03cba9da-3974-46c1-afaf-79caa2e45bbe
```

List all owners from a group specified by display name.

```sh
m365 aad group user list --groupDisplayName Developers --role Owner
```

List all group users from a group specified by name. For each one return the display name and e-mail address

```sh
m365 aad group user list --groupDisplayName Developers --properties "displayName,mail"
```

List all group members that are guest users.

```sh
m365 aad group user list --groupDisplayName Developers --filter "userType eq 'Guest'"
```

## Response

<Tabs>
<TabItem value="JSON">

```json
[
{
"id": "da52218e-4822-4ac6-b41d-255e2059655e",
"displayName": "Adele Vance",
"userPrincipalName": "AdeleV@contoso.OnMicrosoft.com",
"givenName": "Adele",
"surname": "Vance",
"roles": [
"Owner",
"Member"
]
}
]
```

</TabItem>
<TabItem value="Text">

```text
id displayName userPrincipalName roles
------------------------------------ -------------------- ------------------------------------ --------
da52218e-4822-4ac6-b41d-255e2059655e Adele Vance AdeleV@contoso.OnMicrosoft.com Owner,Member
```

</TabItem>
<TabItem value="CSV">

```csv
id,displayName,userPrincipalName,givenName,surname
da52218e-4822-4ac6-b41d-255e2059655e,Adele Vance,AdeleV@contoso.OnMicrosoft.com,Adele,Vance
```

</TabItem>
<TabItem value="Markdown">

```md
# aad group user list --groupId "1deaa428-8dde-4043-b028-5492226d6114"

Date: 2023-10-02

## Adele Vance (da52218e-4822-4ac6-b41d-255e2059655e)

Property | Value
---------|-------
id | da52218e-4822-4ac6-b41d-255e2059655e
displayName | Adele Vance
userPrincipalName | AdeleV@contoso.OnMicrosoft.com
givenName | Adele
surname | Vance
```

</TabItem>
</Tabs>
nanddeepn marked this conversation as resolved.
Show resolved Hide resolved
1 change: 1 addition & 0 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ const config = {
favicon: 'img/favicon.ico',
organizationName: 'pnp',
projectName: 'cli-microsoft365',
trailingSlash: false,

i18n: {
defaultLocale: 'en',
Expand Down
5 changes: 5 additions & 0 deletions docs/src/config/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,11 @@ const sidebars = {
type: 'doc',
label: 'group remove',
id: 'cmd/aad/group/group-remove'
},
{
type: 'doc',
label: 'group user list',
id: 'cmd/aad/group/group-user-list'
}
]
},
Expand Down
1 change: 1 addition & 0 deletions src/m365/aad/commands.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ export default {
GROUP_GET: `${prefix} group get`,
GROUP_LIST: `${prefix} group list`,
GROUP_REMOVE: `${prefix} group remove`,
GROUP_USER_LIST: `${prefix} group user list`,
GROUPSETTING_ADD: `${prefix} groupsetting add`,
GROUPSETTING_GET: `${prefix} groupsetting get`,
GROUPSETTING_LIST: `${prefix} groupsetting list`,
Expand Down
Loading