EntraAppAuthentication interface

Package:

@azure/search-documents

Configuration for a customer-owned Microsoft Entra app registration used for federated credential-based on-behalf-of authentication.

Properties

applicationId	The application (client) ID of the customer-owned Entra app registration.
federatedCredentialId	The federated credential ID configured on the app registration, enabling the search service to authenticate as the app without a stored client secret.
tenantId	The tenant ID of the app registration. Required when the app registration is in a different tenant than the search service. If omitted, the search service's tenant is used.

Property Details

applicationId

The application (client) ID of the customer-owned Entra app registration.

applicationId: string

Property Value

string

federatedCredentialId

The federated credential ID configured on the app registration, enabling the search service to authenticate as the app without a stored client secret.

federatedCredentialId: string

Property Value

string

tenantId

The tenant ID of the app registration. Required when the app registration is in a different tenant than the search service. If omitted, the search service's tenant is used.

tenantId?: string

Property Value

string