Identity Broker Documentation Index
Configuration Reference Home

HTTP User Authenticator

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

HTTP User Authenticators may be used to authenticate user provided identification details against a DataView.

↓Direct Subcomponents
↓Properties
↓dsconfig Usage

Direct Subcomponents

The following HTTP User Authenticators are available in the server :

These HTTP User Authenticators inherit from the properties described below.

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 HTTP User Authenticator
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 this HTTP User Authenticator is enabled for use.
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 name of the Java class that provides the HTTP User Authenticator implementation.
Default Value
None
Allowed Values
The fully-qualified name of a Java class that extends or implements com.unboundid.directory.server.protocols.http.HTTPUserAuthenticator
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured HTTP User Authenticators:

dsconfig list-http-user-authenticators
     [--property {propertyName}] ...

To view the configuration for an existing HTTP User Authenticator:

dsconfig get-http-user-authenticator-prop
     --authenticator-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing HTTP User Authenticator:

dsconfig set-http-user-authenticator-prop
     --authenticator-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To delete an existing HTTP User Authenticator:

dsconfig delete-http-user-authenticator
     --authenticator-name {name}