Verify 应用程序编程接口 (API)

可以访问 Verify 应用程序编程接口 (API) 并将其用于内部应用程序开发。

支持 有关更多信息，请参阅 IBM® Security Verify 文档中心中的 API 文档。

IBM 培训 在 IBM 培训 中观看 Verify API 视频。

HTTP 方法

每个 API 资源都由一个指定的统一资源标识 (URI) 进行标识，并通过使用以下标准 HTTP 方法进行访问。 HTTP 方法指示针对对象的目标操作。
表 1. HTTP 方法
HTTP 方法 描述
GET 在指定的 URL 检索资源或关系。
  • URL （ <resource-noun> ）的请求会检索所有实例，但会受到搜索和分页的限制（参见搜索部分）。
  • 资源标识级别 (<resource-noun>/<resource-id>) 的请求返回单个资源。
  • 处于关系名称级别 (<relationship>) 的请求会检索所有关系实例，这取决于搜索和页面调度约束。
  • 缺省响应状态码为 200。
  • 结果的分页可以通过添加查询参数（如“count”，最大值为 1000）进行定制。
  • 关系标识级别 (<relationship>/<relationship-id>) 的请求返回单个关系实例。
POST 在指定 URL 处创建资源或关系。
  • 在URL （ <resource-noun> ）发出请求即可创建资源。
  • 关系标识级别 (<relationship>) 的请求将创建新关系。
  • 可用于批量装入创建。
PUT 在指定 URL 处更新资源或关系。
  • 在URL （ <resource-noun> ）发出请求，即可更新资源。
  • 关系标识级别 (<relationship>) 的请求将更新新关系。 并非所有关系都可以修改，因此在某些情况下，此请求可能会被视为错误请求。
  • 更改只读信息（例如，资源或关系标识）的请求被视为错误请求。
PATCH

用于对资源执行部分更新。

  • URL请求（ <resource-noun> 仅更新指定资源请求中提供的属性的增量）。
  • PATCH 的内容类型为 application/json-patch+json。
  • 如果使用主要标识（映射到主键的唯一标识或特性）指定删除操作，那么会删除整个对象。
删除 在指定 URL 处除去资源或关系。
注: 对于批量装入删除，请使用 PATCH。