Obtenir un groupe

  • Article

Espace de noms: microsoft.graph

Récupérer les propriétés et les relations d’un objet groupe.

Cette opération renvoie par défaut uniquement un sous-ensemble de toutes les propriétés disponibles, comme indiqué dans la section Propriétés. Pour obtenir des propriétés qui ne sont t_ retournées par défaut, spécifiez-les dans une $select option de requête OData. Les propriétés hasMembersWithLicenseErrors et isArchived sont une exception et ne sont pas retournées dans la $select requête.

Remarque : Cette demande peut avoir des retards de réplication pour les groupes qui ont été récemment créés, mis à jour ou supprimés.

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) GroupMember.Read.All Group.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Group.Read.All
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application GroupMember.Read.All Group.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Group.Read.All

Requête HTTP

GET /groups/{id}

Paramètres facultatifs de la requête

Vous pouvez utiliser $select pour obtenir des propriétés de groupe spécifiques, y compris celles qui ne sont pas retournées par défaut. Les propriétés d’extension prennent également en charge les paramètres de requête comme suit :

Type d’extension Commentaires
Extensions de schéma Retourné uniquement avec $select.
Extensions d’ouverture Retourné par le biais de l’opération d’extension ouverte Get.
Extensions de répertoire Renvoyé par défaut.

Pour plus d’informations sur les options de requête OData, consultez la rubrique relative aux paramètres de requête OData.

En-têtes de demande

Nom Type Description
Autorisation string Porteur {token}. Obligatoire.

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 200 OK et un objet Group dans le corps de la réponse. Elle renvoie les propriétés par défaut, sauf si vous utilisez $select pour spécifier des propriétés spécifiques.

Exemple

Exemple 1 : Renvoyer toutes les propriétés par défaut

Renvoyer toutes les propriétés par défaut.

Demande

Voici un exemple de requête GET.

GET https://graph.microsoft.com/v1.0/groups/02bd9fd6-8f93-4758-87c3-1fb73740a315

Réponse

L’exemple suivant illustre la réponse. Il inclut uniquement les propriétés par défaut.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité. Toutes les propriétés par défaut sont renvoyées dans un appel réel.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groups/$entity",
    "id": "02bd9fd6-8f93-4758-87c3-1fb73740a315",
    "deletedDateTime": null,
    "classification": null,
    "createdDateTime": "2017-07-31T18:56:16Z",
    "description": "Welcome to the HR Taskforce team.",
    "displayName": "HR Taskforce",
    "expirationDateTime": null,
    "groupTypes": [
        "Unified"
    ],
    "isAssignableToRole": null,
    "mail": "HRTaskforce@contoso.com",
    "mailEnabled": true,
    "mailNickname": "HRTaskforce",
    "membershipRule": null,
    "membershipRuleProcessingState": null,
    "onPremisesDomainName": null,
    "onPremisesLastSyncDateTime": null,
    "onPremisesNetBiosName": null,
    "onPremisesSamAccountName": null,
    "onPremisesSecurityIdentifier": null,
    "onPremisesSyncEnabled": null,
    "preferredDataLocation": null,
    "preferredLanguage": null,
    "proxyAddresses": [
        "SMTP:HRTaskforce@contoso.com",
        "SPO:SPO_896cf652-b200-4b74-8111-c013f64406cf@SPO_dcd219dd-bc68-4b9b-bf0b-4a33a796be35"
    ],
    "renewedDateTime": "2020-01-24T19:01:14Z",
    "resourceBehaviorOptions": [],
    "resourceProvisioningOptions": [
        "Team"
    ],
    "securityEnabled": false,
    "securityIdentifier": "S-1-12-1-45981654-1196986259-3072312199-363020343",
    "serviceProvisioningErrors": [],
    "theme": null,
    "visibility": "Private",
    "onPremisesProvisioningErrors": []
}

Exemple 2 : Retourner d’autres propriétés à l’aide de $select

Retournez d’autres propriétés à l’aide de $select.

Demande

Voici un exemple de requête GET.

GET https://graph.microsoft.com/v1.0/groups/02bd9fd6-8f93-4758-87c3-1fb73740a315?$select=allowExternalSenders,autoSubscribeNewMembers,isSubscribedByMail,unseenCount

Réponse

Voici un exemple de réponse qui inclut les propriétés non par défaut demandées.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groups(allowExternalSenders,autoSubscribeNewMembers,isSubscribedByMail,unseenCount)/$entity",
    "id": "02bd9fd6-8f93-4758-87c3-1fb73740a315",
    "allowExternalSenders": false,
    "autoSubscribeNewMembers": false,
    "isSubscribedByMail": false,
    "unseenCount": 3
}