Note: this is an abstract component that cannot be instantiated.
Username Mappers may be used to map provided username values to the entry for the user to whom that username belongs.
↓Direct Subcomponents
↓Relations From this Component
↓Properties
↓dsconfig Usage
The following Username Mappers are available in the server :
These Username Mappers inherit from the properties described below.
The following components have a direct aggregation relation to Username Mappers:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | None |
| ↓ enabled | |
| ↓ java-class | |
| ↓ create-base-dn | |
| ↓ create-username-pattern | |
| ↓ create-rdn |
| Description | A description for this Username Mapper |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether this Username Mapper is enabled for use. |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the name of the Java class that provides the username mapper implementation. |
| Default Value | None |
| Allowed Values | The fully-qualified name of a Java class that extends or implements com.unboundid.directory.broker.core.UsernameMapper |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the base dn where new user entries are created. Specifies the base DN that should be used when creating new user entries mapped from the provided username. |
| Default Value | The default value (no base DN defined) implies this username mapper does not support creating new entries. |
| Allowed Values | A valid DN. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the regular expression pattern that is used to match a username when creating user entries. Portions of the username may be replaced to specify an RDN for the new user. The RDN pattern may include a string from a capturing group matched by the match pattern by using a dollar sign ($) followed by an integer value that indicates which capturing group should be used. Capture group 0 refers to the entire username that matched. For example, for a create-rdn of uid=$1,ou=$2, the create-username-pattern of ^(.*)@(.*)$ will substitute $1 and $2 with the portions before and after the '@' symbol in the username respectively. |
| Default Value | The default value is no RDN pattern defined. |
| Allowed Values | Any valid regular expression pattern which is supported by the javax.util.regex.Pattern class (see http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html for documentation about this class for Java SE 6). |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the replacement string used when creating new users mapping the provided username to an RDN. The replacement string may include a string from a capturing group matched by the username pattern by using a dollar sign ($) followed by an integer value that indicates which capturing group should be used. Capture group 0 refers to the entire username that matched. For example, the replacement string uid=$1 with a match-pattern of ^uid:(.*)$ will substitute $1 with the portion after the attribute name in the username respectively. |
| Default Value | The default value is no replacement string defined. |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Username Mappers:
dsconfig list-username-mappers
[--property {propertyName}] ...
To view the configuration for an existing Username Mapper:
dsconfig get-username-mapper-prop
--mapper-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Username Mapper:
dsconfig set-username-mapper-prop
--mapper-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To delete an existing Username Mapper:
dsconfig delete-username-mapper
--mapper-name {name}