Skip to content

Fix OAuth example to avoid unsupported custom basepath #5901

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.

Sign up for GitHub

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
compair-steven wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix OAuth example to avoid unsupported custom basepath #5901

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions deploy/authentication-setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,15 +129,15 @@ You host your documentation at `docs.foo.com` and your entire team has access to

### OAuth 2.0 example

You host your documentation at `foo.com/docs` and you have an existing OAuth server at `auth.foo.com` that supports the Authorization Code Flow.
You host your documentation at `docs.foo.com` and you have an existing OAuth server at `auth.foo.com` that supports the Authorization Code Flow.

**Configure your OAuth server details** in your dashboard:
- **Authorization URL**: `https://auth.foo.com/authorization`
- **Client ID**: `ydybo4SD8PR73vzWWd6S0ObH`
- **Scopes**: `['provider.users.docs']`
- **Token URL**: `https://auth.foo.com/exchange`
- **Info API URL**: `https://api.foo.com/docs/user-info`
- **Logout URL**: `https://auth.foo.com/logout?returnTo=https%3A%2F%2Ffoo.com%2Fdocs`
- **Logout URL**: `https://auth.foo.com/logout?returnTo=https%3A%2F%2Fdocs.foo.com`

**Create a user info endpoint** at `api.foo.com/docs/user-info`, which requires an OAuth access token with the `provider.users.docs` scope, and returns:

Expand Down
6 changes: 3 additions & 3 deletions es/deploy/authentication-setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ Selecciona el método de handshake que quieres configurar.

### Ejemplo de OAuth 2.0

Alojas tu documentación en `foo.com/docs` y tienes un servidor OAuth existente en `auth.foo.com` que admite el flujo de código de autorización (Authorization Code Flow).
Alojas tu documentación en `docs.foo.com` y tienes un servidor OAuth existente en `auth.foo.com` que admite el flujo de código de autorización (Authorization Code Flow).

**Configura los detalles de tu servidor OAuth** en tu dashboard:

Expand All @@ -149,7 +149,7 @@ Selecciona el método de handshake que quieres configurar.
* **Scopes**: `['provider.users.docs']`
* **Token URL**: `https://auth.foo.com/exchange`
* **Info API URL**: `https://api.foo.com/docs/user-info`
* **Logout URL**: `https://auth.foo.com/logout?returnTo=https%3A%2F%2Ffoo.com%2Fdocs`
* **Logout URL**: `https://auth.foo.com/logout?returnTo=https%3A%2F%2Fdocs.foo.com`

**Crea un endpoint de información de usuario** en `api.foo.com/docs/user-info`, que requiera un token de acceso OAuth con el scope `provider.users.docs`, y devuelva:

Expand Down Expand Up @@ -504,4 +504,4 @@ Algunas funciones se comportan de manera diferente o no están disponibles cuand
| [Assistant](/es/assistant/index) | Compatibilidad completa | Compatibilidad completa, respeta los grupos de usuarios | Compatibilidad completa, respeta los grupos de usuarios |
| [skill.md](/es/ai/skillmd) | Compatibilidad completa | No compatible | No compatible |
| [Mapa del sitio](/es/optimize/seo#sitemaps-and-robotstxt-files) | Compatibilidad completa | Disponible tras autenticación, pero excluye las páginas en groups | Disponible tras autenticación, pero excluye las páginas en groups |
| [robots.txt](/es/optimize/seo#sitemaps-and-robotstxt-files) | Compatibilidad completa | Disponible tras autenticación | Disponible tras autenticación |
| [robots.txt](/es/optimize/seo#sitemaps-and-robotstxt-files) | Compatibilidad completa | Disponible tras autenticación | Disponible tras autenticación |
6 changes: 3 additions & 3 deletions fr/deploy/authentication-setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ Sélectionnez la méthode de poignée de main que vous souhaitez configurer.

### Exemple OAuth 2.0

Vous hébergez votre documentation sur `foo.com/docs` et vous disposez d’un serveur OAuth existant sur `auth.foo.com` qui prend en charge le flux « Authorization Code ».
Vous hébergez votre documentation sur `docs.foo.com` et vous disposez d’un serveur OAuth existant sur `auth.foo.com` qui prend en charge le flux « Authorization Code ».

**Configurez les détails de votre serveur OAuth** dans votre Dashboard :

Expand All @@ -149,7 +149,7 @@ Sélectionnez la méthode de poignée de main que vous souhaitez configurer.
* **Scopes** : `['provider.users.docs']`
* **Token URL** : `https://auth.foo.com/exchange`
* **Info API URL** : `https://api.foo.com/docs/user-info`
* **Logout URL** : `https://auth.foo.com/logout?returnTo=https%3A%2F%2Ffoo.com%2Fdocs`
* **Logout URL** : `https://auth.foo.com/logout?returnTo=https%3A%2F%2Fdocs.foo.com`

**Créez un endpoint d’informations utilisateur** à `api.foo.com/docs/user-info`, qui requiert un jeton d’accès OAuth avec le scope `provider.users.docs`, et renvoie :

Expand Down Expand Up @@ -504,4 +504,4 @@ Certaines fonctionnalités se comportent différemment ou ne sont pas disponible
| [Assistant](/fr/assistant/index) | Prise en charge complète | Prise en charge complète, respecte les groupes d’utilisateurs | Prise en charge complète, respecte les groupes d’utilisateurs |
| [skill.md](/fr/ai/skillmd) | Prise en charge complète | Non pris en charge | Non pris en charge |
| [Sitemap](/fr/optimize/seo#sitemaps-and-robotstxt-files) | Prise en charge complète | Disponible derrière l’authentification, mais exclut les pages dans des groupes | Disponible derrière l’authentification, mais exclut les pages dans des groupes |
| [robots.txt](/fr/optimize/seo#sitemaps-and-robotstxt-files) | Prise en charge complète | Disponible derrière l’authentification | Disponible derrière l’authentification |
| [robots.txt](/fr/optimize/seo#sitemaps-and-robotstxt-files) | Prise en charge complète | Disponible derrière l’authentification | Disponible derrière l’authentification |
6 changes: 3 additions & 3 deletions zh/deploy/authentication-setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ keywords: ['authentication', 'auth', 'OAuth', 'JWT', 'password']

### OAuth 2.0 示例

你将文档托管在 `foo.com/docs`，并且你有一个现有的 OAuth 服务器 `auth.foo.com`，它支持 Authorization Code Flow。
你将文档托管在 `docs.foo.com`，并且你有一个现有的 OAuth 服务器 `auth.foo.com`，它支持 Authorization Code Flow。

**在控制台中配置你的 OAuth 服务器详细信息**：

Expand All @@ -149,7 +149,7 @@ keywords: ['authentication', 'auth', 'OAuth', 'JWT', 'password']
* **Scopes**：`['provider.users.docs']`
* **Token URL**：`https://auth.foo.com/exchange`
* **Info API URL**：`https://api.foo.com/docs/user-info`
* **Logout URL**：`https://auth.foo.com/logout?returnTo=https%3A%2F%2Ffoo.com%2Fdocs`
* **Logout URL**：`https://auth.foo.com/logout?returnTo=https%3A%2F%2Fdocs.foo.com`

在 `api.foo.com/docs/user-info` 上**创建一个用户信息端点**，该端点要求使用带有 `provider.users.docs` scope 的 OAuth 访问令牌，并返回：

Expand Down Expand Up @@ -504,4 +504,4 @@ groups: ["admin"]
| [AI 助手](/zh/assistant/index) | 完全支持 | 完全支持，尊重用户分组 | 完全支持，尊重用户分组 |
| [skill.md](/zh/ai/skillmd) | 完全支持 | 不支持 | 不支持 |
| [站点地图](/zh/optimize/seo#sitemaps-and-robotstxt-files) | 完全支持 | 需要通过认证后才能访问，但会排除 groups 中的页面 | 需要通过认证后才能访问，但会排除 groups 中的页面 |
| [robots.txt](/zh/optimize/seo#sitemaps-and-robotstxt-files) | 完全支持 | 需要通过认证后才能访问 | 需要通过认证后才能访问 |
| [robots.txt](/zh/optimize/seo#sitemaps-and-robotstxt-files) | 完全支持 | 需要通过认证后才能访问 | 需要通过认证后才能访问 |