Metrics Engine Documentation Index
Configuration Reference Home

HTTP Authentication Scheme

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 UnboundID support in order to understand the potential impact of that change.

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

HTTP Authentication Schemes may be used to define a HTTP authentication scheme and its initialization parameters for use with a Spring Security HTTP servlet extension.

↓Direct Subcomponents
↓Relations From this Component
↓Properties
↓dsconfig Usage

Direct Subcomponents

The following HTTP Authentication Schemes are available in the server :

These HTTP Authentication Schemes inherit from the properties described below.

Relations to This Component

The following components have a direct aggregation relation to HTTP Authentication Schemes:

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 Authentication Scheme
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 authentication scheme is enabled. If a scheme is not enabled, then its authentication requests using this scheme will not be processed.
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 scheme extension class which can be used to obtain a scheme instance.
Default Value
None
Allowed Values
The fully-qualified name of a Java class that extends or implements com.unboundid.directory.server.protocols.http.HTTPAuthenticationScheme
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured HTTP Authentication Schemes:

dsconfig list-http-authentication-schemes
     [--property {propertyName}] ...

To view the configuration for an existing HTTP Authentication Scheme:

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

To update the configuration for an existing HTTP Authentication Scheme:

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

To delete an existing HTTP Authentication Scheme:

dsconfig delete-http-authentication-scheme
     --scheme-name {name}