diff --git a/docs/developing/guides/appstore-and-integration/oauth.mdx b/docs/developing/guides/appstore-and-integration/oauth.mdx deleted file mode 100644 index 85f3090c62..0000000000 --- a/docs/developing/guides/appstore-and-integration/oauth.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: "How to use OAuth to authorize apps with Cal.com accounts" ---- - -As an example, you can view our OAuth flow in action on Zapier. Try to connect your cal.com account [here](https://zapier.com/apps/calcom/integrations). -To enable OAuth in one of your apps, you will need a Client ID, Client Secret, Authorization URL, Access Token Request URL, and Refresh Token Request URL. - - - -### Authorization URL -To initiate the OAuth flow, direct users to the following authorization URL: -- `https://app.cal.com/auth/oauth2/authorize` -- URL Parameters: - - *client_id* - - *state*: A securely generated random string to mitigate CSRF attacks - - *redirect_uri*: This is where users will be redirected after authorization - - *scope*: Specify the required scopes. Current scopes include READ_BOOKING and READ_PROFILE. Additional scopes can be added as needed. - -After users click *Allow*, they will be redirected to the redirect_uri with the code (authorization code) and state as URL parameters. - -### Access Token Request -Endpoint: `POST https://app.Cal.com/api/auth/oauth/token` - -Request Body: -- *code*: The authorization code received in the redirect URI -- *client_id* -- *client_secret* -- *grant_type*: "authorization_code" -- *redirect_uri* - -Response: -``` -{ - access_token: “exampleAccessToken” - refresh_token: “exampleRefreshToken” -} -``` - -### Refresh Token Request -Endpoint: `POST https://app.Cal.com/api/auth/oauth/refreshToken` - -Request Body: -- *grant_type*: "refresh_token" -- *client_id* -- *client_secret* - -Response: -``` -{ - access_token: “exampleAccessToken” -} -``` - -### Testing OAuth Credentials -To verify the correct setup and functionality of OAuth credentials you can use the following endpoint: -`GET https://app.Cal.com/api/auth/oauth/me` - -Headers: -- Authorization: Bearer *exampleAccessToken* - - -### Authorize requests with Bearer token -Ensure that Cal.com endpoints accessed by the app support authentication via Bearer Token. -If this is not the case, it will be necessary to update the code accordingly. -Here is an example of an endpoint that supports both apiKey and Bearer token authentication: [/listBookings endpoint](https://github.com/calcom/cal.com/blob/main/packages/app-store/zapier/api/subscriptions/listBookings.ts) diff --git a/docs/mint.json b/docs/mint.json index 81f3ff2c31..1337963bf4 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -83,8 +83,7 @@ "pages": [ "developing/guides/appstore-and-integration/build-a-greeter-app", "developing/guides/appstore-and-integration/build-an-app", - "developing/guides/appstore-and-integration/how-to-show-assigned-people-from-a-crm", - "developing/guides/appstore-and-integration/oauth" + "developing/guides/appstore-and-integration/how-to-show-assigned-people-from-a-crm" ] }, {