AuthenticationProvider component makes it possible to execute queries with an identity that the end user
can obtain using an authentication provider configured on the Coveo REST Search API
(see Claims Authentication).
When necessary, this component handles redirecting the browser to the address that starts the authentication process.
You can use the
data-tab attribute to enable the
AuthenticationProvider component only for the tabs of your
search interface that require authentication (see the
Return the debug info about this component.
Disable the component. Normally this means that the component will not execute handlers for the framework events (query events, for example). Components are enabled by default on creation.
Enable the component. Normally this means that the component will execute handlers for the framework events (query events, for example). Components are enabled by default on creation.
Return the bindings, or environment, for the current component.
Get the bound component to the given HTMLElement. Throws an assert if the HTMLElement has no component bound, unless using the noThrow argument.
If there is multiple component bound to the current HTMLElement, you must specify the component class.
HTMLElement for which to get the bound component.
Optional component class. If the HTMLElement has multiple components bound, you must specify which one you are targeting.
Boolean option to tell the method to not throw on error.
Allows the component to bind events and execute them only when it is enabled.
Contains the state of options for different components. Mainly used by ResultLink.
Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events.
A disabled component will not participate in the query, or listen to ComponentEvents.
Allows component to log in the dev console.
Contains the singleton that allows to trigger queries.
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
A reference to the root HTMLElement (the SearchInterface).
A reference to the root of every component, the SearchInterface.
The static ID that each component needs in order to be identified.
For example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
Specifies the display name of the authentication provider. This is the name that you want to appear in the user interface when the end user is logging in.
Default value is the
name option value.
Specifies the name of the authentication provider.
See SAML Authentication.
useIFrame option is
true, specifies whether to make
<iframe> visible to the user (inside a popup).
When the underlying authentication provider requires no user interaction (for example, when a user authenticates
using Windows authentication along with SharePoint claims), setting this option to
false reduces the visual
impact of the authentication process.
Default value is
Specifies whether to use an
<iframe> to host the chain of redirection that make up the authentication
<iframe> prevents leaving the search page as part of the authentication process. However, some login
providers refuse to load in an
Default value is
Creates a new
The HTMLElement on which to instantiate the component.
The options for the
The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).