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 Office client applications that support that requirement set, and the build or version numbers for the Office application.

Requirement set Office 2021 or later on Windows
(one-time purchase)
Office on Windows
(connected to a Microsoft 365 subscription)
Office on iPad
(connected to a Microsoft 365 subscription)
Office on Mac
(connected to a Microsoft 365 subscription)
Office on the web
IdentityAPI 1.3 Build 16.0.14326.20454 or later 2008 (build 13127.20000) or later Not supported 16.40 or later Microsoft SharePoint Online and OneDrive*

* Currently, the requirement set is supported in Office on the web only for documents that are opened from Microsoft SharePoint Online and OneDrive.


Outlook: To require the Identity API set 1.3 in your 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.

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.

IdentityAPI Preview

For details about this API, see either the version that uses Promises at getAccessToken or the version that uses callbacks at getAccessTokenAsync.

See also