Agent Microsoft 365 Publishing

Generate a Microsoft 365 app package

POST /agents/{agent_name}/microsoft365/zip

Generates the Microsoft Teams app package (zip) for a Foundry agent from the supplied publish request, without publishing it. Returns the app package as application/zip.

Path parameters

agent_name string required

The name of the agent to generate the app package for.

Query parameters

api-version string required

The API version to use for this operation.

Request Body

Content-Type: application/json

agentDisplayName string

Display name used as the published Teams app name. When omitted, the agent name from the route is used.

botServiceArmId string

ARM resource id of the Azure Bot Service that fronts this agent in Microsoft Teams. Required for workspaces on the default bot-based Teams backend; optional for workspaces on the API-based backend. Must not be supplied when publishAsAutopilot is true.

publishAsAutopilot boolean

When true, the agent is published as an autopilot (digital worker) agent: the bot id is taken from the agent's blueprint identity and the generated Teams manifest is marked as a digital worker.

accessBoundaries ActivityProtocolAccessBoundary[]

Activity-protocol access boundaries to apply to the agent when publishing as an autopilot agent. An empty list clears the existing boundaries. When omitted, the existing boundaries are left unchanged.

optionalPermissionScopes Microsoft365PermissionScopes[]

Exact selection of delegated permission scopes to grant to the autopilot blueprint. May only be supplied when publishAsAutopilot is true. When omitted or empty, the platform's default permission set is used. Mandatory platform permissions are always granted and are not affected by this value.

publishScope string | enum required

The publish scope for the generated Microsoft Teams app.

Any of the following:

string

enum

PersonalSharedTenant

canRespondWithoutMention boolean

Controls how the published agent responds to Teams messages: when true it responds to all messages on its surfaces, when false only when it is at-mentioned. When omitted, the agent's existing Teams message-notification setting is left unchanged.

appVersion string

App version (for example 1.2.3) written into the Teams manifest. May contain only digits and periods, must not start with 0, and must end with a digit. When omitted, a platform default is used.

shortDescription string

Short, one-line description shown in the Teams app listing.

fullDescription string

Full description shown on the Teams app details page.

developerName string

Display name of the developer / publisher shown in the Teams app listing.

developerWebsiteUrl string

Developer / publisher website URL shown in the Teams app listing. Must be an https URL.

privacyUrl string

termsOfUseUrl string

Terms-of-use URL shown in the Teams app listing.

colorIconBase64 string

Optional base64-encoded PNG used as the color (full-bleed) icon in the Teams app package. Must be a 192x192 PNG (perfect square, no border or rounded corners). Max 1 MB after decode. When omitted, the platform default color icon is used.

outlineIconBase64 string

Optional base64-encoded PNG used as the outline icon in the Teams app package. Must be a 32x32 PNG. Max 1 MB after decode. When omitted, the platform default outline icon is used.

Responses

The generated Microsoft 365 app package (Microsoft Teams app zip).

Body

Content-Type: application/zip