Créer un groupe externe

Article
10/28/2023

Espace de noms : microsoft.graph.externalConnectors

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Créez un objet externalGroup .

Cette API est disponible dans les déploiements de cloud national suivants.

Service global	Gouvernement des États-Unis L4	Us Government L5 (DOD)	Chine gérée par 21Vianet
✅	✅	✅	❌

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation	Autorisations avec privilèges minimum	Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire)	ExternalItem.ReadWrite.OwnedBy	ExternalItem.ReadWrite.All
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	ExternalItem.ReadWrite.OwnedBy	ExternalItem.ReadWrite.All

Requête HTTP

POST /external/connections/{connectionId}/groups

En-têtes de demande

Nom	Description
Autorisation	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type	application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON de l’objet externalGroup .

Vous pouvez spécifier les propriétés suivantes lorsque vous créez un externalGroup.

Propriété	Type	Description
description	Chaîne	Description du groupe externe. Optional.
displayName	Chaîne	Nom convivial du groupe externe. Optional.
id	Chaîne	ID unique du groupe externe au sein d’une connexion. Il doit être alphanumérique et contenir jusqu’à 128 caractères.

Réponse

Si elle réussit, cette méthode renvoie un 201 Created code de réponse et un objet externalGroup dans le corps de la réponse.

Exemples

Demande

L’exemple suivant illustre une demande.

POST https://graph.microsoft.com/beta/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.Beta.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);

Importante

Microsoft Graph SDK utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le SDK, consultez Utiliser les kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta external connections groups create --external-connection-id {externalConnection-id} --body '{\
  "id": "31bea3d537902000",\
  "displayName": "Contoso Marketing",\
  "description": "The product marketing team"\
}\
'

Importante



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodelsexternalconnectors "github.com/microsoftgraph/msgraph-beta-sdk-go/models/externalconnectors"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodelsexternalconnectors.NewExternalGroup()
id := "31bea3d537902000"
requestBody.SetId(&id) 
displayName := "Contoso Marketing"
requestBody.SetDisplayName(&displayName) 
description := "The product marketing team"
requestBody.SetDescription(&description) 

groups, err := graphClient.External().Connections().ByExternalConnectionId("externalConnection-id").Groups().Post(context.Background(), requestBody, nil)

Importante


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.beta.models.externalconnectors.ExternalGroup externalGroup = new com.microsoft.graph.beta.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);

Importante


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')
	.version('beta')
	.post(externalGroup);

Importante


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\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();

Importante


Import-Module Microsoft.Graph.Beta.Search

$params = @{
	id = "31bea3d537902000"
	displayName = "Contoso Marketing"
	description = "The product marketing team"
}

New-MgBetaExternalConnectionGroup -ExternalConnectionId $externalConnectionId -BodyParameter $params

Importante


from msgraph import GraphServiceClient
from msgraph.generated.models.external_group import ExternalGroup

graph_client = GraphServiceClient(credentials, scopes)

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)

Importante

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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

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

Créer un groupe externe

Autorisations

Requête HTTP

En-têtes de demande

Corps de la demande

Réponse

Exemples

Demande

Réponse

Commentaires

Commentaires

Ressources supplémentaires