トークン・イベント・ペイロード

オンラインで編集

以下のトークン・イベント・ペイロードを使用して、イベント通知 Webhook および API の非同期ワークフローおよび同期をトリガーできます。

表 1. トークン属性
名前 データ・タイプ 説明
data.access_token_type ストリング 要求されたトークンのタイプ。 例えば、デフォルトの不透明なトークンの場合は「bearer」、JWT 形式のトークンの場合は「jwt」です。
data.action ストリング 要求に対して実行される操作。 例えば、トークン要求の場合は「issued」、トークン取り消しの場合は「revoked」です。
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 クライアントの場合は「アプリケーション API クライアント」などです。
data.client_id ストリング クライアント ID。
data.client_name ストリング クライアント名。
data.client_type ストリング クライアントが機密クライアントであるか公開クライアントであるかを指定します。
data.devicetype ストリング 要求を実行したデバイスの「ユーザー・エージェント」。 例えば、ブラウザー名やリライング・パーティー・クライアント名などです。
data.entitlement ストリング このトークン・リクエストに対して付与された IBM® Verify API アクセス権限。
data.grant_id ストリング このトークン要求に対して作成された付与を識別するための固有 ID。
data.grant_type ストリング 付与タイプ。 例えば、「client_credentials」などです。
data.origin ストリング このトークン要求の起点の IP アドレス。
data.result ストリング このトークン要求の結果。 例えば、success や failure などです。
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 を使用してイベント・サービスによって拡張

例

以下のコードは、サンプル・ペイロードです。 イベント 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
}