🔍 Code Extractor

class VerifiedDomain

Maturity: 36

A class representing a verified domain for a tenant in Microsoft 365/Office 365, inheriting from ClientValue to provide domain verification information.

File:
/tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/domains/verified.py
Lines:
4 - 8
Complexity:
simple

Purpose

This class models a verified domain entity within an Office 365 organization. It is used to represent domains that have been verified for a tenant and is typically part of the verifiedDomains collection property of an organization entity. The class serves as a data transfer object (DTO) for domain verification information in the Office 365 API client library.

Source Code

class VerifiedDomain(ClientValue):
    """
    Specifies a domain for a tenant. The verifiedDomains property of the organization entity is a collection of
    verifiedDomain objects.
    """

Parameters

Name Type Default Kind
bases ClientValue -

Parameter Details

bases: Inherits from ClientValue, which is the base class for client-side value objects in the Office 365 SDK. This provides serialization/deserialization capabilities and common value object functionality.

Return Value

Instantiation returns a VerifiedDomain object that represents a verified domain entity. The object can be used to access domain properties and is typically retrieved as part of an organization's verifiedDomains collection rather than instantiated directly.

Class Interface

Dependencies

  • office365

Required Imports

from office365.runtime.client_value import ClientValue

Usage Example

from office365.runtime.client_value import ClientValue
from office365.directory.verified_domain import VerifiedDomain

# Typically not instantiated directly, but retrieved from organization
# Example of accessing verified domains from an organization:
# org = client.organization.get().execute_query()
# for domain in org.verifiedDomains:
#     if isinstance(domain, VerifiedDomain):
#         print(f"Domain: {domain.name}")
#         print(f"Is Default: {domain.isDefault}")
#         print(f"Is Initial: {domain.isInitial}")

# Direct instantiation (if needed for testing or manual creation):
verified_domain = VerifiedDomain()
# Properties would be set via the ClientValue base class mechanisms

Best Practices

  • This class is typically not instantiated directly by users; instead, instances are created and populated by the Office 365 SDK when querying organization information
  • The class inherits from ClientValue which provides automatic serialization/deserialization from API responses
  • When working with VerifiedDomain objects, they are usually accessed as part of the organization.verifiedDomains collection
  • The class is immutable in typical usage patterns - properties are set during deserialization from API responses
  • Common properties expected on VerifiedDomain instances include: name (domain name), isDefault (boolean), isInitial (boolean), capabilities (string), and type (string)
  • Always check if the domain object has the expected properties before accessing them, as the API response structure may vary

Tags

office365 microsoft-graph domain tenant organization verification client-value dto data-model

Similar Components

AI-powered semantic similarity - components with related functionality:

  • class Domain 65.3% similar

    Represents a domain associated with the tenant. Use domain operations to associate domains to a tenant, verify domain ownership, and configure supported services. Domain operations enable registrars to automate domain association for services such as Microsoft 365. For example, as part of domain sign up, a registrar can enable a vanity domain for email, websites, authentication, etc.

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

  • class Certification 64.0% similar

    A data class representing certification details of an application, inheriting from ClientValue to provide serialization capabilities for Office 365 API interactions.

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

  • class TenantInformation 62.7% similar

    A data class representing publicly displayed information about an Azure AD tenant, including domain name, display name, federation brand name, and tenant ID.

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

  • class DomainState 62.3% similar

    A class representing the status of asynchronous operations scheduled on a domain, inheriting from ClientValue.

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

  • class DomainDnsRecord 62.2% similar

    Represents a DNS record that must be added to a domain's DNS zone file before the domain can be used by Microsoft Online Services.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/domains/dns_record.py
← Back to Browse