Metrics Engine Documentation Index
Configuration Reference Home

Certificate Mapper

Note: this component has a complexity level of "expert", which means that objects of this type are not expected to be created or altered. Please contact UnboundID support for assistance if you believe that you have a need to create or modify this type of object.

Note: this is an abstract component that cannot be instantiated.

Certificate Mappers are responsible for establishing a mapping between a client certificate and the entry for the user that corresponds to that certificate.

Direct Subcomponents
Relations From this Component
Properties
dsconfig Usage

Direct Subcomponents

The following Certificate Mappers are available in the server :

These Certificate Mappers inherit from the properties described below.

Relations to This Component

The following components have a direct aggregation relation to Certificate Mappers:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ enabled
↓ java-class

Basic Properties

description

Description
A description for this Certificate Mapper
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

enabled

Description
Indicates whether the Certificate Mapper is enabled.
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

java-class (Read-Only)

Description
Specifies the fully-qualified name of the Java class that provides the Certificate Mapper implementation.
Default Value
None
Allowed Values
The fully-qualified name of a Java class that extends or implements com.unboundid.directory.server.api.CertificateMapper
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Certificate Mappers:

dsconfig list-certificate-mappers
     [--property {propertyName}] ...

To view the configuration for an existing Certificate Mapper:

dsconfig get-certificate-mapper-prop
     --mapper-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Certificate Mapper:

dsconfig set-certificate-mapper-prop
     --mapper-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To delete an existing Certificate Mapper:

dsconfig delete-certificate-mapper
     --mapper-name {name}