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:

HTTP Basic Authorization Mechanism Properties

You can use configuration expressions to set property values at startup time. For details, see Property Value Substitution.

Basic Properties Advanced Properties

alt-authentication-enabled
alt-password-header
alt-username-header
enabled
identity-mapper

java-class

Basic Properties

Use the --advanced option to access advanced properties.

alt-authentication-enabled

Synopsis

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

No

Read-Only

No

alt-password-header

Synopsis

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

No

Read-Only

No

alt-username-header

Synopsis

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

No

Read-Only

No

enabled

Synopsis

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

No

Read-Only

No

identity-mapper

Synopsis

Specifies the name of the identity mapper(s) used to get the user’s entry corresponding to the user-id provided in the HTTP authentication header.

Default Value

None

Allowed Values

The name of an existing identity-mapper.

The referenced identity mapper(s) must be enabled when the HTTP Basic Authorization Mechanism is enabled.

Multi-valued

Yes

Required

Yes

Admin Action Required

None

Advanced

No

Read-Only

No

Advanced Properties

Use the --advanced option to access advanced properties.

java-class

Synopsis

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 extends or implements:

  • org.opends.server.protocols.http.authz.HttpAuthorizationMechanism

Multi-valued

No

Required

Yes

Admin Action Required

None

Advanced

Yes

Read-Only

No