MS Entra – Groups – Add Group Member

Add a member to a group in Entra ID.

Action details

Property	Value
Action label	MS Entra – Groups – Add Group Member
Category	CloudTools
Apex class and method	AddEntraGroupMember.addGroupMember
Input type	AddEntraGroupMember.AddEntraGroupMemberInput
Output type	List<AddEntraGroupMember.AddEntraGroupMemberOutput>
Authorization	Microsoft 365 connector; supported authorization depends on the endpoint and target.
Microsoft Graph request	POST /groups/{groupId}/members/$ref

Prerequisites and permissions

Configure a CloudTools Connector with Connector Type set to Microsoft 365. Complete sign-in for OAuth Delegated (Authorization Code). For supported OAuth Application (Client Credentials) requests, grant application permissions and administrator consent. The identity must have access to the selected resource; directory operations can also require Microsoft Entra roles. Use Creating an Entra ID App and Integration Connectors for setup.

The action permission provider declares these alternatives. They are not cumulative requirements or universally interchangeable; check the Microsoft reference for endpoint, target, and property restrictions.

Permission type	Declared alternatives
Delegated	GroupMember.ReadWrite.All
Application	GroupMember.ReadWrite.All

Endpoints: /groups/{groupId}/members/$ref. GroupMember.ReadWrite.All covers user/group membership. Other directory object types need additional object-specific permissions. Role-assignable groups additionally require RoleManagement.ReadWrite.Directory and a supported administrator role; delegated callers need a supported role or group ownership.

See the Microsoft operation and permissions reference.

Inputs

Input	Apex field	Type	Required	Description
Group Id	groupId	String	Yes	Group identifier
User ID	memberUserPrincipalName	String	Yes	User principal name (UPN) or object ID of the member to add

Supply a nonempty list with a non-null first request. Graph actions process only that first request. Global inputs do not expose connectorId; subscriber Apex and Flow use CloudTools connector selection. Use Microsoft Graph resource IDs or the specifically documented user identifier, and resolve dynamic values before invocation.

Outputs

Returns one operation result after the call returns. Inspect success and message; an accepted or started operation may still require completion checks. Exceptions are generally thrown for failures rather than returned as success=false.

Output	Apex field	Type	Description
Success	success	Boolean	Whether the add succeeded
Message	message	String	Result message

Use in Flow

Use MS Entra – Groups – Add Group Member where supported. Use a Microsoft 365 application connector configured as Set as default for Flow automations only if the endpoint and target support application access. Supply required values, retain useful outputs, and add fault handling. Delegated connections are not supported for CloudTools Flow automation. The action processes only the first input request.

Use in custom Apex

This subscriber-org example uses the Apptigent namespace. Replace identifiers and example values before use. Configure the connector, complete authorization first, run in a context permitting callouts, and handle exceptions, empty results, and unmapped fields.

Apptigent.AddEntraGroupMember.AddEntraGroupMemberInput request =
    new Apptigent.AddEntraGroupMember.AddEntraGroupMemberInput();
request.groupId = 'f11f1340-30b1-4f1d-91ec-c853b7245646';
request.memberUserPrincipalName = 'adele.vance@example.com';



List<Apptigent.AddEntraGroupMember.AddEntraGroupMemberOutput> results =
    Apptigent.AddEntraGroupMember.addGroupMember(
        new List<Apptigent.AddEntraGroupMember.AddEntraGroupMemberInput>{ request }
    );
System.debug(results);

Use in a Lightning Web Component

Use addEntraGroupMember from msEntraConnectorLib through MSEntraConnectorController. These c/ imports apply in the same namespace. Set request.connectorId for direct MSEntraAction calls. The controller captures the request selection for MSEntraAction.

Global input	LWC request mapping
groupId	request.groupId
memberUserPrincipalName	request.userId

entraActionExample.js

import { LightningElement } from 'lwc';
import { addEntraGroupMember } from 'c/msEntraConnectorLib';

export default class EntraActionExample extends LightningElement {
    result = null;
    errorMessage = '';
    isRunning = false;
    completed = false;

    async handleRun() {
        if (this.isRunning || this.completed) return;
        this.isRunning = true;
        this.errorMessage = '';
        try {
            const request = { connectorId: 'REPLACE_WITH_CONNECTOR_RECORD_ID' };
            request.groupId = 'f11f1340-30b1-4f1d-91ec-c853b7245646';
            request.userId = 'adele.vance@example.com';
            this.result = await addEntraGroupMember(request);
            this.completed = true;
        } catch (error) {
            this.errorMessage = error.requiresInteractiveAuthorization
                ? 'Sign in to Microsoft for the connector, then try again.'
                : error.message || 'The Entra action failed.';
        } finally {
            this.isRunning = false;
        }
    }
}

entraActionExample.html

<template>
    <lightning-button label="Run action" onclick={handleRun}
        disabled={isRunning}></lightning-button>
    <p role="alert">{errorMessage}</p>
</template>

The library returns one mapped DTO or null. The controller can flatten nested fields, serialize data, or map an action result into an operation DTO. rawJson contains serialized mapped Apex data rather than the untouched Graph response.

Use getMSEntraAuthorizationState, beginMSEntraAuthorization, and createMSEntraOAuthMessageHandler to arrange delegated sign-in. The library normalizes errors but does not automatically sign in or retry. Reset completed for a new deliberate operation, and inspect resource state before retrying a mutation with an uncertain outcome.

Error handling and troubleshooting

Symptom	What to check
Required fields error	Supply a nonempty request list and required or conditionally required inputs. For LWC, use the mapped field names.
Authorization or access denied	Check connector selection, sign-in, endpoint/target permission support, administrator consent, directory roles, and resource access.
Resource not found	Check Microsoft IDs and parent resource relationships. Preserve group/drive/item associations and mailbox/calendar/event IDs.
Missing or unexpected output	Check query support, pagination, wrapper versus item models, public-only properties, and mapped DTO fields.
Operation rejected	Inspect the Microsoft error, supported writable fields, group/calendar restrictions, recipient/license data, and file transfer limits.

See Entra connector introduction.