PUT User Search
4 min
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.
Search Users
The purpose of the PUT Search User API is for the client to obtain a complete listing of all groups, permissions, and roles for users from the server. The response also includes user preferences such as preferred language and page size. While the intended purpose is to retrieve information about a specific user, it may also be used to retrieve the same information for all users or users within a certain group or any other user attribute. This API mimics searching for a user under Administration → User Management in Entity Management.
PUT
/api/v4/user-access/users/search
var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");
var raw = JSON.stringify({
"id": "String"
});
var requestOptions = {
method: 'GET',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://api.cakes.com", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));Return Search Results
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).