Users

The user tool lists the users of Neptune DXP - Open Edition. It is read-only. Users are not assigned to development packages, so no development package check applies.

Required role: users.

Available tools

Tool Description Parameters

list_users

List users. Without field selection, each entry contains id, username, name, email, locked, and admin.

listOptions (object, optional). Fields for filtering and sorting: username, name, email, language, locked, admin, isExternal, idpSource, jwtEnabled, lastLogin, createdBy, changedBy, createdAt, updatedAt.

The following fields can be selected: id, username, name, email, phone, mobile, language, locked, admin, isExternal, idpSource, jwtEnabled, defaultPackage, lastLogin, begins, ends, passwordUpdatedAt, createdBy, changedBy, createdAt, and updatedAt. Passwords are not returned.

Was this page helpful?

What made the biggest difference for you?
What went wrong? (Your feedback helps us fix it.)

Please don't include personal or sensitive data.