The Secure Search API in SearchBlox requires two API calls:

Get the security token

Make the Search API request using the security token

GET the Security Token

The authentication request sends user credentials based on the configured security system, such as SearchBlox Realm or LDAP Realm.

Prerequisite

Select the required realm in Search → Security settings in SearchBlox, add the necessary users and groups, and then authenticate using the following API call.

Method

POST

Content-Type

application/json

URL

https://localhost:8443/rest/v2/api/secured/authenticate

JSON Request

{
"username":"ad-test\\test",
"password":"password"
}

{
"username":"user",
"password":"pwd"
}

Search API Request

Using the token generated in the previous step, you can retrieve search results in JSON format by making the following API request.

Prerequisite

Provide the token generated in the previous request as the Bearer Token under the Authorization section in Postman. Please refer to the screenshot in postman for the same.

Method

GET

URL

https://localhost:8443/rest/v2/api/search?query=\*&public=true

Parameters

Below given are the basic mandatory parameters. There are a wide variety of parameters that are supported, please refer to Search Parameters