This repository has been archived by the owner on Sep 29, 2023. It is now read-only.
Oauth provider guides #383
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gewenyu99
commented
Jun 8, 2023
| account.createOAuth2Session('github', '[LINK_ON_SUCCESS]', '[LINK_ON_FAILURE]'); | ||
| ``` | ||
|
|
||
| ### Flutter |
gewenyu99
commented
Jun 8, 2023
| }); | ||
| ``` | ||
|
|
||
| ### Flutter |
Dart code fix in refreshing OAuth2 session
This was referenced Jul 25, 2023
stnguyen90
suggested changes
Aug 2, 2023
| Don't close this modal, we'll need to create a GitHub OAuth app to complete this form. | ||
|
|
||
| ## Creating a GitHub OAuth app | ||
| To use GitHub OAuth with Appwrite, you need to create an OAuth app on your GitHub account or in your Github organization. You can do this by following the [Creating an OAuth App](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) guide from GitHub. When prompted to provide a **Authorization callback URL**, provide the **URI** found in the **Github OAuth2 Settings** modal from your Appwrite console. |
There was a problem hiding this comment.
Suggested change
| To use GitHub OAuth with Appwrite, you need to create an OAuth app on your GitHub account or in your Github organization. You can do this by following the [Creating an OAuth App](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) guide from GitHub. When prompted to provide a **Authorization callback URL**, provide the **URI** found in the **Github OAuth2 Settings** modal from your Appwrite console. | |
| To use GitHub OAuth with Appwrite, you need to create an OAuth app on your GitHub account or in your GitHub organization. You can do this by following the [Creating an OAuth App](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) guide from GitHub. When prompted to provide an **Authorization callback URL**, provide the **URI** found in the **Github OAuth2 Settings** modal from your Appwrite console. |
stnguyen90
suggested changes
Aug 2, 2023
| 1. Navigate to your Appwrite project | ||
| 2. Navigate to **Auth** > **Settings** | ||
| 3. Find and open the OAuth provider | ||
| 4. In the **Github OAuth2 Settings** modal, use the toggle to enable the provider |
There was a problem hiding this comment.
Suggested change
| 4. In the **Github OAuth2 Settings** modal, use the toggle to enable the provider | |
| 4. In the **GitHub OAuth2 Settings** modal, use the toggle to enable the provider |
This is going to be fixed in 1.4.x:
| ## Creating a GitHub OAuth app | ||
| To use GitHub OAuth with Appwrite, you need to create an OAuth app on your GitHub account or in your Github organization. You can do this by following the [Creating an OAuth App](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) guide from GitHub. When prompted to provide a **Authorization callback URL**, provide the **URI** found in the **Github OAuth2 Settings** modal from your Appwrite console. | ||
|
|
||
| After you've created your GitHub OAuth app, you can head back to your Appwrite console to complete the form in the **Github OAuth2 Settings** modal. |
There was a problem hiding this comment.
Suggested change
| After you've created your GitHub OAuth app, you can head back to your Appwrite console to complete the form in the **Github OAuth2 Settings** modal. | |
| After you've created your GitHub OAuth app, you can head back to your Appwrite console to complete the form in the **GitHub OAuth2 Settings** modal. |
| To use GitHub OAuth with Appwrite, you need to create an OAuth app on your GitHub account or in your Github organization. You can do this by following the [Creating an OAuth App](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) guide from GitHub. When prompted to provide a **Authorization callback URL**, provide the **URI** found in the **Github OAuth2 Settings** modal from your Appwrite console. | ||
|
|
||
| After you've created your GitHub OAuth app, you can head back to your Appwrite console to complete the form in the **Github OAuth2 Settings** modal. | ||
| - Find the **Client ID** in your GitHub OAuth app and provide this in the **App ID** field in the **Github OAuth2 Settings** modal from the Appwrite console. |
There was a problem hiding this comment.
Suggested change
| - Find the **Client ID** in your GitHub OAuth app and provide this in the **App ID** field in the **Github OAuth2 Settings** modal from the Appwrite console. | |
| - Find the **Client ID** in your GitHub OAuth app and provide this in the **App ID** field in the **GitHub OAuth2 Settings** modal from the Appwrite console. |
|
|
||
| After you've created your GitHub OAuth app, you can head back to your Appwrite console to complete the form in the **Github OAuth2 Settings** modal. | ||
| - Find the **Client ID** in your GitHub OAuth app and provide this in the **App ID** field in the **Github OAuth2 Settings** modal from the Appwrite console. | ||
| - Navigate to the **Client secrets** section in your Github OAuth app and click **Generate a new client secret**. |
There was a problem hiding this comment.
Suggested change
| - Navigate to the **Client secrets** section in your Github OAuth app and click **Generate a new client secret**. | |
| - Navigate to the **Client secrets** section in your GitHub OAuth app and click **Generate a new client secret**. |
| After you've created your GitHub OAuth app, you can head back to your Appwrite console to complete the form in the **Github OAuth2 Settings** modal. | ||
| - Find the **Client ID** in your GitHub OAuth app and provide this in the **App ID** field in the **Github OAuth2 Settings** modal from the Appwrite console. | ||
| - Navigate to the **Client secrets** section in your Github OAuth app and click **Generate a new client secret**. | ||
| - Copy your new client secret and provide this in the **App Secret** field in the **Github OAuth2 Settings** modal from the Appwrite console. |
There was a problem hiding this comment.
Suggested change
| - Copy your new client secret and provide this in the **App Secret** field in the **Github OAuth2 Settings** modal from the Appwrite console. | |
| - Copy your new client secret and provide this in the **App Secret** field in the **GitHub OAuth2 Settings** modal from the Appwrite console. |
| Before you can use GitHub to authenticate users, you need to enable the provider in your Appwrite console. | ||
| 1. Navigate to your Appwrite project | ||
| 2. Navigate to **Auth** > **Settings** | ||
| 3. Find and open the OAuth provider |
There was a problem hiding this comment.
Suggested change
| 3. Find and open the OAuth provider | |
| 3. Find and open the OAuth2 provider |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
(Provide a description of what this PR does.)
Test Plan
(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work.)
Related PRs and Issues
(If this PR is related to any other PR or resolves any issue or related to any issue link all related PR and issues here.)
Have you read the Contributing Guidelines on issues?
(Write your answer here.)