令牌事件有效载荷

在线编辑

您可以使用以下令牌事件有效载荷，为事件通知 Webhook 和 API 触发异步工作流和同步操作。

表 1. 代币属性
名称 数据类型 描述
data.access_token_type 字符串 请求的令牌类型。 例如，默认不透明令牌使用“bearer”，JWT 格式令牌使用“jwt”。
data.action 字符串 针对该请求执行的操作。 例如，令牌请求时显示“已签发”，令牌撤销时显示“已撤销”。
data.applicationname 字符串 与该令牌请求关联的应用程序名称。 当 client_category 为“应用程序客户端”或“应用程序 API 客户端”时可用。
data.applicationtype 字符串 与该令牌请求关联的应用程序类型。 例如“自定义应用程序”。 当 client_category 为“应用程序客户端”或“应用程序 API 客户端”时可用。
data.applicationid 字符串 与该令牌请求关联的应用程序 ID。 当 client_category 为“应用程序客户端”或“应用程序 API 客户端”时可用。
data.at_hash 字符串 访问令牌的哈希值。
data.cause 字符串 故障原因。
data.client_category 字符串 客户端的类型。 例如，租户 API 客户端称为“API 客户端”，应用程序客户端称为“应用程序客户端”，而应用程序 API 客户端则称为“应用程序 API 客户端”。
data.client_id 字符串 客户机标识。
data.client_name 字符串 客户名称。
data.client_type 字符串 指定客户端是保密客户端还是公共客户端。
data.devicetype 字符串 发出请求的设备的“User-agent”。 例如，浏览器名称或依赖方客户端名称。
data.entitlement 字符串 IBM® Verify 此令牌请求所获的 API 访问权限。
data.grant_id 字符串 用于标识此代币请求所创建的拨款的唯一标识符。
data.grant_type 字符串 资助类型。 例如，“client_credentials”。
data.origin 字符串 此令牌请求的源IP地址。
data.result 字符串 此令牌请求的结果。 例如，成败。
data.scope 字符串 此令牌请求所获的权限范围。 例如，“openid”以及为此请求授予的任何其他权限范围。
data.token_lifetime 字符串 生成的令牌有效期为多少秒。 例如 7200。
data.token_type 字符串 令牌类型。 例如，“访问令牌”。
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。

{
  
    "geoip": {
      "continent_name": "North America",
      "city_name": "Columbus",
      "country_iso_code": "USA",
      "ip": "11.111.11.11",
      "country_name": "United States",
      "region_name": "Ohio",
      "location": {
        "lon": "-83.0235",
        "lat": "39.9653"
      }
    },
    "data": {
      "at_hash": "AbcDeFg123hiJKlmNOpq-U",
      "client_category": "API client",
      "origin": "22.222.22.22",
      "entitlement": "authnAnyUser performDUA createPrivacyConsent runExternalAgent generateOTP manageAccessPolicies manageAPIClients manageAppAccessOwner manageAppAccessAdmin manageAppPurpose manageAttributes manageAuthenticatorsConfig manageAuthenticatorsAnyUser manageCerts manageExternalAgents manageFederations manageIdentitySources manageOIDCConsents manageOIDCGrants manageOidcDynamicClient managePwdVault managePwdPolicy managePwdVaultConfig managePwdVaultAnyUser managePrivacyConsent managePurpose managePrivacyPolicy managePushCreds manageReports manageEnrollMFAMethodAnyUser manageMFAMethods manageTemplates manageUserStandardGroups manageUserGroups readAccessPolicies readAppConfig readAttributes readAuthenticatorsConfig readAuthenticatorsAnyUser readCerts readExternalAgents readFederations readIdentitySources readOIDCConsents readOIDCGrants readPwdVault readPwdPolicy readPwdVaultConfig readPwdVaultAnyUser readPrivacyConsent readPurpose readPrivacyPolicy readPushCreds readReports readEnrollMFAMethodAnyUser readMFAMethods readTemplates readTenantProperties readUserGroups recoverUsername resetPassword resetPasswordAnyUser performDSP manageAllUserGroups updateAnyUser",
      "token_type": "Access token",
      "devicetype": "UNKNOWN",
      "client_id": "33333333-3333-3333-3333-333333333333",
      "access_token_type": "Bearer",
      "result": "success",
      "token_lifetime": "7200",
      "grant_type": "client_credentials",
      "grant_id": "44444444-4444-4444-4444-444444444444",
      "scope": "openid",
      "action": "issued",
      "client_name": "My client"
    },
    "year": 2023,
    "event_type": "token",
    "month": 1,
    "indexed_at": 1674769220306,
    "tenantid": "55555555-5555-5555-5555-555555555555",
    "tenantname": "tenant name.verify.ibmcloudsecurity.com",
    "correlationid": "CORR_ID-6666666666-6666-6666-6666-666666666666",
    "id": "77777777-7777-7777-7777-777777777777",
    "time": 1674769219931,
    "day": 26
}