Zoomdata Version

Implementing OAuth 2.0 with Zoomdata

Zoomdata supports the OAuth 2.0 protocol's implicit workflow for user authentication and authorization. Here is some terminology that is used.

Term Definition
access token A token created by a resource server and returned to an authorized client, identifying that client in future requested transactions.
client A third-party application that attempts to access the user's account. The client must obtain permission from the resource owner before it can do so.
resource owner The owner, typically a human, of an account. The resource owners can give access to some portion of their account.
resource server The Zoomdata server used to access the user's information.
transaction

An attempt by a client to create, read, update, or delete Zoomdata resources or to use Zoomdata functionality in a third-party application.

In Zoomdata's implementation, only a Zoomdata server's supervisor can create a client to access that particular server. After a Zoomdata server's supervisor has created one or more clients, developers can use those clients to request access tokens from the Zoomdata server. At this point, the Zoomdata server will request the user grant access to the application. When the user grants access, the server supplies an access token to the client application. Once those access tokens are granted, the client application can use those access tokens to request Zoomdatatransactions, getting data and using functionality, in their own applications.

The following high-level steps will guide you in this workflow.

  1. If you are working with Zoomdata 2.3 or later, you must first enable OAuth.
  2. Register an OAuth Client.
  3. Request an Access Token.
  4. Request a Transaction.

Using these high-level steps, developers can add the ability to use Zoomdata data and functionality to their own applications, restricting authorization to the level and permissions of the user logged in.

Was this topic helpful?