Créer des paramètres

Espace de noms: microsoft.graph

Créez un paramètre basé sur les modèles disponibles dans groupSettingTemplates. Ces paramètres peuvent être au niveau du locataire ou au niveau du groupe.

Les paramètres de groupe s’appliquent uniquement aux groupes Microsoft 365. Le modèle nommé Group.Unified peut être utilisé pour configurer les paramètres de groupe Microsoft 365 à l’échelle du locataire, tandis que le modèle nommé Group.Unified.Guest peut être utilisé pour configurer des paramètres spécifiques au 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

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

Pour les scénarios délégués, l’utilisateur appelant a besoin d’au moins l’un des rôles Microsoft Entra suivants.

Microsoft Entra rôle Privilèges autorisés
Microsoft Entra Administrateur local de l’appareil joint
Lecteurs d’annuaire
Lecteur général
Lire les propriétés de base sur la définition des modèles et des paramètres
Administrateur de groupes
Rédacteurs d'annuaires
Gérer tous les paramètres de groupe
Administrateur de stratégie d’authentification Mettre à jour Password Rule Settings
Administrateur d’utilisateurs Lire les propriétés de base sur la définition des modèles et des paramètres
Définir les paramètres de mise à jour

Requête HTTP

Créez un paramètre à l’échelle du locataire.

POST /groupSettings

Créez un paramètre spécifique au groupe.

POST /groups/{id}/settings

En-têtes de demande

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

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON de l’objet groupSetting. Le nom d’affichage, le templateId et la description sont hérités de l’objet groupSettingTemplates référencé. Seule la propriété value peut être modifiée à partir de la valeur par défaut.

Les propriétés suivantes sont requises lors de la création de l’objet groupSetting .

Paramètre Type Description
templateId Chaîne Identificateur unique de l’objet groupSettingTemplates au niveau du locataire utilisé pour créer cet objet de paramètres au niveau du groupe. En lecture seule.
values collection settingValue Collection de paires nom-valeur correspondant aux propriétés name et defaultValue dans l’objet groupSettingTemplates référencé.

Réponse

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

Exemple 1 : Créer un paramètre pour tous les groupes Microsoft 365 dans le locataire

Demande

Seul l’objet groupSettingTemplates nommé Group.Unified peut être appliqué à tous les groupes Microsoft 365 au niveau du locataire.

POST https://graph.microsoft.com/v1.0/groupSettings
Content-type: application/json

{
    "templateId": "62375ab9-6b52-47ed-826b-58e47e0e304b",
    "values": [
        {
            "name": "GuestUsageGuidelinesUrl",
            "value": "https://privacy.contoso.com/privacystatement"
        },
        {
            "name": "EnableMSStandardBlockedWords",
            "value": "true"
        },
        {
            "name": "EnableMIPLabels",
            "value": "true"
        },
        {
            "name": "PrefixSuffixNamingRequirement",
            "value": "[Contoso-][GroupName]"
        }
    ]
}

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groupSettings/$entity",
    "id": "844d252c-4de2-43eb-a784-96df77231aae",
    "displayName": null,
    "templateId": "62375ab9-6b52-47ed-826b-58e47e0e304b",
    "values": [
        {
            "name": "GuestUsageGuidelinesUrl",
            "value": "https://privacy.contoso.com/privacystatement"
        },
        {
            "name": "EnableMSStandardBlockedWords",
            "value": "true"
        },
        {
            "name": "EnableMIPLabels",
            "value": "true"
        },
        {
            "name": "PrefixSuffixNamingRequirement",
            "value": "[Contoso-][GroupName]"
        }
    ]
}

La propriété displayName et les autres paires nom-valeur seront remplies avec les valeurs par défaut de l’objet groupSettingTemplates qui correspond à templateId.

Exemple 2 : Créer un paramètre pour bloquer les invités d’un groupe Microsoft 365 spécifique

Demande

Seul l’objet groupSettingTemplates nommé Group.Unified.Guest peut être appliqué à des groupes Microsoft 365 spécifiques.

POST https://graph.microsoft.com/v1.0/groups/055a5d18-a3a9-4338-b9c5-de92559b7ebf/settings
Content-type: application/json

{
    "templateId": "08d542b9-071f-4e16-94b0-74abb372e3d9",
    "values": [
        {
            "name": "AllowToAddGuests",
            "value": "false"
        }
    ]
}

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

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groupSettings/$entity",
    "id": "a06fa228-3042-4662-bd09-33e298da1afe",
    "displayName": null,
    "templateId": "08d542b9-071f-4e16-94b0-74abb372e3d9",
    "values": [
        {
            "name": "AllowToAddGuests",
            "value": "false"
        }
    ]
}