Knowledge Base

Create your OAuth Apps

Create more integrations for your Bynder brand portal using the new OAuth 2.0 setup to easily provide authorized access to the Bynder API. This new setup empowers you to create your account specific integrations to leverage Bynder throughout your brand ecosystem.

Who can access and manage OAuth Apps?
Users with the following right can access and manage OAuth Apps:

  • Access & manage OAuth apps

How to enable this feature?

Contact your Customer Success Manager if this feature is not enabled for your portal. Your Customer Success Manager is happy to assist you in setting this up.

Why OAuth 2.0?

Previously Bynder only offered the OAuth 1.0a flow to provide authorized access to the Bynder API but we have seen a tremendous growth and demand in integrations and want to offer the newest standard is OAuth 2.0.

OAuth 2.0 is an authorization framework and is the industry-standard delegation protocol that enables you to work with external apps in a secure way using digital identifiers called tokens. Bynder OAuth Apps provide authorized access to the Bynder API in order to request assets or other Bynder available data. The OAuth 2.0 API service uses the access token to determine if you’re allowed to do what you are trying to do.

Obtaining an access token is accomplished by following the OAuth 2.0 authentication flow. That simply refers to the steps taken to obtain an access token. The OAuth 2.0 specification formalizes a number of these flows referred to as grant types. With OAuth Apps we at Bynder have implemented the Authorization Code Grant Flow which allows clients to exchange an authorization code for an access token.

How to create a new OAuth App?

The client for the OAuth App can be created as follows:

  1. Go to Settings > Advanced Settings > Portal settings and click OAuth Apps.
  2. Click Register new application to create your first OAuth App
  3. Configure your OAuth App.
  • Application name
    Enter a name for your application. Use a name that users will recognize and trust.
  • Homepage URL
    Enter the URL of the application's homepage, where users can find more information about the application.
  • Application description
    Describe what your application can do.
  • Authorization redirect URIs
    Fill in the callback URL(s) to where the application will redirect to after successful authentication and press Enter to add it.
  • Set HTTP access control (CORS)
    Fill in one or more domains to make cross-domain requests to and press Enter to add a domain.
  • Select scopes
    Define what the application can do on the user’s behalf. The API documentation defines what scopes are needed to call specific endpoints.

5. Click Register application to retrieve a Client ID and Client Secret for your OAuth application.

The Client Secret will only be visible once and needs to be regenerated in case it is lost. If you regenerate it, your existing operations with the previous client secret will no longer work.

In addition, users who can manage OAuth Apps have the possibility to revoke all refresh tokens for an OAuth App and if needed delete the application once and for all which will permanently delete the application's associated refresh tokens.


Click for an example of an OAuth application

For more detailed technical documentation please visit our Bynder developer docs.

How to modify an existing OAuth App?

All OAuth App specifications can be changed except for the OAuth scopes. Therefore, we recommend you to create a new application when you want to modify the OAuth scopes.

  1. Go to Settings > Advanced Settings > Portal settings and click OAuth Apps.
  2. Click OAuth Apps.
  3. Click the icon of the application you want to modify.
  4. Modify your OAuth App information.
  5. Click Update application to save your changes.

How to revoke refresh tokens?

  1. Go to Settings > Advanced Settings > Portal settings and click OAuth Apps.
  2. Click OAuth Apps.
  3. Click the  icon of the application you want to revoke the refresh tokens for.
  4. Click Revoke refresh tokens. A popup will open.
  5. Read the warning message and click Revoke all refresh tokens if you want to revoke the refresh tokens.
    This action cannot be undone

How to delete an application?

  1. Go to Settings > Advanced Settings > Portal settings and click OAuth Apps.
  2. Click OAuth Apps
  3. Click the icon of the application you want to delete.
  4. Click Delete application. A popup will open.
  5. Read the warning message and click Delete if you want to delete the application.
This will permanently delete the application and revoke all associated refresh tokens. This action cannot be undone.

FAQ

What does this mean for my existing integrations or scripts calling the Bynder API?
OAuth 2.0 works in parallel with OAuth1a. They can coexist but we want to promote the use of OAuth 2.0 (OAuth Apps) as much as possible since it is the newest implementation to provide authorized access to the Bynder API and will be continuously improved.

What are the main benefits of OAuth 2.0?
Bynder’s OAuth 2.0 scopes implementation for OAuth Apps provides full transparency to the user regarding what the application can request on the user’s behalf. In addition, access tokens can now be refreshed which means users no longer need to re-authenticate every 30 days but they can be refreshed in the background using the refresh token generated by the OAuth 2.0 service.

How to migrate my migrations from OAuth1 to OAuth 2.0?
Customers can easily upgrade to OAuth 2.0 by using our Bynder SDKs. The new endpoints and the refresh mechanisms have been fully implemented in all our SDKs and, therefore, allow a fast upgrade for your integrations.

If you have questions feel free to reach out to our Support Team.

How can I update my OAuth App over time?
All OAuth App specs can be changed except for OAuth scopes. At this point in time we did not implement the update of the OAuth scopes for an existing application. Therefore, we recommend you to create a new application.