Ajouter des membres

Espace de noms : microsoft.graph

Ajouter un membre à un groupe de sécurité ou Microsoft 365. Lorsque vous utilisez l’API pour ajouter plusieurs membres dans une même requête, vous ne pouvez ajouter que 20 membres.

Le tableau suivant présente les types de membres qui peuvent être ajoutés à des groupes de sécurité ou à des groupes Microsoft 365.

Type d’objet Membre du groupe de sécurité Membre du groupe Microsoft 365
Utilisateur Peut être membre du groupe Peut être membre du groupe
Groupe de sécurité Peut être membre du groupe Ne peut pas être membre du groupe
Groupe Microsoft 365 Ne peut pas être membre du groupe Ne peut pas être membre du groupe
Appareil Peut être membre du groupe Ne peut pas être membre du groupe
Principal de service Peut être membre du groupe Ne peut pas être membre du groupe
Contact de l’organisation Peut être membre du groupe Ne peut pas être membre du groupe

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

Le tableau suivant montre l’autorisation la moins privilégiée requise par chaque type de ressource lors de l’appel de cette API. Pour plus d’informations, notamment sur la façon de choisir les autorisations, voir Autorisations.

Ressource prise en charge Déléguée (compte professionnel ou scolaire) Déléguée (compte Microsoft personnel) Application
appareil GroupMember.ReadWrite.All et Device.ReadWrite.All Non prise en charge. GroupMember.ReadWrite.All et Device.ReadWrite.All
groupe GroupMember.ReadWrite.All Non prise en charge. GroupMember.ReadWrite.All
orgContact GroupMember.ReadWrite.All et OrgContact.Read.All Non prise en charge. GroupMember.ReadWrite.All et OrgContact.Read.All
servicePrincipal GroupMember.ReadWrite.All et Application.ReadWrite.All Non prise en charge. GroupMember.ReadWrite.All et Application.ReadWrite.All
user GroupMember.ReadWrite.All Non prise en charge. GroupMember.ReadWrite.All

Dans les scénarios délégués, l’utilisateur connecté doit également se voir attribuer un rôle Microsoft Entra pris en charge ou un rôle personnalisé avec l’autorisation de microsoft.directory/groups/members/update rôle. Les rôles les moins privilégiés suivants sont pris en charge pour cette opération, à l’exception des groupes assignables à un rôle :

  • Propriétaires de groupe
  • Rédacteurs d'annuaires
  • Administrateur de groupes
  • Administrateur de gouvernance des identités
  • Administrateur d’utilisateurs
  • Administrateur Exchange : uniquement pour les groupes Microsoft 365
  • Administrateur SharePoint : uniquement pour les groupes Microsoft 365
  • Administrateur Teams - uniquement pour les groupes Microsoft 365
  • Administrateur Yammer : uniquement pour les groupes Microsoft 365
  • Administrateur Intune : uniquement pour les groupes de sécurité

Pour ajouter des membres à un groupe assignable à un rôle, l’application doit également recevoir l’autorisation RoleManagement.ReadWrite.Directory et l’utilisateur appelant doit se voir attribuer un rôle Microsoft Entra pris en charge. Administrateur de rôle privilégié est le rôle le moins privilégié pris en charge pour cette opération.

Requête HTTP

POST /groups/{group-id}/members/$ref
POST /groups/{group-id}/members/

En-têtes de demande

En-tête Valeur
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-type application/json. Obligatoire.

Corps de la demande

Lorsque vous utilisez la /groups/{group-id}/members/$ref syntaxe , fournissez un objet JSON qui contient une propriété @odata.id avec une référence par ID à un type d’objet membre de groupe pris en charge.

Lorsque vous utilisez la /groups/{group-id}/members syntaxe , fournissez un objet JSON qui contient une propriété avec une members@odata.bind ou plusieurs références par ID à un type d’objet membre de groupe pris en charge.

Si vous utilisez la référence directoryObjects , autrement dit , https://graph.microsoft.com/v1.0/directoryObjects/{id}le type d’objet doit toujours être un type d’objet membre de groupe pris en charge.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 204 No Content. Elle retourne un 400 Bad Request code de réponse lorsque l’objet est déjà membre du groupe ou n’est pas pris en charge en tant que membre du groupe. Elle retourne un 404 Not Found code de réponse lorsque l’objet ajouté n’existe pas.

Exemples

Exemple 1: Ajouter un membre à un groupe

Demande

L’exemple suivant montre une requête qui utilise la référence directoryObjects pour ajouter un membre à un groupe.

POST https://graph.microsoft.com/v1.0/groups/{group-id}/members/$ref
Content-type: application/json

{
  "@odata.id": "https://graph.microsoft.com/v1.0/directoryObjects/{id}"
}

Dans le corps de la demande, fournissez une représentation JSON de l’id de l’objet du directoryObject, de l’utilisateur ou du groupe que vous souhaitez ajouter.

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 204 No Content

Exemple 2 : Ajouter plusieurs membres à un groupe dans une seule demande

Cet exemple montre comment ajouter plusieurs membres à un groupe avec le support de la liaison OData dans une opération de correctif. Jusqu’à 20 membres peuvent être ajoutés dans une seule requête. L’opération POST n’est pas prise en charge. Si une condition d’erreur existe dans le corps de la demande, nous n’ajouterons aucun membre et renverrons le code de réponse approprié.

Demande

L’exemple suivant illustre une demande.

PATCH https://graph.microsoft.com/v1.0/groups/{group-id}
Content-type: application/json

{
  "members@odata.bind": [
    "https://graph.microsoft.com/v1.0/directoryObjects/{id}",
    "https://graph.microsoft.com/v1.0/directoryObjects/{id}",
    "https://graph.microsoft.com/v1.0/directoryObjects/{id}"
    ]
}

Dans le corps de la demande, fournissez une représentation JSON de l’id de l’objet du directoryObject, de l’utilisateur ou du groupe que vous souhaitez ajouter.

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 204 No Content