管理开发者
开发者是你的开发者门户的用户。一些开发者管理任务是通过提供商门户管理 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
}
要查看待处理的注册,请使用下一部分中的批准端点。在本地验证中,将 state=Pending 添加到 GET /api/developers 并不能提供可靠的仅待处理过滤器。
创建开发者
开发者账户通常通过 开发者门户自行注册创建(参见注册与登录)。
要以编程方式配置开发者,请调用独立的开发者门户后端(默认 :4321),而不是仪表板/提供商门户管理 API。相关端点为POST /api/developers;请求正文、响应模式和身份验证标头(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)进行身份验证。 |