🔍 Code Extractor

GroupProfile is a data class that represents the profile configuration for a Microsoft 365/Azure AD group, encapsulating properties like name, description, mail settings, and security settings.

Purpose

This class serves as a data transfer object (DTO) for creating or representing Microsoft 365/Azure AD group profiles. It inherits from ClientValue, indicating it's part of the Office365 REST API client library. The class is used to define group properties including display name, mail nickname, security settings, group types, and associated members/owners. It's typically used when creating new groups or updating existing group properties through the Microsoft Graph API or Office365 REST API.

Source Code

class GroupProfile(ClientValue):
    def __init__(
        self,
        name,
        description=None,
        mail_enabled=False,
        security_enabled=True,
        group_types=None,
    ):
        """
        :param str name: The display name for the group
        :param str description: An optional description for the group.
        :param bool mail_enabled: Specifies whether the group is mail-enabled. Default: false
        :param bool security_enabled: Specifies whether the group is a security group. Default: true.
        :param list[str] group_types:
        """
        super(GroupProfile, self).__init__()
        self.mailNickname = name
        self.displayName = name
        self.description = description
        self.mailEnabled = mail_enabled
        self.securityEnabled = security_enabled
        self.owners = None
        self.members = None
        self.groupTypes = StringCollection(group_types)

Parameters

Parameter Details

name: The display name for the group. This value is used for both the displayName and mailNickname properties. Required parameter that identifies the group to users.

description: An optional text description for the group that provides additional context about the group's purpose. Defaults to None if not provided.

mail_enabled: Boolean flag indicating whether the group is mail-enabled (can receive emails). Set to False by default, meaning the group won't have email capabilities unless explicitly enabled.

security_enabled: Boolean flag specifying whether the group is a security group (used for access control). Set to True by default, making it a security group by default.

group_types: A list of strings defining the group types (e.g., ['Unified'] for Microsoft 365 groups). This parameter determines special characteristics of the group. Defaults to None, which creates a standard group.

Return Value

Instantiation returns a GroupProfile object with all specified properties set. The object contains attributes for mailNickname, displayName, description, mailEnabled, securityEnabled, owners, members, and groupTypes. The owners and members attributes are initialized to None and can be populated later. The groupTypes attribute is wrapped in a StringCollection object.

Class Interface

Methods

Attributes

Dependencies

• office365

Required Imports

from office365.runtime.client_value import ClientValue
from office365.runtime.types.collections import StringCollection

Usage Example

from office365.runtime.client_value import ClientValue
from office365.runtime.types.collections import StringCollection

# Create a basic security group profile
group_profile = GroupProfile(
    name="Engineering Team",
    description="Group for engineering department members",
    security_enabled=True,
    mail_enabled=False
)

# Create a Microsoft 365 group (mail-enabled, unified group)
m365_group_profile = GroupProfile(
    name="Marketing Team",
    description="Marketing department collaboration group",
    mail_enabled=True,
    security_enabled=False,
    group_types=["Unified"]
)

# Access the properties
print(group_profile.displayName)  # "Engineering Team"
print(group_profile.mailNickname)  # "Engineering Team"
print(group_profile.securityEnabled)  # True
print(m365_group_profile.groupTypes)  # StringCollection with ["Unified"]

Best Practices

• Always provide a meaningful name parameter as it's used for both displayName and mailNickname
• Set mail_enabled=True and group_types=['Unified'] when creating Microsoft 365 groups (formerly Office 365 groups)
• For security groups used only for access control, keep mail_enabled=False and security_enabled=True (the defaults)
• The owners and members attributes are initialized to None and should be populated separately after group creation
• The groupTypes parameter accepts specific values like 'Unified' for Microsoft 365 groups; consult Microsoft Graph API documentation for valid values
• This class is typically used as a parameter when calling group creation methods in the Office365 API client, not used standalone
• The class inherits from ClientValue, which provides serialization capabilities for REST API communication

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class Group 71.2% similar

  Represents an Azure Active Directory (Azure AD) group, which can be an Office 365 group or a security group, providing methods to manage group operations, memberships, and associated resources.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/groups/group.py

• class PasswordProfile 65.2% similar

  A data class representing a user's password profile in Microsoft Graph API, containing password and password change policy settings.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/users/password_profile.py

• class DisableGroupify 63.3% similar

  DisableGroupify is a marker class that inherits from ClientValue, likely used to represent a configuration option to disable grouping functionality in Office 365 operations.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/tenant/administration/types.py

• class GroupCreationInformation_v1 62.6% similar

  A data class that encapsulates information required to create a SharePoint group, including display name, alias, visibility settings, and optional parameters.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/portal/groups/creation_information.py

• class GroupCollection 62.2% similar

  A collection class for managing Microsoft Graph API Group resources, providing methods to create, retrieve, and manage groups including Microsoft 365 groups and Security groups.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/groups/collection.py