searchProfiles #
Searches security profiles.
Available since 2.14.1
Support for search using a search query with the query
property.
This method also supports the Koncorde Filters DSL to match documents by passing the lang
argument with the value koncorde
.
Koncorde filters will be translated into an Elasticsearch query.
Query Syntax #
HTTP #
URL: http://kuzzle:7512/profiles/_search[?from=0][&size=42][&scroll=<time to live>]
Method: POST
Body:
{
// list of roles (deprecated since 2.14.1)
"roles": [
"role1",
"admin"
],
// use a search query
"query": {
"terms": {
"policies.roleId": ["role1", "admin"]
}
}
}
Other protocols #
{
"controller": "security",
"action": "searchProfiles",
"body": {
// list of roles (deprecated since 2.14.1)
"roles": [
"role1",
"admin"
],
// use a search query
"query": {
"terms": {
"policies.roleId": ["role1", "admin"]
}
}
},
// optional: result pagination configuration
"from": 0,
"size": 42,
"scroll": "<ttl>"
}
Arguments #
Optional: #
from
: the offset from the first result you want to fetch. Usually used with thesize
argumentscroll
: create a new forward-only result cursor. This option must be set with a time duration, at the end of which the cursor is destroyed. If set, a cursor identifier namedscrollId
will be returned in the results. This cursor can then be moved forward using the scrollProfiles API actionsize
: the maximum number of profiles returned in one response pagelang
: specify the query language to use. By default, it'selasticsearch
butkoncorde
can also be used.Available since 2.14.1
Body properties #
Optional: #
roles
: an array of role identifiers. Restrict the search to profiles linked to the provided rolesDeprecated since 2.14.1.query
: search query using the ElasticSearch Query DSL or the Koncorde Filters DSL syntax.
If the body is left empty, the result will return all available profiles.
Response #
Returns an object with the following properties:
hits
: array of object. Each object describes a found profile:_id
: profile identifier_source
: profile definition
total
: total number of profiles found. Depending on pagination options, this can be greater than the actual number of profiles in a single result page
{
"status": 200,
"error": null,
"result":
{
"hits": [
{
"_id": "firstProfileId",
"_source": {
// Full profile definition
}
},
{
"_id": "secondProfileId",
"_source": {
// Full profile definition
}
}
],
"total": 2
},
"action": "searchProfiles",
"controller": "security",
"requestId": "<unique request identifier>"
}
Edit this page on Github (opens new window)