Properties

Find an Entra ID group based on search data

The configuration is divided in two blocks, config & ui where each block has its own tab below.

See the Example tabs for a full examples.

Control type: EntraGroupSelect

Config properties

Name	Desciption	Default value	Mandatory
namespace	Identifier of EntraID module to use	"default"
columns	List array with columns to display	["displayName","description"]
search_attributes	List array with columns used for searching. Search is done using "starts with".	["displayName","mail"]
owned_groups_only_attribute	If set, groups will filtered based on the attribute.	N/A

UI properties

Name	Desciption	Default value	Mandatory
ui:search	Should search input be visible for end user, true/false	true
ui:submit_on_change	Should selection of an item move to next step. true/false	false

Example 1

In this scenario the grid will contain two columns. The query will also be executed before grid is displayed. This is what "ui:search": false will do, if you add true the grid will let you add Bob* before search is executed.

{
    "id": "<enter_unique_id_for_this_control>",
    "type": "EntraGroupSelect",
    "config": {
        "namespace": "tenant1",
        "columns": [
            "displayName",
            "description"
        ]
    },
    "ui": {
        "ui:search": false,
        "ui:submit_on_change": true
    }
}

Example 2

In addition to example 1 this grid will also contain the owners of the groups returned.

{
    "id": "<enter_unique_id_for_this_control>",
    "type": "EntraGroupSelect",
    "config": {
        "namespace": "tenant1",
        "owned_groups_only_attribute": "owners",
        "columns": [
            "displayName",
            "description",
            "owners"
        ]
    },
    "ui": {
        "ui:size": {
            "md": 12
        },
        "ui:submit_on_change": true,
        "ui:search": false
    }
}

This control works in conjunction with EntraID module. It must be installed.

Only showing groups by end user

Set owned_groups_only_attribute will cause control match the data from owned_groups_only_attribute. Matching is done using data from owned_groups_only_attribute and entra_identifier.

entra_identifier is read from session or flow. Session read first then flow.

Settings "owned_groups_only_attribute":"owner", will match value from entra_identifier with id in "owner". Only showing groups where user is set to owner.

Exposed data to flow

"selected_entra_id" - id of selected group

"selected_entra_displayName" - display name of selected group.