通知事件有效载荷
您可以使用以下通知事件负载,为事件通知 Webhook 和 API 触发异步工作流和同步操作。
| 名称 | 数据类型 | 描述 |
|---|---|---|
| data.action | 字符串 | 用户针对该资源执行的操作。 |
| data.api_grant_type | 字符串 | JWT 中的 grant-type。 |
| data.cause | 字符串 | 描述该操作的消息。 |
| data.devicetype | 字符串 | 浏览器的用户代理。 |
| data.intraservice | 字符串 | 表示该事件是由系统执行的,还是由层级操作执行的。 |
| data.origin | 字符串 | 导致生成事件的系统的 IP 地址。 |
| data.performedby | 字符串 | 云目录用户 ID 或 API 客户端的 UUID。 |
| data.performedby_realm | 字符串 | 实施该行为之人的领域。 |
| data.performedby_type | 字符串 | API、设备、系统或用户。 |
| data.performedby_username | 字符串 | 执行该操作的用户用户名。 |
| data.realm | 字符串 | 用户的身份源。 示例 云目录 - CloudIdentityRealm, IBMid - www.ibm.com SAML 企业 - AzureRealm LDAP pass-through - www.cloudsecurity.com OIDC - www.yahoo.com |
| data.resource | 字符串 |
|
| data.result | 字符串 | 该活动的结果。 例如,成功或失败。 |
| data.self | 字符串 | 指定请求目标是否与通过 value 执行的请求相同。 例如,Scott 更新了 Scott 的 MFA 配置。 |
| data.subject | 字符串 | 其资源受到影响的实体。 |
| data.targetid | 字符串 | 用于定义操作目标的补充信息。 由以下资源使用:用户、组 |
| data.username | 字符串 | 用于登录 Verify 的唯一标识符。 可与用户的电子邮件地址相同。 |
| data.webhook_id | 字符串 | 该 webhook 的唯一标识符。 注意: 使用外部多因素身份验证(MFA)提供商时,会添加 Webhook 字段。该字段仅在通知事件发生于 MFA 流程期间时才会出现。 |
| data.webhook_request_id | 字符串 | Webhook 请求本身的唯一标识符,由 Webhook 返回。 注意: 使用外部多因素身份验证(MFA)提供商时,会添加 Webhook 字段。该字段仅在通知事件发生于 MFA 流程期间时才会出现。 |
| geoip.city_name geoio.continent_name geoip.country_iso_code geoip.country_name geoip.location geoip.region_name |
字符串 | 由事件服务使用 data.origin 扩充。 |
示例
以下代码是一个示例有效载荷。 使用 Events API 获取实际属性。 参见 https://docs.verify.ibm.com/verify/reference/getallevents 和 https://docs.verify.ibm.com/verify/docs/pulling-event-data。
{
"_index": "event-notice-2024.10-000001",
"_type": "_doc",
"_id": "1a1111a1-aa1a-111a-a11a-aa111a11a111",
"_version": 1,
"_score": 1,
"_source": {
"data": {
"result": "failure",
"performedby": "system",
"targetid": "22222b22-2b2b-2222-bb22-22b222bb2222",
"resource": "fido2_metadata",
"action": "attempted",
"devicetype": "system"
},
"year": 2024,
"@metadata": {
"source_dc": "ic-classic-dev-us02a"
},
"event_type": "notice",
"month": 10,
"indexed_at": 1727870534252,
"@processing_time": 1503,
"tenantid": "default",
"tenantname": "c33c3ccc-c3c3-333c-3ccc-3c3333333333",
"servicename": "factors",
"id": "1a1111a1-aa1a-111a-a11a-aa111a11a111",
"time": 1727870532749,
"day": 2
},
"fields": {
"data.performedby.lowercase": [
"system"
],
"year": [
2024
],
"data.devicetype.lowercase": [
"system"
],
"data.result": [
"failure"
],
"event_type.keyword": [
"notice"
],
"data.resource.lowercase": [
"fido2_metadata"
],
"data.result.lowercase": [
"failure"
],
"event_type": [
"notice"
],
"id.keyword": [
"1a1111a1-aa1a-111a-a11a-aa111a11a111"
],
"indexed_at": [
"2024-10-02T12:02:14.252Z"
],
"@processing_time": [
1503
],
"tenantid.keyword": [
"default"
],
"data.targetid": [
"22222b22-2b2b-2222-bb22-22b222bb2222"
],
"tenantid": [
"default"
],
"event_type.lowercase": [
"notice"
],
"@metadata.source_dc.lowercase": [
"ic-classic-dev-us02a"
],
"servicename": [
"factors"
],
"id": [
"1a1111a1-aa1a-111a-a11a-aa111a11a111"
],
"tenantid.lowercase": [
"default"
],
"day": [
2
],
"data.action.keyword": [
"attempted"
],
"data.performedby": [
"system"
],
"servicename.keyword": [
"factors"
],
"id.lowercase": [
"1a1111a1-aa1a-111a-a11a-aa111a11a111"
],
"servicename.lowercase": [
"factors"
],
"data.resource.keyword": [
"fido2_metadata"
],
"data.targetid.lowercase": [
"22222b22-2b2b-2222-bb22-22b222bb2222"
],
"data.targetid.keyword": [
"22222b22-2b2b-2222-bb22-22b222bb2222"
],
"data.performedby.keyword": [
"system"
],
"@metadata.source_dc.keyword": [
"ic-classic-dev-us02a"
],
"data.result.keyword": [
"failure"
],
"data.devicetype.keyword": [
"system"
],
"data.devicetype": [
"system"
],
"tenantname.lowercase": [
"c33c3ccc-c3c3-333c-3ccc-3c3333333333"
],
"month": [
10
],
"data.action": [
"attempted"
],
"data.resource": [
"fido2_metadata"
],
"tenantname.keyword": [
"c33c3ccc-c3c3-333c-3ccc-3c3333333333"
],
"tenantname": [
"c33c3ccc-c3c3-333c-3ccc-3c3333333333"
],
"time": [
"2024-10-02T12:02:12.749Z"
],
"@metadata.source_dc": [
"ic-classic-dev-us02a"
],
"data.action.lowercase": [
"attempted"
]
}
}