🔍 Code Extractor

class SelfSignedCertificate

Maturity: 40

A data class representing the public part of a self-signed certificate, inheriting from ClientValue for use in Office 365 API operations.

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

Purpose

This class serves as a data container for self-signed certificate information in the Office 365 SDK. It encapsulates the display name of a signing certificate and is used when working with certificate-based authentication or security operations in Office 365 services. As a ClientValue subclass, it can be serialized and transmitted in API requests to Office 365 endpoints.

Source Code

class SelfSignedCertificate(ClientValue):
    """Contains the public part of a signing certificate."""

    def __init__(self, display_name=None):
        """
        :param str display_name:
        """
        self.displayName = display_name

Parameters

Name Type Default Kind
bases ClientValue -

Parameter Details

display_name: Optional string parameter that sets the human-readable name for the certificate. This is typically used to identify the certificate in user interfaces or logs. Can be None if no display name is needed.

Return Value

Instantiation returns a SelfSignedCertificate object with the displayName attribute set to the provided value (or None). The object represents a certificate's public information and can be used in Office 365 API operations that require certificate details.

Class Interface

Methods

__init__(self, display_name=None) -> None

Purpose: Initializes a new SelfSignedCertificate instance with an optional display name

Parameters:

  • display_name: Optional string representing the human-readable name of the certificate. Defaults to None if not provided.

Returns: None - this is a constructor that initializes the instance

Attributes

Name Type Description Scope
displayName str or None The human-readable display name for the certificate. Used to identify the certificate in user interfaces and logs. Can be None if no display name was provided during initialization. instance

Dependencies

  • office365

Required Imports

from office365.runtime.client_value import ClientValue
from office365.runtime.client_value_collection import SelfSignedCertificate

Usage Example

from office365.runtime.client_value_collection import SelfSignedCertificate

# Create a certificate object with a display name
cert = SelfSignedCertificate(display_name="My Company Certificate")
print(cert.displayName)  # Output: My Company Certificate

# Create a certificate without a display name
cert_no_name = SelfSignedCertificate()
print(cert_no_name.displayName)  # Output: None

# Update the display name after instantiation
cert_no_name.displayName = "Updated Certificate Name"
print(cert_no_name.displayName)  # Output: Updated Certificate Name

Best Practices

  • This is a simple data container class with minimal logic - primarily used for data transfer in Office 365 API operations
  • The displayName attribute can be modified after instantiation as it is a public instance variable
  • As a ClientValue subclass, this object is designed to be serialized for API requests - avoid storing sensitive certificate data (like private keys) in this class
  • Use descriptive display names to make certificates easily identifiable in logs and user interfaces
  • This class only contains the public part of a certificate - private key information should be handled separately and securely
  • The class follows the Office 365 SDK naming convention where the parameter uses snake_case (display_name) but the attribute uses camelCase (displayName) to match the API schema

Tags

certificate security authentication office365 data-model client-value self-signed signing-certificate

Similar Components

AI-powered semantic similarity - components with related functionality:

  • class CertificateAuthority 75.2% similar

    A data class representing a certificate authority with its associated properties such as certificate, revocation list URL, and issuer information.

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

  • class Certification 74.9% 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 Pkcs12CertificateInformation 74.5% similar

    A data class that represents the public information of a PKCS#12 certificate, including thumbprint, active status, and validity period.

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

  • class ClientCertificateAuthentication 63.9% similar

    A class representing Pkcs12-based client certificate authentication configuration, derived from ApiAuthenticationConfigurationBase, used to manage and retrieve public properties of uploaded certificates.

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

  • class Visualization 60.0% similar

    An empty class that inherits from ClientValue, likely serving as a placeholder or base class for visualization-related functionality in the Office365 API.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/views/visualization.py
← Back to Browse