CreateGroupInput

Represents a request to create a group in a Microsoft tenant.

Fields

global classificationString

INVOCABLEVARIABLE

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

global descriptionString

INVOCABLEVARIABLE

An optional description for the group.

global displayNameString

INVOCABLEVARIABLE

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

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 groupTypesCSVString

INVOCABLEVARIABLE

Comma-separated list of the group’s type/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 isAssignableToRoleBoolean

INVOCABLEVARIABLE

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

global mailEnabledBoolean

INVOCABLEVARIABLE

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

global mailNicknameString

OTHER

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

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

global membershipRuleProcessingStateString

INVOCABLEVARIABLE

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

global preferredDataLocationString

INVOCABLEVARIABLE

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

global preferredLanguageString

INVOCABLEVARIABLE

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

global securityEnabledBoolean

INVOCABLEVARIABLE

Specifies whether the group is a security group.

global sharepointSettingsNameString

INVOCABLEVARIABLE

The API name of the SharePoint Settings Custom Metadata used to complete the action.

global themeString

INVOCABLEVARIABLE

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

global visibilityString

INVOCABLEVARIABLE

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.