履约事件有效载荷

在线编辑

您可以使用以下订单履行事件的有效载荷，来触发事件通知 Webhook 和 API 的异步工作流和同步操作。

表 1. 履约属性
名称 数据类型 描述
data.account_name 字符串 从目标处检索到的账户名称。
data.action 字符串 已执行操作的详细信息。 例如，provisioning_event。
data.application 字符串 应用程序的名称。
data.applicationid 字符串 每个应用程序的唯一标识符。
data.applicationname 字符串 应用程序的名称。
data.application 类型 字符串 应用程序的类型。
data.cause 字符串 描述该操作的消息。 例如，Provisioning event generated,Account provisioning failed.
data.entitlementcategory 字符串 描述该权益所属类别的属性。
data.entitlementid 字符串 指定授权 ID。
data.entitlementname 字符串 许可权的名称。 例如，基础访问。
data.entitlementtype 字符串 该权益的类型。 例如，权限。
data.eventid 字符串 为每个事件生成的ID。
data.group_name 字符串 组的名称。 例如，所有用户。
data.groupid 字符串 分配给该组的ID。 例如，allUsers。
data.ib_request_id 字符串 用于在身份代理端搜索事件的身份代理 ID。
data.lastUpdatedtime 字符串 该事件的最后更新时间，以格林尼治标准时间表示，并采用纪元格式。
data.message_description 字符串 提供该活动的描述。 例如， CSIBK0021E 系统无法连接到目标应用程序。
data.message_details 字符串 该活动的详细说明。 例如，无法连接到端点。
data.owners_ids 字符串 拥有该应用程序的用户 userids 列表。
data.owners 字符串 拥有该应用程序的用户名称。
data.performedby 字符串 云目录的用户 ID 或 API 客户端的 UUID。
data.performedby_clientname 字符串 API 客户端名称。
data.performedby_realm 字符串 实施该行为之人的领域。
data.performedby_type 字符串 API、系统或用户。
data.performedby_username 字符串 执行该操作的用户名。
data.permissionextref 字符串 某项权限的外部引用 ID。
data.permissionrights 字符串 来自目标端的权限值。
data.reason 举办此次活动的缘由。 例如，无法连接到端点。
data.reconcilliationid 字符串 与每次已执行的对账操作相关联的唯一标识符。
data.resource 字符串 指定事件的来源。 例如，特权。
data.response_status 字符串 表示从身份代理接收到的响应的状态。
data.result 字符串 该活动的结果。 例如，成功或失败。
data.status_code 字符串 返回事件的状态码。 例如，500。
data.subaction 字符串 描述在主操作下执行的子操作。
data.subject 字符串 例如，基础访问。
data.subject_type 字符串 请提供科目类型。 例如，特权。
data.subjectid 字符串 目标的唯一标识符。
data.subtype 字符串 定义事件的子类型。 例如，provisioning_event。
data.target_type 字符串 定义目标类型。
data.target 字符串 可能适用的辅助资源。
data.targetid 字符串 目标的唯一标识符。
data.templateid 字符串 该应用程序的模板 ID。
data.userid 字符串 云目录 userid 或 API 客户端的 UUID。
data.userid_username 字符串 用户在云目录中的用户名。
x-service-correlationid 字符串 每个事件的关联 ID。 例如，CORR_ID-AK 85d04a3d-1873-4145-875e-1872b6448871。

示例

以下代码是一个示例有效载荷。 使用 Events API 获取实际属性。 参见 https://docs.verify.ibm.com/verify/reference/getallevents 和 https://docs.verify.ibm.com/verify/docs/pulling-event-data。

{
  
    "data": {
      "reason": "CSIBK0030E The application is suspended because of too many recent token refresh requests. Requests will fail until Thu Feb 02 16:43:32 UTC 2023.",
      "status_code": "500",
      "targetid": "1111111111",
      "subject": "jacob",
      "x-service-correlationid": "2222222222222",
      "cause": "Account deprovisioned or suspended.",
      "owners": "[jacob]",
      "result": "success",
      "performedby": "system",
      "account_name": "jacob",
      "action": "account_deprovisioned",
      "applicationid": "3333333333333333333",
      "ib_request_id": "44444444-4444-4444-4444-444444444444",
      "performedby_type": "system",
      "subject_type": "account",
      "lastUpdatedtime": "1675355917468",
      "message_description": "CSIBK0030E The application is suspended because of too many recent token refresh requests. Requests will fail until Thu Feb 02 16:43:32 UTC 2023.",
      "target_type": "user",
      "templateid": "20",
      "subjectid": "55555555555555555555555555555555",
      "applicationname": "ServiceNow",
      "target": "jacob",
      "applicationtype": "ServiceNow",
      "performedby_clientname": "system",
      "owner_ids": "[6666666666]"
    },
    "year": 2023,
    "event_type": "fulfillment",
    "month": 2,
    "indexed_at": 1675355918313,
    "tenantid": "66666666-6666-6666-6666-666666666666",
    "tenantname": "tenant name.ibmcloudsecurity.com",
    "correlationid": "7777777777777",
    "id": "88888888-8888-8888-8888-888888888888",
    "time": 1675355917530,
    "day": 2
 }