管理开发者
开发者是开发者门户的用户。部分开发者管理任务由 Provider Portal Admin API 处理,创建开发者的功能则由独立的开发者门户后端提供。
前置条件
按照从控制台获取令牌中的步骤创建令牌,并将其导出为环境变量:
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
}
要查看待审批的注册,请使用下一节中的审批端点。本地验证表明,向 GET /api/developers 添加 state=Pending 无法可靠地仅过滤出待审批记录。
创建开发者
开发者账 户通常通过开发者门户自助注册创建(参见注册与登录)。
要以编程方式预配开发者,请调用独立的开发者门户后端(默认使用端口 4321),而不是控制台或 Provider Portal Admin API。相关端点为 POST /api/developers;其请求体、响应 Schema 和身份认证请求头(Authorization: Bearer a7prt-… 和 X-Portal-Developer-ID: <id>)记录在开发者门户 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 | 通过开发者门户内置的电子邮件和密码身份认证注册。 |
sso | 通过外部身份提供商(OIDC、SAML、LDAP 或 CAS)进行身份认证。 |