Skip to main content

entra user list

Lists users matching specified criteria

Usage​

m365 entra user list [options]

Options​

--type [type]

Filter the results to only users of a given type: Member or Guest. By default, all users are listed.

-p, --properties [properties]

Comma-separated list of properties to retrieve.

-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 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​

Using the --properties option, you can specify a comma-separated list of user properties to retrieve from the Microsoft Graph. If you don't specify any properties, the command will output the default properties returned by Graph.

When the properties option includes values with a /, for example: manager/displayName, an additional $expand query parameter will be included on manager.

To filter the list of users, include additional options that match the user property that you want to filter with. For example --displayName Patt will return all users whose displayName starts with Patt. Multiple filters will be combined using the and operator.

Certain properties cannot be returned within a user collection. The following properties are only supported when retrieving an single user using: aboutMe, birthday, hireDate, interests, mySite, pastProjects, preferredName, responsibilities, schools, skills, mailboxSettings.

Examples​

List all users in the tenant.

m365 entra user list

List all guest users in the tenant.

m365 entra user list --type Guest

List all users in the tenant. For each one return the display name and e-mail address.

m365 entra user list --properties "displayName,mail"

Show users whose display name starts with Patt.

m365 entra user list --displayName Patt

Show all account managers whose display name starts with Patt.

m365 entra user list --displayName Patt --jobTitle 'Account manager'

List users from the tenant. For each one return the display name, e-mail address, and manager information.

m365 entra user list --properties "displayName,mail,manager/*"

Response​

[
  {
    "businessPhones": [
      "+32 456 789 123"
    ],
    "displayName": "John Doe",
    "givenName": "John",
    "jobTitle": "Sales Manager",
    "mail": "John@contoso.onmicrosoft.com",
    "mobilePhone": "+32 456 789 123",
    "officeLocation": "Antwerp",
    "preferredLanguage": "nl-BE",
    "surname": "Doe",
    "userPrincipalName": "John@contoso.onmicrosoft.com",
    "id": "ef0d4f29-e359-4443-a15d-bc3dccc8143f"
  }
]

More information​

CTRL + M