Component
org.nuxeo.ecm.platform.usermanager.UserService

Individual Documentation Coverage

66.67 %

A service to interact with the list of users and groups of the platform.

Author: missing

Version: missing

Location: nuxeo-services/nuxeo-platform-usermanager-core/src/main/resources/OSGI-INF/UserService.xml

Require

No requirements

Required by

Not required

Implementation

org.nuxeo.ecm.platform.usermanager.UserService

Extension Points:

userManager

Configure the userManager.

The extension should use the format:

        <userManager>
          <users>
            <directory>somedirectory</directory>
            <emailField>mail</emailField>
            <searchFields append="true">
              <substringMatchSearchField>first</substringMatchSearchField>
              <exactMatchSearchField>last</exactMatchSearchField>
            </searchFields>
            <listingMode>tabbed</listingMode>
            <anonymousUser id="Anonymous">
              <property name="firstName">Anonymous</property>
              <property name="lastName">User</property>
            </anonymousUser>
            <virtualUser id="MyCustomAdministrator" searchable="false">
              <password>secret</password>
              <property name="firstName">My Custom</property>
              <property name="lastName">Administrator</property>
              <group>administrators</group>
            </virtualUser>
            <virtualUser id="MyCustomMember" searchable="false">
              <password>secret</password>
              <property name="firstName">My Custom</property>
              <property name="lastName">Member</property>
              <group>members</group>
              <group>othergroup</group>
              <propertyList name="listprop">
                <value>item1</value>
                <value>item2</value>
              </propertyList>
            </virtualUser>
            <virtualUser id="ExistingVirtualUser" remove="true" />
          </users>
          <defaultAdministratorId>admin</defaultAdministratorId>
          <userSortField>sn</userSortField>
          <userPasswordPattern>^[a-zA-Z0-9]{5,}$</userPasswordPattern>
          <groups>
            <directory>somegroupdir</directory>
            <membersField>members</membersField>
            <subGroupsField>subgroups</subGroupsField>
            <parentGroupsField>parentgroup</parentGroupsField>
            <listingMode>search_only</listingMode>
          </groups>
          <defaultGroup>members</defaultGroup>
          <groupSortField>groupname</groupSortField>
        </userManager>

If the element anonymousUser has the attribute remove="true", then the
anonymous user will be disabled. The anonymous user is searchable by
default.

If a virtual user has the attribute remove="true", it is removed from the
list of virtual users. Virtual users are searchable by default, but it is
not implemented yet... so you should keep the attribute searchable="false"
to keep the same behaviour when it will be.

Virtual users with the "administrators" group will have the same rights
than the default administrator.

Anonymous and virtual users properties have to match the users directory
schema fields to be taken into account.

The userPasswordPattern format is specified by java.util.regex.Pattern.

The values for users listingMode are: "all", "tabbed", "search_only".
(These values are defined in
org.nuxeo.ecm.webapp.security.UserManagerActionsBean.)

The values for groups listingMode are: "all" and "search_only".

Object org.nuxeo.ecm.platform.usermanager.UserManagerDescriptor