プレビュー版
PocketSign Link v2 は現在プレビュー版です。正式提供までに仕様が変更される可能性があります。
KLONEvent 仕様
KLONEvent は、発生したイベントの種類やそのイベントに関する情報を、規定のスキーマでペイロード部分に含んでいる JWT 形式として表現されます。全イベントで共通して含まれるデータと、イベント別に含まれるデータが存在します。
共通
JWT Header
| キー | 値 |
|---|---|
alg | 署名アルゴリズム（ES256 など） |
typ | klonevent+jwt 固定値 |
kid | 署名鍵の識別子 |
JWT Payload
| キー | 値 |
|---|---|
iss | KLONEvent の発行元（IdP サーバーのオリジン） |
iat | JWT 生成日時（Unix タイムスタンプ） |
aud | KLONEvent 通知先のサービスの ID（UUID） |
jti | KLONEvent の一意 ID |
toe | イベント発生日時（Unix タイムスタンプ） |
events | イベント別データのオブジェクト。イベントキーをキーとし、イベント固有のデータを値として持つ |
iss の値は環境によって異なります。
| 環境 | iss |
|---|---|
| ポケットサイン開発環境 | https://id.mock.klon.you |
| テスト環境 | https://id.test.klon.you |
| 本番環境 | https://id.klon.you |
サンプル
Header:
{
"alg": "ES256",
"typ": "klonevent+jwt",
"kid": "kOYoCNsODUMAvobFdTBySIUNJkUVSCb5YCSsZEqw7Mk"
}
Payload:
{
"iss": "https://id.mock.klon.you",
"iat": 1752204930,
"aud": "6e205c39-a73b-4a5d-b2cf-1d4f0e8b0a60",
"jti": "0e30e0e1-8a6e-4d7c-8257-7b1f8df6d6c1",
"toe": 1752204925,
"events": {
"https://id.klon.you/events/v1/service/subscribed": {
"subscription_id": "f9a4d8db-98e0-41b3-af12-5cb499f6e4c1",
"service_id": "6e205c39-a73b-4a5d-b2cf-1d4f0e8b0a60"
}
}
}
イベント別データ
注記
イベントキーは環境によって変化しません。
例えば、「サービスがサブスクライブされた」イベントのイベントキーは、本番環境・ポケットサイン開発環境ともに https://id.klon.you/events/v1/service/subscribed です。
サブスクリプション系イベント
service/subscribed: サービスがサブスクライブされた
イベントキー: https://id.klon.you/events/v1/service/subscribed
| キー | 値 |
|---|---|
subscription_id | サブスクリプション ID |
service_id | サブスクライブされたサービスの ID |
{
"https://id.klon.you/events/v1/service/subscribed": {
"subscription_id": "f9a4d8db-98e0-41b3-af12-5cb499f6e4c1",
"service_id": "6e205c39-a73b-4a5d-b2cf-1d4f0e8b0a60"
}
}
service/unsubscribed: サービスのサブスクライブが解除された
イベントキー: https://id.klon.you/events/v1/service/unsubscribed
| キー | 値 |
|---|---|
subscription_id | サブスクリプション ID |
service_id | サブスクライブが解除されたサービスの ID |
{
"https://id.klon.you/events/v1/service/unsubscribed": {
"subscription_id": "f9a4d8db-98e0-41b3-af12-5cb499f6e4c1",
"service_id": "6e205c39-a73b-4a5d-b2cf-1d4f0e8b0a60"
}
}
リソース系イベント
resource/written: リソース値が書き込まれた
イベントキー: https://id.klon.you/events/v1/resource/written
| キー | 値 |
|---|---|
resource_definition_id | 書き込まれたリソース定義の ID |
subscription_id | 対象ユーザーのサブスクリプション ID |
{
"https://id.klon.you/events/v1/resource/written": {
"resource_definition_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"subscription_id": "f9a4d8db-98e0-41b3-af12-5cb499f6e4c1"
}
}
resource/deleted: リソース値が削除された
イベントキー: https://id.klon.you/events/v1/resource/deleted
| キー | 値 |
|---|---|
resource_definition_id | 削除されたリソース定義の ID |
subscription_id | 対象ユーザーのサブスクリプション ID |
{
"https://id.klon.you/events/v1/resource/deleted": {
"resource_definition_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"subscription_id": "f9a4d8db-98e0-41b3-af12-5cb499f6e4c1"
}
}
resource/derived_changed: 算出リソースが変化した
イベントキー: https://id.klon.you/events/v1/resource/derived_changed
| キー | 値 |
|---|---|
resource_definition_id | 変化した算出リソース定義の ID |
subscription_id | 対象ユーザーのサブスクリプション ID |
{
"https://id.klon.you/events/v1/resource/derived_changed": {
"resource_definition_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"subscription_id": "f9a4d8db-98e0-41b3-af12-5cb499f6e4c1"
}
}