🔍 Code Extractor

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

Purpose

This class serves as a data transfer object (DTO) for managing secondary administrator information in Office 365 environments. It inherits from ClientValue, which is part of the Office 365 REST API client framework, allowing it to be serialized and transmitted in API requests/responses. The class encapsulates three key identifiers for a secondary administrator: their email address, login name, and user principal name (UPN).

Source Code

class SecondaryAdministratorsInfo(ClientValue):
    def __init__(self, email=None, loginName=None, userPrincipalName=None):
        """

        :param str email:
        :param str loginName:
        :param str userPrincipalName:
        """
        super(SecondaryAdministratorsInfo, self).__init__()
        self.email = email
        self.loginName = loginName
        self.userPrincipalName = userPrincipalName

Parameters

Parameter Details

email: The email address of the secondary administrator. Optional string parameter that can be None. Used for email-based identification and communication.

loginName: The login name (username) used by the secondary administrator to authenticate. Optional string parameter that can be None. Typically used for authentication purposes.

userPrincipalName: The User Principal Name (UPN) of the secondary administrator, typically in the format 'user@domain.com'. Optional string parameter that can be None. This is the primary identifier in Azure AD/Office 365 environments.

Return Value

Instantiation returns a SecondaryAdministratorsInfo object with the specified email, loginName, and userPrincipalName attributes. The object inherits from ClientValue, making it serializable for Office 365 API operations.

Class Interface

Methods

Attributes

Dependencies

• office365

Required Imports

from office365.runtime.client_value import ClientValue

Usage Example

from office365.runtime.client_value import ClientValue

# Create a SecondaryAdministratorsInfo instance with all parameters
admin_info = SecondaryAdministratorsInfo(
    email='admin@contoso.com',
    loginName='admin',
    userPrincipalName='admin@contoso.onmicrosoft.com'
)

# Create with partial information
admin_info2 = SecondaryAdministratorsInfo(email='admin2@contoso.com')

# Access attributes
print(admin_info.email)  # 'admin@contoso.com'
print(admin_info.loginName)  # 'admin'
print(admin_info.userPrincipalName)  # 'admin@contoso.onmicrosoft.com'

# Modify attributes
admin_info.email = 'newemail@contoso.com'

# Create empty instance and populate later
admin_info3 = SecondaryAdministratorsInfo()
admin_info3.email = 'admin3@contoso.com'
admin_info3.loginName = 'admin3'
admin_info3.userPrincipalName = 'admin3@contoso.onmicrosoft.com'

Best Practices

• All constructor parameters are optional, allowing flexible instantiation based on available information
• This class is primarily a data container and does not perform validation on the input values
• The class inherits from ClientValue, which provides serialization capabilities for Office 365 API operations
• Attributes can be modified after instantiation as they are simple instance variables
• When using with Office 365 APIs, ensure at least one identifier (email, loginName, or userPrincipalName) is provided for meaningful operations
• The userPrincipalName is typically the most reliable identifier in Office 365/Azure AD environments
• No explicit cleanup or disposal is required; the object can be garbage collected normally
• This class has no side effects and maintains no internal state beyond the three attributes

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class SecondaryAdministratorsFieldsData 83.7% 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 SiteAdministratorsInfo 77.8% 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 SharedWithUser 63.1% similar

  A data class representing a user with whom content has been shared, capturing their email and name for change log tracking in sharing actions.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/sharing/shared_with_user.py

• class UserDirectoryInfo 61.7% similar

  A data class representing user information retrieved from a directory service, such as Active Directory or Azure AD, used in SharePoint sharing operations.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/sharing/user_directory_info.py

• class MeetingParticipantInfo 61.6% similar

  A data class representing information about a participant in a meeting, including their identity, role, and user principal name.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/communications/onlinemeetings/participant_info.py