The OneNote REST API now supports application-level permissions

The OneNote API team is pleased to announce that we have enabled application-level permissions support for the OneNote API. Until now, OneNote API calls could only be made with user-delegated permissions. This meant that your application would be restricted to scenarios that required a user to be signed in. With application-level permissions support, your application now supports scenarios that do not require a user to be signed in! Read the MSDN article for details of the OneNote API application-level permissions support.

With the availability of OneNote API application-level permissions support, many new scenarios that weren’t possible earlier are now enabled. Some example scenarios include:

  • Analytics (based on OneNote metadata and content exposed by the OneNote API).
  • Dashboards (based on OneNote metadata and content exposed by the OneNote API).
  • Background provisioning of OneNote content.
  • Background update of OneNote content.

During the development process of building the new application-level permissions support for OneNote API, our Product Management and Engineering teams worked closely with third-party partners to ensure that relevant and key education scenarios were implemented. We also ensured that our API would work well with new and upcoming third-party solutions. One of these education companies we worked closely with during the API development was Hapara.

The Hapara Dashboard provides educators with a bird’s-eye view into student work across the Office 365 platform. With Dashboard, educators view and access student work from OneDrive and OneNote Class Notebooks from a central hub, making it easier to engage with students and their work across the Office 365 platform. Hapara relies on the new OneNote API to help co-teachers, counselors, coaches and school administrators gain appropriate access to student work in any classroom, something that previously required manual sharing and significant administrative effort by the individual teachers. Now, cross-school teams gain the same level of access and visibility into Class Notebooks via the Hapara Dashboard as teachers get via the OneNote Class Notebook app. This allows all to participate in serving students, while reducing the administrative burden on the teachers.”
—Nara Chilluvuri, product manager at Hapara

With the availability of application-level permissions support for OneNote API, solution providers, ISVs and IT admins can access important usage data about OneNote across a tenant, including:

  • Teacher usage of Class Notebooks.
  • Student usage of Class Notebooks.
  • Information about specific pages, sections or notebooks.
  • How many pages were touched and last time each page was touched.
  • Information about the Collaboration Space usage in the Class Notebook.
  • Information about OneNote Page content, including paragraphs, tables, images and attachments.

Creating a new application or updating your existing application to use the new application-level permissions support for OneNote API requires just a couple of additional (relative to using user-delegated permissions) steps. For step-by-step instructions, see the detailed OneNote app-only API documentation on MSDN.

—The OneNote team