Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

AuthConfiguration interface

Represents the authentication configuration.

Properties

altBlueprintConnectionName

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

Entra Authentication Endpoint to use.
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.
FICClientId

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

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

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

The tenant ID for the authentication configuration.
WIDAssertionFile

The path to K8s provided token.

Property Details

altBlueprintConnectionName

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

altBlueprintConnectionName?: string

Property Value

string

authority

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

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

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

scope 

scope?: 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

The path to K8s provided token.

WIDAssertionFile?: string

Property Value

string