ConnectionSettingsBase interface

Package:
@microsoft/agents-hosting

Connection-level settings common to every authentication provider.

Remarks

Mirrors the .NET Microsoft.Agents.Authentication.ConnectionSettingsBase abstract class: these are the credential-agnostic properties shared by all connection types. Provider-specific settings extend this base (see MsalConnectionSettings for MSAL and SidecarConnectionSettings for the Entra sidecar). The active provider for a connection is selected by authType; see AuthProviderFactory.

Properties

altBlueprintConnectionName

An optional alternative blueprint Connection name used when constructing a connector client.
alternateBlueprintConnectionName

Alias of altBlueprintConnectionName named to match the .NET AlternateBlueprintConnectionName connection setting exactly.
authority
authorityEndpoint

Entra Authentication Endpoint to use.
authType

The authentication type for the connection.
clientId

The client ID for the authentication configuration. Required in production.
connectionName

The connection name for the authentication configuration.
issuers

A list of valid issuers for the authentication configuration.
scope
scopes

The scopes for the authentication configuration.
tenantId

The tenant ID for the authentication configuration.
validateIssuer

Whether to validate the token issuer against issuers.

Property Details

altBlueprintConnectionName

An optional alternative blueprint Connection name used when constructing a connector client.

altBlueprintConnectionName?: string

Property Value

string

Remarks

Equivalent to the .NET AlternateBlueprintConnectionName connection setting. alternateBlueprintConnectionName is an alias of this property that matches the .NET name exactly; when both are provided this property takes precedence.

alternateBlueprintConnectionName

Alias of altBlueprintConnectionName named to match the .NET AlternateBlueprintConnectionName connection setting exactly.

alternateBlueprintConnectionName?: string

Property Value

string

Remarks

Provided for stricter .NET parity. The two properties are kept in sync during configuration normalization; altBlueprintConnectionName takes precedence when both are set.

authority

Warning

This API is now deprecated.

Use authorityEndpoint instead.

Entra Authentication Endpoint to use.

authority?: string

Property Value

string

Remarks

If not populated the Entra Public Cloud endpoint is assumed. This example of Public Cloud Endpoint is https://login.microsoftonline.com see also https://learn.microsoft.com/entra/identity-platform/authentication-national-cloud

authorityEndpoint

Entra Authentication Endpoint to use.

authorityEndpoint?: string

Property Value

string

Remarks

If not populated the Entra Public Cloud endpoint is assumed. This example of Public Cloud Endpoint is https://login.microsoftonline.com see also https://learn.microsoft.com/entra/identity-platform/authentication-national-cloud

authType

The authentication type for the connection.

authType?: string

Property Value

string

clientId

The client ID for the authentication configuration. Required in production.

clientId?: string

Property Value

string

connectionName

The connection name for the authentication configuration.

connectionName?: string

Property Value

string

issuers

A list of valid issuers for the authentication configuration.

issuers?: string[]

Property Value

string[]

scope

Warning

This API is now deprecated.

Use scopes instead.

scope?: string

Property Value

string

scopes

The scopes for the authentication configuration.

scopes?: string[]

Property Value

string[]

tenantId

The tenant ID for the authentication configuration.

tenantId?: string

Property Value

string

validateIssuer

Whether to validate the token issuer against issuers.

validateIssuer?: boolean

Property Value

boolean

Remarks

Disabled by default for backward compatibility. Tenant-to-issuer binding is always applied independently when both claims contain comparable tenant GUIDs.