Share via

AuthConfiguration interface

Package:
@microsoft/agents-hosting

Represents the authentication configuration.

Properties

authority

Entra Authentication Endpoint to use, If not populated the Entra Public Cloud endpoint is assumed. This example of Public Cloud Endpoint is https://login.microsoftonline.com
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.
FICClientId

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

A list of valid issuers for the authentication configuration.
tenantId

The tenant ID for the authentication configuration.

Property Details

authority

Entra Authentication Endpoint to use, If not populated the Entra Public Cloud endpoint is assumed. This example of Public Cloud Endpoint is https://login.microsoftonline.com

authority?: string

Property Value

string

Remarks

see also https://learn.microsoft.com/entra/identity-platform/authentication-national-cloud

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

FICClientId

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

FICClientId?: string

Property Value

string

issuers

A list of valid issuers for the authentication configuration.

issuers: string[]

Property Value

string[]

tenantId

The tenant ID for the authentication configuration.

tenantId?: string

Property Value

string