Query REST Service request
To call the Query REST Service, send an HTTP GET request to the following URL:
https://<hostname>:<port>/nevisidm/api/query/v1/users
The old url (https://<hostname>:<port>/nevisidm/api/v1/query/users) has been deprecated and won't be supported in future versions.
The request must include a valid SecToken. The SecToken has to contain the ID or extId of the user's profile to be able to correctly identify the user in nevisIDM. In this context, the user is the initiator of the search.
To use the Query REST Service, the authenticated user must have the required basic permission needed to search the corresponding entity. For an overview of the required permissions per entity, see the table in the chapter: Functional authorization. For additional security purposes, the queries are restricted to the Client data room for which the initiator of the search is authorized (see the chapter "Data room restrictions" for more details).
If you only want to search for a specific entity, use one of the following URLs:
| Entity | URL |
|---|---|
| Users | https://<hostname>:<port>/nevisidm/api/query/v1/users |
| Clients | https://<hostname>:<port>/nevisidm/api/query/v1/clients |
| Applications | https://<hostname>:<port>/nevisidm/api/query/v1/applications |
| Units | https://<hostname>:<port>/nevisidm/api/query/v1/units |
| Roles | https://<hostname>:<port>/nevisidm/api/query/v1/roles |
| All supported entities | https://<hostname>:<port>/nevisidm/api/query/v1/all |
URL parameters
To restrict your search, add parameters to the request URL. The next table shows the available parameters and their function.
| Parameter | Mandatory? | Default value | Description |
|---|---|---|---|
| df | No | (empty) | This parameter defines the default field (df) to use when no field prefix is defined in the search expression. It is possible to define multiple default fields by adding the parameter multiple times. This parameter restricts the search to the given default field names.Example:To search for "apple" in the Login ID, Name and First name fields, configure the URL as follows: https://<host>:<port>/nevisidm/api//query/v1/all?q=apple&df=loginid&df=name&df=firstName |
| from | No | 0 | The starting index of the hits to return. Used for paging the results. |
| size | No | 10 | The number of hits to return. Used for paging the results. |
| q | Yes | (none) | The query string. This parameter specifies the Lucene search expression or query string that enables searches in the supported entities as well as wildcard searches. It is possible to use Boolean operators (e.g., "AND", "OR"). For example, https://<host>:<port>/nevisidm/api/query/v1/all?q=apple Here, q=apple is the query string. To learn about the query syntax in more detail, see the chapter "Search syntax". The length of the query string must exceed the minimum index length. By default, the minimum index length is 3 characters. However, you can configure this setting according to your needs (for a description of the parameter application.queryservice.index.length.min, see the chapter "Configuration"). |
Supported entities
For an overview of all entities that can be included in the search, see the chapter: Supported entities.
Supported attributes
For an overview of all attributes that can be included in the search, see the chapter: Supported attributes.