List Groups

Configuration reference for the List Groups Pipes valve and its supported options.

This page describes the List Groups Pipes valve and its supported options.

Introduction

Result objects are returned as items. Requires an EntraID module.

The valve can either execute once per current item in the pipe context, or once for the whole flow. This is controlled by the execution_mode property.

The execution_mode property only controls how many Graph requests are made. Result objects are still added to the pipe context as items based on id_property. Existing context items are not replaced just because "once" is used, unless a returned result has the same item id and is merged into an existing item.

Configuration

Properties
Example

Name	Description	Default
`namespace`	Bind to EntraID module.
`user_id`	User id or UPN.
`execution_mode`	Controls how the valve iterates. `"per_item"` runs once for each current item in the pipe context. `"once"` runs a single Graph lookup for the whole flow, even if multiple items already exist.	`"per_item"`
`id_property`	Use this id property from result entries. The id value will be used as item id.	`"id"`
`filter`	Search filter.
`select`	Select properties.
`use_beta_api`	Graph API beta endpoint.	`false`

{
    "name": "EntraIDListGroupsForUser",
    "config": {
        "namespace": "X",
        "user_id": "${request.findUser.0.value.mail}",
        "execution_mode": "once",
        "id_property": "id",
        "filter": "startsWith(displayName,'LoA')",
        "select": "id,displayName"
    }
}

Use "execution_mode": "per_item" when user_id is based on ${item...} and you want one Graph lookup per input item.

Use "execution_mode": "once" when user_id comes from request data, globals, or another non-item source, and you want exactly one Graph lookup for the valve.