Forefront Identity Manager Certificate Management Developer Reference
Documentation Home
Forefront Identity Manager Certificate Management Developer Reference
FIM Certificate Management Overview
FIM CM Notification API Overview
FIM CM Notification API Fundamentals
FIM CM Notification API Architecture
Getting Started Tutorials
How to: Register for an Event Using a Notification Handler
How to: Access Detailed Request Information Using a Notification Handler
How to: Log Notification Events
Developing an Event Notification Handler
Notification Handler Subscription and Configuration
FIM CM Notification Mechanism
FIM CM Provision API Overview
FIM CM Provision API Fundamentals
FIM CM Provision API Architecture
Programming with the FIM CM Provision API
Certificate Filtering
Permission Operations
How to: Check Permissions with the Provision API
Sensitive API Configuration
Understanding Profiles and Smart Cards
Working with Profile Templates
Working with Requests
How to: Creating an Enrollment Request
How to: Creating a Request on an Existing Smart Card
.NET Framework Remoting in the Provision API
FIM CM Remoting Configuration
FIM CM SQL API Overview
Getting Started with the SQL API for Smart Cards
Scheduled Processing
Request Handling
Submitting an Enroll Request with Registration Data
Submitting a Bulk Enroll Request
Monitoring the Status of an Existing Request
Retrieve All Smart Cards Assigned to a User
Understanding Registration Data
FIM CM SQL API Procedures
externalGetStatus
externalGetUserSmartCards
externalSubmitDisableRequest
externalSubmitDuplicateRequest
externalSubmitEnrollRequest
externalSubmitOnlineUpdateRequest
externalSubmitReinstateRequest
externalSubmitRenewRequest
externalSubmitReplaceRequest
externalSubmitRetireRequest
externalSubmitSuspendRequest
externalSubmitTemporaryCardDisableRequest
externalSubmitTemporaryCardEnrollRequest
externalSubmitTemporaryCardRetireRequest
FIM CM Customizable Interfaces Overview
Introduction to ICardInitialization
Developing with the ICardInitialization Interface
Introduction to ICustomItemValidator2
Developing with the ICustomItemValidator2 Interface
FIM Certificate Management Managed Reference
Microsoft.Clm
ICardContext Interface
ICardContext Members
ICardContext Properties
Atr Property
CardId Property
ICardInitialization Interface
ICardInitialization Members
ICardInitialization Methods
GenerateCardId Method
GetCardChallengeResponse Method
GetDiversifiedAdminKey Method
Initialize Method
ICardInitialization Properties
DefaultAdminKey Property
ICustomItemValidator2 Interface
ICustomItemValidator2 Members
ICustomItemValidator2 Methods
VerifyDataItem Method
ICustomUserPinGenerator Interface
ICustomUserPinGenerator Members
ICustomUserPinGenerator Methods
GenerateUserPin Method
IRequestSecurity Interface
IRequestSecurity Members
IRequestSecurity Methods
BuildRequestSecurityDescriptor Method
ISecretProvider Interface
ISecretProvider Members
ISecretProvider Methods
CalculateHash Method
GenerateSecrets Method
GetExpirationDate Method
GetSecrets Method
Initialize Method
ValidateSecretIntegrity Method
ValidateUserSecrets Method
ISecretProvider Properties
ExpirationPeriod Property
NumberOfSecrets Property
IServerKeyGenerator Interface
IServerKeyGenerator Members
IServerKeyGenerator Methods
ExportKey Method
GenerateRequest Method
Initialize Method
SymmetricKey Class
SymmetricKey Members
SymmetricKey Constructor
SymmetricKey Methods
Dispose Method
Encrypt Method
SymmetricKey Properties
Key Property
Microsoft.Clm.Common.Requests
Request Class
Request Members
Request Methods
Request Properties
RequestUUID Property
RequestFlags Enumeration
RequestType Enumeration
SkgOptions Class
SkgOptions Members
SkgOptions Methods
SkgOptions Properties
Archive Property
Csp Property
ExchangeCert Property
KeySize Property
KeySpec Property
Smime Property
Template Property
Microsoft.Clm.Common.UserProfiles
KeyGeneratorOptions Enumeration
Microsoft.Clm.Provision
CertificateServerOperations Class
CertificateServerOperations Members
CertificateServerOperations Methods
RegisterCA Method
UpdateCertificateStatus Method
WriteCertificateData Method
CertificateServerOperations Properties
Proxy Property
UseRemoting Property
CertificateServerOperationsByCulture Class
CertificateServerOperationsByCulture Members
CertificateServerOperationsByCulture Constructor
CertificateServerOperationsByCulture Methods
RegisterCA Method
UpdateCertificateStatus Method
WriteCertificateData Method
CertificatesFilter Class
CertificatesFilter Members
CertificatesFilter Methods
FindAll Method
CertificatesFilterFlags Enumeration
ExecuteOperations Class
ExecuteOperations Members
ExecuteOperations Methods
Complete Method
ConfirmActiveAdminPin Method
CreateProfileForCertificate Method
Enroll Method
GetActiveAdminPin Method
GetAdminKey Method
GetBaseCspResponse Method
GetProposedAdminPin Method
GetUserPin Method
OfflineUnblock Method
Recover Method
Retire Method
SetProposedAdminPin Method
SetProposedAdminPin Method (Guid)
SetProposedAdminPin Method (Guid, String)
Unblock Method
WriteEvent Method
ExecuteOperations Properties
Proxy Property
UseRemoting Property
FindOperations Class
FindOperations Members
FindOperations Methods
FindAllProfileTemplates Method
FindCertificates Method
FindCertificates Method (Profile)
FindCertificates Method (Smartcard)
FindRequests Method
FindSmartcards Method
GetProfile Method
GetProfileTemplate Method
GetRequest Method
GetSmartcard Method
FindOperations Properties
Proxy Property
UseRemoting Property
PermissionOperations Class
PermissionOperations Members
PermissionOperations Methods
AccessCheck Method
AccessCheck Method (Guid, UserPermission)
AccessCheck Method (Request, RequestPermission)
PermissionOperations Properties
Proxy Property
UseRemoting Property
RequestOperations Class
RequestOperations Members
RequestOperations Methods
Abandon Method
Approve Method
CreateSmartcard Method
CreateSmartcard Method (String, String, Request)
CreateSmartcard Method (String, String, String, Request)
Deny Method
DistributeSecrets Method
GetClientDocuments Method
InitiateEnroll Method
InitiateOfflineUnblock Method
InitiateRecover Method
InitiateRecover Method (Profile, DataCollection, String, Byte)
InitiateRecover Method (Smartcard, DataCollection, String, Byte)
InitiateRetire Method
InitiateUnblock Method
PrintServerDocuments Method
RequestOperations Properties
Proxy Property
UseRemoting Property
Microsoft.Clm.Shared
CertificateRequestException Class
CertificateRequestException Members
CertificateRequestException Methods
GetObjectData Method
CertificateRequestException Properties
Disposition Property
Status Property
ClmInvalidDataException Class
ClmInvalidDataException Members
ClmInvalidDataException Methods
ClmInvalidDataException Properties
ClmInvalidProfileTemplateDataException Class
ClmInvalidProfileTemplateDataException Members
ClmInvalidProfileTemplateDataException Methods
ClmInvalidProfileTemplateDataException Properties
ClmSmartcardDecodingClientTokenException Class
ClmSmartcardDecodingClientTokenException Members
ClmSmartcardDecodingClientTokenException Methods
GetObjectData Method
ClmSmartcardDecodingClientTokenException Properties
ClmSmartcardException Class
ClmSmartcardException Members
ClmSmartcardException Methods
GetObjectData Method
ClmSmartcardException Properties
SubType Property
ClmSmartcardException.ErrorId Enumeration
ClmSmartcardException.ExceptionSubType Enumeration
ClmSmartcardProcessingClientTokenException Class
ClmSmartcardProcessingClientTokenException Members
ClmSmartcardProcessingClientTokenException Methods
GetObjectData Method
ClmSmartcardProcessingClientTokenException Properties
ClmValidationCustomClassException Class
ClmValidationCustomClassException Members
ClmValidationCustomClassException Methods
GetObjectData Method
ClmValidationCustomClassException Properties
ClmValidationDataRequiredException Class
ClmValidationDataRequiredException Members
ClmValidationDataRequiredException Methods
GetObjectData Method
ClmValidationDataRequiredException Properties
ClmValidationDataTypeException Class
ClmValidationDataTypeException Members
ClmValidationDataTypeException Methods
GetObjectData Method
ClmValidationDataTypeException Properties
ClmValidationException Class
ClmValidationException Members
ClmValidationException Methods
GetObjectData Method
ClmValidationException Properties
HResult Property
ClmValidationRegularExpressionException Class
ClmValidationRegularExpressionException Members
ClmValidationRegularExpressionException Methods
GetObjectData Method
ClmValidationRegularExpressionException Properties
ClmWorkflowException Class
ClmWorkflowException Members
ClmWorkflowException Methods
ClmWorkflowException Properties
Document Class
Document Members
Document Methods
Document Properties
Content Property
MimeType Property
Name Property
INotificationSink Interface
INotificationSink Members
INotificationSink Methods
Initialize Method
Notify Method
RequestPermission Enumeration
UserPermission Enumeration
Microsoft.Clm.Shared.Certificates
Certificate Class
Certificate Members
Certificate Methods
Certificate Properties
CertificateId Property
Error Property
Flags Property
IsExternal Property
isKeyHistory Property
isPfx Property
isPkcs7 Property
isServerGenerated Property
Pfx Property
Pkcs7 Property
TemplateCommonName Property
UseLocalMachineStore Property
CertificateFlags Enumeration
CertificateRequest Class
CertificateRequest Members
CertificateRequest Constructor
CertificateRequest Methods
CertificateRequest Properties
Options Property
RawRequest Property
TemplateCommonName Property
CertificateRequestError Class
CertificateRequestError Members
CertificateRequestError Methods
CertificateRequestError Properties
Disposition Property
Status Property
CertificateRequestOptions Class
CertificateRequestOptions Members
CertificateRequestOptions Constructor
CertificateRequestOptions Methods
CertificateRequestOptions Properties
UseLocalMachine Property
UseRawRequest Property
CertificateType Enumeration
Disposition Enumeration
X509ClmCertificate Class
X509ClmCertificate Members
X509ClmCertificate Constructor
X509ClmCertificate Methods
X509ClmCertificate Properties
ArchivedOnCa Property
CertificateType Property
IsKeyHistory Property
SerialNumber Property
TemplateCommonName Property
Thumbprint Property
Microsoft.Clm.Shared.CertificateServer
Capability Enumeration
CAType Enumeration
CertificateOperationException Class
CertificateOperationException Members
CertificateOperationException Constructor
CertificateOperationException Constructor ()
CertificateOperationException Constructor (String)
CertificateOperationException Constructor (SerializationInfo, StreamingContext)
CertificateOperationException Constructor (String, Exception)
CertificateOperationException Constructor (String, String)
CertificateOperationException Constructor (String, String, Exception)
CertificateOperationException Methods
GetObjectData Method
CertificateOperationException Properties
Serial Property
CertificateResponse Class
CertificateResponse Members
CertificateResponse Constructor
CertificateResponse Methods
CertificateResponse Properties
Certificate Property
Disposition Property
ErrorMessage Property
DataItemStorage Class
DataItemStorage Members
DataItemStorage Constructor
DataItemStorage Methods
DataItemStorage Properties
Data Property
StorageOptions Property
StorageType Property
DataItemStorageOptions Enumeration
DataItemStorageType Enumeration
DataItemType Enumeration
EnrollmentAttributes Class
EnrollmentAttributes Members
EnrollmentAttributes Constructor
EnrollmentAttributes Methods
SetDataCollection Method
EnrollmentAttributes Properties
DataCollection Property
ProfileGuid Property
ProfileTemplateName Property
RequestGuid Property
RequestType Property
TargetUserGuid Property
TargetUserName Property
ValidityPeriod Property
ValidityPeriodTicks Property
EnrollmentDataCollection Class
EnrollmentDataCollection Members
EnrollmentDataCollection Constructor
EnrollmentDataCollection Constructor ()
EnrollmentDataCollection Constructor (Generic IList)
EnrollmentDataCollection Methods
EnrollmentDataCollection Properties
Item Property
Item Property (String)
EnrollmentDataItem Class
EnrollmentDataItem Members
EnrollmentDataItem Constructor
EnrollmentDataItem Methods
EnrollmentDataItem Properties
DataItemStorage Property
DataItemType Property
Name Property
Value Property
ICertificateServer Interface
ICertificateServer Members
ICertificateServer Methods
GetCAExchangeCertificate Method
GetCertificate Method
GetCrls Method
Initialize Method
IsOnline Method
PublishCrl Method
RecoverKeys Method
RequestCertificates Method
RevokeCertificates Method
Supports Method
PublishCrlOptions Enumeration
Microsoft.Clm.Shared.Notifications
Notification Class
Notification Members
Notification Methods
Notification Properties
ActorUserUuid Property
Completed Property
IsSuccess Property
NotificationType Property
Request Property
Started Property
NotificationType Enumeration
Microsoft.Clm.Shared.Profiles
Profile Class
Profile Members
Profile Methods
Profile Properties
AssignedUserUuid Property
Comment Property
Flags Property
ParentProfileUuid Property
PrimaryProfileUuid Property
ProfileTemplateUuid Property
ProfileTemplateVersion Property
Status Property
Uuid Property
ProfileFlags Enumeration
ProfileStatus Enumeration
Microsoft.Clm.Shared.ProfileTemplates
ApplicationSecurityDescriptor Class
ApplicationSecurityDescriptor Members
ApplicationSecurityDescriptor Methods
ApplicationSecurityDescriptor Properties
SecurityDescriptor Property
Uuid Property
ApplicationUserRole Enumeration
CertificateAuthority Class
CertificateAuthority Members
CertificateAuthority Methods
CertificateAuthority Properties
CaConfig Property
Name Property
Server Property
CertificateTemplate Class
CertificateTemplate Members
CertificateTemplate Methods
CertificateTemplate Properties
AllowRawRequest Property
Name Property
ShowAdvancedOptions Property
TargetCa Property
DataCollection Class
DataCollection Members
DataCollection Methods
ContainsItemForRole Method
DataCollection Properties
DataCollectionItem Class
DataCollectionItem Members
DataCollectionItem Methods
DataCollectionItem Properties
DefaultValue Property
Description Property
ItemStorage Property
ItemType Property
ItemValidation Property
Name Property
OriginatorRole Property
Required Property
DataCollectionItemStorage Class
DataCollectionItemStorage Members
DataCollectionItemStorage Methods
DataCollectionItemStorage Properties
Flags Property
StorageData Property
StorageType Property
DataCollectionItemStorageFlags Enumeration
DataCollectionItemStorageType Enumeration
DataCollectionItemType Enumeration
DataCollectionItemValidation Class
DataCollectionItemValidation Members
DataCollectionItemValidation Methods
DataCollectionItemValidation Properties
ValidationData Property
ValidationType Property
DataCollectionItemValidationType Enumeration
DeliveryType Enumeration
DuplicatePolicy Class
DuplicatePolicy Members
DuplicatePolicy Methods
DuplicatePolicy Properties
EmailTemplate Class
EmailTemplate Members
EmailTemplate Constructor
EmailTemplate Methods
EmailTemplate Properties
Body Property
From Property
Subject Property
To Property
EnrollPolicy Class
EnrollPolicy Members
EnrollPolicy Methods
EnrollPolicy Properties
NumberOfIssuedAllowed Property
ExternalCertificates Class
ExternalCertificates Members
ExternalCertificates Methods
ExternalCertificates Properties
NumberOfCertificatesToCopy Property
KeyGeneratorOptions Enumeration
OfflineUnblockPolicy Class
OfflineUnblockPolicy Members
OfflineUnblockPolicy Methods
OfflineUnblockPolicy Properties
OneTimePasswordDistribution Class
OneTimePasswordDistribution Members
OneTimePasswordDistribution Methods
OneTimePasswordDistribution Properties
DistributionType Property
MailTemplate Property
OneTimePasswordPolicy Class
OneTimePasswordPolicy Members
OneTimePasswordPolicy Methods
OneTimePasswordPolicy Properties
Distribution Property
SecretProviderData Property
SecretProviderType Property
OnlineUpdatePolicy Class
OnlineUpdatePolicy Members
OnlineUpdatePolicy Methods
OnlineUpdatePolicy Properties
AllowSpecifyCertificateTemplate Property
RevocationSettingsForCertificateExpiry Property
RevocationSettingsForContentChange Property
RevocationSettingsForRemovedCertificateTemplates Property
PasswordDistributionType Enumeration
PersonalizationOptions Class
PersonalizationOptions Members
PersonalizationOptions Constructor
PersonalizationOptions Methods
PersonalizationOptions Properties
Enabled Property
PersonalizationProfile Property
PinCharacterSet Enumeration
PolicyDocument Class
PolicyDocument Members
PolicyDocument Methods
PolicyDocument Properties
DeliveryType Property
Description Property
MimeType Property
Path Property
Title Property
PolicyDocuments Class
PolicyDocuments Members
PolicyDocuments Constructor
PolicyDocuments Methods
PolicyDocuments Properties
ProfileTemplate Class
ProfileTemplate Members
ProfileTemplate Methods
ProfileTemplate Properties
CertificateTemplates Property
CommonName Property
Description Property
DisplayName Property
DuplicatePolicy Property
EnrollPolicy Property
ExternalCertificates Property
OfflineUnblockPolicy Property
OnlineUpdatePolicy Property
ProfileTemplateType Property
RecoverOnBehalfPolicy Property
RecoverPolicy Property
ReinstatePolicy Property
RenewPolicy Property
RetirePolicy Property
RevokePolicy Property
ServerKeyGeneration Property
SmartcardConfig Property
TemporaryCardsPolicy Property
UnblockPolicy Property
Uuid Property
Version Property
ProfileTemplatePolicy Class
ProfileTemplatePolicy Members
ProfileTemplatePolicy Constructor
ProfileTemplatePolicy Methods
ProfileTemplatePolicy Properties
ApprovalsNeeded Property
AuthorizedApprover Property
AuthorizedEnrollmentAgent Property
AuthorizedInitiator Property
CollectComments Property
CollectRequestPriority Property
DefaultRequestPriority Property
Documents Property
Enabled Property
EnrollAgentRequired Property
OneTimePasswordPolicy Property
Personalization Property
PolicyDataCollection Property
SelfServiceEnabled Property
ProfileTemplateType Enumeration
RecoverOnBehalfPolicy Class
RecoverOnBehalfPolicy Members
RecoverOnBehalfPolicy Methods
RecoverOnBehalfPolicy Properties
RecoverPolicy Class
RecoverPolicy Members
RecoverPolicy Methods
RecoverPolicy Properties
ReissueArchivedCertificates Property
RevocationSettings Property
RevocationSettingsForDuplicates Property
UseClmCredentials Property
ReinstatePolicy Class
ReinstatePolicy Members
ReinstatePolicy Methods
ReinstatePolicy Properties
RenewPolicy Class
RenewPolicy Members
RenewPolicy Methods
RenewPolicy Properties
AllowCardReuseOnRenew Property
RevocationSettings Property
RetirePolicy Class
RetirePolicy Members
RetirePolicy Methods
RetirePolicy Properties
BlockAdminPin Property
BlockUserPin Property
EraseCard Property
ResetAdminPin Property
RevocationOptions Class
RevocationOptions Members
RevocationOptions Methods
RevocationOptions Properties
AllowSpecifyDelay Property
AllowSpecifyReason Property
DisableOldCardOrProfile Property
EffectiveRevocationDelay Property
PublishBaseCrl Property
PublishDeltaCrl Property
Reason Property
RevokeOldCertificates Property
RevocationReason Enumeration
RevokePolicy Class
RevokePolicy Members
RevokePolicy Methods
RevokePolicy Properties
RevocationSettings Property
UseClmCredentials Property
ServerKeyGeneration Class
ServerKeyGeneration Members
ServerKeyGeneration Methods
ServerKeyGeneration Properties
KeyGeneratorData Property
KeyGeneratorType Property
ServerGeneratesArchivedKeys Property
SmartcardConfig Class
SmartcardConfig Members
SmartcardConfig Fields
BaseCspProviderId Field
UnlimitedCertificates Field
SmartcardConfig Methods
SmartcardConfig Properties
AdminPinPolicy Property
AllowSmartcardReuse Property
CardInitializationData Property
CardInitializationType Property
CertificateLabel Property
DefaultAdminKeyHex Property
DiversifyAdminKey Property
DoNotInstallCaCertificates Property
EraseOnOverflow Property
InitializeNewSmartcard Property
MaxNumberOfCertificates Property
ProviderId Property
ProviderName Property
ProviderType Property
SmartcardPrintPolicy Property
UserPinOption Property
UserPinPolicy Property
UseSecureKeyInjection Property
SmartcardPinPolicy Class
SmartcardPinPolicy Members
SmartcardPinPolicy Methods
SmartcardPinPolicy Properties
CharacterSet Property
DefaultValue Property
MaxLength Property
MinLength Property
Rollover Property
SmartcardPrintPolicy Class
SmartcardPrintPolicy Members
SmartcardPrintPolicy Methods
SmartcardPrintPolicy Properties
CardName Property
FieldMapping Property
Print Property
ProjectName Property
SmartcardProviderType Enumeration
TemporaryCardsPolicy Class
TemporaryCardsPolicy Members
TemporaryCardsPolicy Fields
UnlimitedIssuedAllowed Field
TemporaryCardsPolicy Methods
TemporaryCardsPolicy Properties
AllowKioskRetirement Property
AutoenrollEnabled Property
BlockAdminPin Property
BlockUserPin Property
DuplicatesAllowed Property
EraseCard Property
GenerateAuthenticationCertificatesOnly Property
ImmediatelySuspendLinkedCard Property
NumberOfDaysValidityPeriod Property
NumberOfIssuedAllowed Property
ResetAdminPin Property
RevocationSettings Property
UnblockPolicy Class
UnblockPolicy Members
UnblockPolicy Methods
UnblockPolicy Properties
UserPinOption Enumeration
Microsoft.Clm.Shared.Requests
DataCollection Class
DataCollection Members
DataCollection Constructor
DataCollection Methods
DataCollection Properties
DataCollectionFlags Enumeration
DataCollectionItem Class
DataCollectionItem Members
DataCollectionItem Constructor
DataCollectionItem Methods
DataCollectionItem Properties
Name Property
Value Property
Request Class
Request Members
Request Methods
Request Properties
Comment Property
Completed Property
DataCollection Property
DataCollectionFlags Property
Flags Property
IsDataCollectionComplete Property
IsEnrollmentAgent Property
IsSmartcard Property
NewProfileUuid Property
NewSmartcardUuid Property
OldProfileUuid Property
OldSmartcardUuid Property
OriginatorUserUuid Property
Priority Property
ProfileTemplateUuid Property
RequestType Property
SecurityDescriptor Property
Status Property
Submitted Property
TargetUserUuid Property
Uuid Property
RequestFlags Enumeration
RequestStatus Enumeration
RequestType Enumeration
Microsoft.Clm.Shared.Smartcards
AdminKeyVersion Enumeration
Smartcard Class
Smartcard Members
Smartcard Methods
Smartcard Properties
AssignedUserUuid Property
Atr Property
Comment Property
Flags Property
Middleware Property
ParentSmartcardUuid Property
PermanentSmartcardUuid Property
PrimarySmartcardUuid Property
ProfileTemplateUuid Property
ProfileTemplateVersion Property
SerialNumber Property
Status Property
Uuid Property
SmartcardFlags Enumeration
SmartcardStatus Enumeration
External Resources for FIM CM
Documentation Home