Introduction

This guide provides information about the implementation, authentication, and application programming interfaces available to extend OneStream functionality. 

OneStream Web API is a RESTful web service designed to expose OneStream Data Automation functions when interacting with third-party API client applications.

For customers in a self-hosted environment, Web API must be installed on a web server and configured for external authentication providers supporting OAuth2.0/OpenID Connect authorization protocol. Identity providers currently supported are Azure AD, Okta, and PingFederate.

All customers in a OneStream-hosted environment using authentication with OneStream IdentityServer, including those using native authentication and any OIDC or SAML 2.0 compliant external identity providers, can use personal access tokens (PATs) to access OneStream REST API. See the Identity and Access Management Guide for information about authentication with OneStream IdentityServer and using PATs.

OneStream Web API is API client agnostic. It accepts and outputs data in JSON format making it possible for every API client application that supports this format to also interact with the service.