HTTP Basic Authorization Mechanism

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

Parent

The HTTP Basic Authorization Mechanism object inherits from HTTP Authorization Mechanism.

Dependencies

HTTP Basic Authorization Mechanisms depend on the following objects:

Properties

Use the --advanced option to access advanced properties.

Basic Properties

alt-authentication-enabled

SynopsisSpecifies whether user credentials may be provided using alternative headers to the standard 'Authorize' header.
Default Valuefalse
Allowed Valuestrue
false
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

alt-password-header

SynopsisAlternate HTTP headers to get the user's password from.
Default ValueNone
Allowed ValuesA string.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

alt-username-header

SynopsisAlternate HTTP headers to get the user's name from.
Default ValueNone
Allowed ValuesA string.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

enabled

SynopsisIndicates whether the HTTP Authorization Mechanism is enabled.
Default ValueNone
Allowed Valuestrue
false
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

identity-mapper

Synopsis> 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 ValueNone
Allowed ValuesThe name of an existing Identity Mapper. The referenced identity mapper must be enabled when the HTTP Basic Authorization Mechanism is enabled.
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

Advanced Properties

java-class

SynopsisSpecifies the fully-qualified name of the Java class that provides the HTTP Basic Authorization Mechanism implementation.
Default Valueorg.opends.server.protocols.http.authz.HttpBasicAuthorizationMechanism
Allowed ValuesA Java class that extends or implements:
org.opends.server.protocols.http.authz.HttpAuthorizationMechanism
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedYes
Read-OnlyNo