Skip to main content

​
Authorize

To start the authorization flow you need to redirect the user to the authorization URL. It looks like this: 
https://rapidly.tech/oauth2/authorize?
  response_type=code
  &client_id=CLIENT_ID
  &redirect_uri=https%3A%2F%2Fexample.com%2Fcallback
  &scope=openid%20email
The parameters are the one described in the OpenID Connect specification. The most important ones are:
​
response_type=code
string
required
Indicates that you want to use the authorization code flow. Most common and the only one supported by Rapidly.
​
client_id
string
required
The Client ID you got when creating the OAuth 2.0 client.
​
redirect_uri
string
required
The URL where the user will be redirected after granting access to their data. Make sure you declared it when creating the OAuth2 client.
​
scope
string
required
A space-separated list of scopes you want to ask for. Make sure they are part of the scopes you declared when creating the OAuth2 client.
If you redirect the user to this URL, they’ll see a page asking them to grant access to their data, corresponding to the scopes you asked for. By default, the user will also be prompted to select one of their workspaces, as Rapidly generates workspace-level access tokens by default. If they allow it and select a workspace, they’ll be redirected to your redirect_uri with a code parameter in the query string. This code is a one-time code that you can exchange for an access token. To skip the workspace selection and get a user-scoped token instead, you can add sub_type=user to the authorization URL: 
https://rapidly.tech/oauth2/authorize?
  response_type=code
  &client_id=CLIENT_ID
  &redirect_uri=https%3A%2F%2Fexample.com%2Fcallback
  &scope=openid%20email
  &sub_type=user

​
Exchange code token

Once you have the authorization code, you can exchange it for an access token. To do so, you’ll need to make a POST request to the token endpoint. This call needs to be authenticated with the Client ID and Client Secret you got when creating the OAuth2 client. Here is an example with cURL:
Terminal
curl -X POST https://api.rapidly.tech/api/oauth2/token \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'grant_type=authorization_code&code=AUTHORIZATION_CODE&client_id=CLIENT_ID&client_secret=CLIENT_SECRET&redirect_uri=https://example.com/callback'
You should get the following response: 
{
  "token_type": "Bearer",
  "access_token": "rapidly_at_XXX",
  "expires_in": 864000,
  "refresh_token": "rapidly_rt_XXX",
  "scope": "openid email",
  "id_token": "ID_TOKEN"
}
The access_token will allow you to make authenticated API requests on behalf of the user. The refresh_token is a long-lived token that you can use to get new access tokens when the current one expires. The id_token is a signed JWT token containing information about the user, as per the OpenID Connect specification.

​
Workspace vs User Access Tokens

By default, Rapidly OAuth2 flow generates workspace-level access tokens. These tokens are tied to a specific workspace rather than a user, allowing requests to operate only on that workspace’s data, which improves privacy and security. When using the default flow, the user will be prompted to select one of their workspaces before allowing access to their data: 
https://rapidly.tech/oauth2/authorize?response_type=code&client_id=rapidly_ci_j3X95_MgfdSCeCd2qkFnUw&redirect_uri=https%3A%2F%2Fexample.com%2Fcallback&scope=openid%20email
To request a user-scoped access token instead, you need to explicitly add the parameter sub_type=user to the authorization URL: 
https://rapidly.tech/oauth2/authorize?response_type=code&client_id=rapidly_ci_j3X95_MgfdSCeCd2qkFnUw&redirect_uri=https%3A%2F%2Fexample.com%2Fcallback&scope=openid%20email&sub_type=user
The rest of the flow remains unchanged. The access token you’ll get will be tied to either the selected workspace (default) or the user (when explicitly requested).

​
Public Clients

Public clients are clients where the Client Secret can’t be kept safe, as it would be accessible by the final user. This is the case for SPA, mobile applications, or any client running on the user’s device. In this case, and only if the client is configured as a Public Client, the request to the token endpoint won’t require the client_secret parameter. However, the PKCE method will be required to maximize security.

​
Make authenticated requests

Once you have an access token, either from a Personal Access Token or from the OpenID Connect flow, you can make authenticated requests to the API. Here is a simple example with cURL:
Terminal
curl -X GET https://api.rapidly.tech/api/oauth2/userinfo \
  -H 'Authorization: Bearer rapidly_at_XXX'