Nota
O acesso a esta página requer autorização. Pode tentar iniciar sessão ou alterar os diretórios.
O acesso a esta página requer autorização. Pode tentar alterar os diretórios.
Namespace: microsoft.graph
Representa um grupo do Microsoft Entra, um grupo do Microsoft 365 ou um grupo de segurança. Esse recurso é um tipo aberto que permite propriedades adicionais além daquelas documentadas aqui.
Herda de directoryObject.
Por motivos de desempenho, as operações create, get e list retornam por padrão apenas um subconjunto das propriedades usadas com mais frequência. Essas propriedades padrão estão listadas na seção Propriedades. Para obter qualquer uma das propriedades não retornadas por padrão, especifique-as em uma $select opção de consulta OData.
Esse recurso permite:
- Adicionando seus dados a propriedades personalizadas como extensões.
- Assinar as notificações de alteração.
- Usar a consulta delta para controlar adições, exclusões e atualizações incrementais oferecendo uma função delta.
Métodos
| Método | Tipo de retorno | Descrição |
|---|---|---|
| List | Coleção group | Listar objetos group e suas propriedades. |
| Create | group | Criar um novo grupo. Pode ser um grupo do Microsoft 365, um grupo dinâmico ou um grupo de segurança. |
| Get | group | Ler as propriedades de um objeto group. |
| Atualizar | Nenhum | Atualizar as propriedades de um objeto group. |
| Executar upsert | group | Crie um novo grupo, caso não exista, ou atualize as propriedades de um grupo existente. |
| Delete | Nenhum | Excluir um objeto group. |
| Obter delta | Coleção group | Obter alterações incrementais para grupos. |
| Gerenciamento de grupos | ||
| Listar membros | Coleção directoryObject | Obtenha os membros diretos deste grupo a partir da propriedade de navegação membros. |
| Adicionar membros | Nenhum | Adicione um membro a esse grupo postando na propriedade de navegação de membros (com suporte apenas para grupos de segurança e grupos do Microsoft 365). |
| Remover membro | Nenhum | Remova um membro de um grupo do Microsoft 365 ou de um grupo de segurança por meio da propriedade de navegação membros. |
| Listar proprietários | Coleção directoryObject | Obter os proprietários do grupo da propriedade de navegação owners. |
| Adicionar proprietários | Nenhum | Adicione um novo proprietário para o grupo postando na propriedade de navegação dos proprietários (com suporte para grupos de segurança e grupos do Microsoft 365 apenas). |
| Remover proprietário | Nenhum | Remova um proprietário de um grupo do Microsoft 365 ou de um grupo de segurança por meio da propriedade de navegação proprietários. |
| Listar associações | Coleção directoryObject | Obtenha os grupos, funções administrativas e unidades administrativas das quais esse grupo é membro direto da propriedade de navegação memberOf. |
| Listar membros transitivos | Coleção directoryObject | Obtenha os usuários, grupos e dispositivos que são membros, incluindo membros aninhados desse grupo. |
| Listar associações transitivas | Coleção directoryObject | Lista os grupos dos quais esse grupo é membro. Essa operação é transitiva e inclui os grupos que são membros aninhados desse grupo. |
| Políticas de ciclo de vida de grupo de listas | Coleção groupLifecyclePolicy | Listar políticas de ciclo de vida de grupo. |
| Atribuir licença | group | Adicione ou remova assinaturas para o grupo. Você também pode habilitar e desabilitar planos específicos associados a uma assinatura. |
| Renovar | Booliano | Renova o período de validade de um grupo. A renovação estende a expiração do grupo pelo número de dias definido na política. |
| Validar propriedades | JSON | Valide se o nome de exibição ou apelido de email de um grupo da Microsoft 365 está em conformidade com as políticas de nomenclatura. |
| Atribuição de funções do aplicativo | ||
| List | appRoleAssignment collection | Obtenha os aplicativos e as funções de aplicativo atribuídos a este grupo. |
| Add | appRoleAssignment | Atribuir uma função do aplicativo a esse grupo. |
| Remove | Nenhum. | Remover uma atribuição de função do aplicativo desse grupo. |
| Calendar | ||
| Obter calendário | calendar | Obter o calendário do grupo. |
| Atualizar calendário | Nenhum | Atualize o calendário do grupo. |
| Listar eventos | Coleção event | Obter uma coleção de objetos de evento. |
| Criar evento | event | Criar um novo Event postando na coleção de eventos. |
| Obter evento | event | Ler as propriedades de um objeto event. |
| Atualizar evento | Nenhum | Atualizar as propriedades de um objeto event. |
| Excluir evento | Nenhum | Excluir o objeto event. |
| Listar modo de exibição de calendário | Coleção event | Obter um conjunto de eventos em uma janela de tempo especificada. |
| Conversas | ||
| Listar conversas | Coleção conversation | Obter uma coleção de objetos Conversation. |
| Criar conversa | conversa | Crie uma nova conversa postando na coleção de conversas. |
| Obter conversa | conversation | Ler as propriedades de um objeto conversation. |
| Excluir conversa | Nenhum | Excluir objeto conversation. |
| Listar threads | Coleção conversationThread | Obter todos os threads de um grupo. |
| Criar thread | conversationThread | Criar um novo thread de conversa. |
| Acessar thread | conversationThread | Ler as propriedades de um objeto thread. |
| Atualizar thread | Nenhum | Atualizar as propriedades de um objeto thread. |
| Excluir thread | Nenhum | Excluir objeto thread. |
| Listar remetentes aceitos | Coleção directoryObject | Obtenha uma lista de usuários ou grupos que estão na lista de remetentes aceitos para este grupo. |
| Adicionar remetente aceito | directoryObject | Adicionar um Usuário ou Grupo à coleção acceptSenders. |
| Remover remetente aceito | directoryObject | Remover um Usuário ou Grupo da coleção acceptedSenders. |
| Listar remetentes rejeitados | Coleção directoryObject | Obtenha uma lista de usuários ou grupos que estão na lista de remetentes rejeitados para este grupo. |
| Adicionar remetente rejeitado | directoryObject | Adicionar um novo Usuário ou Grupo à coleção rejectedSenders. |
| Remover remetente rejeitado | directoryObject | Remover um novo Usuário ou Grupo da coleção Remetentesrejeitados. |
| Objetos de diretório | ||
| Listar itens excluídos | Coleção directoryObject | Recupere os grupos excluídos no locatário nos últimos 30 dias. |
| Obter item excluído | Coleção directoryObject | Recupere um grupo excluído por ID. |
| Restaurar item excluído | Coleção directoryObject | Restaure um grupo excluído no locatário nos últimos 30 dias. |
| Excluir permanentemente item | Coleção directoryObject | Exclua permanentemente um grupo excluído do locatário. |
| Listar itens excluídos pertencentes ao usuário | Coleção directoryObject | Recupere os grupos do usuário excluídos no locatário nos últimos 30 dias. |
| Verificar grupos de membros | Coleção de cadeias de caracteres | Verifique se há uma associação em uma lista de grupos. Essa função é transitiva. |
| Obter grupos de membros | String collection | Retornar todos os grupos dos quais o grupo é membro. Essa função é transitiva. |
| Verificar objetos de membro | Coleção de cadeias de caracteres | Verifique se há associação em uma lista de grupo, função de diretório ou objetos de unidade administrativa. Essa função é transitiva. |
| Obter objetos de membros | String collection | Retorne todos os grupos e unidades administrativas dos quais o grupo é membro. Essa função é transitiva. |
| Unidade | ||
| Obter unidade | unidade | Recuperar as propriedades e as relações de um recurso Drive. |
| Filhos de lista | DriveItems | Retornar uma coleção de DriveItems no relacionamento filho de um DriveItem. |
| Configurações de grupo | ||
| List | Conjunto groupSetting | Lista propriedades de todos os objetos de configuração. |
| Create | groupSetting | Crie um objeto de configuração com base em um groupSettingTemplate. A solicitação POST deve fornecer settingValues para todas as configurações definidas no modelo. Somente grupos de modelos específicos podem ser usados para esta operação. |
| Get | groupSetting | Ler propriedades de um objeto de configuração específico. |
| Atualizar | Nenhum | Atualizar um objeto setting. |
| Delete | Nenhum | Excluir um objeto de configuração. |
| Listar modelo de configuração | Nenhum | Listar propriedades de todos os modelos de configuração. |
| Obter modelo de configuração | Nenhum | Ler as propriedades de um modelo de configuração. |
| Observações | ||
| Listar blocos de anotações | Coleção bloco de anotações | Recuperar uma lista de objetos do bloco de anotações. |
| Criar bloco de anotações | bloco de anotações | Crie um novo bloco de anotações do OneNote. |
| Foto do perfil | ||
| Get | profilePhoto | Obtém o profilePhoto especificado ou seus metadados (propriedades profilePhoto). |
| Atualizar | Nenhum | Atualiza a foto de qualquer usuário no locatário, incluindo o usuário conectado ou o grupo ou contato especificado. |
| Delete | Nenhum | Exclua a foto de qualquer usuário no locatário, incluindo o usuário conectado ou o grupo especificado. |
| Planner | ||
| Listar planos | coleção plannerPlan | Obter planos atribuídos ao grupo. |
| Postagens | ||
| List | Coleção post | Obtenha postagens em um tópico de conversa. |
| Get | postagem | Obtenha uma postagem específica. |
| Responder à postagem | Nenhum | Responder a uma postagem. |
| Encaminhar postagem | Nenhum | Encaminhar uma postagem. |
| Outros recursos de grupo | ||
| Listar as concessões de permissões | Coleção resourceSpecificPermissionGrant | Listar as permissões concedidas aos aplicativos para acessar o grupo. |
| Configurações do usuário | ||
| Adicionar favorito | Nenhum | Adicionar o grupo à lista de grupos de favoritos do usuário conectado. Apenas grupos do Microsoft 365 são suportados. |
| Remover favorito | Nenhum | Remover o grupo da lista de grupos favoritos do usuário conectado. Apenas grupos do Microsoft 365 são suportados. |
| Listar membro de | Coleção directoryObject | Obter os grupos e unidades administrativas dos quais esse usuário é um membro direto a partir da propriedade de navegação memberOf. |
| Listar equipes unidas | Coleção group | Obtenha as equipes do Microsoft Teams das quais o usuário é um membro direto. |
| Listar equipes associadas | Coleção associatedTeamInfo | Obtenha a lista de objetos associatedTeamInfo no Microsoft Teams as quais um usuário está associado. |
| Assinar por email | Nenhum | Defina a propriedade isSubscribedByMail como true. Permitir que o usuário conectado receba conversas por email. Apenas grupos do Microsoft 365 são suportados. |
| Cancelar assinatura por email | Nenhum | Defina a propriedade isSubscribedByMail como false. Desabilitar o recebimento de conversas por email do usuário conectado. Apenas grupos do Microsoft 365 são suportados. |
| Redefinir contagem não vista | Nenhum | Redefina o unseenCount para 0 de todas as postagens que o usuário conectado não viu desde sua última visita. Apenas grupos do Microsoft 365 são suportados. |
Propriedades
Importante
O uso específico de $filter e o parâmetro de consulta $search é suportado somente quando se usa o cabeçalho ConsistencyLevel definido como eventual e $count. Para obter mais informações, consulte Recursos avançados de consulta em objetos de diretório.
| Propriedade | Tipo | Descrição |
|---|---|---|
| accessType | groupAccessType | Indica o tipo de acesso ao grupo. Os valores possíveis são: none, private, secret, public, unknownFutureValue. Requer $select recuperação. Com suporte apenas para Obter API de grupo (GET /groups/{ID}) |
| allowExternalSenders | Boolean | Indica se as pessoas externas à empresa podem enviar mensagens para o grupo. O valor padrão é false. Requer $select recuperação. Com suporte apenas para Obter API de grupo (GET /groups/{ID}) |
| assignedLabels | coleção assignedLabel | A lista de pares de rótulos de confidencialidade (ID do rótulo, nome do rótulo) associados a um grupo do Microsoft 365 ou a um grupo de segurança na nuvem. Requer uma licença P1 do Microsoft Entra ID. Requer $select recuperação. Essa propriedade pode ser especificada durante a criação ou atualização do grupo. No entanto, para grupos de segurança de nuvem, ele é imutável depois de definido. Essa propriedade pode ser atualizada somente em cenários delegados em que o chamador requer a permissão do Microsoft Graph e uma função de administrador com suporte. Consulte Principais diferenças da rotulagem de grupo do Microsoft 365 para saber mais sobre como gerenciar essa propriedade para o Microsoft 365 versus grupos de segurança na nuvem. |
| assignedLicenses | Coleção assignedLicense | As licenças que são atribuídas ao grupo. Requer $select recuperação. Suporta $filter (eq). Somente leitura. |
| autoSubscribeNewMembers | Boolean | Indica se os novos membros adicionados ao grupo são inscritos automaticamente para receber notificações por email. Você pode definir esta propriedade em uma solicitação PATCH para o grupo; não o defina na solicitação POST inicial que cria o grupo. O valor padrão é false. Requer $select recuperação. Com suporte apenas para Obter API de grupo (GET /groups/{ID}) |
| classificação | String | Descreve uma classificação para o grupo (como baixo, médio ou alto impacto nos negócios). Os valores válidos para essa propriedade são definidos criando um valor de configuração ClassificationList, com base na definição de modelo. Retornado por padrão. Suporta $filter (eq, ne, not, ge, le, startsWith). |
| createdDateTime | DateTimeOffset | Carimbo de data/hora da ocasião em que o grupo foi criado. O valor não pode ser modificado e é preenchido automaticamente quando o grupo é criado. O tipo Timestamp representa informações de data e hora usando o formato ISO 8601 e está sempre no horário UTC. Por exemplo, meia-noite UTC em 1º de janeiro de 2014 é 2014-01-01T00:00:00Z. Retornado por padrão. Somente leitura. |
| deletedDateTime | DateTimeOffset | Para alguns objetos do Microsoft Entra (usuário, grupo, aplicativo), se o objeto for excluído, ele será excluído logicamente primeiro, e essa propriedade será atualizada com a data e a hora em que o objeto foi excluído. Caso contrário, esta propriedade é null. Se o objeto for restaurado, esta propriedade será atualizada para null. Herdado de directoryObject. |
| description | String | Uma descrição opcional para o grupo. Retornado por padrão. Suporta $filter (eq, ne, not, ge, le, startsWith) e $search. |
| displayName | String | O nome de exibição do grupo. Esta propriedade é necessária quando um grupo é criado e não pode ser limpa durante atualizações. O comprimento máximo é de 256 caracteres. Retornado por padrão. Suporte $filter (eq, ne, not, ge, le, in, startsWith, e eq no null valores), $search, e $orderby. |
| expirationDateTime | DateTimeOffset | Data e hora de quando o grupo está configurado para expirar. É para grupos de null segurança, mas para grupos do Microsoft 365, representa quando o grupo está definido para expirar, conforme definido no groupLifecyclePolicy. O tipo Timestamp representa informações de data e hora usando o formato ISO 8601 e está sempre em UTC. Por exemplo, meia-noite UTC em 1º de janeiro de 2014 é 2014-01-01T00:00:00Z. Retornado por padrão. Suporta $filter (eq, ne, not, ge, le, in). Somente leitura. |
| groupTypes | Coleção de cadeias de caracteres | Especifica o tipo de grupo e sua associação. Se a coleção contiver Unified, o grupo será um grupo do Microsoft 365; caso contrário, será um grupo de segurança ou um grupo de distribuição. Para obter detalhes, confira visão geral sobre grupos.Se a coleção inclui DynamicMembership, o grupo tem associação dinâmica; caso contrário, a associação é estática. Retornado por padrão. Suporta $filter (eq, not). |
| hasMembersWithLicenseErrors | Boolean | Indica se existem membros neste grupo com erros de licença da sua atribuição de licença baseada em grupo. Esta propriedade nunca é retornada em uma operação GET. Você pode usá-lo como um argumento $filter para acessar os grupos que têm membros com erros de licença (ou seja, o filtro para essa propriedade é true). Veja um exemplo. Suporta $filter (eq). |
| hideFromAddressLists | Booliano | Verdadeiro se o grupo não for exibido em determinadas partes da interface do usuário do Outlook: o Catálogo de Endereços, listas de endereços para selecionar destinatários de mensagens e a caixa de diálogo Procurar Grupos para pesquisar grupos; caso contrário, false. O valor padrão é false. Requer $select recuperação. Com suporte apenas para Obter API de grupo (GET /groups/{ID}) |
| hideFromOutlookClients | Booliano | Verdadeiro se o grupo não for exibido em clientes Outlook, como Outlook para Windows e Outlook na Web; caso contrário, falso. O valor padrão é false. Requer $select recuperação. Com suporte apenas para Obter API de grupo (GET /groups/{ID}) |
| id | String | O identificador exclusivo do grupo. Retornado por padrão. Herdado de directoryObject. Chave. Não anulável. Somente leitura. Suporta $filter (eq, ne, not, in). |
| isArchived | Booliano | Quando um grupo está associado a uma equipe, esta propriedade determina se a equipe está em modo somente leitura. Para ler essa propriedade, use o ponto de extremidade /group/{groupId}/team ou a API Obter equipe. Para atualizar essa propriedade, use as APIs archiveTeam e unarchiveTeam. |
| isAssignableToRole | Booliano | Indica se esse grupo pode ser atribuído a uma função do Microsoft Entra. Opcional. Esta propriedade só pode ser definida durante a criação do grupo e é imutável. Se definido como true, a propriedade securityEnabled também deve ser definida como true, a visibilidade deve ser Hidden, e o grupo não pode ser um grupo dinâmico (ou seja, groupTypes não pode conter DynamicMembership). Somente chamadores com pelo menos a função Privileged Role Administrator podem definir essa propriedade. O chamador também deve receber a permissão RoleManagement.ReadWrite.Directory para definir essa propriedade ou atualizar a associação desses grupos. Para obter mais informações, consulte Usando um grupo para gerenciar atribuições de função do Microsoft Entra O uso desse recurso requer uma licença do Microsoft Entra ID P1. Devolvido por padrão. Suporta $filter (eq, ne, not). |
| isFavorite | Boolean | Indica se o usuário marcou o grupo como favorito. Requer $select recuperação. Com suporte apenas para Obter API de grupo (GET /groups/{ID}) |
| isManagementRestricted | Booliano | Indica se o grupo é membro de uma unidade administrativa de gerenciamento restrito. Caso contrário, o valor padrão será null e o comportamento padrão será false. Somente leitura. Para gerenciar um membro do grupo de uma unidade administrativa de gerenciamento restrito, o administrador ou o aplicativo de chamada deve receber uma função do Microsoft Entra no escopo da unidade administrativa de gerenciamento restrita. Requer $select recuperação. |
| isSubscribedByMail | Boolean | Indica se o usuário conectado está inscrito para receber conversas de email. O valor padrão é true. Requer $select recuperação. Com suporte apenas para Obter API de grupo (GET /groups/{ID}) |
| licenseProcessingState | String | Indica o status da atribuição de licença do grupo a todos os membros do grupo. O valor padrão é false. Somente leitura. Valores possíveis: QueuedForProcessing, ProcessingInProgress e ProcessingComplete.Requer $select recuperação. Somente leitura. |
| String | O endereço SMTP do grupo, por exemplo, "serviceadmins@contoso.com". Retornado por padrão. Somente leitura. Suporte $filter (eq, ne, not, ge, le, in, startsWith, e eq no null valores). |
|
| mailEnabled | Boolean | Especifica se o grupo está habilitado para email. Obrigatório. Devolvido por padrão. Suporta $filter (eq, ne, not). |
| mailNickname | String | O alias de email do grupo, exclusivo para grupos do Microsoft 365 na organização. O comprimento máximo é de 64 caracteres. Esta propriedade pode conter apenas caracteres no conjunto de caracteres ASCII 0 - 127 , exceto os seguintes caracteres: @ () \ [] " ; : <> , SPACE. Obrigatório. Devolvido por padrão. Suporta $filter (eq, ne, not, ge, le, in, startsWith, e eq em null valores). |
| membershipRule | String | A regra que determina membros para esse grupo se o grupo for um grupo dinâmico (groupTypes contém DynamicMembership). Para saber mais sobre a sintaxe da regra de associação, confira sintaxe regras de associação. Retornado por padrão. Suporta $filter (eq, ne, not, ge, le, startsWith). |
| membershipRuleProcessingState | String | Indica se o processamento de associação dinâmica está ativado ou em pausa. Os valores possíveis são: On ou Paused. Retornado por padrão. Suporta $filter (eq, ne, not, in). |
| onPremisesDomainName | Cadeia de Caracteres | Contém o nome de domínio totalmente qualificado (FQDN) local, também chamado de dnsDomainName sincronizado no diretório local. A propriedade é preenchida apenas para clientes que sincronizam seu diretório local com o Microsoft Entra ID por meio do Microsoft Entra Connect. Retornado por padrão. Somente leitura. |
| onPremisesLastSyncDateTime | DateTimeOffset | Indica a última vez em que o grupo foi sincronizado com o diretório local. O tipo Timestamp representa informações de data e hora usando o formato ISO 8601 e está sempre no horário UTC. Por exemplo, meia-noite UTC em 1º de janeiro de 2014 é 2014-01-01T00:00:00Z. Retornado por padrão. Somente leitura. Suporta $filter (eq, ne, not, ge, le, in). |
| onPremisesNetBiosName | Cadeia de Caracteres | Contém o netBios name local sincronizado no diretório local. A propriedade é preenchida apenas para clientes que sincronizam seu diretório local com o Microsoft Entra ID por meio do Microsoft Entra Connect. Retornado por padrão. Somente leitura. |
| onPremisesProvisioningErrors | coleção OnPremisesProvisioningError | Erros ao usar o produto de sincronização da Microsoft durante a configuração. Retornado por padrão. Suporta $filter (eq, not). |
| onPremisesSamAccountName | Cadeia de Caracteres | Contém o nome da conta SAM local sincronizado no diretório local. A propriedade é preenchida apenas para clientes que sincronizam seu diretório local com o Microsoft Entra ID por meio do Microsoft Entra Connect. Devolvido por padrão. Suporta $filter (eq, ne, not, ge, le, in, startsWith). Somente leitura. |
| onPremisesSecurityIdentifier | String | Contém o SID (identificador de segurança) local do grupo sincronizado do local para a nuvem. Somente leitura. Devolvido por padrão. Suporta $filter(eq inclusive em null valores). |
| onPremisesSyncEnabled | Booliano |
true se este grupo for sincronizado de um diretório local; false Se este grupo foi originalmente sincronizado de um diretório local, mas não está mais sincronizado; NULL se esse objeto nunca tiver sido sincronizado de um diretório local (padrão). Retornado por padrão. Somente leitura. Suporte $filter (eq, ne, not, in, e eq no null valores). |
| preferredDataLocation | String | O local de data preferido para o grupo do Microsoft 365. Por padrão, o grupo herda o local de dados preferencial do criador do grupo. Para definir essa propriedade, o aplicativo de chamada deve receber a permissão Directory.ReadWrite.All e o usuário deve receber pelo menos uma das seguintes funções do Microsoft Entra:
Para obter mais informações sobre essa propriedade, consulte OneDrive Online Multi-Geo. Anulável. Retornado por padrão. |
| preferredLanguage | Cadeia de caracteres | Idioma de preferência de um grupo do Microsoft 365. Deve seguir o Código ISO 639-1; por exemplo, en-US. Devolvido por padrão. Suporte $filter (eq, ne, not, ge, le, in, startsWith, e eq no null valores). |
| proxyAddresses | String collection | Endereços de email para o grupo que direcionam para a mesma caixa de correio do grupo. Por exemplo: ["SMTP: bob@contoso.com", "smtp: bob@sales.contoso.com"]. O operador any é obrigatório para filtrar expressões em propriedades de vários valores. Retornado por padrão. Somente leitura. Não anulável. Suporta $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0). |
| renewedDateTime | DateTimeOffset | Carimbo de data/hora da ocasião em que o grupo foi renovado pela última vez. Esse valor não pode ser modificado diretamente e só é atualizado por meio da ação de serviço renovar. O tipo Timestamp representa informações de data e hora usando o formato ISO 8601 e está sempre em UTC. Por exemplo, meia-noite UTC em 1º de janeiro de 2014 é 2014-01-01T00:00:00Z. Retornado por padrão. Suporta $filter (eq, ne, not, ge, le, in). Apenas leitura. |
| resourceBehaviorOptions | Conjunto de cadeias de caracteres | Especifica os comportamentos de grupo que podem ser configurados para um grupo do Microsoft 365 durante sua criação. Esta propriedade pode ser definida somente como parte da criação (POST). Para obter a lista de valores possíveis, consulte Comportamentos de grupo e opções de provisionamento do Microsoft 365. |
| resourceProvisioningOptions | Conjunto de cadeias de caracteres | Especifica os recursos do grupo que estão associados ao grupo do Microsoft 365. O valor possível é Team. Para obter mais informações, consulte Comportamentos de grupo do Microsoft 365 e opções de provisionamento. Devolvido por padrão. Suporta $filter (eq, not, startsWith). |
| securityEnabled | Boolean | Especifica se o grupo é um grupo de segurança. Obrigatório. Devolvido por padrão. Suporta $filter (eq, ne, not, in). |
| securityIdentifier | Cadeia de Caracteres | Identificador de segurança do grupo, usado em cenários do Windows. Somente leitura. Devolvido por padrão. |
| serviceProvisioningErrors | serviceProvisioningError (em inglês) | Erros publicados por um serviço federado descrevendo um erro não transitório, específico do serviço em relação às propriedades ou ao link de um objeto de grupo. Suporta $filter (eq, not, para isResolved e serviceInstance). |
| tema | cadeia de caracteres | Especifica o tema de cor de um grupo do Microsoft 365. Os valores possíveis são Teal, Purple, Green, BluePink, , Orange, ou Red. Devolvido por padrão. |
| Nome único | Cadeia de caracteres | O identificador exclusivo que pode ser atribuído a um grupo e usado como uma chave alternativa. Imutável. Somente leitura. |
| unseenConversationsCount | Int32 | Contagem de conversas que tiveram uma ou mais novas postagens entregues desde a última visita do usuário conectado ao grupo. Essa propriedade é igual a unseenCount. Requer $select recuperação. Com suporte apenas para Obter API de grupo (GET /groups/{ID}) |
| unseenCount | Int32 | Contagem das conversas que receberam novas postagens desde que o usuário conectado visitou o grupo pela última vez. Essa propriedade é igual a unseenConversationsCount. Requer $select recuperação. Suportado apenas para Obter API de grupo (GET /groups/{ID}). |
| unseenMessagesCount | Int32 | Contagem de novas postagens que foram entregues às conversas do grupo desde a última visita do usuário conectado ao grupo. Requer $select recuperação. Com suporte apenas para Obter API de grupo (GET /groups/{ID}) |
| visibility | Cadeia de caracteres | Especifica a política de associação ao grupo e a visibilidade do conteúdo do grupo para grupos. Os valores possíveis são: Private, Public, ou HiddenMembership.
HiddenMembership podem ser definidos somente para grupos do Microsoft 365 quando os grupos são criados. Não pode ser atualizado posteriormente. Outros valores de visibilidade podem ser atualizados após a criação do grupo.Se o valor de visibilidade não for especificado durante a criação do grupo no Microsoft Graph, um grupo de segurança será criado como Private por padrão, e o grupo do Microsoft 365 será Public. Grupos atribuídos a funções são sempre Private. Para saber mais, confira opções de visibilidade do grupo. Retornado por padrão. Anulável. |
Opções de visibilidade do grupo
| Valor | Descrição |
|---|---|
| Público | Qualquer pessoa pode ingressar no grupo sem precisar de permissão de proprietário. Qualquer pessoa pode exibir os atributos do grupo. Qualquer pessoa pode ver os membros do grupo. |
| Privado | A permissão de proprietário é necessária para ingressar no grupo. Qualquer pessoa pode exibir os atributos do grupo. Qualquer pessoa pode ver os membros do grupo. |
| HiddenMembership | A permissão de proprietário é necessária para ingressar no grupo. Os convidados não podem exibir os atributos do grupo. Os não membros não podem ver os membros do grupo. Essa configuração não afeta a visibilidade dos proprietários do grupo. Administradores (global, empresa, usuário e helpdesk) podem visualizar a associação do grupo. O grupo aparece no catálogo de endereços global (GAL). |
Relações
| Relação | Tipo | Descrição |
|---|---|---|
| acceptedSenders | Coleção directoryObject | A lista de usuários ou grupos com permissão para criar postagens ou eventos de calendário neste grupo. Se essa lista não estiver vazia, somente os usuários ou grupos listados aqui poderão postar. |
| appRoleAssignments | appRoleAssignment collection | Representa as funções de aplicativo concedidas a um grupo para um aplicativo. Suporta o $expand. |
| calendar | calendar | O calendário do grupo. Somente leitura. |
| calendarView | Coleção event | O modo de exibição do calendário. Somente leitura. |
| conversations | Coleção conversation | As conversas do grupo. |
| createdOnBehalfOf | directoryObject | O usuário (ou aplicativo) que criou o grupo. OBSERVAÇÃO: Esta propriedade não será definida se o usuário for um administrador. Apenas leitura. |
| drive | unidade | Unidade padrão do grupo. Somente leitura. |
| unidades | Coleção drive | As unidades do grupo. Somente leitura. |
| events | Coleção event | Os eventos de calendário do grupo. |
| extensions | Coleção extension | A coleção de extensões abertas definidas para o grupo. Somente leitura. Anulável. |
| groupLifecyclePolicies | Coleção groupLifecyclePolicy | O conjunto de políticas de ciclo de vida para esse grupo. Somente leitura. Anulável. |
| memberOf | Coleção directoryObject | Grupos dos quais esse grupo é membro. Métodos HTTP: GET (suporte para todos os grupos). Somente leitura. Anulável. Suporta o $expand. |
| membros | Coleção directoryObject | Os membros deste grupo, que podem ser usuários, dispositivos, outros grupos ou entidades de serviço. Suporta as operações Membros da lista, Adicionar membro e Remover membro. Anulável. Suporta $expand incluindo $select aninhado. Por exemplo, /groups?$filter=startsWith(displayName,'Role')&$select=id,displayName&$expand=members($select=id,userPrincipalName,displayName). |
| membersWithLicenseErrors | Coleção user | Uma lista de membros do grupo com erros de licença desse grupo baseado em atribuição de licença. Somente leitura. |
| onenote | Onenote | Somente leitura. |
| owners | Coleção directoryObject | Os proprietários do grupo que podem ser usuários ou entidades de serviço. Limitado a 100 proprietários. Anulável. Suporta $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1); Dá suporte $expand à inclusão de aninhamento $select. Por exemplo, /groups?$filter=startsWith(displayName,'Role')&$select=id,displayName&$expand=owners($select=id,userPrincipalName,displayName). |
| photo | profilePhoto | A foto de perfil do grupo |
| fotos | Coleção profilePhoto | As fotos de perfil pertencentes ao grupo. Somente leitura. Anulável. |
| planejador | plannerGroup | Ponto de entrada para o recurso Planejador que pode existir para um Grupo unificado. |
| rejectedSenders | Coleção directoryObject | A lista de usuários ou grupos que não têm permissão para criar postagens ou eventos de calendário neste grupo. Anulável |
| configurações | Conjunto groupSetting | Configurações que podem controlar o comportamento desse grupo, como se os membros podem convidar pessoas para o grupo. Anulável. |
| sites | conjunto de sites | A lista de sites do SharePoint neste grupo. Acesse o site padrão com /sites/root. |
| team | Coleção channel | A equipe associada a este grupo. |
| threads | Coleção conversationThread | Os threads de conversas do grupo. Anulável. |
| transitiveMemberOf | Coleção directoryObject | Os grupos dos quais um grupo é membro, diretamente ou por meio de associação aninhada. Anulável. |
| transitiveMembers | Coleção directoryObject | Os membros diretos e transitórios de um grupo. Anulável. |
Representação JSON
A representação JSON a seguir mostra o tipo de recurso.
{
"accessType": "String",
"allowExternalSenders": "Boolean",
"acceptedSenders": [{ "@odata.type": "microsoft.graph.directoryObject" }],
"assignedLicenses": [{ "@odata.type": "microsoft.graph.assignedLicense" }],
"autoSubscribeNewMembers": "Boolean",
"calendar": { "@odata.type": "microsoft.graph.calendar" },
"calendarView": [{ "@odata.type": "microsoft.graph.event" }],
"classification": "String",
"conversations": [{ "@odata.type": "microsoft.graph.conversation" }],
"createdDateTime": "String (timestamp)",
"createdOnBehalfOf": { "@odata.type": "microsoft.graph.directoryObject" },
"deletedDateTime": "String (timestamp)",
"description": "String",
"displayName": "String",
"drive": { "@odata.type": "microsoft.graph.drive" },
"events": [{ "@odata.type": "microsoft.graph.event" }],
"groupTypes": ["String"],
"hasMembersWithLicenseErrors": "Boolean",
"hideFromAddressLists": "Boolean",
"hideFromOutlookClients": "Boolean",
"id": "String (identifier)",
"isAssignableToRole": "Boolean",
"isFavorite": "Boolean",
"isManagementRestricted": "Boolean",
"isSubscribedByMail": "Boolean",
"licenseProcessingState": "String",
"mail": "String",
"mailEnabled": "Boolean",
"mailNickname": "String",
"memberOf": [{ "@odata.type": "microsoft.graph.directoryObject" }],
"members": [{ "@odata.type": "microsoft.graph.directoryObject" }],
"membersWithLicenseErrors": [{ "@odata.type": "microsoft.graph.user" }],
"onPremisesDomainName": "String",
"onPremisesLastSyncDateTime": "String (timestamp)",
"onPremisesNetBiosName": "String",
"onPremisesProvisioningErrors": [
{ "@odata.type": "microsoft.graph.onPremisesProvisioningError" }
],
"onPremisesSecurityIdentifier": "String",
"onPremisesSyncEnabled": "Boolean",
"owners": [{ "@odata.type": "microsoft.graph.directoryObject" }],
"preferredDataLocation": "String",
"proxyAddresses": ["String"],
"photo": { "@odata.type": "microsoft.graph.profilePhoto" },
"photos": [{ "@odata.type": "microsoft.graph.profilePhoto" }],
"rejectedSenders": [{ "@odata.type": "microsoft.graph.directoryObject" }],
"renewedDateTime": "String (timestamp)",
"resourceBehaviorOptions": ["String"],
"resourceProvisioningOptions": ["String"],
"securityEnabled": "Boolean",
"securityIdentifier": "String",
"serviceProvisioningErrors": [
{ "@odata.type": "microsoft.graph.serviceProvisioningXmlError" }
],
"sites": [{ "@odata.type": "microsoft.graph.site" }],
"threads": [{ "@odata.type": "microsoft.graph.conversationThread" }],
"uniqueName": "String",
"unseenConversationsCount": "Int32",
"unseenCount": "Int32",
"unseenMessagesCount": "Int32",
"visibility": "String"
}