🔍 Code Extractor

A data class representing secondary administrators configuration for a SharePoint site, including their email addresses and login names.

Purpose

This class serves as a data transfer object (DTO) for managing secondary administrator information in SharePoint Online tenant administration. It encapsulates the site ID, administrator email addresses, and login names in a structured format that can be serialized and transmitted to SharePoint services. It inherits from ClientValue, making it compatible with the Office365 REST API client framework for data serialization.

Source Code

class SecondaryAdministratorsFieldsData(ClientValue):
    def __init__(self, site_id=None, emails=None, names=None):
        """
        :type emails: List[str] or None
        :type names: List[str] or None
        :type site_id: str or None
        """
        super(SecondaryAdministratorsFieldsData, self).__init__()
        self.secondaryAdministratorEmails = StringCollection(emails)
        self.secondaryAdministratorLoginNames = StringCollection(names)
        self.siteId = site_id

    @property
    def entity_type_name(self):
        return "Microsoft.Online.SharePoint.TenantAdministration.SecondaryAdministratorsFieldsData"

Parameters

Parameter Details

site_id: Optional string identifier for the SharePoint site. Represents the unique GUID or URL identifier of the site where secondary administrators are being configured. Can be None if not yet assigned.

emails: Optional list of strings containing email addresses of secondary administrators. Each string should be a valid email address. Can be None or an empty list if no administrators are being added. This parameter is wrapped in a StringCollection for proper serialization.

names: Optional list of strings containing login names (user principal names or domain\username format) of secondary administrators. Should correspond to the emails parameter. Can be None or an empty list. This parameter is wrapped in a StringCollection for proper serialization.

Return Value

Instantiation returns a SecondaryAdministratorsFieldsData object with three attributes: secondaryAdministratorEmails (StringCollection), secondaryAdministratorLoginNames (StringCollection), and siteId (string or None). The entity_type_name property returns the fully qualified type name string used by SharePoint's REST API for type identification.

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
from office365.sharepoint.tenant.administration.secondary_administrators_fields_data import SecondaryAdministratorsFieldsData

# Create instance with administrator data
admin_data = SecondaryAdministratorsFieldsData(
    site_id='12345678-1234-1234-1234-123456789abc',
    emails=['admin1@contoso.com', 'admin2@contoso.com'],
    names=['admin1@contoso.com', 'admin2@contoso.com']
)

# Access the entity type name for API calls
type_name = admin_data.entity_type_name

# Access the collections
emails = admin_data.secondaryAdministratorEmails
login_names = admin_data.secondaryAdministratorLoginNames
site_id = admin_data.siteId

# Create instance with no administrators
empty_admin_data = SecondaryAdministratorsFieldsData(site_id='site-guid')

Best Practices

• Always ensure that the emails and names lists correspond to each other (same order and length) when both are provided
• Use valid email addresses and login names that exist in the SharePoint tenant
• The site_id should be a valid SharePoint site GUID when specified
• This class is typically instantiated and passed to SharePoint tenant administration methods rather than used standalone
• The class inherits from ClientValue, which provides serialization capabilities for SharePoint REST API calls
• Do not modify the entity_type_name property as it is used by the SharePoint API for type identification
• The StringCollection wrapper ensures proper serialization of list data to SharePoint's expected format

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class SiteAdministratorsInfo 85.5% similar

  A data class representing site administrator information in SharePoint Online tenant administration, including email, login name, and display name.

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

• class SecondaryAdministratorsInfo 83.7% similar

  A data class representing secondary administrator information in an Office 365 context, storing email, login name, and user principal name.

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

• class SiteUserGroupInfo 66.0% similar

  A data class representing SharePoint site user group information in the Microsoft Online SharePoint Tenant Administration context.

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

• class SiteCreationData 64.2% similar

  A data class representing site creation information for SharePoint Online tenant administration, including creation count and source GUID.

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

• class AuditData 63.2% similar

  AuditData is a data class representing audit data in Microsoft SharePoint Tenant Administration, inheriting from ClientValue to provide serialization capabilities.

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