The REST interface is designed to serve the following purposes:
- Provide an OpenID Connect UserInfo Endpoint in nevisIDM.
- Allow user search with quick, full-text search queries.
- Expose all nevisIDM entities, like users, profiles, credentials through REST API.
When using REST APIs some information is transferred in the URL, for example in case of a call to the Query REST Service: /nevisidm/api/query/v1/users?q=loginid:jim. Depending on jurisdiction and industry sector regulations, this transferred information could be treated as sensitive data which requires additional protection. If this is the case, ensure the logs are properly protected or scrubbed of sensitive data.