Skip to content

Commit ad9804b

Browse files
authored
Merge pull request #5473 from OfficeDev/copilot-auth-property
[All Hosts] (copilot) the 'auth' property is really required now
2 parents a505e66 + dc1f3c0 commit ad9804b

File tree

4 files changed

+18
-15
lines changed

4 files changed

+18
-15
lines changed

docs/design/agent-and-add-in-overview.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Combine Copilot Agents with Office Add-ins (preview)
33
description: Get an overview of why and how to combine a Copilot agent with an Office Add-in.
4-
ms.date: 10/17/2025
4+
ms.date: 11/11/2025
55
ms.topic: overview
66
ms.localizationpriority: medium
77
---
@@ -141,8 +141,6 @@ The agent configuration file includes instructions for the agent and specifies o
141141
}
142142
```
143143

144-
[!INCLUDE [Validation warning about missing 'auth' property](../includes/auth-property-warning-note.md)]
145-
146144
The reference documentation for declarative agents is at [Declarative agent schema 1.5 for Microsoft 365 Copilot](/microsoft-365-copilot/extensibility/declarative-agent-manifest-1.5).
147145

148146
### Copilot API plug-in configuration
@@ -154,7 +152,8 @@ The API plug-in configuration file specifies the "functions" of the plug-in in t
154152
- The `"responding.instructions"` property only provides *guidance* to Copilot about how to respond. It doesn't put any limits or structural requirements on the response.
155153
- The `"runtimes.run_for_functions"` array must include either the same string as `"functions.name"` or a wildcard string that matches it.
156154
- The `"runtimes.spec.local_endpoint"` property specifies that the JavaScript function that is associated with the "fillcolor" string is available in an Office Add-in, rather than in some REST endpoint.
157-
-The `"runtimes.spec.allowed_host"` property specifies that the agent should only be visible in Excel.
155+
- The `"runtimes.spec.allowed_host"` property specifies that the agent should only be visible in Excel.
156+
- The `"runtimes.auth.type"` property is always "None" for Office Add-in agents.
158157

159158
```json
160159
{
@@ -206,7 +205,10 @@ The API plug-in configuration file specifies the "functions" of the plug-in in t
206205
"local_endpoint": "Microsoft.Office.Addin",
207206
"allowed_host": ["workbook"]
208207
},
209-
"run_for_functions": ["fillcolor"]
208+
"run_for_functions": ["fillcolor"],
209+
"auth": {
210+
"type": "None"
211+
}
210212
}
211213
]
212214
}

docs/develop/agent-and-add-in.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Add a Copilot agent to an add-in
33
description: Learn how to add a Copilot agent to an add-in.
4-
ms.date: 10/17/2025
4+
ms.date: 11/11/2025
55
ms.topic: how-to
66
ms.service: microsoft-365
77
ms.localizationpriority: medium
@@ -191,8 +191,6 @@ The runtime object should look similar to the following. There may be other prop
191191
}
192192
```
193193

194-
[!INCLUDE [Validation warning about missing 'auth' property](../includes/auth-property-warning-note.md)]
195-
196194
1. *Replace the property values with new values that are appropriate for your add-in.* For more information about these properties, see [Declarative agent manifest object](/microsoft-365-copilot/extensibility/declarative-agent-manifest-1.2#declarative-agent-manifest-object).
197195

198196
> [!NOTE]
@@ -251,7 +249,10 @@ The runtime object should look similar to the following. There may be other prop
251249
"local_endpoint": "Microsoft.Office.Addin",
252250
"allowed_host": ["workbook"]
253251
},
254-
"run_for_functions": ["FillColor"]
252+
"run_for_functions": ["FillColor"],
253+
"auth": {
254+
"type": "None"
255+
}
255256
}
256257
]
257258
}
@@ -270,6 +271,7 @@ The runtime object should look similar to the following. There may be other prop
270271
- The `"runtimes.run_for_functions"` array must include either the same string as `"functions.name"` or a wildcard string that matches it.
271272
- The `"reasoning.description"` and `"reasoning.instructions"` refer to a JavaScript function, not a REST API.
272273
- The `"runtimes.spec.local_endpoint"` property tells the Copilot agent to look for functions in an Office Add-in instead of at a REST service URL.
274+
- The `"runtimes.auth.type"` property is always "None" for Office Add-in agents.
273275

274276
### Create the app package
275277

docs/includes/auth-property-warning-note.md

Lines changed: 0 additions & 2 deletions
This file was deleted.

docs/quickstarts/agent-and-add-in-quickstart.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Build your first add-in as a Copilot skill
33
description: Learn how to build a simple Copilot agent that has an Excel add-in as a skill.
4-
ms.date: 10/23/2025
4+
ms.date: 11/11/2025
55
ms.topic: how-to
66
ms.service: microsoft-365
77
ms.localizationpriority: high
@@ -160,14 +160,15 @@ Add the agent with the following steps.
160160
"local_endpoint": "Microsoft.Office.Addin",
161161
"allowed_host": ["workbook"]
162162
},
163-
"run_for_functions": ["fillcolor"]
163+
"run_for_functions": ["fillcolor"],
164+
"auth": {
165+
"type": "None"
166+
}
164167
}
165168
]
166169
}
167170
```
168171

169-
[!INCLUDE [Validation warning about missing 'auth' property](../includes/auth-property-warning-note.md)]
170-
171172
1. Open the **\src\commands\commands.ts** file and add the following code the end of it.
172173

173174
```javascript

0 commit comments

Comments
 (0)