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 Windows
- Microsoft 365 subscription
- retail perpetual Office 2016 and later
Office on Windows
(volume-licensed perpetual)
Office on Mac Office on iPad Office on the web
IdentityAPI 1.3 Version 2008 (Build 13127.20000) Office 2021: Version 2108 (Build 14326.20454) 16.40 Not supported Microsoft SharePoint Online and OneDrive*

* 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

Office versions and build numbers

To find out more about versions, build numbers, and Office Online Server, see:

Office Common API requirement sets

For information about Common API requirement sets, see Office Common API requirement sets.

See also