OAuth

The OAuth 2.0 authorization flow is primarily designed for Tool Plugins and Space Plugins that need to interact with the Management API on behalf of a user. OAuth tokens obtained through this flow are accepted on all Management API endpoints. The OAuth endpoints use different domains and tokens than the standard Management API, and it is a multi-step process to get the token and send a request using it.

Tip

You can read more about the OAuth 2.0 Authorization flow here.

The token for making requests from inside the custom plugins is retrieved following the OAuth flow linked above. It is not the same as a personal access token.

Note

The OAuth token works on other Management API endpoints, as long as they are within the space and scopes it was granted.

One important thing to note is that the domains for making these requests to oauth endpoints are different from the general Management API domain.

Here is a list of domains for the different regions -

European Union

Base URL for spaces created in the EU

https://api.storyblok.com/oauth

United States

Base URL for spaces created in the USA

https://api-us.storyblok.com/oauth

Canada

Base URL for spaces created in Canada

https://api-ca.storyblok.com/oauth

Australia

Base URL for spaces created in Australia

https://api-ap.storyblok.com/oauth

China

Base URL for spaces created in China

https://app.storyblokchina.cn/oauth