FlowmageDocs

List users

BetaReads dataVersion 2

Lists the people in your Microsoft 365 directory, with filters.

Settings

SettingWhat it is
ConnectionRequiredThe Microsoft Graph connection the step signs in with.
FieldsComma-separated property names. Asking for fewer is faster.
FilterAn OData filter, e.g. department eq 'Sales'. Needs ConsistencyLevel, which this node sends for you.
Sort bytext
SearchA search phrase, e.g. "displayName:Sales". Wrap it in double quotes.
Users per call1 to 999.
Fetch every pageFollows Graph's own next-page link until it runs out. It refuses rather than handing back a short list when Stop after is reached.
Stop afterPages — at most 50. Reaching it fails the node rather than truncating.
CursorPaste a previous run's Next cursor to read the page after it.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `microsoft-graph`)
selecttext, by default "id,displayName,mail,userPrincipalName,jobTitle"
filtertext
orderBytext
searchtext
topnumber, by default 100
returnAlltrue/false, by default false
maxPagesnumber, by default 10
cursortext

Output

FieldType
usersarray
countUsers in this answernumber
hasMoreMore users are waiting behind this pageboolean
nextCursorCursor for the next pagestring
Sample output, and the expression for each field
  • count0
  • hasMorefalse
  • users[]

Errors

When a step of this node stops a run, the run page shows a code. Look it up:

Example step

The step as a flow file holds it. Replace each value in <…>.

{
  "config": {
    "connection": "<connection id>",
    "cursor": "",
    "filter": "",
    "maxPages": 10,
    "orderBy": "",
    "returnAll": false,
    "search": "",
    "select": "id,displayName,mail,userPrincipalName,jobTitle",
    "top": 100
  },
  "label": "List users",
  "type": "graph.listUsers",
  "version": 2
}

Older versions

A flow that already has this version keeps running it. A new step always gets the newest.

Version 1
SettingWhat it is
ConnectionRequiredThe Microsoft Graph connection the step signs in with.
FieldsComma-separated property names. Asking for fewer is faster.
FilterAn OData filter, e.g. department eq 'Sales'. Needs ConsistencyLevel, which this node sends for you.
Sort bytext
SearchA search phrase, e.g. "displayName:Sales". Wrap it in double quotes.
Users per call1 to 999.
Fetch every pageFollows Graph's own next-page link until it runs out. It refuses rather than handing back a short list when Stop after is reached.
Stop afterPages — at most 50. Reaching it fails the node rather than truncating.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `microsoft-graph`)
selecttext, by default "id,displayName,mail,userPrincipalName,jobTitle"
filtertext
orderBytext
searchtext
topnumber, by default 100
returnAlltrue/false, by default false
maxPagesnumber, by default 10