Create externalGroup

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.

Create a new externalGroup object.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) ExternalItem.ReadWrite.OwnedBy ExternalItem.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application ExternalItem.ReadWrite.OwnedBy ExternalItem.ReadWrite.All

HTTP request

POST /external/connections/{connectionId}/groups

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of the externalGroup object.

You can specify the following properties when you create an externalGroup.

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.

Response

If successful, this method returns a 201 Created response code and an externalGroup object in the response body.

Examples

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/external/connections/contosohr/groups
Content-Type: application/json

{
  "id": "31bea3d537902000",
  "displayName": "Contoso Marketing",
  "description": "The product marketing team"
}

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "id": "31bea3d537902000",
  "displayName": "Contoso Marketing",
  "description": "The product marketing team"
}