List Users

Configuration reference for listing Entra ID users as Pipes items

Retrieve a list of user objects. An item is created for each user. Requires an EntraID module.

Configuration

Properties
Example

Name	Description	Default
`namespace`	Bind to EntraID module
`filter`	Search filter
`select`	Select properties
`id_property`	Use this id property in result entries	`"id"`
`min`	Set value to enforce min result size
`max`	Set value to enforce max result size
`use_beta_api`	Graph API beta endpoint.	`false`

{
  "name": "EntraIDListUsers",
  "config": {
    "filter": "startsWith(displayName,'Måns') or startsWith(displayName, 'Robert')",
    "select": "businessPhones,displayName,mail,id,apa,preferredLanguage,userPrincipalName",
    "id_property": "id",
    "min": 1,
    "max": 2
  }
}

Custom Security Attributes

When select includes customSecurityAttributes, Microsoft Graph can return nested JSON where collection values are represented inside the attribute payload. If you need those collection values as Pipes multi-value properties, pass the relevant JSON through JsonToItems with array_to_mv enabled.

Example:

{
  "name": "JsonToItems",
  "config": {
    "src": "${item.Skoldata}",
    "array_to_mv": true
  }
}

With array_to_mv: true, a value such as schoolUnitCode: ["19051089","20100577"] is stored as a multi-value property instead of a JSON string.