AccessOptions

Access Options

Description

This object contains optional settings for external access.

The entries of the map are searcher names to credentials. This is used to either to provide external searcher specific credentials (e.g. username/password), or to provide access to restricted searchers (then no credentials are given).

Fields

Parameter Name	Type	Description
searcherAccess	map of string to credentials	Map of external searcher name to Credentials
reportingAccess	boolean	Whether the user has access to the reporting interface
assessmentAccess	boolean	Whether the user has access to the full assessment mode interface
assessmentLightAccess	boolean	Whether the user has access to the light assessment mode interface
transformedQueryAccess	boolean	Whether the user has access to the query info panel, showing the transformed query (as sent to the underlying searcher). Do not provide to end users because the query may contain credentials that the user is not allowed to see.

Examples

JSON

{
  "searcherAccess": {
    "monsterweb": {
      "fields": {
        "cat": "kdsjflenf958"
      }
    },
    "edge": {
      "fields": {
        "redirect_uri": "http://example.url.nl"
      }
    },
    "linkedin": {
      "fields": {
        "api_key": "Alzaen3843otj9845043j",
        "cx": "000390843904:dksjdf3qk4"
      }
    }
  },
  "reportingAccess": false,
  "assessmentAccess": false,
  "transformedQueryAccess": false,
  "assessmentLightAccess": false
}

SOAP

<accessOptions>
    <searcherAccess>
        <entry>
            <key>monsterweb</key>
            <value>
                <fields>
                    <entry>
                        <key>cat</key>
                        <value>kdsjflenf958</value>
                    </entry>
                </fields>
            </value>
        </entry>
        <entry>
            <key>edge</key>
            <value>
                <fields>
                    <entry>
                        <key>redirect_uri</key>
                        <value>http://example.url.nl</value>
                    </entry>
                </fields>
            </value>
        </entry>
        <entry>
            <key>linkedin</key>
            <value>
                <fields>
                    <entry>
                        <key>api_key</key>
                        <value>Alzaen3843otj9845043j</value>
                    </entry>
                    <entry>
                        <key>cx</key>
                        <value>000390843904:dksjdf3qk4</value>
                    </entry>
                </fields>
            </value>
        </entry>
    </searcherAccess>
    <reportingAccess>false</reportingAccess>
    <assessmentAccess>false</assessmentAccess>
    <transformedQueryAccess>false</transformedQueryAccess>
    <assessmentLightAccess>false</assessmentLightAccess>
</accessOptions>