Identity API requirement sets
Requirement sets are named groups of API members. Office Add-ins use requirement sets specified in the manifest or use a runtime check to determine whether an Office application supports APIs that an add-in needs. For more information, see Office versions and requirement sets.
Office Add-ins run across multiple versions of Office. The following table lists the Identity API requirement sets, the supported Office client applications, and the minimum builds or versions for those applications where applicable.
| Requirement set | Office on the web | Office on Windows
|
Office on Windows
|
Office on Mac | Office on iOS | Outlook on Android |
|---|---|---|---|---|---|---|
| IdentityAPI 1.3 | Microsoft SharePoint Online and OneDrive* | Version 2008 (Build 13127.20000) | Office 2021: Version 2108 (Build 14326.20454) | Version 16.40 (20081000) | Not supported | Not supported |
* Currently, the IdentityAPI 1.3 requirement set is supported in Office on the web only for documents that are opened from Microsoft SharePoint Online and OneDrive.
Important
- In Outlook, the Identity API requirement set isn't supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
Outlook and Identity API requirement sets
To require the Identity API set 1.3 in your Outlook add-in code, check if it's supported by calling isSetSupported('IdentityAPI', '1.3'). Declaring it in the Outlook add-in's manifest isn't supported. You can also determine if the API is supported by checking that it's not undefined. For further details, see Using APIs from later requirement sets.
Note
- IdentityAPI 1.3 isn't supported in Outlook on Android or on iOS.
- In an Outlook add-in using event-based activation, the OfficeRuntime.Auth interface is supported in Outlook from Version 2108 (Build 14326.20258) on Windows. The Office.Auth interface is supported from Version 2111 (Build 14701.20000). For more details according to your version, see the update history page for Office 2021 or Microsoft 365 and how to find your Office client version and update channel.
Office versions and build numbers
To find out more about versions and build numbers, see:
- Version and build numbers of update channel releases for Microsoft 365 clients
- What version of Office am I using?
Office Common API requirement sets
For information about Common API requirement sets, see Office Common API requirement sets.
See also
Office Add-ins