跳到主要内容
版本:3.8.x

支持开发者门户单点登录

API7 开发者门户支持单点登录(SSO),允许用户通过组织的身份提供方(IdP)验证身份,提供流畅、安全的登录体验,提升易用性和安全性。

通常不建议为外部开发者使用 SSO,因为这要求他们在组织的 IdP 中拥有账号。开发者门户的 SSO 配置独立于 API7 控制台的 SSO 配置,后者用于登录控制台并管理网关配置、API 提供方等 API7 企业版设置。

创建登录选项​

API7 开发者门户支持使用多种协议实现单点登录(SSO)。通过集成现有用户系统,内部开发者无需创建新账号即可访问 API7 开发者门户。

IdP 配置

本节介绍 Keycloak 26.3.3 中的配置。如果使用其他版本的 Keycloak 或其他身份提供方(IdP),请参考对应 IdP 文档调整配置。

  1. 创建 Realm,例如 quickstart-realm。
  2. 创建客户端,例如 apisix-quickstart-client,并完成以下配置。
    1. 启用客户端身份认证,将访问类型设为机密。
    2. 启用标准流程(授权码授权)。
    3. 配置重定向 URL,例如 *。
    4. 创建客户端后,前往凭据选项卡获取客户端密钥,并记录此值以供后续使用。
  3. 创建用户,并完成以下配置。
    1. 创建用户密码。
    2. 根据需要配置用户邮箱、名字和姓氏。
  4. 在 Realm 设置中找到发现文档链接,在发现文档中记录以下值以供后续使用。
    1. issuer URL,例如 http://192.168.10.101:8080/realms/quickstart-realm。
    2. end_session_endpoint URL,例如 http://192.168.10.101:8080/realms/quickstart-realm/protocol/openid-connect/logout。

API7 开发者门户配置

  1. 在顶部导航栏选择组织,然后选择设置。
  2. 点击新增登录选项。
  3. 填写配置。
  • 名称应为唯一且便于用户识别的登录名称。例如,将名称配置为 Employee Account 时,控制台登录页会显示 使用 Employee Account 登录 选项。
  • 提供方选择 OIDC。
  • 签发者填写 OpenID Connect 提供方的签发者 URL,例如 http://192.168.10.101:8080/realms/quickstart-realm。
  • 客户端 ID填写 OIDC 提供方分配给应用的唯一标识符,例如 apisix-quickstart-client。
  • 客户端密钥填写 OIDC 提供方分配的身份认证密钥。
  • 请求作用域填写向 OIDC 提供方请求的作用域,用于定义访问级别及 Token 中包含的声明。所有 OIDC 请求都必须包含 openid 作用域。可以根据需要添加其他作用域,使用空格分隔,例如 openid profile email。
  • 根 URL填写用户访问 API7 开发者门户的根地址,例如 https://api7-portal.your-company.com。此 URL 必须与用户在浏览器中输入的地址完全一致,包括协议(HTTP 或 HTTPS),以及非标准端口(80 或 443 以外)的端口号。
    • 回调 URL 将自动生成为 <Root_URL>/api/oidc/<LOGIN_OPTION_ID>/callback。
  • SSL 验证用于指定是否验证 OIDC 提供方的 SSL/TLS 证书。
  • 登出 URL用于结束用户会话,并将用户重定向到登录页。应使用 end_session_endpoint URL,并将 post_logout_redirect_uri 查询参数设为 API7 开发者门户 URL,例如 http://192.168.10.101:8080/realms/quickstart-realm/protocol/openid-connect/logout?post_logout_redirect_uri=https://api7-portal.your-company.com.
  • 属性映射用于将 API7 用户字段映射到 OIDC 声明。例如以下映射。
    • username: preferred_username
    • email: email
    • name: name
  1. 点击新增。

开发者门户登录页现在应显示新的登录选项,用户可以通过 IdP 验证身份。

从 IdP 同步开发者数据​

SCIM(跨域身份管理系统)是一种将身份提供方(IdP)的用户和组信息同步到 API7 开发者门户的协议。它免去了跨多个系统手动管理用户和组的工作,节省时间并降低出错风险。

启用 SCIM 预配后,当 IdP 注册或删除用户时,API7 开发者门户会自动同步用户数据。

  1. 在顶部导航栏选择组织,然后选择设置。
  2. 启用 SCIM 预配。
  3. 复制 API7 SCIM 端点 URL 和 SCIM Token。
  4. 如果 IdP 支持 SCIM,请在其中配置 SCIM。

删除开发者登录选项​

注意

删除登录选项会移除开发者门户中与该选项关联的所有用户。

  1. 在顶部导航栏选择组织,然后选择用户。
  2. 检查是否仍有用户使用此登录选项。如有,请在变更前通知他们。
  3. 在顶部导航栏选择组织,然后选择设置。
  4. 点击目标登录选项的删除。

相关阅读​