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

Requirement set Office 2013 or later on Windows
(one-time purchase)
Office on Windows
(connected to Office 365 subscription)
Office on iPad
(connected to Office 365 subscription)
Office on Mac
(connected to Office 365 subscription)
Office on the web SharePoint Online OneDrive.com Outlook.com & Exchange Online
IdentityAPI Preview N/A Preview* Coming soon Preview* Preview*† Preview*† Coming soon Coming soon

* During the preview phase, the Identity API requires Office 365 (the subscription version of Office). You should use the latest monthly version and build from the Insiders channel. You need to be an Office Insider to get this version. For more information, see Be an Office Insider. Please note that when a build graduates to the production semi-annual channel, support for preview features, including SSO, is turned off for that build.

Add-ins that use the SSO APIs on these platforms will only work if the user's tenant administrator has granted consent to the add-in. The user cannot grant consent even to their own Azure AD profile.

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