跳到主要内容
版本：3.10.x

管理开发者

开发者是开发者门户的用户。部分开发者管理任务由 Provider Portal Admin API 处理，创建开发者的功能则由独立的开发者门户后端提供。

前置条件​

按照从控制台获取 Token中的步骤创建 Token，并将其导出为环境变量：

export API_KEY="a7ee-xxxxxxxxxxxxx"

列出开发者​

检索在门户上注册的所有开发者：

curl -k "https://localhost:7443/api/developers?portal_id={portal_id}" \
  -H "X-API-KEY: ${API_KEY}"

如果不在本地运行，请将 localhost 替换为控制台主机。如果控制台使用自签名 TLS 证书，则需要 -k 参数。

响应包括开发者元数据：

{
  "list": [
    {
      "id": "d1a2b3c4-...",
      "developer_id": "org_abc123",
      "username": "jane.smith",
      "name": "Jane Smith",
      "email": "jane@example.com",
      "email_verified": true,
      "state": "Active",
      "provider": "builtin",
      "last_active_at": "2025-01-15T10:30:00Z",
      "created_at": "2025-01-10T08:00:00Z"
    }
  ],
  "total": 1
}

使用电子邮件和密码注册会创建一个门户用户。随后创建组织时，控制面会创建一条处于活动状态的开发者记录。Provider Portal 不提供注册审批设置，公开 API 也不会创建开发者注册审批请求。

创建开发者​

开发者账户通常在用户通过开发者门户创建组织时建立（参见注册与登录）。

要以编程方式预配开发者，请调用独立的开发者门户后端（默认使用端口 4321），而不是控制台或 Provider Portal Admin API。相关端点为 POST /api/developers；其请求体、响应 Schema 和身份认证请求头（Authorization: Bearer a7prt-… 和 X-Portal-Developer-ID: <id>）记录在开发者门户 API 参考中。

在默认的开发者门户实现中，组织邀请通常在开发者门户体验本身中处理，而不是通过此端点。

审查自定义注册审批​

仅当现有或基于源码定制的流程已生成 developer_registration 审批记录时，才使用这些端点。公开 API 不会创建这些记录。发布版前端的电子邮件和密码注册流程也不涉及这些记录。

列出待审批请求​

curl -k "https://localhost:7443/api/approvals?event=developer_registration&status=pending" \
  -H "X-API-KEY: ${API_KEY}"

批准注册​

curl -k -X POST "https://localhost:7443/api/approvals/{approval_id}/accept" \
  -H "X-API-KEY: ${API_KEY}"

批准后，开发者的状态从 Pending（待审批）更改为 Active（活动）。

拒绝注册​

curl -k -X POST "https://localhost:7443/api/approvals/{approval_id}/reject" \
  -H "X-API-KEY: ${API_KEY}"

拒绝后，开发者账户将被删除。

删除开发者​

删除开发者会删除开发者账户和所有关联的资源：

curl -k -X DELETE "https://localhost:7443/api/developers/{developer_external_id}?portal_id={portal_id}" \
  -H "X-API-KEY: ${API_KEY}"
警告

删除开发者的操作不可逆，并且会级联删除开发者拥有的所有资源，包括应用程序、凭证、订阅和待审批请求。

开发者身份提供商​

开发者记录中的 provider 字段指示账户的创建方式：

提供商描述
builtin通过发布版门户 API 创建。包括对应组织的开发者记录，其门户前端使用电子邮件和密码或在本地配置的 OAuth 进行身份认证。
sso由现有、旧版或基于源码定制的外部身份认证流程创建。发布版前端不会用此值保存通过本地配置的 OAuth 登录的用户。
scim由现有或基于源码定制的 SCIM 流程创建。发布版前端默认不注册 SCIM。

其他资源​