Search for users
- Última actualización2020/04/15
Search for users
Use the Search for Users API to search for all users in the Control Room.
Prerequisites
- View Users
- Users who have
view users
permissions can retrieve all users. - JSON Web Token (JWT)
- All Control Room APIs require a JSON Web Token (JWT) to access the APIs. Generate an authentication token using the Authentication API. See Enterprise 11 Authentication API.
- URL:
http://<your_control_room_url>/v1/usermanagement/users/list
.Replace the content in the angle brackets with your Control Room URL.
- Method: POST.
- Use the Swagger definition files installed with your Control Room to test the APIs. View the available Swagger
APIs at:
http://<your_control_room_url>/swagger/
. - You can also use a REST client to complete this task.
Procedure
Note: You can also run REST requests from a command terminal. The following is a curl
request example. This example is formatted for readability. Replace the text inside
the angle brackets,
<authentication_token>
, with your
authentication token.curl -X POST "http://<your_control_room_url>/v1/usermanagment/users/list"
-H "accept: application/json"
-H "X-Authorization: <authentication_token>"
-H "Content-Type: application/json" -d "{
"fields": [],
"filter": {
"operator": "and",
"operands": [
{
"operator": "substring",
"field": "username",
"value": "doc"
},
{
"operator": "gt",
"field": "createdOn",
"value": "2019-12-01T00:00:00.989Z"
},
{
"operator": "lt",
"field": "createdOn",
"value": "2019-12-06T23:00:00.123Z"
}
]
}
}'