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

    Interface AuthProvider

    Represents an authentication provider.

    interface AuthProvider {
        connectionSettings?: AuthConfiguration;
        getAgenticApplicationToken: (
            tenantId: string,
            agentAppInstanceId: string,
        ) => Promise<string>;
        getAgenticInstanceToken: (
            tenantId: string,
            agentAppInstanceId: string,
        ) => Promise<string>;
        getAgenticUserToken: (
            tenantId: string,
            agentAppInstanceId: string,
            upn: string,
            scopes: string[],
        ) => Promise<string>;
        acquireTokenOnBehalfOf(
            scopes: string[],
            oboAssertion: string,
        ): Promise<string>;
        acquireTokenOnBehalfOf(
            authConfig: AuthConfiguration,
            scopes: string[],
            oboAssertion: string,
        ): Promise<string>;
        acquireTokenOnBehalfOf(
            authConfigOrScopes: string[] | AuthConfiguration,
            scopesOrOboAssertion?: string | string[],
            oboAssertion?: string,
        ): Promise<string>;
        getAccessToken(
            authConfig: AuthConfiguration,
            scope: string,
        ): Promise<string>;
        getAccessToken(scope: string): Promise<string>;
        getAccessToken(
            authConfigOrScope: string | AuthConfiguration,
            scope?: string,
        ): Promise<string>;
    }

    Implemented by

    Index

    Properties

    connectionSettings? getAgenticApplicationToken getAgenticInstanceToken getAgenticUserToken

    Methods

    acquireTokenOnBehalfOf getAccessToken

    Properties

    connectionSettings?: AuthConfiguration

    The AuthConfiguration used for token acquisition.

    getAgenticApplicationToken: (
        tenantId: string,
        agentAppInstanceId: string,
    ) => Promise<string>

    Get an access token for the agentic application

    Type Declaration

      • (tenantId: string, agentAppInstanceId: string): Promise<string>

      • Parameters

        • tenantId: string
        • agentAppInstanceId: string

        Returns Promise<string>

        a promise that resolves to the access token.

    getAgenticInstanceToken: (
        tenantId: string,
        agentAppInstanceId: string,
    ) => Promise<string>

    Get an access token for the agentic instance

    Type Declaration

      • (tenantId: string, agentAppInstanceId: string): Promise<string>

      • Parameters

        • tenantId: string
        • agentAppInstanceId: string

        Returns Promise<string>

        a promise that resolves to the access token.

    getAgenticUserToken: (
        tenantId: string,
        agentAppInstanceId: string,
        upn: string,
        scopes: string[],
    ) => Promise<string>

    Get an access token for the agentic user

    Type Declaration

      • (
            tenantId: string,
            agentAppInstanceId: string,
            upn: string,
            scopes: string[],
        ): Promise<string>

      • Parameters

        • tenantId: string
        • agentAppInstanceId: string
        • upn: string
        • scopes: string[]

        Returns Promise<string>

        a promise that resolves to the access token.

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods