dsconfig set-identity-mapper-prop
Prev | dsconfig Subcommands Reference | Next

## Name

dsconfig set-identity-mapper-prop — Modifies Identity Mapper properties

## Synopsis

`dsconfig set-identity-mapper-prop` {options}

## Description

Modifies Identity Mapper properties.

## Options

The dsconfig set-identity-mapper-prop command takes the following options:

`--mapper-name {name}`

  The name of the Identity Mapper.

  Identity Mapper properties depend on the Identity Mapper type, which depends on the {name} you provide.

  By default, OpenDJ directory server supports the following Identity Mapper types:

  exact-match-identity-mapper

    Default {name}: Exact Match Identity Mapper

    Enabled by default: true

    See the section called “Exact Match Identity Mapper” for the properties of this Identity Mapper type.

  regular-expression-identity-mapper

    Default {name}: Regular Expression Identity Mapper

    Enabled by default: true

    See the section called “Regular Expression Identity Mapper” for the properties of this Identity Mapper type.

`--set {PROP:VALUE}`

  Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it.

  Identity Mapper properties depend on the Identity Mapper type, which depends on the `--mapper-name {name}` option.

`--reset {property}`

  Resets a property back to its default values where PROP is the name of the property to be reset.

  Identity Mapper properties depend on the Identity Mapper type, which depends on the `--mapper-name {name}` option.

`--add {PROP:VALUE}`

  Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added.

  Identity Mapper properties depend on the Identity Mapper type, which depends on the `--mapper-name {name}` option.

`--remove {PROP:VALUE}`

  Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed.

  Identity Mapper properties depend on the Identity Mapper type, which depends on the `--mapper-name {name}` option.

## Exact Match Identity Mapper

Identity Mappers of type exact-match-identity-mapper have the following properties:

enabled
  Description

    Indicates whether the Identity Mapper is enabled for use.

  Default Value

    None

  Allowed Values

    true

    false

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

java-class
  Description

    Specifies the fully-qualified name of the Java class that provides the Exact Match Identity Mapper implementation.

  Default Value

    org.opends.server.extensions.ExactMatchIdentityMapper

  Allowed Values

    A Java class that implements or extends the class(es): org.opends.server.api.IdentityMapper

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    The Identity Mapper must be disabled and re-enabled for changes to this setting to take effect

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

match-attribute
  Description

    Specifies the attribute whose value should exactly match the ID string provided to this identity mapper. At least one value must be provided. All values must refer to the name or OID of an attribute type defined in the directory server schema. If multiple attributes or OIDs are provided, at least one of those attributes must contain the provided ID string value in exactly one entry. The internal search performed includes a logical OR across all of these values.

  Default Value

    uid

  Allowed Values

    The name of an attribute type defined in the server schema.

  Multi-valued

    Yes

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

match-base-dn
  Description

    Specifies the set of base DNs below which to search for users. The base DNs will be used when performing searches to map the provided ID string to a user entry. If multiple values are given, searches are performed below all specified base DNs.

  Default Value

    The server searches below all public naming contexts.

  Allowed Values

    A valid DN.

  Multi-valued

    Yes

  Required

    No

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

## Regular Expression Identity Mapper

Identity Mappers of type regular-expression-identity-mapper have the following properties:

enabled
  Description

    Indicates whether the Identity Mapper is enabled for use.

  Default Value

    None

  Allowed Values

    true

    false

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

java-class
  Description

    Specifies the fully-qualified name of the Java class that provides the Regular Expression Identity Mapper implementation.

  Default Value

    org.opends.server.extensions.RegularExpressionIdentityMapper

  Allowed Values

    A Java class that implements or extends the class(es): org.opends.server.api.IdentityMapper

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    The Identity Mapper must be disabled and re-enabled for changes to this setting to take effect

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

match-attribute
  Description

    Specifies the name or OID of the attribute whose value should match the provided identifier string after it has been processed by the associated regular expression. All values must refer to the name or OID of an attribute type defined in the directory server schema. If multiple attributes or OIDs are provided, at least one of those attributes must contain the provided ID string value in exactly one entry.

  Default Value

    uid

  Allowed Values

    The name of an attribute type defined in the server schema.

  Multi-valued

    Yes

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

match-base-dn
  Description

    Specifies the base DN(s) that should be used when performing searches to map the provided ID string to a user entry. If multiple values are given, searches are performed below all the specified base DNs.

  Default Value

    The server searches below all public naming contexts.

  Allowed Values

    A valid DN.

  Multi-valued

    Yes

  Required

    No

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

match-pattern
  Description

    Specifies the regular expression pattern that is used to identify portions of the ID string that will be replaced. Any portion of the ID string that matches this pattern is replaced in accordance with the provided replace pattern (or is removed if no replace pattern is specified). If multiple substrings within the given ID string match this pattern, all occurrences are replaced. If no part of the given ID string matches this pattern, the ID string is not altered. Exactly one match pattern value must be provided, and it must be a valid regular expression as described in the API documentation for the java.util.regex.Pattern class, including support for capturing groups.

  Default Value

    None

  Allowed Values

    Any valid regular expression pattern which is supported by the javax.util.regex.Pattern class (see http://download.oracle.com/docs/cd/E17409_01/javase/6/docs/api/java/util/regex/Pattern.html for documentation about this class for Java SE 6).

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

replace-pattern
  Description

    Specifies the replacement pattern that should be used for substrings in the ID string that match the provided regular expression pattern. If no replacement pattern is provided, then any matching portions of the ID string will be removed (i.e., replaced with an empty string). The replacement pattern may include a string from a capturing group by using a dollar sign ($) followed by an integer value that indicates which capturing group should be used.

  Default Value

    The replace pattern will be the empty string.

  Allowed Values

    Any valid replacement string that is allowed by the javax.util.regex.Matcher class.

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

Prev | Up | Next
dsconfig set-http-endpoint-prop | Home | dsconfig set-key-manager-provider-prop