externalGroup resource type

Namespace: microsoft.graph.externalConnectors

Represents a non-Microsoft Entra group.

External groups determine permissions to the content in your external data source. These external groups can be used in entries on the acl of an externalItem.

Examples of external groups are business units and work teams.

Methods

Method Return type Description
Create externalGroup microsoft.graph.externalConnectors.externalGroup Create a new externalGroup object.
Get externalGroup microsoft.graph.externalConnectors.externalGroup Get an externalGroup object.
Update externalGroup microsoft.graph.externalConnectors.externalGroup Update the properties of an externalGroup object.
Delete externalGroup None Delete an externalGroup object.

Properties

Property Type Description
description String The description of the external group. Optional.
displayName String The friendly name of the external group. Optional.
id String The unique ID of the external group within a connection. It must be alphanumeric and can be up to 128 characters long.

Relationships

Relationship Type Description
members microsoft.graph.externalConnectors.identity collection A member added to an externalGroup. You can add Microsoft Entra users, Microsoft Entra groups, or an externalGroup as members.

JSON representation

The following is a JSON representation of the resource.

{
  "description": "String",
  "displayName": "String",
  "id": "String (identifier)"
}