🔍 Code Extractor

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

Purpose

This class serves as a data transfer object (DTO) for SharePoint site administrator information within the Microsoft Online SharePoint TenantAdministration context. It inherits from ClientValue, which is part of the Office365 REST API client framework, allowing it to be serialized and transmitted in API requests/responses. The class encapsulates the essential identity information for site administrators: their email address, login name (typically in UPN or claims format), and display name.

Source Code

class SiteAdministratorsInfo(ClientValue):
    def __init__(self, email=None, login_name=None, name=None):
        """
        :param str email:
        :param str login_name:
        :param str name:
        """
        self.email = email
        self.loginName = login_name
        self.name = name

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

Parameters

Parameter Details

email: The email address of the site administrator. Optional string parameter that can be None. Expected format is a valid email address (e.g., 'admin@contoso.com').

login_name: The login name or user principal name of the site administrator. Optional string parameter that can be None. Typically in the format 'i:0#.f|membership|user@domain.com' for claims-based authentication or 'user@domain.com' for standard UPN.

name: The display name of the site administrator. Optional string parameter that can be None. This is the human-readable name shown in SharePoint interfaces (e.g., 'John Doe').

Return Value

Instantiation returns a SiteAdministratorsInfo object with the provided administrator details. The entity_type_name property returns the string 'Microsoft.Online.SharePoint.TenantAdministration.SiteAdministratorsInfo', which is used for type identification in SharePoint REST API serialization.

Class Interface

Methods

Attributes

Dependencies

• office365-rest-python-client

Required Imports

from office365.runtime.client_value import ClientValue

Usage Example

from office365.runtime.client_value import ClientValue
from office365.sharepoint.tenant.administration.site_administrators_info import SiteAdministratorsInfo

# Create a site administrator info object
admin_info = SiteAdministratorsInfo(
    email='admin@contoso.com',
    login_name='i:0#.f|membership|admin@contoso.com',
    name='Site Administrator'
)

# Access properties
print(admin_info.email)  # Output: admin@contoso.com
print(admin_info.loginName)  # Output: i:0#.f|membership|admin@contoso.com
print(admin_info.name)  # Output: Site Administrator
print(admin_info.entity_type_name)  # Output: Microsoft.Online.SharePoint.TenantAdministration.SiteAdministratorsInfo

# Create with partial information
admin_info2 = SiteAdministratorsInfo(email='user@contoso.com')
print(admin_info2.loginName)  # Output: None

Best Practices

• This class is primarily used as a data container and should be instantiated with at least one identifying attribute (email, login_name, or name) to be meaningful.
• The loginName attribute uses camelCase internally to match SharePoint API conventions, while the constructor parameter uses snake_case following Python conventions.
• This class is typically not instantiated directly by end users but rather created by the Office365 REST client library when deserializing API responses or preparing API requests.
• When creating instances for API requests, ensure the login_name format matches the authentication method used by your SharePoint tenant (claims-based, UPN, etc.).
• The entity_type_name property is used internally by the serialization framework and should not be modified.
• As a ClientValue subclass, this object is immutable in practice once used in API calls; create new instances for different administrators rather than modifying existing ones.
• All parameters are optional, but at least one should be provided for the object to be useful in identifying an administrator.

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class SecondaryAdministratorsFieldsData 85.5% similar

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

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

• class SiteUserGroupInfo 79.2% 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 SecondaryAdministratorsInfo 77.8% 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 SiteInfoForSitePicker 72.1% similar

  A data transfer object representing site information for SharePoint site picker operations in Microsoft Online SharePoint Tenant Administration.

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

• class SiteCreationData 70.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