View as Markdown
Microsoft Entra ID icon

Microsoft Entra ID ACTION

Update Group

Updates an existing group in Microsoft Entra ID. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Microsoft Entra ID account once, then configure and run Update Group from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "microsoft_entra_id-update-group",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    microsoft_entra_id: { authProvisionId: "apn_xxxxxxx" },
    groupId: "Group",
    allowExternalSenders: true,
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Update Group inputs
Property Type Description
groupId Group string
Identifier of a group
Required Dynamic
allowExternalSenders Allow External Senders boolean
Indicates whether people external to the organization can send messages to the group
Optional
autoSubscribeNewMembers Auto Subscribe New Members boolean
Indicates whether new members added to the group will be auto-subscribed to receive email notifications
Optional
description Description string
An optional description for the group
Optional
displayName Display Name string
The name to display in the address book for the group
Optional
mailNickname Mail Nickname string
The mail alias for the group, unique for groups in the organization. Maximum length is 64 characters. This property can contain only characters in the ASCII character set 0 - 127 except the following characters: @ () \ [] " ; : <> , SPACE.
Optional
securityEnabled Security Enabled boolean
Set to true for security-enabled groups
Optional
visibility Visibility string
Specifies the visibility of the group
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
microsoft_entra_id-update-group
Version
0.0.1
App
Microsoft Entra ID
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes