PUT User Search

entity management (em) contains user data that is associated to groups and roles the user, group, role and permission records work in conjunction with each other to control workflow activities and what users can or cannot do within the system roles and users are associated to groups using group management, and permissions are associated to roles using role management for more information about the data driving this function, refer to the em application data document return search results default return fields user id is active username email display name first name last name country effective date basic return fields everything in default plus last synchronized date last user agreement date member firm id member firm name external source id external hr user id idp user id idp id preferred language (id) preferred language value preferred page size (id) preferred page size value full return fields everything in default and basic plus office location override id location override value is supervisor group list role list permission list user search fields the table below outlines the fields supported for use in the queries array, filters array, and/or orders array as indicated in the description column (filters/queries, orders) supported search fields field description allnames string filters/queries a special purpose field to search upon for the provided value(s) against all name types (e g , first, last, username, display name) without having to provide each field in the request firstname string filters/queries orders the first name of the user lastname string filters/queries orders the last name of the user id integer filters/queries orders the unique object identifier of the user profile object externalhruserid string filters/queries orders an external user id that may be used by the client organization to identify the user username string filters/queries orders the user name of the user this is dependent on what the client organization uses as the username to identify the user email string filters/queries orders the email address of the user this value must be unique within the application country string filters/queries orders the name of the country where the user is located groupids integer filters/queries orders the unique object identifiers of the groups the user is a member of roleids integer filters/queries orders the unique object identifiers of the roles the user holds inactive boolean filters/queries orders indicates if the user is active the user may set their personal preferences to always include inactive records note the api response returns all users unless “isactive” is used in the request payload the user interface, on the other hand, automatically filters to only return active users unless specifically requested to include inactive the “isactive” field must be provided in the api request payload to receive the same results as the user interface by default