All URIs are relative to https://beta.appflowy.cloud
| Method | HTTP request | Description |
|---|---|---|
| gotrueToken | POST /gotrue/token | Get a new access token and refresh token based on grant type |
| oauthRedirectToken | GET /web-api/oauth-redirect/token | Sign in with AppFlowy OAuth 2.0 |
gotrue_token_response gotrueToken(grant_type, gotrueToken_request)
Get a new access token and refresh token based on grant type
This endpoint is used to obtain a new access token and refresh token based on the grant type.
| Name | Type | Description | Notes |
|---|---|---|---|
| grant_type | String | The grant type of the OAuth 2.0 flow being used to obtain an access token. This can be one of the following: - `refresh_token`: Used to exchange a refresh token for an access token. - `password`: Used to exchange a username and password for an access token. - `id_token`: Used to exchange an ID token for an access token. - `pkce`: Used to exchange an authorization code for an access token. | [default to null] |
| gotrueToken_request | gotrueToken_request | The request body for obtaining an access token |
No authorization required
- Content-Type: application/json
- Accept: application/json
gotrue_token_response oauthRedirectToken(code, grant_type, client_id, client_secret, redirect_uri, code_verifier)
Sign in with AppFlowy OAuth 2.0
This endpoint is used obtain an access token from AppFlowy OAuth 2.0. This is called after user tried to sign in with AppFlowy OAuth (/web-api/oauth-redirect). This is primarily used integration with third-party applications.
| Name | Type | Description | Notes |
|---|---|---|---|
| code | String | The authorization code received from the redirect. | [default to null] |
| grant_type | String | Type of OAuth 2.0 flow being used to exchange the authorization code for an access token. | [default to null] |
| client_id | String | The client ID of the application | [optional] [default to null] |
| client_secret | String | The client's secret (if applicable, for confidential clients). | [optional] [default to null] |
| redirect_uri | String | The redirect URI used in the initial authorization request. | [optional] [default to null] |
| code_verifier | String | Used in PKCE (Proof Key for Code Exchange) to secure public clients. | [optional] [default to null] |
No authorization required
- Content-Type: Not defined
- Accept: application/json