Documentation - v1.2.0-alpha.3
    Preparing search index...

    Interface AuthConfiguration

    Represents the authentication configuration.

    interface AuthConfiguration {
        altBlueprintConnectionName?: string;
        authority?: string;
        certKeyFile?: string;
        certPemFile?: string;
        clientId?: string;
        clientSecret?: string;
        connectionName?: string;
        connections?: Map<string, AuthConfiguration>;
        connectionsMap?: ConnectionMapItem[];
        FICClientId?: string;
        issuers?: string[];
        scope?: string;
        tenantId?: string;
        WIDAssertionFile?: string;
    }
    Index

    Properties

    altBlueprintConnectionName? authority? certKeyFile? certPemFile? clientId? clientSecret? connectionName? connections? connectionsMap? FICClientId? issuers? scope? tenantId? WIDAssertionFile?

    Properties

    altBlueprintConnectionName?: string

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

    authority?: string

    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 see also https://learn.microsoft.com/entra/identity-platform/authentication-national-cloud

    certKeyFile?: string

    The path to the certificate key file.

    certPemFile?: string

    The path to the certificate PEM file.

    clientId?: string

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

    clientSecret?: string

    The client secret for the authentication configuration.

    connectionName?: string

    The connection name for the authentication configuration.

    connections?: Map<string, AuthConfiguration>

    A map of connection names to their respective authentication configurations.

    connectionsMap?: ConnectionMapItem[]

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

    FICClientId?: string

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

    issuers?: string[]

    A list of valid issuers for the authentication configuration.

    scope?: string
    tenantId?: string

    The tenant ID for the authentication configuration.

    WIDAssertionFile?: string

    The path to K8s provided token.

    Settings

    Member Visibility

    On This Page

    Properties