Criar configurações

Namespace: microsoft.graph

Crie uma nova configuração de grupo com base nos modelos disponíveis em groupSettingTemplates. Essas configurações podem estar no nível do locatário ou no nível do grupo.

Os seguintes modelos de configuração de grupo estão disponíveis para grupos:

  • Group.Unified: defina as configurações para todos ou para grupos específicos do Microsoft 365.
  • Group.Unified.Guest: defina as configurações de acesso de convidado para um grupo específico do Microsoft 365.
  • Group.Security: defina configurações para todos ou grupos de segurança de nuvem específicos, como habilitar rótulos de confidencialidade MIP. Requer uma licença P1 do Microsoft Entra ID.
  • Group.Security.Policies: defina as configurações para um grupo de segurança de nuvem específico. Requer uma licença P1 do Microsoft Entra ID.

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Criar configurações para todo o locatário

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) GroupSettings.ReadWrite.All Directory.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application GroupSettings.ReadWrite.All Directory.ReadWrite.All

Importante

Para acesso delegado usando contas corporativas ou de estudante, o usuário conectado deve receber uma função do Microsoft Entra com suporte ou uma função personalizada que conceda as permissões necessárias para esta operação. Esta operação dá suporte às seguintes funções internas, que fornecem apenas o menor privilégio necessário:

  • Ler propriedades básicas sobre como definir modelos e configurações - Microsoft Entra Joined Device Administrador Local, Leitores de Diretório, Leitor Global
  • Gerenciar todas as configurações de grupo/diretório - Gravadores de Diretório
  • Gerenciar configurações globais e locais para grupos; gerenciar Group.Unified.Guest e Group.Unified configurações - Administrador de Grupos
  • Atualizar Password Rule Settings - Administrador da Política de Autenticação
  • Atualizar configurações, ler propriedades básicas sobre definição de modelos e configurações - Administrador de usuários

Quando um aplicativo recebe permissões delegadas Directory.Read.All ou Directory.ReadWrite.All , o usuário conectado só precisa da função de membro padrão. Nenhuma função adicional do Microsoft Entra é necessária. As funções do Microsoft Entra listadas acima são necessárias somente quando o aplicativo de chamada recebe uma permissão delegada mais limitada, como GroupSettings.Read.All. Nesse caso, o usuário conectado deve ter uma das funções listadas.

Criar configurações específicas do grupo

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) GroupSettings.ReadWrite.All Directory.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application GroupSettings.ReadWrite.All Directory.ReadWrite.All

Solicitação HTTP

Crie uma configuração para todo o locatário.

POST /groupSettings

Crie uma configuração específica para o grupo.

POST /groups/{id}/settings

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json

Corpo da solicitação

No corpo da solicitação, forneça uma representação JSON do objeto groupSetting. O nome de exibição, templateId e a descrição são herdados do objeto groupSettingTemplates referenciado. Somente a propriedade value pode ser alterada do valor padrão.

As propriedades a seguir são necessárias ao criar o objeto groupSetting .

Parâmetro Tipo Descrição
templateId Cadeia de caracteres Identificador exclusivo do objeto groupSettingTemplates de nível de locatário usado para criar esse objeto de configurações de nível de grupo. Somente leitura.
values Coleção settingValue Coleção de pares nome-valor correspondentes às propriedades name e defaultValue no objeto groupSettingTemplates referenciado.

Resposta

Se bem-sucedido, este método retorna o código de resposta 201 Created e um objeto groupSetting no corpo da resposta.

Exemplos

Exemplo 1: Criar uma nova configuração para todos os grupos do Microsoft 365 no locatário

Solicitação

Somente o objeto groupSettingTemplates nomeado Group.Unified pode ser aplicado a todos os grupos do Microsoft 365 no nível do locatário.

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]"
        }
    ]
}

Resposta

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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]"
        }
    ]
}

A propriedade displayName e outros pares nome-valor serão preenchidos com os valores padrão do objeto groupSettingTemplates que corresponde ao templateId.

Exemplo 2: Criar uma configuração para bloquear convidados para um grupo específico do Microsoft 365

Solicitação

Somente o objeto groupSettingTemplates nomeado Group.Unified.Guest pode ser aplicado a grupos específicos do Microsoft 365.

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"
        }
    ]
}

No corpo da solicitação, forneça uma representação JSON do objeto groupSetting.

Resposta

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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"
        }
    ]
}

Exemplo 3: Habilitar rótulos de confidencialidade para todos os grupos de segurança de nuvem no locatário

Somente o objeto groupSettingTemplates nomeado Group.Security pode ser aplicado a todos os grupos de segurança de nuvem no nível do locatário.

Observação

Esse recurso requer uma licença do Microsoft Entra ID P1.

Solicitação

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

{
    "templateId": "d209f6fa-3839-4d70-b83f-60b1c64d0e8f",
    "values": [
        {
            "name": "EnableMIPLabels",
            "value": "true"
        }
    ]
}

Resposta

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groupSettings/$entity",
    "id": "3e4a9b9d-1234-5678-abcd-1234567890ab",
    "displayName": null,
    "templateId": "d209f6fa-3839-4d70-b83f-60b1c64d0e8f",
    "values": [
        {
            "name": "EnableMIPLabels",
            "value": "true"
        }
    ]
}

Exemplo 4: bloquear convidados para um grupo de segurança de nuvem específico

Somente o objeto groupSettingTemplates nomeado Group.Security.Policies pode ser aplicado a grupos de segurança de nuvem específicos.

Observação

Esse recurso requer uma licença do Microsoft Entra ID P1.

Solicitação

POST https://graph.microsoft.com/v1.0/groups/{securityGroupId}/settings
Content-type: application/json

{
    "templateId": "7e0abea2-5c20-405f-9658-bfc9a523fd49",
    "values": [
        {
            "name": "AllowToAddGuests",
            "value": "false"
        }
    ]
}

Resposta

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groupSettings/$entity",
    "id": "fa6df613-abcd-1234-add2-1234567890ab",
    "displayName": null,
    "templateId": "7e0abea2-5c20-405f-9658-bfc9a523fd49",
    "values": [
        {
            "name": "AllowToAddGuests",
            "value": "false"
        }
    ]
}