Directory Server Documentation Index
Configuration Reference Home

Pass Through Authentication Handler

Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.

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

Pass Through Authentication Handlers are used in conjunction with the pluggable pass-through authentication plugin to handle all interaction with the external authentication service.

Direct Subcomponents
Relations to This Component
Properties
dsconfig Usage

Direct Subcomponents

The following Pass Through Authentication Handlers are available in the server :

These Pass Through Authentication Handlers inherit from the properties described below.

Relations to This Component

The following components have a direct aggregation relation to Pass Through Authentication Handlers:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None

Basic Properties

description

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


dsconfig Usage

To list the configured Pass Through Authentication Handlers:

dsconfig list-pass-through-authentication-handlers
     [--property {propertyName}] ...

To view the configuration for an existing Pass Through Authentication Handler:

dsconfig get-pass-through-authentication-handler-prop
     --handler-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Pass Through Authentication Handler:

dsconfig set-pass-through-authentication-handler-prop
     --handler-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To delete an existing Pass Through Authentication Handler:

dsconfig delete-pass-through-authentication-handler
     --handler-name {name}