Basic User Registry (basicRegistry)

A simple XML-based user registry.

Name	Type	Default	Description
certificateMapMode	CUSTOM NOT_SUPPORTED PRINCIPAL_CN	PRINCIPAL_CN	Specifies the X.509 certificate authentication mapping mode for the basic registry: PRINCIPAL_CN, CUSTOM, or NOT_SUPPORTED. CUSTOM The basic registry attempts to authenticate the X.509 certificate by using the custom X509CertificateMapper implementation that is specified by the certificateMapperId attribute. If a single matching entity is found, the authentication is successful. If a matching entity is not found or more than a single matching entity is found, authentication fails and the program returns an error. NOT_SUPPORTED The LDAP registry does not support X.509 certificate authentication. Attempts to authenticate with an X.509 certificate fail, and a CertificateMapNotSupportedException exception is thrown. PRINCIPAL_CN The basic registry attempts to authenticate the X.509 certificate by mapping the PrincipalName value in the X.509 certificate to the exact distinguished name (DN) in the repository. If a single matching entity is found, the authentication is successful. If a matching entity is not found or more than a single matching entity is found, authentication fails and the program returns an error.
certificateMapperId	string		Specifies the X509CertificateMapper to use when the X.509 certificate authentication mapping mode is CUSTOM. The value must match the value of the 'x509.certificate.mapper.id' property that is specified for the X509CertificateMapper implementation.
id	string		A unique configuration ID.
ignoreCaseForAuthentication	boolean	false	Allow case-insensitive user name authentication.
realm	string	BasicRegistry	The realm name represents the user registry.

Name

Type

Default

Description

certificateMapMode

CUSTOM
NOT_SUPPORTED
PRINCIPAL_CN

PRINCIPAL_CN

Specifies the X.509 certificate authentication mapping mode for the basic registry: PRINCIPAL_CN, CUSTOM, or NOT_SUPPORTED.
CUSTOM
The basic registry attempts to authenticate the X.509 certificate by using the custom X509CertificateMapper implementation that is specified by the certificateMapperId attribute. If a single matching entity is found, the authentication is successful. If a matching entity is not found or more than a single matching entity is found, authentication fails and the program returns an error.
NOT_SUPPORTED
The LDAP registry does not support X.509 certificate authentication. Attempts to authenticate with an X.509 certificate fail, and a CertificateMapNotSupportedException exception is thrown.
PRINCIPAL_CN
The basic registry attempts to authenticate the X.509 certificate by mapping the PrincipalName value in the X.509 certificate to the exact distinguished name (DN) in the repository. If a single matching entity is found, the authentication is successful. If a matching entity is not found or more than a single matching entity is found, authentication fails and the program returns an error.

certificateMapperId

string

Specifies the X509CertificateMapper to use when the X.509 certificate authentication mapping mode is CUSTOM. The value must match the value of the 'x509.certificate.mapper.id' property that is specified for the X509CertificateMapper implementation.

string

A unique configuration ID.

ignoreCaseForAuthentication

boolean

false

Allow case-insensitive user name authentication.

realm

string

BasicRegistry

The realm name represents the user registry.

group

A group in a Basic User Registry.

Name	Type	Default	Description
id	string		A unique configuration ID.
name	string Required		Name of a group in a Basic User Registry.

Name

Type

Default

Description

string

A unique configuration ID.

name

string
Required

Name of a group in a Basic User Registry.

group > member

A member of a Basic User Registry group.

Name	Type	Default	Description
id	string		A unique configuration ID.
name	string Required		Name of a user in a Basic User Registry group.

Name

Type

Default

Description

string

A unique configuration ID.

name

string
Required

Name of a user in a Basic User Registry group.

user

A user in a Basic User Registry.

Name	Type	Description
id	string	A unique configuration ID.
name	string Required	Name of a user in a Basic User Registry.
password	One way hashable, or reversably encoded password (string) Required	Password of a user in a Basic User Registry. The value can be stored in clear text or encoded form. It is recommended that you encode the password. To do so, use the securityUtility tool with the encode option.

Name

Type

Default

Description

string

A unique configuration ID.

name

string
Required

Name of a user in a Basic User Registry.

password

One way hashable, or reversably encoded password (string)
Required

Password of a user in a Basic User Registry. The value can be stored in clear text or encoded form. It is recommended that you encode the password. To do so, use the securityUtility tool with the encode option.