Edit

Share via

externalGroup resource type

  • Article

Namespace: microsoft.graph.externalConnectors

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

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.
Delete externalGroup None Delete an externalGroup object.
Create member microsoft.graph.externalConnectors.externalGroupMember Create a new externalGroupMember object.

Properties

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

Relationships

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

JSON representation

The following JSON representation shows the resource type.

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