Export (0) Print
Expand All

IX509Enrollment interface

The IX509Enrollment interface represents the top level object and enables you to enroll in a certificate hierarchy and install a certificate response. The enrollment process supports the following three scenarios:

Out-of-band enrollment

  1. Call any initialization method implemented by the IX509Enrollment object.
  2. Call the CreateRequest method.
  3. Submit the request out of band (manually or through some other process).
  4. Receive the response from a certification or registration authority.
  5. Call the InstallResponse method.
Automatic enrollment
  1. Call any initialization method implemented by the IX509Enrollment object.
  2. Call the Enroll method.
Delayed enrollment
  1. Call any initialization method implemented by the IX509Enrollment object.
  2. Call the CreateRequest method.
  3. Store the request for a period of time such as days or weeks.
  4. Call the Initialize method to create a request object when you are ready to enroll.
  5. Populate the request object from your stored request.
  6. Call the InstallResponse method.

Members

The IX509Enrollment interface inherits from the IDispatch interface. IX509Enrollment also has these types of members:

Methods

The IX509Enrollment interface has these methods.

MethodDescription
CreatePFX

Creates a Personal Information Exchange (PFX) message.

CreateRequest

Retrieves an encoded certificate request.

[WebEnabled]

Enroll

Encodes a request, submits it to an appropriate certification authority (CA), and installs the response.

Initialize

Initializes the enrollment object and creates a default PKCS #10 request.

[WebEnabled]

InitializeFromRequest

Initializes the enrollment object from an existing IX509CertificateRequest object.

[WebEnabled]

InitializeFromTemplateName

Initializes the enrollment object from a template common name (CN).

InstallResponse

Installs a certificate chain on the end-entity computer.

[WebEnabled]

 

Properties

The IX509Enrollment interface has these properties.

PropertyDescription

CAConfigString

Retrieves the configuration string that identifies the certification authority (CA) to which the certificate request was submitted.

Certificate

Retrieves the installed certificate.

CertificateDescription

Specifies or retrieves a string that contains a description of the certificate.

[WebEnabled]

CertificateFriendlyName

Specifies or retrieves the display name of a certificate.

[WebEnabled]

EnrollmentContext

Retrieves an enrollment context that identifies whether the certificate is intended for a computer or an end user.

NameValuePairs

Retrieves a collection of name-value pairs associated with the enrollment object.

ParentWindow

Specifies or retrieves the ID of the window used to display the enrollment information.

Request

Retrieves the certificate request associated with the enrollment object.

RequestId

Retrieves a unique identifier for the certificate request sent to the certification authority by the Enroll method.

Response

Retrieves the certificate response returned from a certification authority.

Silent

Specifies or retrieves a Boolean value that indicates whether a user interface is displayed during the certificate enrollment process.

Status

Retrieves an IX509EnrollmentStatus object that can be used to monitor the status of the enrollment process and retrieve error information.

 

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

CertEnroll.h

DLL

CertEnroll.dll

See also

Certificate Enrollment API
IX509EnrollmentStatus

 

 

Community Additions

ADD
Show:
© 2014 Microsoft