RUAL Documentation

GET /_system/users/search

Search system users (GET) with Elasticsearch query parameters

Search system users (GET) with Elasticsearch query parameters
Key Type Example Description
limit optional integer
42
offset optional integer
42
Elasticsearch query offset parameter
Key Type Example Description
authorization required string
"Bearer access_token"
Access token
{}
{ "error": "INVALID_ACCESS_TOKEN", "code": 401 }
Status Error Code Description
401 INVALID_ACCESS_TOKEN Authentication required or invalid token
403 INSUFFICIENT_PERMISSIONS Insufficient permissions for this operation
Permission Description
Bearer token Access token required via Authorization header, x-authtoken, x-token, query param, or cookie
users_view Required scope: users_view

Back to Users Return to the Users category to view other endpoints All API Categories Browse all available API categories