Click or drag to resize
CertificateAuthority Class
The class represents Certification Authority (CA) object and contains related properties and methods.
Inheritance Hierarchy
SystemObject
  PKI.CertificateServicesCertificateAuthority

Namespace: PKI.CertificateServices
Assembly: PKI.Core (in PKI.Core.dll) Version: 3.2.6.0 (3.2.6.0)
Syntax
public class CertificateAuthority

The CertificateAuthority type exposes the following members.

Constructors
  NameDescription
Public methodCertificateAuthority(String)
Initializes a new instance of the CertificateAuthority class
Public methodCertificateAuthority(String, String)
Initializes a new instance of the CertificateAuthority class
Top
Properties
  NameDescription
Public propertyBaseCRL
Gets the most recent Base CRL object.
Public propertyCertificate
Gets the most recent CA certificate.
Public propertyComputerName
Gets the host fully qualified domain name (FQDN) of the server where Certification Authority is installed.
Public propertyConfigString
Gets the configuration string of the Certification Authority in a form: ComputerName\SanitizedName.
Public propertyDeltaCRL
Gets the most recent Delta CRL. If CA server is not configured to use Delta CRLs, the property is empty.
Public propertyDisplayName
Gets the display name of the Certification Authority (sanitized characters are decoded to textual characters).
Public propertyDistinguishedName
Gets the LDAP path of the Certification Authority in Active Directory. This property is set to Null for Standalone CAs.
Public propertyEnrollmentServiceURI
Gets or sets an array of Certification Authority's web services URI.
Public propertyIsAccessible
Gets accessibility status for Certification Authority. Returns True if Certification Authority is online and management interfaces are accessbile, otherwise False.

This property does not indicate whether remote registry is available or not. Refer to RegistryOnline property to determine remote registry availability.

Public propertyName
Gets the common name of the Certification Authority in a sanitized form as specified in MS-WCCE §3.1.1.4.1.1.
Public propertyOperatingSystem
Gets operating system of the server which runs Certification Authority role.
Public propertyRegistryOnline
Gets remote registry accessibility status for Certification Authority. Returns True if Certification Authority if remote registry is accessible, otherwise False.

This property does not indicate whether management interfaces are available or not. Refer to IsAccessible property to determine management interface availability.

Public propertyServiceStatus
Gets the status of the CertSvc service.
Public propertySetupStatus
Gets the status of the current CA installation.

This property is set to Unknown if RegistryOnline property is False.

Public propertyType
Gets the type of the Certification Authority. The value can be one of the following types:
  • Enterprise Root
  • Enterprise Subordinate
  • Standalone Root
  • Standalone Subordinate
  • Undefined (if CA type cannot be recognized).
  • Unknown (if CA server is offline)
Top
Methods
  NameDescription
Public methodStatic memberConnect
Connects to a specified Certification Authority server. This method allows you to connect to either Standalone CA or Enterprise CA.
Public methodStatic memberEnumEnterpriseCAs
Enumerates registered Enterprise Certification Authorities from the current Active Directory forest.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodStatic memberGetCA Obsolete.

This method is obsolete.

Enumerates registered Enterprise Certification Authorities from the current Active Directory forest.
Public methodGetCACerts
Returns all CA certificates.
Public methodGetCAExchangeCertificate
Retrieves the most recent 'CA Exchange' certificate. If the certificate does not exist, the method will instruct CA server to generate or enroll a new one.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetMyRoles
Returns all roles granted on the CA to the caller.
Public methodGetSchema
Gets Certification Authority database schema for specified table.
Public methodGetSecurityDescriptor
Gets the access control list (ACL) for the current Certification Authority.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPing
Attempts to check Certification Authority's management interfaces availability.
Public methodStatic memberPing(String)
Attempts to check specified Certification Authority's management interfaces availability.
Public methodPublishCRL
This method publishes certificate revocation lists (CRLs) for a certification authority (CA).

The PublishCRL method publishes a CRL based on the CA's current certificate, as well as CRLs based on any CA certificates that have been renewed and are not yet expired.

Public methodRestart
Restarts a current Certification Authority instance. This method restarts 'certsvc' service.
Public methodStatic memberRestart(String)
Restarts a specified Certification Authority service. This method restarts 'certsvc' service.
Public methodStart
Starts Certification Authority service.
Public methodStatic memberStart(String)
Starts Certification Authority service on a specified server.
Public methodStop
Stops Certification Authority service.
Public methodStatic memberStop(String)
Stops Certification Authority service on a specified server.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdateEnrollmentServiceUri
Updates Enrollment Services URLs in the Active Directory.
Top
See Also