开发者
开发者是发现、订阅和使用 API 的开发者门户用户。开发者不同于 API7 网关用户(管理网关基础设施)和消费者(用于访问控制的提供商管理的身份)。
注册方式
开发者可以通过多种方法加入:
| 方法 | 描述 |
|---|---|
| 自助注册 | 开发者使用电子邮件和密码直接在开发者门户上注册。需要内置身份验证选项才能启用自注册。 |
| 邀请 | 在默认门户实施中,组织所有者和管理员通过电子邮件邀请人们加入组织。提供商端开发者邀请流程也可能存在于提供商门户 UI 中,具体取决于你的产品版本和部署。 |
| SSO | 开发者通过在门户上配置的外部身份提供商(OIDC、SAML、LDAP 或 CAS)进行身份验证。请参阅配置 SSO。 |
| SCIM 预配 | 用户账户使用 SCIM 2.0 协议从身份提供商(例如 Okta)自动同步。 |
账户状态
开发者账户有两种可能的状态:
| 状态 | 描述 |
|---|---|
| 待定 | 开发者已注册,但账号尚未审核通过。待定开发者无 法访问受保护的 API 产品或创建订阅。 |
| 活跃 | 开发者账户已获得批准且功能齐全。 |
当自行注册需要批准时(registration_auto_approval 已禁用),新注册将进入 待处理 状态。管理员必须先批准在提供商门户中的注册,然后开发者才能使用该门户。
如果启用注册自动批准,新账户将立即设置为活动。
组织
在默认的开发者门户实现中(基于 API7 开发者门户 Boilerplate),开发者属于组织。每个组织都与提供商门户中的开发者身份进行一对一映射。
组织支持三种角色:
| 角色 | 权限 |
|---|---|
| 所有者 | 完全访问权限,包括管理组织成员和设置。 |
| 管理员 | 和楼主一样。 |
| 会员 | 对组织资源的只读访问权限。 |
备注
组织模型来自默认开发者门户实现使用的身份验证系统(Better Auth)。如果你在没有 Better Auth 的情况下构建自定义开发者门户,则组织概念可能不适用。
开发者与消费者
开发者和 消费者 都代表访问 API 的实体,但它们有不同的用途:
| 方面 | 开发者 | 消费者 |
|---|---|---|
| 管理人 | 开发者通过开发者门户管理自己的凭证。 | 提供商通过仪表板或管理员 API 管理消费者凭证。 |
| 访问控制 | 开发者通过订阅 API 产品来请求访问。提供商批准订阅。 | 提供商直接将消费者分配到白名单或阻止列表。 |
| 用例 | 供内部、合作伙伴或公共开发者使用的自助服务 API 访问。 | 提供商控制的内部服务或系统到系统集成的访问。 |
开发者和消费者可以共存于同一部署中。但是,对于给定服务,请使用 API 产品身份验证(开发者凭证)或网关插件身份验证(消费者凭证),而不是同时使用两者。在同一服务上混合使用身份验证方法可能会导致冲突,每个请求需要多个凭证。
级联删除
删除开发者账户后,以下资源也会被删除:
- 开发者拥有的所有应用程序
- 与这些应用程序相关的所有凭证
- 所有订阅(有效和待定)
- 所有待批准的请求