Google Search Appliance OneBox for Enterprise Developers Manual de usuario descargar pdf (Pagina 25)

Google Search Appliance: Google OneBox for Enterprise Developer’s Guide 25

Call Parameters

A GET request from a search appliance is sent to the external provider as specified in the OneBox

module definition. The table below lists the parameters in a GET call.

Certain parameters can be suppressed if the appropriate attributes are set on the

element.

Access control settings are only passed if the OneBox module is configured to include user-level access

control. If the provider is configured to use basic authentication between the search appliance and the

provider (

<GSA_username>

and

<GSA_password>

elements are defined, see the element “security” on

page 23) then the GET request will include these parameters in the HTTP header.

Parameter Required Description Type of Value

apiMaj

required API major version number. Changes in

this value may break compatibility.

Integer (1, 2, 3...)

apiMin

required API minor version number. Changes in

this value do not break compatibility.

Integer (0, 1, 2, 3...)

authType

required The authentication mechanism used to

provide user-specific information.

One of the following values:

none, basic, ldap

, or

sso

dateTime

optional Date and time of the query on the calling

search appliance.

Text, UTC format

ipAddr

optional The IP address of the originating user. IP address

lang

required The language of the user’s browser

where the query originated.

Text, two-character language

code, such as EN, JP, or DE

oneboxName

required Name of the OneBox module. Must

match the OneBox Module definition

specified in the Admin Console.

Text, no spaces

password

optional The password for the user if HTTP Basic

authentication is being used.

Text

P0, P1,

P2, ...,

required Match groups from the regular

expression evaluation (if applicable)

Text

query

required The query string from the user’s query to

a search appliance. The query string

does not include the trigger term.

UTF-8 encoded and URL-

escaped text

userName

optional The user identity for secure or

personalized results from a provider:

• If

authType=basic

userName

is the

username of the search user.

• If

authType=ldap

userName

is the

distinguished name (DN) from the

LDAP server.

• If

authType=sso

userName

is the

user of the cookie used by a

provider.

Text

1 2 ... 20 21 22 23 24 25 26 27 28 29 30

Comentarios a estos manuales

Sin comentarios

Google Search Appliance OneBox for Enterprise Developers Manual de usuario Pagina 25

Comentarios a estos manuales

Relacionado con productos y manuales para Software Google Search Appliance OneBox for Enterprise Developers