Namespace: microsoft.graph.externalConnectors
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/{connectionsId}/groups
Request body
In the request body, supply a JSON representation of the externalGroup object.
You can specify the following properties when creating an externalGroup.
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. Required. |
displayName |
String |
The friendly name of the external group. Optional. |
description |
String |
The description of the external group. Optional. |
Response
If successful, this method returns a 201 Created
response code and an externalGroup object in the response body.
Example
Request
POST https://graph.microsoft.com/v1.0/external/connections/contosohr/groups
Content-Type: application/json
{
"id": "31bea3d537902000",
"displayName": "Contoso Marketing",
"description": "The product marketing team"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models.ExternalConnectors;
var requestBody = new ExternalGroup
{
Id = "31bea3d537902000",
DisplayName = "Contoso Marketing",
Description = "The product marketing team",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.External.Connections["{externalConnection-id}"].Groups.PostAsync(requestBody);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
mgc external connections groups create --external-connection-id {externalConnection-id} --body '{\
"id": "31bea3d537902000",\
"displayName": "Contoso Marketing",\
"description": "The product marketing team"\
}\
'
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphmodelsexternalconnectors "github.com/microsoftgraph/msgraph-sdk-go/models/externalconnectors"
//other-imports
)
requestBody := graphmodelsexternalconnectors.NewExternalGroup()
id := "31bea3d537902000"
requestBody.SetId(&id)
displayName := "Contoso Marketing"
requestBody.SetDisplayName(&displayName)
description := "The product marketing team"
requestBody.SetDescription(&description)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
groups, err := graphClient.External().Connections().ByExternalConnectionId("externalConnection-id").Groups().Post(context.Background(), requestBody, nil)
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.models.externalconnectors.ExternalGroup externalGroup = new com.microsoft.graph.models.externalconnectors.ExternalGroup();
externalGroup.setId("31bea3d537902000");
externalGroup.setDisplayName("Contoso Marketing");
externalGroup.setDescription("The product marketing team");
com.microsoft.graph.models.externalconnectors.ExternalGroup result = graphClient.external().connections().byExternalConnectionId("{externalConnection-id}").groups().post(externalGroup);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
const options = {
authProvider,
};
const client = Client.init(options);
const externalGroup = {
id: '31bea3d537902000',
displayName: 'Contoso Marketing',
description: 'The product marketing team'
};
await client.api('/external/connections/contosohr/groups')
.post(externalGroup);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\ExternalConnectors\ExternalGroup;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new ExternalGroup();
$requestBody->setId('31bea3d537902000');
$requestBody->setDisplayName('Contoso Marketing');
$requestBody->setDescription('The product marketing team');
$result = $graphServiceClient->external()->connections()->byExternalConnectionId('externalConnection-id')->groups()->post($requestBody)->wait();
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
Import-Module Microsoft.Graph.Search
$params = @{
id = "31bea3d537902000"
displayName = "Contoso Marketing"
description = "The product marketing team"
}
New-MgExternalConnectionGroup -ExternalConnectionId $externalConnectionId -BodyParameter $params
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.external_connectors.external_group import ExternalGroup
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ExternalGroup(
id = "31bea3d537902000",
display_name = "Contoso Marketing",
description = "The product marketing team",
)
result = await graph_client.external.connections.by_external_connection_id('externalConnection-id').groups.post(request_body)
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
Response
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "31bea3d537902000",
"displayName": "Contoso Marketing",
"description": "The product marketing team"
}