MicrosoftGroup

Represents a group that can be found in a Microsoft tenant.

Implemented types

Comparable

Constructors

global MicrosoftGroup()


Fields

global classificationString

INVOCABLEVARIABLE AURAENABLED

A label that classifies the group that must match one of the options provided by the Azure admin.

global createdDateTimeDatetime

INVOCABLEVARIABLE AURAENABLED

Timestamp of when the group was created. The value can’t be modified and is automatically populated when the group is created.

global descriptionString

INVOCABLEVARIABLE AURAENABLED

An optional description for the group.

global displayNameString

INVOCABLEVARIABLE AURAENABLED

The display name for the group. This property is required when a group is created and can’t be cleared during updates. Maximum length is 256 characters.

global expirationDateTimeDatetime

INVOCABLEVARIABLE AURAENABLED

Timestamp of when the group is set to expire. It’s null for security groups, but for Microsoft 365 groups, it represents when the group is set to expire as defined in the groupLifecyclePolicy.

global groupTypesList<String>

INVOCABLEVARIABLE AURAENABLED

Specifies the group type and its membership. Valid values include: Unified, DynamicMembership. If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it’s either a security group or a distribution group. If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static.

global idString

INVOCABLEVARIABLE AURAENABLED

The unique identifier for the group.

global isAssignableToRoleBoolean

INVOCABLEVARIABLE AURAENABLED

Indicates whether this group can be assigned to a Microsoft Entra role. Using this feature requires a Microsoft Entra ID P1 license.

global mailString

INVOCABLEVARIABLE AURAENABLED

The SMTP address for the group, for example, “serviceadmins@contoso.com”.

global mailEnabledBoolean

INVOCABLEVARIABLE AURAENABLED

Specifies whether the group has its own email address from which group members can receive notifications and messages.

global mailNicknameString

OTHER AURAENABLED

The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the ASCII character set 0 - 127 except the following characters: @ () \ [] “ ; : <> , SPACE.

global membershipRuleString

OTHER AURAENABLED

The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership).

global membershipRuleProcessingStateString

INVOCABLEVARIABLE AURAENABLED

Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused.

global onPremisesDomainNameString

INVOCABLEVARIABLE AURAENABLED

Contains the on-premises domain FQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect.

global onPremisesLastSyncDateTimeDatetime

INVOCABLEVARIABLE AURAENABLED

Indicates the last time at which the group was synced with the on-premises directory.

global onPremisesNetBiosNameString

INVOCABLEVARIABLE AURAENABLED

Contains the on-premises netBios name synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect.

global onPremisesSamAccountNameString

INVOCABLEVARIABLE AURAENABLED

Contains the on-premises SAM account name synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect.

global onPremisesSecurityIdentifierString

OTHER AURAENABLED

Contains the on-premises security identifier (SID) for the group synchronized from on-premises to the cloud.

global onPremisesSyncEnabledBoolean

OTHER AURAENABLED

true if this group is synced from an on-premises directory; false if this group was originally synced from an on-premises directory but is no longer synced; null if this object has never synced from an on-premises directory (default).

global preferredDataLocationString

INVOCABLEVARIABLE AURAENABLED

The preferred data location for the Microsoft 365 group. By default, the group inherits the group creator’s preferred data location.

global preferredLanguageString

INVOCABLEVARIABLE AURAENABLED

The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example, en-US.

global proxyAddressesList<String>

INVOCABLEVARIABLE AURAENABLED

Email addresses for the group that direct to the same group mailbox. For example: [“SMTP: bob@contoso.com”, “smtp: bob@sales.contoso.com”].

global renewedDateTimeDatetime

INVOCABLEVARIABLE AURAENABLED

Timestamp of when the group was last renewed. This value can’t be modified directly and is only updated via the renew service action.

global securityEnabledBoolean

INVOCABLEVARIABLE AURAENABLED

Specifies whether the group is a security group.

global securityIdentifierString

INVOCABLEVARIABLE AURAENABLED

Security identifier of the group, used in Windows scenarios.

global themeString

INVOCABLEVARIABLE AURAENABLED

Specifies a Microsoft 365 group’s color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange, or Red.

global visibilityString

INVOCABLEVARIABLE AURAENABLED

Specifies the group join policy and group content visibility for groups. Possible values are: Private, Public, or HiddenMembership. HiddenMembership can be set only for Microsoft 365 groups when the groups are created. It can’t be updated later. Other values of visibility can be updated after group creation. Defaults to Private for security groups and Public for Microsoft 365 groups.