Webhooksイベントタイプ

Session.Delete

セッションが削除されたときに発行されます。

このイベントの後、セッションは存在しなくなります。/session/get は NOT_FOUND で HTTP 400 を返し、プレイヤーがアクセスを取り戻すには年齢ゲートをもう一度完了する必要があります。

セッションが終了するそれぞれのケースへの対応は、セッションのライフサイクル全体の一部として、セッションと権限の管理を参照してください。

セッションはさまざまな理由で終了する可能性があります。revocation オブジェクトに、誰がなぜ終了したかが示されます:

actorreason発生するタイミング
parentaccess-revoked-by-parent保護者が Family Connect でプロダクトへのすべてのアクセスを取り消した
developerdeleted-by-developerお客様のインテグレーションが /session/delete でセッションを削除した
developererased-by-developerお客様のインテグレーションが hardDelete: true でセッションを削除した
developeressential-product-deleted依存先の必須プロダクトのセッションが essentialDependencies: cascade で削除された

これらの値は今後増える可能性があります

k-ID は新しい actor、reason、evidence のキーをいつでも追加する可能性があります。revocation の内容にかかわらず、すべての Session.Delete を「このプレイヤーにはセッションがない」として扱ってください。actor と reason での分岐は既知の値に対してのみ行い、それ以外は無視してください。

フィールド

フィールドタイプ必須説明
eventTypestringはい常に"Session.Delete"
dataobjectはいセッション削除データ
data.idstring (UUID)はいセッションID
data.productIdnumberはいプロダクトID
data.revocationobjectいいえ誰がなぜセッションを終了したか
data.revocation.actorstringはいセッションを終了した主体。例:parent、developer
data.revocation.reasonstringはいセッションが終了した理由。例:access-revoked-by-parent
data.revocation.evidenceobjectいいえ理由の詳細(文字列値)。下記を参照

証拠

reason証拠のキー
essential-product-deletedcauseSessionId:依存先の削除されたセッション。causeProductId:そのセッションのプロダクト

その他の理由には、現時点では evidence はありません。

例

{
  "eventType": "Session.Delete",
  "data": {
    "id": "2d064cf7-0726-4193-b19a-8bd387937e60",
    "productId": 42,
    "revocation": {
      "actor": "parent",
      "reason": "access-revoked-by-parent"
    }
  }
}

On this page