AuthConfiguration interface

Package:
@microsoft/agents-hosting

Represents the authentication configuration.

Properties

altBlueprintConnectionName

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

Entra Authentication Endpoint to use.
authType

The authentication type for the connection.
azureRegion

The Azure region for ESTS-R regional token acquisition (e.g. 'westus', 'eastus'). When set, MSAL routes token requests to the specified regional endpoint. See https://learn.microsoft.com/en-us/entra/msal/javascript/node/regional-authorities for details.
certKeyFile

The path to the certificate key file.
certPemFile

The path to the certificate PEM file.
clientId

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

The client secret for the authentication configuration.
connectionName

The connection name for the authentication configuration.
connections

A map of connection names to their respective authentication configurations.
connectionsMap

A list of connection map items to map service URLs to connection names.
federatedClientId

The federated client ID for the authentication configuration, used for workload identity federation scenarios.
federatedTokenFile

The path to the federated token file used for Workload Identity authentication.
FICClientId
idpmResource

Sets the resource URL for Identity Proxy Manager (IDPM).
issuers

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

The scopes for the authentication configuration.
sendX5C

Indicates whether to send the X5C param or not (for SNI authentication).
tenantId

The tenant ID for the authentication configuration.
WIDAssertionFile

Property Details

altBlueprintConnectionName

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

altBlueprintConnectionName?: string

Property Value

string

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

azureRegion

The Azure region for ESTS-R regional token acquisition (e.g. 'westus', 'eastus'). When set, MSAL routes token requests to the specified regional endpoint. See https://learn.microsoft.com/en-us/entra/msal/javascript/node/regional-authorities for details.

azureRegion?: string

Property Value

string

certKeyFile

The path to the certificate key file.

certKeyFile?: string

Property Value

string

certPemFile

The path to the certificate PEM file.

certPemFile?: string

Property Value

string

clientId

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

clientId?: string

Property Value

string

clientSecret

The client secret for the authentication configuration.

clientSecret?: string

Property Value

string

connectionName

The connection name for the authentication configuration.

connectionName?: string

Property Value

string

connections

A map of connection names to their respective authentication configurations.

connections?: Map<string, AuthConfiguration>

Property Value

Map<string, AuthConfiguration>

connectionsMap

A list of connection map items to map service URLs to connection names.

connectionsMap?: ConnectionMapItem[]

Property Value

ConnectionMapItem[]

federatedClientId

The federated client ID for the authentication configuration, used for workload identity federation scenarios.

federatedClientId?: string

Property Value

string

federatedTokenFile

The path to the federated token file used for Workload Identity authentication.

federatedTokenFile?: string

Property Value

string

FICClientId

Warning

This API is now deprecated.

Use federatedClientId instead.

The FIC (First-Party Integration Channel) client ID.

FICClientId?: string

Property Value

string

idpmResource

Sets the resource URL for Identity Proxy Manager (IDPM).

idpmResource?: string

Property Value

string

Remarks

Set this to the appropriate resource identifier when the application is running in an environment, such as a Foundry container, that exposes Managed Identity through a container-specific IMDS endpoint. This setting is only meaningful when using Identity Proxy Manager (AuthType.IdentityProxyManager) for authentication.

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[]

sendX5C

Indicates whether to send the X5C param or not (for SNI authentication).

sendX5C?: boolean

Property Value

boolean

tenantId

The tenant ID for the authentication configuration.

tenantId?: string

Property Value

string

WIDAssertionFile

Warning

This API is now deprecated.

Use authType set to 'WorkloadIdentity' and federatedTokenFile instead.

The path to K8s provided token.

WIDAssertionFile?: string

Property Value

string