Edit

EnrollmentTemplateProperty enumeration (certenroll.h)

  • Article

The EnrollmentTemplateProperty enumeration contains property values for a given template.

Syntax

typedef enum EnrollmentTemplateProperty {
  TemplatePropCommonName = 1,
  TemplatePropFriendlyName = 2,
  TemplatePropEKUs = 3,
  TemplatePropCryptoProviders = 4,
  TemplatePropMajorRevision = 5,
  TemplatePropDescription = 6,
  TemplatePropKeySpec = 7,
  TemplatePropSchemaVersion = 8,
  TemplatePropMinorRevision = 9,
  TemplatePropRASignatureCount = 10,
  TemplatePropMinimumKeySize = 11,
  TemplatePropOID = 12,
  TemplatePropSupersede = 13,
  TemplatePropRACertificatePolicies = 14,
  TemplatePropRAEKUs = 15,
  TemplatePropCertificatePolicies = 16,
  TemplatePropV1ApplicationPolicy = 17,
  TemplatePropAsymmetricAlgorithm = 18,
  TemplatePropKeySecurityDescriptor = 19,
  TemplatePropSymmetricAlgorithm = 20,
  TemplatePropSymmetricKeyLength = 21,
  TemplatePropHashAlgorithm = 22,
  TemplatePropKeyUsage = 23,
  TemplatePropEnrollmentFlags = 24,
  TemplatePropSubjectNameFlags = 25,
  TemplatePropPrivateKeyFlags = 26,
  TemplatePropGeneralFlags = 27,
  TemplatePropSecurityDescriptor = 28,
  TemplatePropExtensions = 29,
  TemplatePropValidityPeriod = 30,
  TemplatePropRenewalPeriod = 31
} ;

Constants

 
TemplatePropCommonName
Value: 1
A VT_BSTR value that contains the common name of the template in Active Directory.
TemplatePropFriendlyName
Value: 2
A VT_BSTR value that contains the template display name.
TemplatePropEKUs
Value: 3
A VT_DISPATCH pointer to an IObjectIds interface that contains a collection of extended key usage object identifiers. This value applies to version 2 and later templates.
TemplatePropCryptoProviders
Value: 4
A VT_ARRAY		 VT_BSTR collection of cryptographic service providers (version 2) and key storage providers (version 3) that the client can use when generating requests based on this template.
TemplatePropMajorRevision
Value: 5
A VT_UI4 (VT_I4 beginning with Windows 8.1) value that specifies the major version number for the template.
TemplatePropDescription
Value: 6
Not used.
TemplatePropKeySpec
Value: 7
A VT_UI4 (VT_I4 beginning with Windows 8.1) value that contains AT_SIGNATURE or AT_KEYEXCHANGE to specify the Key_Spec value for legacy cryptographic service providers.
TemplatePropSchemaVersion
Value: 8
A VT_UI4 (VT_I4 beginning with Windows 8.1) value that specifies the template version. Currently, this can be 1, 2, or 3.
TemplatePropMinorRevision
Value: 9
A VT_UI4 (VT_I4 beginning with Windows 8.1) value that specifies the minor version number of a version 2 and later template.
TemplatePropRASignatureCount
Value: 10
A VT_UI4 (VT_I4 beginning with Windows 8.1) value that specifies the number of recovery agent signatures that are required when generating a certificate request base on this template.
TemplatePropMinimumKeySize
Value: 11
A VT_UI4 (VT_I4 beginning with Windows 8.1) value that specifies the minimum size of the public key used by the enrolling client.
TemplatePropOID
Value: 12
A VT_DISPATCH pointer to an IObjectId interface that contains an object identifier for this template. This value applies to version 2 and later templates.
TemplatePropSupersede
Value: 13
A VT_ARRAY		 VT_BSTR collection that contains the common names of all version 2 and later templates that have been superseded.
TemplatePropRACertificatePolicies
Value: 14
A VT_DISPATCH pointer to an IObjectIds interface that contains a collection of certificate policy object identifiers for the registration authority certificates. This value applies to version 2 and later templates.
TemplatePropRAEKUs
Value: 15
A VT_DISPATCH pointer to an IObjectIds interface that contains a collection of application policy object identifiers for the registration authority certificates. This value applies to version 2 and later templates.
TemplatePropCertificatePolicies
Value: 16
A VT_DISPATCH pointer to an IObjectIds interface that contains a collection of policy object identifiers to be added to the certificate policy extension.
TemplatePropV1ApplicationPolicy
Value: 17
A VT_DISPATCH pointer to an IObjectIds interface that contains a collection of policy object identifiers to be added to the certificate application policy extension.
TemplatePropAsymmetricAlgorithm
Value: 18
A VT_BSTR value that specifies the name of a public key algorithm the enrolling client must use when generating a certificate request based on this template. This value applies to version 3 and later templates.
TemplatePropKeySecurityDescriptor
Value: 19
A VT_BSTR value that specifies the asymmetric key security descriptor for version 3 and later templates.
TemplatePropSymmetricAlgorithm
Value: 20
A VT_BSTR value that specifies the name of the symmetric algorithm that a client must use for key exchange when using this template. This value applies to version 3 and later templates.
TemplatePropSymmetricKeyLength
Value: 21
A VT_UI4 (VT_I4 beginning with Windows 8.1) value that specifies the length, in bits, of the symmetric key. This value applies to version 3 and later templates.
TemplatePropHashAlgorithm
Value: 22
A VT_BSTR value that specifies the name of the hashing algorithm that an enrolling client must use. This value applies to version 3 and later templates.
TemplatePropKeyUsage
Value: 23
TemplatePropEnrollmentFlags
Value: 24
A VT_I4 value that contains a bitwise OR of X509CertificateTemplateEnrollmentFlag values.
TemplatePropSubjectNameFlags
Value: 25
A VT_UI4 (VT_I4 beginning with Windows 8.1) value that contains a bitwise OR of X509CertificateTemplateSubjectNameFlag values.
TemplatePropPrivateKeyFlags
Value: 26
A VT_UI4 (VT_I4 beginning with Windows 8.1) value that contains a bitwise OR of X509CertificateTemplatePrivateKeyFlag values.
TemplatePropGeneralFlags
Value: 27
A VT_UI4 (VT_I4 beginning with Windows 8.1) value that contains a bitwise OR of X509CertificateTemplateGeneralFlag values.
TemplatePropSecurityDescriptor
Value: 28
A VT_BSTR value that specifies the security descriptor.
TemplatePropExtensions
Value: 29
A VT_DISPATCH pointer to an IX509Extensions interface that contains the certificate extensions to be added to the certificate request when generating requests based on this template.
TemplatePropValidityPeriod
Value: 30
A VT_UI8 FILETIME value that contains the maximum validity period, in seconds, of the certificate.
TemplatePropRenewalPeriod
Value: 31
A VT_UI8 FILETIME value that specifies the amount of time before expiration that automatic enrollment has to attempt certificate renewal.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Header certenroll.h