用途:从门户消费者视角管理用于调用 API 的凭证型对象(应用)。每个应用拥有 clientId/clientSecret 对,并可对已发布 API 持有多个契约。
主要能力与用法(均使用 api: urn:api:api-experience-hub-consumer):
- 列出应用:operationId getApplications,需 targetOrganizationId、portalId,输出应用列表及 applicationId。
- 检查名称可用性:operationId checkExistenceApplicationName,输入候选名称(如 orders-prod-client),输出 available 判断是否可用。
- 创建应用:operationId createApplication,需 targetOrganizationId、portalId,以及按门户策略可能需要的 groupId、assetId、minorVersion 与应用元数据(名称、描述、OAuth/OIDC redirectUris)。输出新应用 ID、clientId、clientSecret。clientSecret 仅创建时展示,须安全保存;丢失需通过密钥轮换重置。
- 更新元数据:operationId updateApplication,需 applicationId 与更新内容,确认返回 ID。
- 重置密钥:operationId resetClientSecretForApplication,需 applicationId,输出新 clientSecret(仅展示一次),旧密钥随即失效,须同步更新所有调用方。
- 查看详情:operationId getApplicationDetailById,返回当前元数据,含 clientId,不返回密钥。
- 删除应用:operationId deleteApplication,删除后与该应用绑定的所有契约被撤销。
适用场景:门户消费者维护健康的凭证组合——盘点应用、创建与命名、更新回调地址、按计划或事故后轮换密钥、清理闲置客户端。
前置条件:有效的门户消费者 Bearer 令牌、为该门户成员、已知 targetOrganizationId 与 portalId。后续可通过 request-api-access 为应用创建针对已发布 API 的契约,并用相关步骤审计契约。
限制:clientSecret 仅在创建或轮换时返回一次,无法再次获取;删除应用会连带撤销契约;具体名称规则、group/asset 绑定是否必需等以门户策略为准,资料未进一步说明。