@microsoft/teams-js 2.31.0-beta.1 → 2.31.0-beta.2

package/dist/esm/packages/teams-js/dts/private/externalAppAuthentication.d.ts

@@ -1,378 +1,384 @@
+/**
+ * @hidden
+ * Module to delegate authentication and message extension requests to the host
+ * @internal
+ * Limited to Microsoft-internal use
+ * @module
+ */
 import { ResponseHandler } from '../internal/responseHandler';
 import { ISerializable } from '../public/serializable.interface';
+/*********** BEGIN REQUEST TYPE ************/
 /**
  * @hidden
- * Namespace to delegate authentication and message extension requests to the host
+ * Information about the bot request that should be resent by the host
  * @internal
  * Limited to Microsoft-internal use
  */
-export declare namespace externalAppAuthentication {
-    /*********** BEGIN REQUEST TYPE ************/
-    /**
-     * @hidden
-     * Information about the bot request that should be resent by the host
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    type IOriginalRequestInfo = IQueryMessageExtensionRequest | IActionExecuteInvokeRequest;
-    /**
-     * @hidden
-     * Parameters OauthWindow
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    type OauthWindowProperties = {
-        /**
-         * The preferred width for the pop-up. This value can be ignored if outside the acceptable bounds.
-         */
-        width?: number;
-        /**
-         * The preferred height for the pop-up. This value can be ignored if outside the acceptable bounds.
-         */
-        height?: number;
-        /**
-         * Some identity providers restrict their authentication pages from being displayed in embedded browsers (e.g., a web view inside of a native application)
-         * If the identity provider you are using prevents embedded browser usage, this flag should be set to `true` to enable the authentication page
-         * to be opened in an external browser. If this flag is `false`, the page will be opened directly within the current hosting application.
-         *
-         * This flag is ignored when the host for the application is a web app (as opposed to a native application) as the behavior is unnecessary in a web-only
-         * environment without an embedded browser.
-         */
-        isExternal?: boolean;
-    };
-    /**
-     * @hidden
-     * Parameters for the authentication pop-up. This interface is used exclusively with the externalAppAuthentication APIs
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    type AuthenticatePopUpParameters = {
-        /**
-         * The URL for the authentication pop-up.
-         */
-        url: URL;
-        /**
-         * The preferred width for the pop-up. This value can be ignored if outside the acceptable bounds.
-         */
-        width?: number;
-        /**
-         * The preferred height for the pop-up. This value can be ignored if outside the acceptable bounds.
-         */
-        height?: number;
-        /**
-         * Some identity providers restrict their authentication pages from being displayed in embedded browsers (e.g., a web view inside of a native application)
-         * If the identity provider you are using prevents embedded browser usage, this flag should be set to `true` to enable the authentication page specified in
-         * the {@link url} property to be opened in an external browser.
-         * If this flag is `false`, the page will be opened directly within the current hosting application.
-         *
-         * This flag is ignored when the host for the application is a web app (as opposed to a native application) as the behavior is unnecessary in a web-only
-         * environment without an embedded browser.
-         */
-        isExternal?: boolean;
-    };
-    /**
-     * @hidden
-     * Parameters for SSO authentication. This interface is used exclusively with the externalAppAuthentication APIs
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    type AuthTokenRequestParameters = {
-        /**
-         * An optional list of claims which to pass to Microsoft Entra when requesting the access token.
-         */
-        claims?: string[];
-        /**
-         * An optional flag indicating whether to attempt the token acquisition silently or allow a prompt to be shown.
-         */
-        silent?: boolean;
-    };
-    /**
-     * @hidden
-     * Information about the message extension request that should be resent by the host. Corresponds to request schema in https://learn.microsoft.com/microsoftteams/platform/resources/messaging-extension-v3/search-extensions#receive-user-requests
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    interface IQueryMessageExtensionRequest {
-        requestType: OriginalRequestType.QueryMessageExtensionRequest;
-        commandId: string;
-        parameters: {
-            name: string;
-            value: string;
-        }[];
-        queryOptions?: {
-            count: number;
-            skip: number;
-        };
-    }
-    /**
-     * @hidden
-     * Information about the Action.Execute request that should be resent by the host. Corresponds to schema in https://adaptivecards.io/explorer/Action.Execute.html
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    interface IActionExecuteInvokeRequest {
-        requestType: OriginalRequestType.ActionExecuteInvokeRequest;
-        type: string;
-        id: string;
-        verb: string;
-        data: string | Record<string, unknown>;
-    }
-    /**
-     * @hidden
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    class SerializableActionExecuteInvokeRequest implements ISerializable {
-        private invokeRequest;
-        constructor(invokeRequest: externalAppAuthentication.IActionExecuteInvokeRequest);
-        serialize(): object | string;
-    }
-    /**
-     * @beta
-     * @hidden
-     * Determines if the provided response object is an instance of IActionExecuteResponse
-     * @internal
-     * Limited to Microsoft-internal use
-     * @param response The object to check whether it is of IActionExecuteResponse type
-     */
-    function isActionExecuteResponse(response: unknown): response is externalAppAuthentication.IActionExecuteResponse;
-    /**
-     * @hidden
-     * This is the only allowed value for IActionExecuteInvokeRequest.type. Used for validation
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    const ActionExecuteInvokeRequestType = "Action.Execute";
-    /**
-     * @hidden
-     * Used to differentiate between IOriginalRequestInfo types
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    enum OriginalRequestType {
-        ActionExecuteInvokeRequest = "ActionExecuteInvokeRequest",
-        QueryMessageExtensionRequest = "QueryMessageExtensionRequest"
-    }
-    /*********** END REQUEST TYPE ************/
-    /*********** BEGIN RESPONSE TYPE ************/
-    /**
-     * @hidden
-     * The response from the bot returned via the host
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    type IInvokeResponse = IQueryMessageExtensionResponse | IActionExecuteResponse;
-    /**
-     * @hidden
-     * Used to differentiate between IInvokeResponse types
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    enum InvokeResponseType {
-        ActionExecuteInvokeResponse = "ActionExecuteInvokeResponse",
-        QueryMessageExtensionResponse = "QueryMessageExtensionResponse"
-    }
-    /**
-     * @hidden
-     * The response from the bot returned via the host for a message extension query request.
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    interface IQueryMessageExtensionResponse {
-        responseType: InvokeResponseType.QueryMessageExtensionResponse;
-        composeExtension?: ComposeExtensionResponse;
-    }
-    /**
-     * @hidden
-     * The response from the bot returned via the host for an Action.Execute request.
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    interface IActionExecuteResponse {
-        responseType: InvokeResponseType.ActionExecuteInvokeResponse;
-        value: Record<string, unknown>;
-        signature?: string;
-        statusCode: number;
-        type: string;
-    }
+export type IOriginalRequestInfo = IQueryMessageExtensionRequest | IActionExecuteInvokeRequest;
+/**
+ * @hidden
+ * Parameters OauthWindow
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export type OauthWindowProperties = {
     /**
-     * @hidden
-     * @internal
-     * Limited to Microsoft-internal use
+     * The preferred width for the pop-up. This value can be ignored if outside the acceptable bounds.
      */
-    class ActionExecuteResponseHandler extends ResponseHandler<IActionExecuteResponse, IActionExecuteResponse> {
-        validate(response: externalAppAuthentication.IActionExecuteResponse): boolean;
-        deserialize(response: externalAppAuthentication.IActionExecuteResponse): externalAppAuthentication.IActionExecuteResponse;
-    }
+    width?: number;
     /**
-     * @hidden
-     * The compose extension response returned for a message extension query request. `suggestedActions` will be present only when the type is is 'config' or 'auth'.
-     * @internal
-     * Limited to Microsoft-internal use
+     * The preferred height for the pop-up. This value can be ignored if outside the acceptable bounds.
      */
-    type ComposeExtensionResponse = {
-        attachmentLayout: AttachmentLayout;
-        type: ComposeResultTypes;
-        attachments?: QueryMessageExtensionAttachment[];
-        suggestedActions?: QueryMessageExtensionSuggestedActions;
-        text?: string;
-    };
+    height?: number;
     /**
-     * @hidden
+     * Some identity providers restrict their authentication pages from being displayed in embedded browsers (e.g., a web view inside of a native application)
+     * If the identity provider you are using prevents embedded browser usage, this flag should be set to `true` to enable the authentication page
+     * to be opened in an external browser. If this flag is `false`, the page will be opened directly within the current hosting application.
      *
-     * @internal
-     * Limited to Microsoft-internal use
+     * This flag is ignored when the host for the application is a web app (as opposed to a native application) as the behavior is unnecessary in a web-only
+     * environment without an embedded browser.
      */
-    type QueryMessageExtensionSuggestedActions = {
-        actions: Action[];
-    };
-    /**
-     * @hidden
-     *
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    type Action = {
-        type: string;
-        title: string;
-        value: string;
-    };
+    isExternal?: boolean;
+};
+/**
+ * @hidden
+ * Parameters for the authentication pop-up. This interface is used exclusively with the externalAppAuthentication APIs
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export type AuthenticatePopUpParameters = {
     /**
-     * @hidden
-     *
-     * @internal
-     * Limited to Microsoft-internal use
+     * The URL for the authentication pop-up.
      */
-    type QueryMessageExtensionCard = {
-        contentType: string;
-        content: Record<string, unknown>;
-        fallbackHtml?: string;
-        signature?: string;
-    };
+    url: URL;
     /**
-     * @hidden
-     *
-     * @internal
-     * Limited to Microsoft-internal use
+     * The preferred width for the pop-up. This value can be ignored if outside the acceptable bounds.
      */
-    type QueryMessageExtensionAttachment = QueryMessageExtensionCard & {
-        preview?: QueryMessageExtensionCard;
-    };
+    width?: number;
     /**
-     * @hidden
-     *
-     * @internal
-     * Limited to Microsoft-internal use
+     * The preferred height for the pop-up. This value can be ignored if outside the acceptable bounds.
      */
-    type AttachmentLayout = 'grid' | 'list';
+    height?: number;
     /**
-     * @hidden
+     * Some identity providers restrict their authentication pages from being displayed in embedded browsers (e.g., a web view inside of a native application)
+     * If the identity provider you are using prevents embedded browser usage, this flag should be set to `true` to enable the authentication page specified in
+     * the {@link url} property to be opened in an external browser.
+     * If this flag is `false`, the page will be opened directly within the current hosting application.
      *
-     * @internal
-     * Limited to Microsoft-internal use
+     * This flag is ignored when the host for the application is a web app (as opposed to a native application) as the behavior is unnecessary in a web-only
+     * environment without an embedded browser.
      */
-    type ComposeResultTypes = 'auth' | 'config' | 'message' | 'result' | 'silentAuth';
-    /*********** END RESPONSE TYPE ************/
-    /*********** BEGIN ERROR TYPE ***********/
-    interface InvokeError {
-        errorCode: InvokeErrorCode;
-        message?: string;
-    }
-    /**
-     * @beta
-     * @hidden
-     * Determines if the provided error object is an instance of InvokeError
-     * @internal
-     * Limited to Microsoft-internal use
-     * @param err The error object to check whether it is of InvokeError type
-     */
-    function isInvokeError(err: unknown): err is externalAppAuthentication.InvokeError;
+    isExternal?: boolean;
+};
+/**
+ * @hidden
+ * Parameters for SSO authentication. This interface is used exclusively with the externalAppAuthentication APIs
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export type AuthTokenRequestParameters = {
     /**
-     * @hidden
-     *
-     * @internal
-     * Limited to Microsoft-internal use
+     * An optional list of claims which to pass to Microsoft Entra when requesting the access token.
      */
-    enum InvokeErrorCode {
-        INTERNAL_ERROR = "INTERNAL_ERROR"
-    }
+    claims?: string[];
     /**
-     * @hidden
-     * Wrapper to differentiate between InvokeError and IInvokeResponse response from host
-     * @internal
-     * Limited to Microsoft-internal use
+     * An optional flag indicating whether to attempt the token acquisition silently or allow a prompt to be shown.
      */
-    type InvokeErrorWrapper = InvokeError & {
-        responseType: undefined;
+    silent?: boolean;
+};
+/**
+ * @hidden
+ * Information about the message extension request that should be resent by the host. Corresponds to request schema in https://learn.microsoft.com/microsoftteams/platform/resources/messaging-extension-v3/search-extensions#receive-user-requests
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface IQueryMessageExtensionRequest {
+    requestType: OriginalRequestType.QueryMessageExtensionRequest;
+    commandId: string;
+    parameters: {
+        name: string;
+        value: string;
+    }[];
+    queryOptions?: {
+        count: number;
+        skip: number;
     };
-    /**
-     * @beta
-     * @hidden
-     * Signals to the host to perform authentication using the given authentication parameters and then resend the request to the application specified by the app ID with the authentication result.
-     * @internal
-     * Limited to Microsoft-internal use
-     * @param appId ID of the application backend to which the request and authentication response should be sent. This must be a UUID
-     * @param authenticateParameters Parameters for the authentication pop-up
-     * @param originalRequestInfo Information about the original request that should be resent
-     * @returns A promise that resolves to the IInvokeResponse from the application backend and rejects with InvokeError if the host encounters an error while authenticating or resending the request
-     */
-    function authenticateAndResendRequest(appId: string, authenticateParameters: AuthenticatePopUpParameters, originalRequestInfo: IOriginalRequestInfo): Promise<IInvokeResponse>;
-    /**
-     * @beta
-     * @hidden
-     * Signals to the host to perform SSO authentication for the application specified by the app ID
-     * @internal
-     * Limited to Microsoft-internal use
-     * @param appId ID of the application backend for which the host should attempt SSO authentication. This must be a UUID
-     * @param authTokenRequest Parameters for SSO authentication
-     * @returns A promise that resolves when authentication and succeeds and rejects with InvokeError on failure
-     */
-    function authenticateWithSSO(appId: string, authTokenRequest: AuthTokenRequestParameters): Promise<void>;
-    /**
-     * @beta
-     * @hidden
-     * Signals to the host to perform SSO authentication for the application specified by the app ID and then resend the request to the application backend with the authentication result
-     * @internal
-     * Limited to Microsoft-internal use
-     * @param appId ID of the application backend for which the host should attempt SSO authentication and resend the request and authentication response. This must be a UUID.
-     * @param authTokenRequest Parameters for SSO authentication
-     * @param originalRequestInfo Information about the original request that should be resent
-     * @returns A promise that resolves to the IInvokeResponse from the application backend and rejects with InvokeError if the host encounters an error while authenticating or resending the request
-     */
-    function authenticateWithSSOAndResendRequest(appId: string, authTokenRequest: AuthTokenRequestParameters, originalRequestInfo: IOriginalRequestInfo): Promise<IInvokeResponse>;
-    /**
-     * @beta
-     * @hidden
-     * Signals to the host to perform Oauth2 authentication for the application specified by the title ID
-     * @internal
-     * Limited to Microsoft-internal use
-     * @param titleId ID of the acquisition
-     * @param oauthConfigId lookup ID in token store
-     * @param oauthWindowParameters parameters for the signIn window
-     * @returns A promise that resolves when authentication succeeds and rejects with InvokeError on failure
-     */
-    function authenticateWithOauth2(titleId: string, oauthConfigId: string, oauthWindowParameters: OauthWindowProperties): Promise<void>;
-    /**
-     * @beta
-     * @hidden
-     * API to authenticate power platform connector plugins
-     * @internal
-     * Limited to Microsoft-internal use
-     * @param titleId ID of the acquisition
-     * @param signInUrl signInUrl for the connctor page listing the connector. This is optional
-     * @param oauthWindowParameters parameters for the signIn window
-     * @returns A promise that resolves when authentication succeeds and rejects with InvokeError on failure
-     */
-    function authenticateWithPowerPlatformConnectorPlugins(titleId: string, signInUrl?: URL, oauthWindowParameters?: OauthWindowProperties): Promise<void>;
-    /**
-     * @hidden
-     * Checks if the externalAppAuthentication capability is supported by the host
-     * @returns boolean to represent whether externalAppAuthentication capability is supported
-     *
-     * @throws Error if {@linkcode app.initialize} has not successfully completed
-     *
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    function isSupported(): boolean;
 }
+/**
+ * @hidden
+ * Information about the Action.Execute request that should be resent by the host. Corresponds to schema in https://adaptivecards.io/explorer/Action.Execute.html
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface IActionExecuteInvokeRequest {
+    requestType: OriginalRequestType.ActionExecuteInvokeRequest;
+    type: string;
+    id: string;
+    verb: string;
+    data: string | Record<string, unknown>;
+}
+/**
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare class SerializableActionExecuteInvokeRequest implements ISerializable {
+    private invokeRequest;
+    constructor(invokeRequest: IActionExecuteInvokeRequest);
+    serialize(): object | string;
+}
+/**
+ * @beta
+ * @hidden
+ * Determines if the provided response object is an instance of IActionExecuteResponse
+ * @internal
+ * Limited to Microsoft-internal use
+ * @param response The object to check whether it is of IActionExecuteResponse type
+ */
+export declare function isActionExecuteResponse(response: unknown): response is IActionExecuteResponse;
+/**
+ * @hidden
+ * This is the only allowed value for IActionExecuteInvokeRequest.type. Used for validation
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare const ActionExecuteInvokeRequestType = "Action.Execute";
+/**
+ * @hidden
+ * Used to differentiate between IOriginalRequestInfo types
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare enum OriginalRequestType {
+    ActionExecuteInvokeRequest = "ActionExecuteInvokeRequest",
+    QueryMessageExtensionRequest = "QueryMessageExtensionRequest"
+}
+/*********** END REQUEST TYPE ************/
+/*********** BEGIN RESPONSE TYPE ************/
+/**
+ * @hidden
+ * The response from the bot returned via the host
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export type IInvokeResponse = IQueryMessageExtensionResponse | IActionExecuteResponse;
+/**
+ * @hidden
+ * Used to differentiate between IInvokeResponse types
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare enum InvokeResponseType {
+    ActionExecuteInvokeResponse = "ActionExecuteInvokeResponse",
+    QueryMessageExtensionResponse = "QueryMessageExtensionResponse"
+}
+/**
+ * @hidden
+ * The response from the bot returned via the host for a message extension query request.
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface IQueryMessageExtensionResponse {
+    responseType: InvokeResponseType.QueryMessageExtensionResponse;
+    composeExtension?: ComposeExtensionResponse;
+}
+/**
+ * @hidden
+ * The response from the bot returned via the host for an Action.Execute request.
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface IActionExecuteResponse {
+    responseType: InvokeResponseType.ActionExecuteInvokeResponse;
+    value: Record<string, unknown>;
+    signature?: string;
+    statusCode: number;
+    type: string;
+}
+/**
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare class ActionExecuteResponseHandler extends ResponseHandler<IActionExecuteResponse, IActionExecuteResponse> {
+    validate(response: IActionExecuteResponse): boolean;
+    deserialize(response: IActionExecuteResponse): IActionExecuteResponse;
+}
+/**
+ * @hidden
+ * The compose extension response returned for a message extension query request. `suggestedActions` will be present only when the type is is 'config' or 'auth'.
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export type ComposeExtensionResponse = {
+    attachmentLayout: AttachmentLayout;
+    type: ComposeResultTypes;
+    attachments?: QueryMessageExtensionAttachment[];
+    suggestedActions?: QueryMessageExtensionSuggestedActions;
+    text?: string;
+};
+/**
+ * @hidden
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export type QueryMessageExtensionSuggestedActions = {
+    actions: Action[];
+};
+/**
+ * @hidden
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export type Action = {
+    type: string;
+    title: string;
+    value: string;
+};
+/**
+ * @hidden
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export type QueryMessageExtensionCard = {
+    contentType: string;
+    content: Record<string, unknown>;
+    fallbackHtml?: string;
+    signature?: string;
+};
+/**
+ * @hidden
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export type QueryMessageExtensionAttachment = QueryMessageExtensionCard & {
+    preview?: QueryMessageExtensionCard;
+};
+/**
+ * @hidden
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export type AttachmentLayout = 'grid' | 'list';
+/**
+ * @hidden
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export type ComposeResultTypes = 'auth' | 'config' | 'message' | 'result' | 'silentAuth';
+/*********** END RESPONSE TYPE ************/
+/*********** BEGIN ERROR TYPE ***********/
+export interface InvokeError {
+    errorCode: InvokeErrorCode;
+    message?: string;
+}
+/**
+ * @beta
+ * @hidden
+ * Determines if the provided error object is an instance of InvokeError
+ * @internal
+ * Limited to Microsoft-internal use
+ * @param err The error object to check whether it is of InvokeError type
+ */
+export declare function isInvokeError(err: unknown): err is InvokeError;
+/**
+ * @hidden
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare enum InvokeErrorCode {
+    INTERNAL_ERROR = "INTERNAL_ERROR"
+}
+/**
+ * @hidden
+ * Wrapper to differentiate between InvokeError and IInvokeResponse response from host
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export type InvokeErrorWrapper = InvokeError & {
+    responseType: undefined;
+};
+/**
+ * @beta
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function validateActionExecuteInvokeRequest(actionExecuteRequest: IActionExecuteInvokeRequest): void;
+/**
+ * @beta
+ * @hidden
+ * Signals to the host to perform authentication using the given authentication parameters and then resend the request to the application specified by the app ID with the authentication result.
+ * @internal
+ * Limited to Microsoft-internal use
+ * @param appId ID of the application backend to which the request and authentication response should be sent. This must be a UUID
+ * @param authenticateParameters Parameters for the authentication pop-up
+ * @param originalRequestInfo Information about the original request that should be resent
+ * @returns A promise that resolves to the IInvokeResponse from the application backend and rejects with InvokeError if the host encounters an error while authenticating or resending the request
+ */
+export declare function authenticateAndResendRequest(appId: string, authenticateParameters: AuthenticatePopUpParameters, originalRequestInfo: IOriginalRequestInfo): Promise<IInvokeResponse>;
+/**
+ * @beta
+ * @hidden
+ * Signals to the host to perform SSO authentication for the application specified by the app ID
+ * @internal
+ * Limited to Microsoft-internal use
+ * @param appId ID of the application backend for which the host should attempt SSO authentication. This must be a UUID
+ * @param authTokenRequest Parameters for SSO authentication
+ * @returns A promise that resolves when authentication and succeeds and rejects with InvokeError on failure
+ */
+export declare function authenticateWithSSO(appId: string, authTokenRequest: AuthTokenRequestParameters): Promise<void>;
+/**
+ * @beta
+ * @hidden
+ * Signals to the host to perform SSO authentication for the application specified by the app ID and then resend the request to the application backend with the authentication result
+ * @internal
+ * Limited to Microsoft-internal use
+ * @param appId ID of the application backend for which the host should attempt SSO authentication and resend the request and authentication response. This must be a UUID.
+ * @param authTokenRequest Parameters for SSO authentication
+ * @param originalRequestInfo Information about the original request that should be resent
+ * @returns A promise that resolves to the IInvokeResponse from the application backend and rejects with InvokeError if the host encounters an error while authenticating or resending the request
+ */
+export declare function authenticateWithSSOAndResendRequest(appId: string, authTokenRequest: AuthTokenRequestParameters, originalRequestInfo: IOriginalRequestInfo): Promise<IInvokeResponse>;
+/**
+ * @beta
+ * @hidden
+ * Signals to the host to perform Oauth2 authentication for the application specified by the title ID
+ * @internal
+ * Limited to Microsoft-internal use
+ * @param titleId ID of the acquisition
+ * @param oauthConfigId lookup ID in token store
+ * @param oauthWindowParameters parameters for the signIn window
+ * @returns A promise that resolves when authentication succeeds and rejects with InvokeError on failure
+ */
+export declare function authenticateWithOauth2(titleId: string, oauthConfigId: string, oauthWindowParameters: OauthWindowProperties): Promise<void>;
+/**
+ * @beta
+ * @hidden
+ * API to authenticate power platform connector plugins
+ * @internal
+ * Limited to Microsoft-internal use
+ * @param titleId ID of the acquisition
+ * @param signInUrl signInUrl for the connctor page listing the connector. This is optional
+ * @param oauthWindowParameters parameters for the signIn window
+ * @returns A promise that resolves when authentication succeeds and rejects with InvokeError on failure
+ */
+export declare function authenticateWithPowerPlatformConnectorPlugins(titleId: string, signInUrl?: URL, oauthWindowParameters?: OauthWindowProperties): Promise<void>;
+/**
+ * @hidden
+ * Checks if the externalAppAuthentication capability is supported by the host
+ * @returns boolean to represent whether externalAppAuthentication capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function isSupported(): boolean;