Metrics Engine Documentation Index
Configuration Reference Home

Basic HTTP Authentication Scheme

Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact UnboundID support in order to understand the potential impact of that change.

The Basic HTTP Authentication Scheme may be used to provide configuration for BASIC (RFC 2617) authentication with a username and password

↓Parent Component
↓Properties
↓dsconfig Usage

Parent Component

The Basic HTTP Authentication Scheme component inherits from the HTTP Authentication Scheme

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ enabled
↓ realm

Basic Properties

description

Description
A description for this HTTP Authentication Scheme
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

enabled

Description
Indicates whether the authentication scheme is enabled. If a scheme is not enabled, then its authentication requests using this scheme will not be processed.
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

realm

Description
Specifies the realm name that will be used.
Default Value
Metrics Engine
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured HTTP Authentication Schemes:

dsconfig list-http-authentication-schemes
     [--property {propertyName}] ...

To view the configuration for an existing HTTP Authentication Scheme:

dsconfig get-http-authentication-scheme-prop
     --scheme-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing HTTP Authentication Scheme:

dsconfig set-http-authentication-scheme-prop
     --scheme-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Basic HTTP Authentication Scheme:

dsconfig create-http-authentication-scheme
     --scheme-name {name}
     --type basic
     --set enabled:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing HTTP Authentication Scheme:

dsconfig delete-http-authentication-scheme
     --scheme-name {name}