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.
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-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:
|
Multi-valued |
No |
Required |
Yes |
Admin action required |
None |
Advanced |
Yes |
Read-only |
No |