---
title: HTTP Basic Authorization Mechanism
description: "The HTTP Basic Authorization Mechanism authenticates the end-user using credentials extracted from the HTTP Basic 'Authorization' header."
component: pingds
version: 8.1
page_id: pingds:configref:objects-http-basic-authorization-mechanism
canonical_url: https://docs.pingidentity.com/pingds/8.1/configref/objects-http-basic-authorization-mechanism.html
section_ids:
  parent: Parent
  dependencies: Dependencies
  http_basic_authorization_mechanism_properties: HTTP Basic Authorization Mechanism properties
  basic_properties: Basic properties
  alt-authentication-enabled: alt-authentication-enabled
  alt-password-header: alt-password-header
  alt-username-header: alt-username-header
  enabled: enabled
  identity-mapper: identity-mapper
  advanced_properties: Advanced properties
  java-class: java-class
---

# 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](objects-http-authorization-mechanism.html).

## Dependencies

HTTP Basic Authorization Mechanisms depend on the following objects:

* [Identity Mapper](objects-identity-mapper.html)

## HTTP Basic Authorization Mechanism properties

You can use configuration expressions to set property values at startup time. For details, see [Property value substitution](expressions.html).

| Basic Properties                                                                                                                                                                                          | Advanced Properties       |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- |
| [alt-authentication-enabled](#alt-authentication-enabled) [alt-password-header](#alt-password-header) [alt-username-header](#alt-username-header) [enabled](#enabled) [identity-mapper](#identity-mapper) | [java-class](#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*        | truefalse                                                                                                        |
| *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*        | truefalse                                                      |
| *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](objects-identity-mapper.html).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                                                                                                                        |