@microsoft/teams.api/dist/auth/cloud-environment.d.mts

<p> <a href="https://www.npmjs.com/package/@microsoft/teams.api" target="_blank"> <img src="https://img.shields.io/npm/v/@microsoft/teams.api/latest" /> </a> <a href="https://www.npmjs.com/package/@microsoft/teams.api?activeTab=code" t

/**
 * Bundles all cloud-specific service endpoints for a given Azure environment.
 * Use predefined instances (PUBLIC, US_GOV, US_GOV_DOD, CHINA)
 * or construct a custom one via withOverrides().
 */
type CloudEnvironment = {
    /** The Azure AD login endpoint (e.g. "https://login.microsoftonline.com") */
    readonly loginEndpoint: string;
    /** The default multi-tenant login tenant (e.g. "botframework.com") */
    readonly loginTenant: string;
    /** The Bot Framework OAuth scope (e.g. "https://api.botframework.com/.default") */
    readonly botScope: string;
    /** The Bot Framework token service base URL (e.g. "https://token.botframework.com") */
    readonly tokenServiceUrl: string;
    /** The OpenID metadata URL for token validation */
    readonly openIdMetadataUrl: string;
    /** The token issuer for Bot Framework tokens (e.g. "https://api.botframework.com") */
    readonly tokenIssuer: string;
    /** The Microsoft Graph token scope (e.g. "https://graph.microsoft.com/.default") */
    readonly graphScope: string;
    /** The AgenticIdentity Bot API token scope. */
    readonly agenticIdentityBotScope: string;
};
/** Microsoft public (commercial) cloud. */
declare const PUBLIC: CloudEnvironment;
/** US Government Community Cloud High (GCCH). */
declare const US_GOV: CloudEnvironment;
/** US Government Department of Defense (DoD). */
declare const US_GOV_DOD: CloudEnvironment;
/** China cloud (21Vianet). */
declare const CHINA: CloudEnvironment;
/**
 * Creates a new CloudEnvironment by applying non-null overrides on top of a base.
 * Returns the base instance if no override values differ.
 */
declare function withOverrides(base: CloudEnvironment, overrides: Partial<CloudEnvironment>): CloudEnvironment;
/**
 * Resolves a cloud environment name (case-insensitive) to its corresponding instance.
 * Valid names: "Public", "USGov", "USGovDoD", "China".
 */
declare function cloudFromName(name: string): CloudEnvironment;

export { CHINA, type CloudEnvironment, PUBLIC, US_GOV, US_GOV_DOD, cloudFromName, withOverrides };