Authentication Guide
Adobe is committed to the privacy and security of our users and their data. The first step in accessing the Frame.io API is authentication. The Frame.io V4 API supports multiple authentication types depending on your use case. For Frame.io via our integration with Adobe Business Platform (ABP) and Identity Management Service (IMS), there are authentication types for several use cases.
This allows technical or service user accounts to take action. S2S Authentication is only available to Frame.io V4 accounts administered via the Adobe Admin Console.
This functions as the user whose token it is. User Authentication is available to all Frame.io V4 accounts administered via the Adobe Admin Console, as well as Frame-managed accounts that have switched to Adobe Authentication.
User Authentication
Add the Frame.io V4 API with one of the user authentication credentials available. The steps here walk you through how to create the user authentication credentials and generate an access token and make your first API call.
If the API is added as a web app, use this credential.
If the API is added as a single page app, use this credential.
If the API is configured as a Native app, use this credential.
Server to Server Authentication
Frame.io’s V4 API supports service account users to connect the tools and systems critical to your creative process with your Frame.io account.
See Automate your setup using Frame.io server to server support for more information.
Server-to-server authentication credentials allow your application’s server to generate access tokens and make API calls on behalf of your application within a service account user. Service account users are distinguishable from standard user accounts because they can perform actions on behalf of the service and a user that are viewable by other users.
When a service account user performs an action, the service account user name is displayed in Frame.io. Users can grant and revoke service account users via the Adobe Admin and Developer Consoles. Users can manage service account users within the Frame.io UI including names. The first S2S connection you make will be called Service Account User by default, the second Service Account User 2 by default, and so on.
Adobe Identity Management Service (IMS)
Adobe Identity Management Service (IMS) is Adobe’s OAuth 2.0-based identity management feature that supports authentication. There are two steps required for generating the access token.
User Authorization
First, the user authorizes the application before a token is generated. Details are here.
Fetch Access Token
Next, fetch the access token. The above step returns a code in the response body needed in this step. See the exact endpoints to access, and the parameters to use, here.
The above steps are required for all the three types of app credentials. There are differences in the way the IMS endpoints /authorize/v2
and /token/v3
are accessed to get the token. After you have the access token, you can use it to interact with the Frame.io V4 API.