Configuration Reference Home
OpenDJ Server - HTTP Basic Authorization Mechanism

HTTP Basic Authorization Mechanism

The HTTP Basic Authorization Mechanism authenticates the end-user using credentials extracted from the HTTP Basic 'Authorization' header.

Parent Component

The HTTP Basic Authorization Mechanism component inherits from the HTTP Authorization Mechanism

Relations From this Component

The following components have a direct AGGREGATION relation FROM HTTP Basic Authorization Mechanisms :

Properties

A description of each property follows.


Basic Properties: Advanced Properties:
↓ alt-authentication-enabled ↓ java-class
↓ alt-password-header
↓ alt-username-header
↓ enabled
↓ identity-mapper

Basic Properties

alt-authentication-enabled

Description
Specifies whether user credentials may be provided using alternative headers to the standard 'Authorize' header.
Default Value
false
Allowed Values
true
false
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No

alt-password-header

Description
Alternate HTTP headers to get the user's password from.
Default Value
None
Allowed Values
A String
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

alt-username-header

Description
Alternate HTTP headers to get the user's name from.
Default Value
None
Allowed Values
A String
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

enabled

Description
Indicates whether the HTTP Authorization Mechanism is enabled.
Default Value
None
Allowed Values
true
false
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No

identity-mapper

Description
> Specifies the name of the identity mapper used to get the user's entry corresponding to the user-id provided in the HTTP authentication header.
Default Value
None
Allowed Values
The DN of any Identity Mapper. The referenced identity mapper must be enabled when the HTTP Basic Authorization Mechanism is enabled.
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No


Advanced Properties

java-class

Description
Specifies the fully-qualified name of the Java class that provides the HTTP Basic Authorization Mechanism implementation.
Default Value
org.opends.server.protocols.http.authz.HttpBasicAuthorizationMechanism
Allowed Values
A java class that implements or extends the class(es) :
org.opends.server.protocols.http.authz.HttpAuthorizationMechanism
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
Yes
Read-only
No