Skip to content
Search! & Match! API
Credentials
latest

Credentials

Credentials🔗

Description🔗

This object contains the credentials for a given external searcher. The only relevant attribute is the map of fields, which contains field name to value mappings representign the credentials. Depending on the type of searcher different authentication fields are required. These fields are configured in the external searcher specific web.conf files.

  • If the external searcher does not require authentication: the credentials object can be empty. This is used to grant access to restricted searchers.
  • If the external searcher requires authentication the required fields should be given in the fields attribute of the credentials object. Refer to the external searcher documentation for a definition of these fields per seacher type.

Fields🔗

Parameter Name Type Description
fields map Map of field names to values

Examples🔗

{
    "fields": {
        "username": "name",
        "password": "secret"
    }
}