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

オンラインで編集

以下のトークンイベントペイロードを使用すると、イベント通知のWebhookやAPIに対して、非同期ワークフローや同期処理をトリガーすることができます。

表 1. トークンの属性
名前 データ・タイプ 説明
data.access_token_type ストリング 要求されたトークンの種類。 たとえば、デフォルトの不透明トークンには「bearer」、JWT形式のトークンには「jwt」などです。
data.action ストリング そのリクエストに対して実行される処理。 たとえば、トークンのリクエストの場合は「issued」、トークンの失効の場合は「revoked」などです。
data.applicationname ストリング このトークンリクエストに関連付けられているアプリケーションの名前。 client_category が「Application client」または「Application API client」の場合に利用可能です。
data.applicationtype ストリング このトークンリクエストに関連付けられているアプリケーションの種類。 例えば「カスタムアプリケーション」など。 client_category が「Application client」または「Application API client」の場合に利用可能です。
data.applicationid ストリング このトークンリクエストに関連付けられたアプリケーションのID。 client_category が「Application client」または「Application API client」の場合に利用可能です。
data.at_hash ストリング アクセストークンのハッシュ。
data.cause ストリング 故障の原因。
data.client_category ストリング クライアントの種類。 例えば、テナントAPIクライアントの「APIクライアント」、および「アプリケーションクライアント」や「アプリケーションAPIクライアント」などです。
data.client_id ストリング クライアント ID。
data.client_name ストリング クライアント名。
data.client_type ストリング クライアントが機密クライアントか公開クライアントかを指定します。
data.devicetype ストリング リクエストを送信したデバイスの「User-agent」。 たとえば、ブラウザ名や信頼先クライアント名などです。
data.entitlement ストリング このトークンリクエストに対して付与されたAPIアクセス権限。 IBM® Verify
data.grant_id ストリング このトークンリクエストのために作成されたグラントを識別するための固有の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
}