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

Retrieve a list of group objects. An item is created for each group. 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": "EntraIDListGroups",
  "config": {
    "filter": "startsWith(displayName,'Dev')",
    "select": "createdDateTime,displayName,mail,id,proxyAddresses",
    "id_property": "id",
    "min": 1,
    "max": 2
  }
}