Skip to content

chore: update translations and generated content #1190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/integrations/social/facebook/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Integrate Facebook OAuth 2.0 authentication system to enable Sign-in with Facebo

<GuideTip />

## Get started
## Get started \{#get-started}

The Facebook connector enables OAuth 2.0 integration to let your application:

Expand All @@ -32,30 +32,30 @@ To set up these authentication features, create a Facebook connector in Logto fi

<Integration />

## Utilize the Facebook connector
## Utilize the Facebook connector \{#utilize-the-facebook-connector}

Once you've created a Facebook connector and connected it to Facebook, you can incorporate it into your end-user flows. Choose the options that match your needs:

### Enable "Sign-in with Facebook"
### Enable "Sign-in with Facebook" \{#enable-sign-in-with-facebook}

1. In Logto Console, go to <CloudLink to="/sign-in-experience/sign-up-and-sign-in">Sign-in experience > Sign-up and sign-in</CloudLink>
2. Add the Facebook connector under **Social sign-in** section to let users authenticate with Facebook

Learn more about [social sign-in experience](/end-user-flows/sign-up-and-sign-in/social-sign-in).

### Link or unlink a Facebook account
### Link or unlink a Facebook account \{#link-or-unlink-a-facebook-account}

Use the Account API to build a custom Account Center in your app that lets signed-in users link or unlink their Facebook account. [Follow the Account API tutorial](/end-user-flows/account-settings/by-account-api#link-a-new-social-connection)

:::tip
It's allowed to enable the Facebook connector only for account linking and API access, without enabling it for social sign-in.
:::

### Access Facebook API and perform actions
### Access Facebook API and perform actions \{#access-facebook-api-and-perform-actions}

Your application can retrieve stored Facebook access tokens from the Secret Vault to call Facebook APIs and automate backend tasks (for example, publishing content or managing posts). Refer to the guide on retrieving stored tokens for API access.

## Manage user's Facebook identity
## Manage user's Facebook identity \{#manage-user-s-facebook-identity}

After a user links their Facebook account, admins can manage that connection in the Logto Console:

Expand All @@ -67,7 +67,7 @@ After a user links their Facebook account, admins can manage that connection in
Facebook's access token response does not include the specific scope information, so Logto cannot directly display the list of permissions granted by the user. However, as long as the user has consented to the requested scopes during authorization, your application will have the corresponding permissions when accessing the Facebook API. It is recommended to accurately configure the required scopes in both the Facebook Developer Console and Logto to ensure your app has the necessary access.
:::

## Reference
## Reference \{#reference}

<Url href="https://developers.facebook.com/docs/">Facebook for Developers - Documentation</Url>

Expand Down
20 changes: 10 additions & 10 deletions docs/integrations/social/facebook/_integration.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Step 1: Set up an app on Facebook App Dashboard
## Step 1: Set up an app on Facebook App Dashboard \{#step-1-set-up-an-app-on-facebook-app-dashboard}

Before you can use Facebook as an authentication provider, you must set up an app on the Facebook developer platform to obtain OAuth 2.0 credentials.

Expand All @@ -14,7 +14,7 @@ A use case is the primary way your app will interact with Meta and determines wh
5. Fill in the **Valid OAuth Redirect URIs** with the Logto **Callback URI** (copy this from your Logto Facebook connector). After users sign in with Facebook, they'll be redirected here with an authorization code that Logto uses to finish authentication.
6. Navigate to **Use cases** and click **Customize** of your use case to add the scopes. We recommend adding `email` and `public_profile` which are required to implement Sign-in with Facebook in Logto.

## Step 2: Set up Logto connector with client credentials
## Step 2: Set up Logto connector with client credentials \{#step-2-set-up-logto-connector-with-client-credentials}

1. In the Facebook App Dashboard, click the sidebar **App settings > Basic**.
2. You will see the **App ID** and **App secret** on the panel.
Expand All @@ -24,18 +24,18 @@ A use case is the primary way your app will interact with Meta and determines wh
- Fill the `clientSecret` field with the **App secret**.
- Click **Save and Done** in Logto to connect your identity system with Facebook.

## Step 3: Configure scopes
## Step 3: Configure scopes \{#step-3-configure-scopes}

Scopes define the permissions your app requests from users and control which private data your project can access from their Facebook accounts.

### Configure scopes in Facebook App Dashboard
### Configure scopes in Facebook App Dashboard \{#configure-scopes-in-facebook-app-dashboard}

1. Navigate to **Facebook App Dashboard > Use cases** and click the **Customize** button.
2. Add only the scopes your app needs. Users will review and authorize these permissions on the Facebook consent screen:
- **For authentication (Required)**: `email` and `public_profile`.
- **For API access (Optional)**: Any additional scopes your app needs (e.g., `threads_content_publish`, `threads_read_replies` for accessing the Threads API). Browse the [Meta Developer Documentation](https://developers.facebook.com/docs/) for available services.

### Configure scopes in Logto
### Configure scopes in Logto \{#configure-scopes-in-logto}

Choose one or more of the following approaches based on your needs:

Expand All @@ -60,18 +60,18 @@ By following these steps, your Logto Facebook connector requests exactly the per
If your app requests these scopes to access the Facebook API and perform actions, make sure to enable **Store tokens for persistent API access** in Logto Facebook connector. See the next section for details.
:::

## Step 4: General settings
## Step 4: General settings \{#step-4-general-settings}

Here are some general settings that won't block the connection to Facebook but may affect the end-user authentication experience.

### Sync profile information
### Sync profile information \{#sync-profile-information}

In the Facebook connector, you can set the policy for syncing profile information, such as user names and avatars. Choose from:

- **Only sync at sign-up**: Profile info is fetched once when the user first signs in.
- **Always sync at sign-in**: Profile info is updated every time the user signs in.

### Store tokens to access Facebook APIs (Optional)
### Store tokens to access Facebook APIs (Optional) \{#store-tokens-to-access-facebook-apis-optional}

If you want to access Facebook APIs and perform actions with user authorization (whether via social sign-in or account linking), Logto needs to get specific API scopes and store tokens.

Expand All @@ -82,15 +82,15 @@ If you want to access Facebook APIs and perform actions with user authorization
Facebook doesn't provide refresh tokens. However, when token storage is enabled, Logto automatically requests a long-lived access token (60 days) upon user authentication. During this period, users can manually revoke access tokens, but otherwise won't need re-authorization to access Facebook APIs. Note: Don't add `offline_access` to the `Scope` field as this may cause errors.
:::

## Step 5: Test sign-in with Facebook's test users (Optional)
## Step 5: Test sign-in with Facebook's test users (Optional) \{#step-5-test-sign-in-with-facebook-s-test-users-optional}

You can use test, developer, and admin user accounts to test sign-in with the app. You can also publish the app directly so that any Facebook user can sign in.

1. In the Facebook App Dashboard, click the sidebar **App roles > Test Users**.
2. Click the **Create test users** button to create a testing user.
3. Click the **Options** button of an existing test user to see more operations, such as "Change name and password".

## Step 6: Publish Facebook sign-in settings
## Step 6: Publish Facebook sign-in settings \{#step-6-publish-facebook-sign-in-settings}

Usually, only test, admin, and developer users can sign in with the app. To enable normal Facebook users to sign in with the app in the production environment, you may need to publish this app.

Expand Down
12 changes: 6 additions & 6 deletions docs/integrations/social/github/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Integrate GitHub OAuth app to enable Sign-in with GitHub, account linking, and s

<GuideTip />

## Get started
## Get started \{#get-started}

The GitHub connector enables OAuth 2.0 integration to let your application:

Expand All @@ -33,30 +33,30 @@ To set up these authentication features, create a GitHub connector in Logto firs

<Integration />

## Utilize the GitHub connector
## Utilize the GitHub connector \{#utilize-the-github-connector}

Once you've created a GitHub connector and connected it to GitHub, you can incorporate it into your end-user flows. Choose the options that match your needs:

### Enable "Sign-in with GitHub"
### Enable "Sign-in with GitHub" \{#enable-sign-in-with-github}

1. In Logto Console, go to <CloudLink to="/sign-in-experience/sign-up-and-sign-in">Sign-in experience > Sign-up and sign-in</CloudLink>.
2. Add the GitHub connector under **Social sign-in** section to let users authenticate with GitHub.

Learn more about [social sign-in experience](/end-user-flows/sign-up-and-sign-in/social-sign-in).

### Link or unlink a GitHub account
### Link or unlink a GitHub account \{#link-or-unlink-a-github-account}

Use the Account API to build a custom Account Center in your app that lets signed-in users link or unlink their GitHub account. [Follow the Account API tutorial](/end-user-flows/account-settings/by-account-api#link-a-new-social-connection)

:::tip
It's allowed to enable the GitHub connector only for account linking and API access, without enabling it for social sign-in.
:::

### Access GitHub APIs and perform actions
### Access GitHub APIs and perform actions \{#access-github-apis-and-perform-actions}

Your application can retrieve stored GitHub access tokens from the Secret Vault to call GitHub APIs and automate backend tasks (for example, creating issues, managing repositories, or automating workflows). Refer to the guide on retrieving stored tokens for API access.

## Manage user's GitHub identity
## Manage user's GitHub identity \{#manage-user-s-github-identity}

After a user links their GitHub account, admins can manage that connection in the Logto Console:

Expand Down
20 changes: 10 additions & 10 deletions docs/integrations/social/github/_integration.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Step 1: Create an OAuth app on GitHub
## Step 1: Create an OAuth app on GitHub \{#step-1-create-an-oauth-app-on-github}

Before you can use GitHub as an authentication provider, you must create an OAuth App on GitHub to obtain OAuth 2.0 credentials.

Expand All @@ -17,7 +17,7 @@ We suggest not checking the box for **Enable Device Flow**, as users who sign in
For more details on setting up GitHub OAuth Apps, see [Creating an OAuth App](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app).
:::

## Step 2: Configure your Logto connector
## Step 2: Configure your Logto connector \{#step-2-configure-your-logto-connector}

After creating the OAuth app in GitHub, you'll be redirected to a details page where you can copy the Client ID and generate a Client secret.

Expand All @@ -29,18 +29,18 @@ After creating the OAuth app in GitHub, you'll be redirected to a details page w
Keep your Client secret secure and never expose it in client-side code. GitHub client secrets cannot be recovered if lost - you'll need to generate a new one.
:::

## Step 3: Configure scopes (Optional)
## Step 3: Configure scopes (Optional) \{#step-3-configure-scopes-optional}

Scopes define the permissions your app requests from users and control which data your app can access from their GitHub accounts.

Use the `Scopes` field in Logto to request extra permissions from GitHub. Choose one of the following approaches based on your needs:

### Option 1: No extra API scopes needed
### Option 1: No extra API scopes needed \{#option-1-no-extra-api-scopes-needed}

- Leave the `Scopes` field in your Logto GitHub connector blank.
- The default scope `read:user` will be requested to ensure Logto can get basic user info (e.g., email, name, avatar) properly.

### Option 2: Request additional scopes at sign-in
### Option 2: Request additional scopes at sign-in \{#option-2-request-additional-scopes-at-sign-in}

- Browse all available [GitHub scopes for OAuth apps](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps) and add only the scopes your app needs.
- Enter all desired scopes in the **Scopes** field, separated by spaces.
Expand All @@ -52,7 +52,7 @@ Use the `Scopes` field in Logto to request extra permissions from GitHub. Choose
- `notifications`: Access to notifications
- Ensure all scopes are spelled correctly and valid. An incorrect or unsupported scope will result in an "Invalid scope" error from GitHub.

### Option 3: Request incremental scopes later
### Option 3: Request incremental scopes later \{#option-3-request-incremental-scopes-later}

- After the user signs in, you can request additional scopes on demand by reinitiating a federated social authorization flow and updating users' stored token set.
- These additional scopes do not need to be filled in the `Scopes` field in your Logto GitHub connector, and can be achieved through Logto's Social Verification API.
Expand All @@ -63,18 +63,18 @@ By following these steps, your Logto GitHub connector requests exactly the permi
If your app requests these scopes to access the GitHub API and perform actions, make sure to enable **Store tokens for persistent API access** in Logto GitHub connector. See the next section for details.
:::

## Step 4: General settings
## Step 4: General settings \{#step-4-general-settings}

Here are some general settings that won't block the connection to GitHub but may affect the end-user authentication experience.

### Sync profile information
### Sync profile information \{#sync-profile-information}

In the GitHub connector, you can set the policy for syncing profile information, such as user names and avatars. Choose from:

- **Only sync at sign-up**: Profile info is fetched once when the user first signs in.
- **Always sync at sign-in**: Profile info is updated every time the user signs in.

### Store tokens to access GitHub APIs (Optional)
### Store tokens to access GitHub APIs (Optional) \{#store-tokens-to-access-github-apis-optional}

If you want to access GitHub APIs and perform actions with user authorization (whether via social sign-in or account linking), Logto needs to get specific API scopes and store tokens.

Expand All @@ -87,7 +87,7 @@ When using a GitHub **OAuth App** as described in this tutorial, you cannot get
If you want the access token to expire or use refresh tokens, consider integrating with a **GitHub App** instead. Learn about the [differences between GitHub Apps and OAuth Apps](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps).
:::

## Step 5: Test your integration (Optional)
## Step 5: Test your integration (Optional) \{#step-5-test-your-integration-optional}

Before going live, test your GitHub integration:

Expand Down
12 changes: 6 additions & 6 deletions docs/integrations/social/google/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Integrate Google OAuth 2.0 authentication system to enable Sign-in with Google,

<GuideTip />

## Get started
## Get started \{#get-started}

The Google connector enables OAuth 2.0 integration to let your application:

Expand All @@ -32,31 +32,31 @@ To set up these authentication features, create a Google connector in Logto firs

<Integration />

## Utilize the Google connector
## Utilize the Google connector \{#utilize-the-google-connector}

Once you've created a Google connector and connected it to Google, you can incorporate it into your end-user flows. Choose the options that match your needs:

### Enable "Sign-in with Google"
### Enable "Sign-in with Google" \{#enable-sign-in-with-google}

1. In Logto Console, go to <CloudLink to="/sign-in-experience/sign-up-and-sign-in">Sign-in experience > Sign-up and sign-in</CloudLink>.
2. Add the Google connector under **Social sign-in** section to let users authenticate with Google.
3. Optionally enable **Google One Tap** on the sign-in and sign-up pages for a streamlined authentication experience.

Learn more about [social sign-in experience](/end-user-flows/sign-up-and-sign-in/social-sign-in).

### Link or unlink a Google account
### Link or unlink a Google account \{#link-or-unlink-a-google-account}

Use the Account API to build a custom Account Center in your app that lets signed-in users link or unlink their Google account. [Follow the Account API tutorial](/end-user-flows/account-settings/by-account-api#link-a-new-social-connection)

:::tip
It's allowed to enable the Google connector only for account linking and API access, without enabling it for social sign-in.
:::

### Access Google APIs and perform actions
### Access Google APIs and perform actions \{#access-google-apis-and-perform-actions}

Your application can retrieve stored Google access tokens from the Secret Vault to call Google APIs and automate backend tasks (for example, managing Google Drive files, creating Calendar events, or sending emails through Gmail). Refer to the guide on retrieving stored tokens for API access.

## Manage user's Google identity
## Manage user's Google identity \{#manage-user-s-google-identity}

After a user links their Google account, admins can manage that connection in the Logto Console:

Expand Down
Loading
Loading