pfx-api:importUsers
Import users into Pricefx. This method can also be triggered via loaddata with objectType=U.
URI Format
pfx-api:importUsers?keepExistingPermissions=true
Parameters
|
Parameter |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
|
|
Boolean |
No |
-- |
When |
Applicable Object Type: U (User)
XML Route Examples
Import users while keeping their existing permissions:
<route>
<from uri="direct:importUsers"/>
<to uri="pfx-api:importUsers?keepExistingPermissions=true"/>
</route>
Import users and overwrite permissions:
<route>
<from uri="direct:importUsersOverwrite"/>
<to uri="pfx-api:importUsers?keepExistingPermissions=false"/>
</route>
Alternative: Import users via loaddata:
<route>
<from uri="direct:importUsersViaLoaddata"/>
<to uri="pfx-api:loaddata?objectType=U&mapper=userMapper"/>
</route>
Common Pitfalls
-
Be cautious with
keepExistingPermissions=false-- this will overwrite all permissions for existing users, which may remove access unintentionally. -
The exchange body must contain the user data in the expected format (typically a list of maps with user fields).
-
User import does not delete existing users that are absent from the import data. It only creates or updates.