エンドポイントの分類

API version 2026-09-21

OpenAPI YAMLをダウンロード

APIリファレンス

Runtime APIとManagement APIの全エンドポイントを、配布中のOpenAPI定義から表示しています。日本語の概要と原文、パラメーター、リクエスト、レスポンス、Example Valueを操作ごとに確認できます。

OpenAPI 3.1.0 から生成（このページからは実行できません）

Example ValueはOpenAPIの型と制約から生成した参考値です。実際のID、トークン、秘密値としては使用できません。

エンドポイント

90

53個のパス

接続先

https://usakey.jp

認証

操作ごとの定義を参照

Management APIはAPIキー、Runtime APIは操作に応じて端末署名を使います。

認証の組み込み方針は製品アプリ組み込み（Runtime API）、APIキーとWebhookの運用は外部システム連携（Management API）を先に確認してください。

Runtime API

Runtime 初期化

2操作

署名鍵一覧と署名付きサーバー時刻を取得します。

GET /runtime/v1/products/{product_id}/trust-bundle 署名鍵の信頼バンドルを取得 OpenAPI原文: Fetch the root-authorized signing-key bundle

製品の署名検証に使う、ルート鍵で認証された署名鍵一覧を取得します。

認証
なし
必要な権限
—
操作ID
runtime_v1_products_trust_bundle

パラメーター

名前場所必須型・説明
product_id パス 必須
PublicId

Example Value

"product_id_aaaaaaaaaaaaaaaaaaaa"

レスポンス

200

成功

署名鍵の信頼バンドル

application/json

Schema

TrustBundleResponse

Example Value

{
  "data": {
    "bundle": {},
    "root_signature": "example-token"
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
POST /runtime/v1/time 署名付きサーバー時刻を取得 OpenAPI原文: Obtain signed server time

クライアントのnonceを含む署名付きサーバー時刻を取得し、端末時刻の改ざん検出に使います。

認証
なし
必要な権限
—
操作ID
runtime_v1_time_create

リクエスト本文

必須
application/json

Schema

object

Example Value

{
  "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
  "nonce": "stringxxxxxxxxxxxxxxxx",
  "sdk_version": "string"
}

レスポンス

200

成功

製品の鍵で署名した応答

application/json

Schema

SignedEnvelope

Example Value

{
  "data": "string",
  "response_assertion": {
    "v": 1,
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "key_id": "01K5QWERTY1234567890ABCDEFG",
    "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "nonce": "string",
    "server_time": 1,
    "status": 1,
    "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "response_signature": "example-token",
  "signing_delegation": {
    "delegation": {
      "v": 1,
      "purpose": "runtime-response",
      "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
      "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
      "online_key_id": "01K5QWERTY1234567890ABCDEFG",
      "public_key": "string",
      "issued_at": 1,
      "expires_at": 1
    },
    "signature": "example-token"
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
413

リクエストが大きすぎます

Runtime API の要求本文が、経路ごとのバイト数の上限を超えています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}

Runtime API

Runtime 端末認証

8操作

端末を登録し、ライセンス状態を継続的に確認します。

POST /runtime/v1/activations/{activation_id}/heartbeat 端末認証と証明書を更新 OpenAPI原文: Refresh license state and certificate

認証済み端末からハートビートを送り、ライセンス状態と端末証明書を更新します。

認証
deviceProof
必要な権限
—
操作ID
runtime_v1_activations_heartbeat

パラメーター

名前場所必須型・説明
activation_id パス 必須
PublicId

Example Value

"activation_id_aaaaaaaaaaaaaaaaaaaa"
X-Usakey-Activation ヘッダー 必須
PublicId

Example Value

"x_usakey_activation_aaaaaaaaaaaaaaaaaaaa"
X-Usakey-Timestamp ヘッダー 必須
integer

Example Value

1
X-Usakey-Nonce ヘッダー 必須
string 最小文字数: 22 最大文字数: 255

Example Value

"stringxxxxxxxxxxxxxxxx"
X-Usakey-Signature ヘッダー 必須
string 最大文字数: 1024

Example Value

"example-token"

リクエスト本文

必須
application/json

Schema

ActivationHeartbeatRequest

Example Value

{
  "machine_info": {
    "os": "string",
    "arch": "string"
  }
}

レスポンス

200

成功

現在のライセンス状態と更新した証明書

application/json

Schema

SignedActivationHeartbeatResponse

Example Value

{
  "data": {
    "activation_id": "activation_id_aaaaaaaaaaaaaaaaaaaa",
    "license_status": "active",
    "certificate": "string",
    "next_heartbeat_in": 10,
    "machine_info_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "response_assertion": {
    "v": 1,
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "key_id": "01K5QWERTY1234567890ABCDEFG",
    "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "nonce": "string",
    "server_time": 1,
    "status": 1,
    "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "response_signature": "example-token",
  "signing_delegation": {
    "delegation": {
      "v": 1,
      "purpose": "runtime-response",
      "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
      "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
      "online_key_id": "01K5QWERTY1234567890ABCDEFG",
      "public_key": "string",
      "issued_at": 1,
      "expires_at": 1
    },
    "signature": "example-token"
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスが取消済み（LICENSE_REVOKED）または期限切れ（LICENSE_EXPIRED）である、端末のリスク判定の規則で端末認証またはライセンスが止められた、またはユーザーへの割当が終わっています。ライセンスの状態は端末認証の状態より先に返すため、取消済みのライセンスの端末には ACTIVATION_DEACTIVATED ではなく LICENSE_REVOKED を返します。期限切れのライセンスは端末認証を残すので、期限を延長してライセンスを再開すれば、同じ activation_id で再び使えます。LICENSE_REVOKED と LICENSE_EXPIRED は短い時間の上限には数えますが、Runtime API の月間回数には数えません。一時停止中のライセンスはエラーではなく、license_status が suspended の 200 を返します。

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
410

利用終了

対象はすでに有効ではありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

管理なしのオフライン買い切りライセンスは定期確認を使いません。または、端末情報のハッシュ値が変わった・完全な基準がまだ無い・最後の完全な基準が24時間より前のため、完全な machine_info が必要です

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
413

リクエストが大きすぎます

Runtime API の要求本文が、経路ごとのバイト数の上限を超えています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
POST /runtime/v1/activations/{activation_id}/sealed-file-keys 暗号化したファイルの鍵をこの端末あてに受け取る OpenAPI原文: Re-wrap a sealed file's data key for this device

暗号化したファイルのヘッダーを送り、ライセンスがそのファイルを使える場合に、ファイルごとのデータ鍵をこの端末の鍵あてに包み直して受け取ります。ファイル本体は送りません。

暗号化したファイルのヘッダーを送ります（docs/security/sealed-files.md）。ライセンスがそのファイルを使える場合、販売者が製品の暗号化用の鍵あてに包んだファイルごとのデータ鍵をサーバーで開き、この端末認証のP-256 KEM公開鍵あてにHPKEで包み直します。ファイル本体はUsakeyに届きません。端末は結果をキャッシュするので、呼ぶのはファイルと端末ごとに1回です。

認証
deviceProof
必要な権限
—
操作ID
runtime_v1_activations_sealed_file_keys

パラメーター

名前場所必須型・説明
activation_id パス 必須
PublicId

Example Value

"activation_id_aaaaaaaaaaaaaaaaaaaa"
X-Usakey-Activation ヘッダー 必須
PublicId

Example Value

"x_usakey_activation_aaaaaaaaaaaaaaaaaaaa"
X-Usakey-Timestamp ヘッダー 必須
integer

Example Value

1
X-Usakey-Nonce ヘッダー 必須
string 最小文字数: 22 最大文字数: 255

Example Value

"stringxxxxxxxxxxxxxxxx"
X-Usakey-Signature ヘッダー 必須
string 最大文字数: 1024

Example Value

"example-token"

リクエスト本文

必須
application/json

Schema

SealedFileKeyRequest

Example Value

{
  "header": "example_value",
  "sdk_version": "string"
}

レスポンス

200

成功

この端末のKEM公開鍵あてに包んだデータ鍵

application/json

Schema

SignedSealedFileKeyResponse

Example Value

{
  "data": {
    "activation_id": "activation_id_aaaaaaaaaaaaaaaaaaaa",
    "file_id": "esNxn3TKNIsd_Dyi2XYojA",
    "header_sha256": "f7511808a1669a5481adebe399a96ad043d29ebb887207743368c3fb812717e5",
    "enc": "BC1G-oCCtQBTqm4VEolqWH6MHHbpugqlixdHLXLURww-71zLlbPAaperQqYpqsHIyF9bJ66JOqwcEaZ1yHqSNPI",
    "wrapped_key": "j4LNTalkfJFXswg_u9NXmazh7FZQHrAs4iqPQNp0hHCsdQIZWcS3AOpEkYp2mape"
  },
  "response_assertion": {
    "v": 1,
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "key_id": "01K5QWERTY1234567890ABCDEFG",
    "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "nonce": "string",
    "server_time": 1,
    "status": 1,
    "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "response_signature": "example-token",
  "signing_delegation": {
    "delegation": {
      "v": 1,
      "purpose": "runtime-response",
      "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
      "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
      "online_key_id": "01K5QWERTY1234567890ABCDEFG",
      "public_key": "string",
      "issued_at": 1,
      "expires_at": 1
    },
    "signature": "example-token"
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスが取り消された（LICENSE_REVOKED）・期限切れ（LICENSE_EXPIRED）・一時停止中（LICENSE_SUSPENDED。定期確認と違い、一時停止中のライセンスには鍵を渡しません）、ユーザーの割当が有効でない、契約組織のプランにファイルの暗号化が含まれない（PLAN_ENTITLEMENT_REQUIRED、details.entitlement は sealed_files）、またはファイルが求める機能権限がこのライセンスで true でない（SEALED_FILE_ENTITLEMENT_REQUIRED、details.entitlement に名前）。

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
410

利用終了

対象はすでに有効ではありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

ヘッダーが暗号化したファイルのヘッダーとして正しくない、別の製品向け・不明な鍵・削除のため廃止した鍵・漏えいした鍵で暗号化されている、データ鍵を開けない、または端末認証のKEM鍵がP-256の鍵でない（SEALED_FILE_INVALID）。

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
413

リクエストが大きすぎます

Runtime API の要求本文が、経路ごとのバイト数の上限を超えています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
POST /runtime/v1/activations ライセンスを端末鍵へ紐づけ OpenAPI原文: Bind a license to a device key

ライセンスキーを端末の公開鍵へ関連付け、署名付きライセンス証明書を発行します。

認証
なし
必要な権限
—
操作ID
runtime_v1_activations_create

パラメーター

名前場所必須型・説明
Idempotency-Key ヘッダー 必須
string 最小文字数: 16 最大文字数: 255

Example Value

"stringxxxxxxxxxx"

リクエスト本文

必須
application/json

Schema

ActivationRequest

Example Value

{
  "license_key": "string",
  "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
  "device_signing_public_key": "string",
  "device_kem_public_key": "string",
  "device_proof": "string",
  "machine_signals": {
    "property": "string"
  },
  "machine_info": {
    "os": "string",
    "arch": "string"
  },
  "app_version": "string",
  "sdk_version": "string",
  "request_id": "01K5QWERTY1234567890ABCDEFG",
  "client_time": 1,
  "named_user_token": "Example name",
  "nonce": "stringxxxxxxxxxxxxxxxx"
}

レスポンス

201

作成完了

端末認証と署名付きライセンス証明書

application/json

Schema

SignedActivationResponse

Example Value

{
  "data": {
    "activation_id": "activation_id_aaaaaaaaaaaaaaaaaaaa",
    "certificate": "string",
    "machine_info_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "response_assertion": {
    "v": 1,
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "key_id": "01K5QWERTY1234567890ABCDEFG",
    "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "nonce": "string",
    "server_time": 1,
    "status": 1,
    "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "response_signature": "example-token",
  "signing_delegation": {
    "delegation": {
      "v": 1,
      "purpose": "runtime-response",
      "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
      "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
      "online_key_id": "01K5QWERTY1234567890ABCDEFG",
      "public_key": "string",
      "issued_at": 1,
      "expires_at": 1
    },
    "signature": "example-token"
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
409

競合

冪等キー・バージョン・端末・同時利用の競合、または製品署名鍵の準備中です

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

このライセンスは、端末に結び付いたオフライン利用ファイルでの認証が必要です

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
413

リクエストが大きすぎます

Runtime API の要求本文が、経路ごとのバイト数の上限を超えています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
DELETE /runtime/v1/activations/{activation_id} 認証中の端末を解除 OpenAPI原文: Self-deactivate the authenticated device

端末自身の認証情報を使い、現在の端末認証を解除します。

認証
deviceProof
必要な権限
—
操作ID
runtime_v1_activations_destroy

パラメーター

名前場所必須型・説明
activation_id パス 必須
PublicId

Example Value

"activation_id_aaaaaaaaaaaaaaaaaaaa"
X-Usakey-Activation ヘッダー 必須
PublicId

Example Value

"x_usakey_activation_aaaaaaaaaaaaaaaaaaaa"
X-Usakey-Timestamp ヘッダー 必須
integer

Example Value

1
X-Usakey-Nonce ヘッダー 必須
string 最小文字数: 22 最大文字数: 255

Example Value

"stringxxxxxxxxxxxxxxxx"
X-Usakey-Signature ヘッダー 必須
string 最大文字数: 1024

Example Value

"example-token"

レスポンス

200

成功

製品の鍵で署名した応答

application/json

Schema

SignedEnvelope

Example Value

{
  "data": "string",
  "response_assertion": {
    "v": 1,
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "key_id": "01K5QWERTY1234567890ABCDEFG",
    "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "nonce": "string",
    "server_time": 1,
    "status": 1,
    "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "response_signature": "example-token",
  "signing_delegation": {
    "delegation": {
      "v": 1,
      "purpose": "runtime-response",
      "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
      "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
      "online_key_id": "01K5QWERTY1234567890ABCDEFG",
      "public_key": "string",
      "issued_at": 1,
      "expires_at": 1
    },
    "signature": "example-token"
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
410

利用終了

対象はすでに有効ではありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
413

リクエストが大きすぎます

Runtime API の要求本文が、経路ごとのバイト数の上限を超えています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
POST /runtime/v1/email-verifications メールアドレスでのライセンス確認を始める OpenAPI原文: Start email license verification for a named user

ユーザー単位のライセンスで、販売者が台帳に登録したローカルIDの利用者のアドレスへ、6桁の確認コードを送ります。一致したときだけ送り、一致しなくても同じ形の202を返します（登録済みのアドレスを探れないようにするため）。確認コードは10分・5回まで有効で、同じ製品・ライセンスキー・アドレスの新しい開始は前の確認を無効にします。Runtime APIの月間回数には数えません。

販売元がローカルIDのライセンスユーザーに登録したメールアドレスへ、6桁の確認コードを送ります。製品アプリは、これで端末認証に使うユーザー単位の認証トークンを得られます。アドレスが一致したかどうかにかかわらず、応答の形と状態コードは同じです。確認コードを送るのは、一致したときだけです（ライセンスキーが有効、利用ルールがユーザー単位、契約組織がメールアドレスでのライセンス確認を使えるプラン（個人以上）、このアドレスを持つ有効なローカルIDのライセンスユーザー（OIDC接続に結び付いていない）がちょうど1人、その利用者にこのライセンスの現在の割当がある）。同じ製品・同じライセンスキー・同じアドレスで新しく開始すると、前の確認は使えなくなります。確認コードは10分で期限が切れ、試せるのは5回までです。この2つの要求はRuntime APIの月間回数に数えません。続く端末認証は数えます。

認証
なし
必要な権限
—
操作ID
runtime_v1_email_verifications_create

リクエスト本文

必須
application/json

Schema

EmailVerificationStartRequest

Example Value

{
  "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
  "license_key": "string",
  "email": "developer@example.com",
  "device_signing_public_key": "string",
  "nonce": "stringxxxxxxxxxxxxxxxx",
  "locale": "ja",
  "sdk_version": "string"
}

レスポンス

202

受付完了

確認を開始しました。確認コードはアドレスが一致したときだけ送り、一致したかどうかは応答からは分かりません

application/json

Schema

SignedEmailVerificationStartResponse

Example Value

{
  "data": {
    "verification_id": "verification_id_aaaaaaaaaaaaaaaaaaaa",
    "expires_at": "2026-09-21T00:00:00Z",
    "resend_after_sec": 1,
    "code_length": 1
  },
  "response_assertion": {
    "v": 1,
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "key_id": "01K5QWERTY1234567890ABCDEFG",
    "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "nonce": "string",
    "server_time": 1,
    "status": 1,
    "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "response_signature": "example-token",
  "signing_delegation": {
    "delegation": {
      "v": 1,
      "purpose": "runtime-response",
      "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
      "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
      "online_key_id": "01K5QWERTY1234567890ABCDEFG",
      "public_key": "string",
      "issued_at": 1,
      "expires_at": 1
    },
    "signature": "example-token"
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
413

リクエストが大きすぎます

Runtime API の要求本文が、経路ごとのバイト数の上限を超えています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
POST /runtime/v1/email-verifications/{verification_id}/confirm 確認コードを照合して端末認証用のトークンを得る OpenAPI原文: Confirm the emailed code and obtain a named-user token

開始と同じ端末の署名鍵で確認コードを照合し、端末認証（POST /runtime/v1/activations）のnamed_user_tokenに入れるトークン（5分）を返します。2段階認証を登録済みの利用者は、認証アプリのコード、リカバリーコード、またはパスキーの承認コードをsecond_factor_codeに入れて送ります。パスキーの利用者は、確認メールのリンクを開いてパスキーで承認すると、承認コードが表示されます。承認コードはその確認だけに使え、最長10分・1回限り有効です。2段階目のコードが無いときは401 TWO_FACTOR_REQUIREDで、メールの確認コードは使えるまま残ります。誤りのたびに試行が1回減り、使い切るか10分を過ぎたら、開始からやり直します。

確認を開始したときと同じ端末の署名用公開鍵で6桁の確認コードを照合し、POST /runtime/v1/activationsに渡すユーザー単位の認証トークン（named_user_token）を返します。トークンの有効期間は5分です。2段階認証を使う利用者は、認証アプリのコード、リカバリーコード、またはパスキーの承認コードをsecond_factor_codeに送ってください。承認コードは、確認メールのリンクを開き、パスキーで承認すると表示されます。この確認だけに使え、有効期間は最長10分、使用は1回限りです。2段階認証のコードがない場合は401 TWO_FACTOR_REQUIREDとなり、メールの確認コードは有効なまま残るので、両方をもう一度送ってください。確認コードの誤り・端末の鍵の違い・2段階認証のコードの誤りは、それぞれ5回の試行を1回使います。使い切ったあとや10分を過ぎたあとは、開始からやり直してください。不明な確認や、一致しなかった確認にも、確認コードの誤りと同じエラーを返します。

認証
なし
必要な権限
—
操作ID
runtime_v1_email_verifications_confirm

パラメーター

名前場所必須型・説明
verification_id パス 必須
PublicId

Example Value

"verification_id_aaaaaaaaaaaaaaaaaaaa"

リクエスト本文

必須
application/json

Schema

EmailVerificationConfirmRequest

Example Value

{
  "code": "123456",
  "second_factor_code": "string",
  "device_signing_public_key": "string",
  "nonce": "stringxxxxxxxxxxxxxxxx",
  "sdk_version": "string"
}

レスポンス

200

成功

端末認証に使うユーザー単位の認証トークン

application/json

Schema

SignedEmailVerificationConfirmResponse

Example Value

{
  "data": {
    "named_user_token": "Example name",
    "expires_at": "2026-09-21T00:00:00Z"
  },
  "response_assertion": {
    "v": 1,
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "key_id": "01K5QWERTY1234567890ABCDEFG",
    "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "nonce": "string",
    "server_time": 1,
    "status": 1,
    "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "response_signature": "example-token",
  "signing_delegation": {
    "delegation": {
      "v": 1,
      "purpose": "runtime-response",
      "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
      "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
      "online_key_id": "01K5QWERTY1234567890ABCDEFG",
      "public_key": "string",
      "issued_at": 1,
      "expires_at": 1
    },
    "signature": "example-token"
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

EMAIL_VERIFICATION_CODE_INVALID（確認コードか端末の鍵の違い）、TWO_FACTOR_REQUIRED（メールの確認コードは正しく、まだ有効です。認証アプリのコード、確認メールのリンクからパスキーで得た承認コード、またはリカバリーコードを一緒に送ってください）、またはTWO_FACTOR_INVALIDです。details.remaining_attemptsは残りの試行回数です

application/json

Schema

EmailVerificationError

Example Value

{
  "error": {
    "code": "EMAIL_VERIFICATION_CODE_INVALID",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "details": {
      "remaining_attempts": 0
    }
  }
}
403

権限不足

TWO_FACTOR_LOCKED（この利用者の2段階認証のロックを、販売元が解除する必要があります）、NAMED_USER_ASSIGNMENT_UNAVAILABLE（開始のあとで割当・利用者・ライセンス・プランが変わった）、または PLAN_ENTITLEMENT_REQUIRED です

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
410

利用終了

EMAIL_VERIFICATION_EXPIRED。確認の期限切れ・使用済み・新しい開始による無効化・試行の使い切り、または不明な確認です。確認を開始からやり直してください

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
413

リクエストが大きすぎます

Runtime API の要求本文が、経路ごとのバイト数の上限を超えています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
POST /runtime/v1/trial-verifications メール確認付きの試用を始める OpenAPI原文: Start a trial sign-up with email verification

利用者が入力したアドレスへ6桁の確認コードを送り、この端末で製品の試用を始められるようにします。製品が試用を受け付けている（販売者が試用の利用ルールを選び、24時間の受付上限に空きがある）とき、契約組織にトライアルの権利があるときだけ送り、そうでなくても同じ202を返します。過去の試用の有無は確認のときに伝えます。同じアドレスへの送信は120秒あけて1時間3回・1日5回（製品ごと）、全製品で1日10回まで。Runtime APIの月間回数には数えません。

利用者が入力したメールアドレスへ6桁の確認コードを送り、製品アプリがこの端末でこの製品の試用を始められるようにします。確認コードを送るのは、製品が試用の開始を受け付けていて（販売元が試用の利用ルールを選び、24時間の受付上限に空きがある）、契約組織がトライアルを使えるプラン（trial_licenses）のときだけです。そうでない場合も同じ202を返し、何も送りません。そのアドレスや端末がすでに試用したかどうかはここでは判定せず、確認のときに伝えます。同じアドレスへの送信は120秒あけ、製品ごとに1時間3回・1日5回、全製品で1日10回までです。Runtime APIの月間回数には数えません。

認証
なし
必要な権限
—
操作ID
runtime_v1_trial_verifications_create

リクエスト本文

必須
application/json

Schema

TrialVerificationStartRequest

Example Value

{
  "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
  "email": "developer@example.com",
  "device_signing_public_key": "string",
  "nonce": "stringxxxxxxxxxxxxxxxx",
  "locale": "ja",
  "sdk_version": "string"
}

レスポンス

202

受付完了

確認を開始しました。確認コードは製品が試用の開始を受け付けているときだけ送り、受け付けているかどうかは応答からは分かりません

application/json

Schema

SignedEmailVerificationStartResponse

Example Value

{
  "data": {
    "verification_id": "verification_id_aaaaaaaaaaaaaaaaaaaa",
    "expires_at": "2026-09-21T00:00:00Z",
    "resend_after_sec": 1,
    "code_length": 1
  },
  "response_assertion": {
    "v": 1,
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "key_id": "01K5QWERTY1234567890ABCDEFG",
    "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "nonce": "string",
    "server_time": 1,
    "status": 1,
    "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "response_signature": "example-token",
  "signing_delegation": {
    "delegation": {
      "v": 1,
      "purpose": "runtime-response",
      "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
      "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
      "online_key_id": "01K5QWERTY1234567890ABCDEFG",
      "public_key": "string",
      "issued_at": 1,
      "expires_at": 1
    },
    "signature": "example-token"
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
413

リクエストが大きすぎます

Runtime API の要求本文が、経路ごとのバイト数の上限を超えています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
POST /runtime/v1/trial-verifications/{verification_id}/confirm 確認コードで試用のライセンスを発行し、この端末を認証する OpenAPI原文: Confirm the emailed code, issue a trial license, and activate this device

確認コードと開始のときのアドレスを照合し、販売者が選んだ試用の利用ルールでトライアルのライセンスを発行して、この端末を端末認証します。応答は端末認証と同じ署名付きの内容にlicense_idを足したもので、ライセンスキーは返しません。本文は端末認証の項目（license_keyとproduct_idを除く）にcodeとemailを足したもので、device_proofは、前置き「Usakey-Trial-Proof-v1」と改行に続けて署名します。同じアドレスの試用が有効なら、この端末をその試用に足します。365日以内に同じアドレスか同じ端末の鍵で試用していれば 403 TRIAL_ALREADY_USEDです。端末認証の1回を月間回数に数えます。

確認コードと、開始したときのメールアドレスを照合し、販売元が選んだ利用ルールでトライアルのライセンスを発行し、同じ要求の中でこの端末を認証します。応答は POST /runtime/v1/activations と同じ署名付きの端末認証の結果に license_id を加えたもので、ライセンスキーは返しません。本文は端末認証の項目（license_key と product_id を除く）に code と email を加えたもので、device_proof は端末認証の前置きの代わりに、前置き Usakey-Trial-Proof-v1 と改行を付けて署名します。同じアドレスでこの製品の試用がまだ有効なら、この端末はその試用に加わります。そのアドレスか端末の鍵で、直近365日以内にこの製品を試用していた場合は 403 TRIAL_ALREADY_USED です。端末認証として、Runtime APIの月間回数に1回数えます。

認証
なし
必要な権限
—
操作ID
runtime_v1_trial_verifications_confirm

パラメーター

名前場所必須型・説明
verification_id パス 必須
PublicId

Example Value

"verification_id_aaaaaaaaaaaaaaaaaaaa"
Idempotency-Key ヘッダー 必須
string 最小文字数: 16 最大文字数: 255

Example Value

"stringxxxxxxxxxx"

リクエスト本文

必須
application/json

Schema

TrialVerificationConfirmRequest

Example Value

{
  "code": "123456",
  "email": "developer@example.com",
  "device_signing_public_key": "string",
  "device_kem_public_key": "string",
  "device_proof": "string",
  "machine_signals": {
    "property": "string"
  },
  "machine_info": {
    "os": "string",
    "arch": "string"
  },
  "app_version": "string",
  "sdk_version": "string",
  "request_id": "01K5QWERTY1234567890ABCDEFG",
  "client_time": 1,
  "nonce": "stringxxxxxxxxxxxxxxxx"
}

レスポンス

201

作成完了

トライアルのライセンスを発行し、端末を認証しました

application/json

Schema

SignedTrialSignupResponse

Example Value

{
  "data": {
    "activation_id": "activation_id_aaaaaaaaaaaaaaaaaaaa",
    "certificate": "string",
    "machine_info_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "license_id": "license_id_aaaaaaaaaaaaaaaaaaaa"
  },
  "response_assertion": {
    "v": 1,
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "key_id": "01K5QWERTY1234567890ABCDEFG",
    "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "nonce": "string",
    "server_time": 1,
    "status": 1,
    "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "response_signature": "example-token",
  "signing_delegation": {
    "delegation": {
      "v": 1,
      "purpose": "runtime-response",
      "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
      "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
      "online_key_id": "01K5QWERTY1234567890ABCDEFG",
      "public_key": "string",
      "issued_at": 1,
      "expires_at": 1
    },
    "signature": "example-token"
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

EMAIL_VERIFICATION_CODE_INVALID（確認コード・アドレス・端末の鍵の違い。details.remaining_attempts）または DEVICE_PROOF_INVALID です

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

TRIAL_ALREADY_USED、TRIAL_ACTIVATION_INVALID（製品が試用の開始の受付を止めたか、24時間の上限に達した。details.reason）、LICENSE_*、または PLAN_ENTITLEMENT_REQUIRED です

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
409

競合

PLAN_QUOTA_EXCEEDED（契約組織のトライアル枠がいっぱい）、MACHINE_LIMIT_REACHED、DEVICE_KEY_MISMATCH、または冪等性の衝突です

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
410

利用終了

EMAIL_VERIFICATION_EXPIRED。確認を開始からやり直してください

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

完全な machine_info が必要です

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
413

リクエストが大きすぎます

Runtime API の要求本文が、経路ごとのバイト数の上限を超えています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}

Runtime API

Runtime 同時利用

3操作

同時利用枠を取得・更新・返却します。

POST /runtime/v1/leases/{lease_id}/heartbeat 同時利用リースを更新 OpenAPI原文: Renew a single lease

取得済みの同時利用リースを延長し、利用枠を保持します。

認証
deviceProof
必要な権限
—
操作ID
runtime_v1_leases_heartbeat

パラメーター

名前場所必須型・説明
lease_id パス 必須
PublicId

Example Value

"lease_id_aaaaaaaaaaaaaaaaaaaa"
X-Usakey-Activation ヘッダー 必須
PublicId

Example Value

"x_usakey_activation_aaaaaaaaaaaaaaaaaaaa"
X-Usakey-Timestamp ヘッダー 必須
integer

Example Value

1
X-Usakey-Nonce ヘッダー 必須
string 最小文字数: 22 最大文字数: 255

Example Value

"stringxxxxxxxxxxxxxxxx"
X-Usakey-Signature ヘッダー 必須
string 最大文字数: 1024

Example Value

"example-token"

リクエスト本文

必須
application/json

Schema

LeaseInstanceRequest

Example Value

{
  "instance_id": "01K5QWERTY1234567890ABCDEFG"
}

レスポンス

200

成功

更新した同時利用枠

application/json

Schema

SignedLeaseResponse

Example Value

{
  "data": {
    "lease_id": "lease_id_aaaaaaaaaaaaaaaaaaaa",
    "instance_id": "01K5QWERTY1234567890ABCDEFG",
    "expires_at": 1,
    "heartbeat_in": 10
  },
  "response_assertion": {
    "v": 1,
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "key_id": "01K5QWERTY1234567890ABCDEFG",
    "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "nonce": "string",
    "server_time": 1,
    "status": 1,
    "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "response_signature": "example-token",
  "signing_delegation": {
    "delegation": {
      "v": 1,
      "purpose": "runtime-response",
      "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
      "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
      "online_key_id": "01K5QWERTY1234567890ABCDEFG",
      "public_key": "string",
      "issued_at": 1,
      "expires_at": 1
    },
    "signature": "example-token"
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
410

利用終了

対象はすでに有効ではありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
413

リクエストが大きすぎます

Runtime API の要求本文が、経路ごとのバイト数の上限を超えています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
POST /runtime/v1/leases 同時利用枠を1席取得 OpenAPI原文: Acquire one concurrent-use seat

製品の同時利用枠から1席分のリースを取得します。

認証
deviceProof
必要な権限
—
操作ID
runtime_v1_leases_create

パラメーター

名前場所必須型・説明
X-Usakey-Activation ヘッダー 必須
PublicId

Example Value

"x_usakey_activation_aaaaaaaaaaaaaaaaaaaa"
X-Usakey-Timestamp ヘッダー 必須
integer

Example Value

1
X-Usakey-Nonce ヘッダー 必須
string 最小文字数: 22 最大文字数: 255

Example Value

"stringxxxxxxxxxxxxxxxx"
X-Usakey-Signature ヘッダー 必須
string 最大文字数: 1024

Example Value

"example-token"

リクエスト本文

必須
application/json

Schema

LeaseAcquireRequest

Example Value

{
  "activation_id": "activation_id_aaaaaaaaaaaaaaaaaaaa",
  "instance_id": "01K5QWERTY1234567890ABCDEFG"
}

レスポンス

201

作成完了

取得した同時利用枠

application/json

Schema

SignedLeaseResponse

Example Value

{
  "data": {
    "lease_id": "lease_id_aaaaaaaaaaaaaaaaaaaa",
    "instance_id": "01K5QWERTY1234567890ABCDEFG",
    "expires_at": 1,
    "heartbeat_in": 10
  },
  "response_assertion": {
    "v": 1,
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "key_id": "01K5QWERTY1234567890ABCDEFG",
    "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "nonce": "string",
    "server_time": 1,
    "status": 1,
    "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "response_signature": "example-token",
  "signing_delegation": {
    "delegation": {
      "v": 1,
      "purpose": "runtime-response",
      "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
      "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
      "online_key_id": "01K5QWERTY1234567890ABCDEFG",
      "public_key": "string",
      "issued_at": 1,
      "expires_at": 1
    },
    "signature": "example-token"
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
409

競合

冪等キー・バージョン・端末・同時利用の競合、または製品署名鍵の準備中です

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
413

リクエストが大きすぎます

Runtime API の要求本文が、経路ごとのバイト数の上限を超えています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
DELETE /runtime/v1/leases/{lease_id} 同時利用リースを返却 OpenAPI原文: Release a lease

使用を終えた同時利用リースを返却し、利用枠を解放します。

認証
deviceProof
必要な権限
—
操作ID
runtime_v1_leases_destroy

パラメーター

名前場所必須型・説明
lease_id パス 必須
PublicId

Example Value

"lease_id_aaaaaaaaaaaaaaaaaaaa"
X-Usakey-Activation ヘッダー 必須
PublicId

Example Value

"x_usakey_activation_aaaaaaaaaaaaaaaaaaaa"
X-Usakey-Timestamp ヘッダー 必須
integer

Example Value

1
X-Usakey-Nonce ヘッダー 必須
string 最小文字数: 22 最大文字数: 255

Example Value

"stringxxxxxxxxxxxxxxxx"
X-Usakey-Signature ヘッダー 必須
string 最大文字数: 1024

Example Value

"example-token"

リクエスト本文

必須
application/json

Schema

LeaseInstanceRequest

Example Value

{
  "instance_id": "01K5QWERTY1234567890ABCDEFG"
}

レスポンス

200

成功

返却した同時利用枠

application/json

Schema

SignedLeaseReleaseResponse

Example Value

{
  "data": {
    "lease_id": "lease_id_aaaaaaaaaaaaaaaaaaaa",
    "status": "released"
  },
  "response_assertion": {
    "v": 1,
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "key_id": "01K5QWERTY1234567890ABCDEFG",
    "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "nonce": "string",
    "server_time": 1,
    "status": 1,
    "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "response_signature": "example-token",
  "signing_delegation": {
    "delegation": {
      "v": 1,
      "purpose": "runtime-response",
      "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
      "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
      "online_key_id": "01K5QWERTY1234567890ABCDEFG",
      "public_key": "string",
      "issued_at": 1,
      "expires_at": 1
    },
    "signature": "example-token"
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
413

リクエストが大きすぎます

Runtime API の要求本文が、経路ごとのバイト数の上限を超えています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}

Management API

製品

13操作

製品と署名鍵の状態を管理します。

GET /mgmt/v1/products 製品の一覧を取得

製品を一覧で取得します。絞り込みやページングに使える値はパラメーター欄で確認できます。

認証
managementApiKey
必要な権限
products:read
操作ID
mgmt_v1_products_index

パラメーター

名前場所必須型・説明
limit クエリ 任意
integer 最小値: 1 最大値: 200

Example Value

50
cursor クエリ 任意
string

Example Value

"string"

レスポンス

200

成功

製品の操作に成功しました

application/json

Schema

ProductListResponse

Example Value

{
  "data": [
    {
      "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
      "name": "Example name",
      "code": "string",
      "description": "Example description",
      "environment": "live",
      "status": "active",
      "trust_bundle_sequence": 1,
      "signing_status": "pending",
      "created_at": "2026-09-21T00:00:00Z",
      "updated_at": "2026-09-21T00:00:00Z",
      "version": 1
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
POST /mgmt/v1/products 製品を作成

製品を新しく作成します。送信するJSONと作成後の応答はExample Valueで確認できます。

認証
managementApiKey
必要な権限
products:write
操作ID
mgmt_v1_products_create

パラメーター

名前場所必須型・説明
Idempotency-Key ヘッダー 必須
string 最小文字数: 16 最大文字数: 255

Example Value

"stringxxxxxxxxxx"

リクエスト本文

必須
application/json

Schema

ProductInput

Example Value

{
  "name": "Example name",
  "code": "string",
  "description": "Example description",
  "environment": "string"
}

レスポンス

201

作成完了

製品の操作に成功しました

application/json

Schema

ProductResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "code": "string",
    "description": "Example description",
    "environment": "live",
    "status": "active",
    "trust_bundle_sequence": 1,
    "signing_status": "pending",
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z",
    "version": 1
  }
}
409

競合

冪等キー・バージョン・端末・同時利用の競合、または製品署名鍵の準備中です

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
GET /mgmt/v1/products/{id} 製品の詳細を取得

指定した製品の現在の状態と設定を取得します。

認証
managementApiKey
必要な権限
products:read
操作ID
mgmt_v1_products_show

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

200

成功

製品の操作に成功しました

application/json

Schema

ProductResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "code": "string",
    "description": "Example description",
    "environment": "live",
    "status": "active",
    "trust_bundle_sequence": 1,
    "signing_status": "pending",
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z",
    "version": 1
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
PATCH /mgmt/v1/products/{id} 製品を更新

指定した製品を更新します。変更可能な項目はリクエスト本文のSchemaで確認できます。

認証
managementApiKey
必要な権限
products:write
操作ID
mgmt_v1_products_update

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"
If-Match ヘッダー 任意
string

Example Value

"string"

条件付き更新に使うことを推奨します。製品とライセンスはversion、利用ルールと顧客の詳細取得はETag応答ヘッダーで同時更新確認用の値を返します。ETagを変更せず送ってください。利用ルールのversionは履歴上の版番号であり、このヘッダーには使えません。値が現在のものと一致しないときは 409 VERSION_CONFLICT を返し、何も変更しません。

リクエスト本文

必須
application/json

Schema

ProductInput

Example Value

{
  "name": "Example name",
  "code": "string",
  "description": "Example description",
  "environment": "string"
}

レスポンス

200

成功

製品の操作に成功しました

application/json

Schema

ProductResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "code": "string",
    "description": "Example description",
    "environment": "live",
    "status": "active",
    "trust_bundle_sequence": 1,
    "signing_status": "pending",
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z",
    "version": 1
  }
}
409

競合

冪等キー・バージョン・端末・同時利用の競合、または製品署名鍵の準備中です

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
DELETE /mgmt/v1/products/{id} 製品を削除

指定した製品を削除または無効化します。応答コードと制約を確認してから実行してください。

読んだあとに製品が変わっていないときだけアーカイブするには、If-Match に製品の version を送ります。古い If-Match は 409 VERSION_CONFLICT を返し、何も変更しません。

認証
managementApiKey
必要な権限
products:write
操作ID
mgmt_v1_products_destroy

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"
If-Match ヘッダー 任意
string

Example Value

"string"

条件付き更新に使うことを推奨します。製品とライセンスはversion、利用ルールと顧客の詳細取得はETag応答ヘッダーで同時更新確認用の値を返します。ETagを変更せず送ってください。利用ルールのversionは履歴上の版番号であり、このヘッダーには使えません。値が現在のものと一致しないときは 409 VERSION_CONFLICT を返し、何も変更しません。

レスポンス

204

内容なし

アーカイブしました

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
GET /mgmt/v1/products/{id}/integration-config 製品の接続設定を取得

管理画面の「接続設定をダウンロード」と同じusakey.config.jsonを取得します。開発時に製品リポジトリへ保存する値で、製品アプリの実行時にネットワークから取得しないでください。

製品の usakey.config.json（管理画面でダウンロードできるものと同じファイル）を返します。開発時に製品リポジトリへ保存してください。製品アプリの実行時に取得してはいけません。アーカイブ済みの製品は 409 PRODUCT_ARCHIVED を返します。

認証
managementApiKey
必要な権限
products:read
操作ID
mgmt_v1_products_integration_config

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

200

成功

製品アプリ用の接続設定

application/json

Schema

IntegrationConfigResponse

Example Value

{
  "data": {
    "file_name": "Example name",
    "content": "string",
    "config": {
      "usakey_config_version": 1,
      "generated_at": "2026-09-21T00:00:00Z",
      "bundle_version": "string",
      "environment": "live",
      "api_url": "https://example.com/resource",
      "product": {
        "id": "id_aaaaaaaaaaaaaaaaaaaa",
        "name": "Example name"
      },
      "trust_anchor": {
        "signing_mode": "string",
        "key_id": "01K5QWERTY1234567890ABCDEFG",
        "trust_bundle_url": "https://example.com/resource",
        "minimum_trust_bundle_sequence": 1,
        "root_public_key": "string",
        "development_root_public_key": "string",
        "public_key_unavailable_reason": "string",
        "signing_keys_pending_reason": "string"
      },
      "entitlements": [
        {
          "name": "Example name",
          "type": "boolean",
          "policies": [
            "string"
          ]
        }
      ],
      "license_key_delivery": "manual",
      "stripe_license_claim_url": "https://example.com/resource"
    }
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
409

競合

冪等キー・バージョン・端末・同時利用の競合、または製品署名鍵の準備中です

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
GET /mgmt/v1/products/{product_id}/browser-runtime 製品の詳細を取得

指定した製品の現在の状態と設定を取得します。

製品のブラウザRuntime設定（enabled、allowed_origins、version）を返します。既定は無効です。アーカイブ済みの製品は409 PRODUCT_ARCHIVEDを返します。既存のProduct応答は変わりません。この設定APIはブラウザからのクロスオリジン要求を許可しません。

認証
managementApiKey
必要な権限
products:read
操作ID
mgmt_v1_product_browser_runtimes_show

パラメーター

名前場所必須型・説明
product_id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

200

成功

製品のブラウザRuntime設定

application/json

Schema

ProductBrowserRuntimeResponse

Example Value

{
  "data": {
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "enabled": true,
    "allowed_origins": [
      "string"
    ],
    "version": 0
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
409

競合

冪等キー・バージョン・端末・同時利用の競合、または製品署名鍵の準備中です

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
PATCH /mgmt/v1/products/{product_id}/browser-runtime 製品を更新

指定した製品を更新します。変更可能な項目はリクエスト本文のSchemaで確認できます。

指定した設定だけを、Consoleと同じ入力検証を使って変更します。enabledには真偽値を指定してください。allowed_originsは最大20件のHTTPS許可元の一覧全体を置き換えます。テスト製品ではHTTPのループバック許可元も使えます。ワイルドカード、null、パス、クエリ、フラグメント、userinfoは拒否します。無効化しても一覧は保持します。有効な状態で一覧を空にすると入力検証に失敗します。不正な値は422 VALIDATION_FAILEDを返します。If-Matchは許可元だけの変更も含む製品の版を確認し、競合時は409 VERSION_CONFLICTを返します。アーカイブ済みの製品は409 PRODUCT_ARCHIVEDを返します。変更はproduct.updatedとして監査記録に残します。RuntimeのOPTIONSはRuntime利用枠を消費しません。このManagement APIの呼び出しは通常のManagement API利用枠を消費します。

認証
managementApiKey
必要な権限
products:write
操作ID
mgmt_v1_product_browser_runtimes_update

パラメーター

名前場所必須型・説明
product_id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"
If-Match ヘッダー 任意
string

Example Value

"string"

条件付き更新に使うことを推奨します。製品とライセンスはversion、利用ルールと顧客の詳細取得はETag応答ヘッダーで同時更新確認用の値を返します。ETagを変更せず送ってください。利用ルールのversionは履歴上の版番号であり、このヘッダーには使えません。値が現在のものと一致しないときは 409 VERSION_CONFLICT を返し、何も変更しません。

リクエスト本文

必須
application/json

Schema

ProductBrowserRuntimeInput

Example Value

{
  "enabled": true,
  "allowed_origins": [
    "string"
  ]
}

レスポンス

200

成功

製品のブラウザRuntime設定

application/json

Schema

ProductBrowserRuntimeResponse

Example Value

{
  "data": {
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "enabled": true,
    "allowed_origins": [
      "string"
    ],
    "version": 0
  }
}
409

競合

冪等キー・バージョン・端末・同時利用の競合、または製品署名鍵の準備中です

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
GET /mgmt/v1/products/{product_id}/trial-signup 製品の試用の受付を取得

製品アプリがメール確認付きで始める試用（POST /runtime/v1/trial-verifications）を、この製品が受け付けているかを返します。試用に使う利用ルール、24時間の受付上限、いまの受付の状態が分かります。管理画面の製品の編集にある設定と同じもので、製品の応答には含めていません。アーカイブ済みの製品は 409 PRODUCT_ARCHIVED を返します。

認証
managementApiKey
必要な権限
products:read
操作ID
mgmt_v1_product_trial_signups_show

パラメーター

名前場所必須型・説明
product_id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

200

成功

製品の試用の受付の設定

application/json

Schema

ProductTrialSignupResponse

Example Value

{
  "data": {
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "policy_id": "01K5QWERTY1234567890ABCDEFG",
    "daily_limit": 1,
    "status": "accepting",
    "started_last_24_hours": 0,
    "version": 0
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
409

競合

冪等キー・バージョン・端末・同時利用の競合、または製品署名鍵の準備中です

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
PATCH /mgmt/v1/products/{product_id}/trial-signup 製品の試用の受付を変更

試用の受付の設定を、管理画面と同じ確認で変更します。送った項目だけを変えます。利用ルールを選ぶ・替えるには、トライアル（trial_licenses）を含む契約プランが必要です（403 PLAN_ENTITLEMENT_REQUIRED）。policy_id を null にして受付を止める変更と、daily_limit だけの変更は、いつでもできます。値が正しくなければ 422 VALIDATION_FAILED で、details.errors に policy_id か daily_limit の理由を返します。アーカイブ済みの製品は 409 PRODUCT_ARCHIVED を返します。変更は監査ログに product.updated として記録します。Idempotency-Key は使いません。同じ本文を送り直しても結果は同じです。

認証
managementApiKey
必要な権限
products:write
操作ID
mgmt_v1_product_trial_signups_update

パラメーター

名前場所必須型・説明
product_id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"
If-Match ヘッダー 任意
string

Example Value

"string"

条件付き更新に使うことを推奨します。製品とライセンスはversion、利用ルールと顧客の詳細取得はETag応答ヘッダーで同時更新確認用の値を返します。ETagを変更せず送ってください。利用ルールのversionは履歴上の版番号であり、このヘッダーには使えません。値が現在のものと一致しないときは 409 VERSION_CONFLICT を返し、何も変更しません。

リクエスト本文

必須
application/json

Schema

ProductTrialSignupInput

Example Value

{
  "policy_id": "01K5QWERTY1234567890ABCDEFG",
  "daily_limit": 1
}

レスポンス

200

成功

製品の試用の受付の設定

application/json

Schema

ProductTrialSignupResponse

Example Value

{
  "data": {
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "policy_id": "01K5QWERTY1234567890ABCDEFG",
    "daily_limit": 1,
    "status": "accepting",
    "started_last_24_hours": 0,
    "version": 0
  }
}
409

競合

冪等キー・バージョン・端末・同時利用の競合、または製品署名鍵の準備中です

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
GET /mgmt/v1/products/{product_id}/sealed-files 製品のファイルの暗号化の状態と公開鍵を取得

製品がライセンスのある端末向けにファイルを暗号化できるか（docs/security/sealed-files.md）と、有効にした後の公開鍵を返します。current_key.sealing_key は暗号化ツール（usakey-seal）に渡す1行の鍵で、秘密ではありません。status は enabled（有効）、disabled（無効）、not_entitled（プランに sealed_files が無い。既存の鍵は残りますが、端末はファイルの鍵を受け取れません）、unavailable（この環境ではまだ提供していない）のいずれかです。アーカイブ済みの製品は 409 PRODUCT_ARCHIVED を返します。

認証
managementApiKey
必要な権限
products:read
操作ID
mgmt_v1_product_sealed_files_show

パラメーター

名前場所必須型・説明
product_id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

200

成功

製品のファイルの暗号化の状態

application/json

Schema

ProductSealedFilesResponse

Example Value

{
  "data": {
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "status": "enabled",
    "current_key": {
      "key_id": "key_seal_0123456789abcdef0123",
      "public_key": "p256:BC8ylpFJ44nP01V3Ei2l5hm8iUAyxR8cepHBhlWWLzsAqCUpcNOfUa05MSFt28Z9RVc7yJO2cKyY_V1rZon_v6Y",
      "sealing_key": "usakey-sealing-key:v1:prod_0123456789abcdef0123:key_seal_0123456789abcdef0123:p256:BC8ylpFJ44nP01V3Ei2l5hm8iUAyxR8cepHBhlWWLzsAqCUpcNOfUa05MSFt28Z9RVc7yJO2cKyY_V1rZon_v6Y",
      "created_at": "2026-09-21T00:00:00Z"
    }
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
409

競合

冪等キー・バージョン・端末・同時利用の競合、または製品署名鍵の準備中です

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
POST /mgmt/v1/products/{product_id}/sealed-files 製品のファイルの暗号化を有効にする

製品のファイルの暗号化を有効にします。sealed_files の権利を含むプランと、ファイルの暗号化を提供している環境が必要です（403 PLAN_ENTITLEMENT_REQUIRED、409 SEALED_FILES_UNAVAILABLE）。200 と status enabled、current_key を返します。503 SEALED_FILES_KEY_UNAVAILABLE（再試行できる）は、暗号化用の鍵に一時的につながらなかったことを表します。再送しても何も変わりません。最初に有効にしたときは操作履歴に product.sealed_files_enabled として記録します。本文は不要で、Idempotency-Key も使いません。配布済みのファイルが開けなくなるため、ここでは無効にできません。

認証
managementApiKey
必要な権限
products:write
操作ID
mgmt_v1_product_sealed_files_create

パラメーター

名前場所必須型・説明
product_id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

200

成功

ファイルの暗号化は有効で、鍵ができています

application/json

Schema

ProductSealedFilesResponse

Example Value

{
  "data": {
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "status": "enabled",
    "current_key": {
      "key_id": "key_seal_0123456789abcdef0123",
      "public_key": "p256:BC8ylpFJ44nP01V3Ei2l5hm8iUAyxR8cepHBhlWWLzsAqCUpcNOfUa05MSFt28Z9RVc7yJO2cKyY_V1rZon_v6Y",
      "sealing_key": "usakey-sealing-key:v1:prod_0123456789abcdef0123:key_seal_0123456789abcdef0123:p256:BC8ylpFJ44nP01V3Ei2l5hm8iUAyxR8cepHBhlWWLzsAqCUpcNOfUa05MSFt28Z9RVc7yJO2cKyY_V1rZon_v6Y",
      "created_at": "2026-09-21T00:00:00Z"
    }
  }
}
409

競合

冪等キー・バージョン・端末・同時利用の競合、または製品署名鍵の準備中です

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
GET /mgmt/v1/stripe-integration 自社Stripe連携の状態を取得

自社Stripe連携の有無・テスト用か本番用か・受け取り先URL・価格とライセンスの対応を取得します。制限付きキーと署名シークレットは返しません。

製品アプリが使う、契約組織の自社Stripe連携と、価格とライセンスの対応です。制限付きキーとWebhook署名シークレットは返しません。

認証
managementApiKey
必要な権限
products:read
操作ID
mgmt_v1_stripe_integrations_show

レスポンス

200

成功

自社Stripe連携の状態

application/json

Schema

StripeIntegrationResponse

Example Value

{
  "data": {
    "registered": true,
    "mode": "test",
    "status": "active",
    "secure_claims_required": true,
    "license_claim_url": "https://example.com/resource",
    "last_event": {
      "type": "string",
      "result": "string",
      "at": "2026-09-21T00:00:00Z"
    },
    "offerings": [
      {
        "id": "id_aaaaaaaaaaaaaaaaaaaa",
        "name": "Example name",
        "stripe_price_id": "01K5QWERTY1234567890ABCDEFG",
        "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
        "policy_id": "policy_id_aaaaaaaaaaaaaaaaaaaa",
        "status": "active",
        "license_duration_days": 1
      }
    ]
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}

Management API

利用ルール

5操作

ライセンスの利用条件を管理します。

GET /mgmt/v1/policies 利用ルールの一覧を取得

利用ルールを一覧で取得します。絞り込みやページングに使える値はパラメーター欄で確認できます。

認証
managementApiKey
必要な権限
policies:read
操作ID
mgmt_v1_policies_index

レスポンス

200

成功

利用ルールの操作に成功しました

application/json

Schema

PolicyListResponse

Example Value

{
  "data": [
    {
      "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
      "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
      "name": "Example name",
      "version": 1,
      "license_type": "perpetual",
      "validation_mode": "string",
      "perpetual_mode": "managed",
      "heartbeat_required": true,
      "revocation_guarantee_sec": 0,
      "fail_mode": "string",
      "identity_mode": "string",
      "license_unit_limit": 1,
      "max_machines": 1,
      "max_concurrent": 1,
      "concurrency_unit": "string",
      "cert_ttl_sec": 1,
      "heartbeat_sec": 1,
      "lease_ttl_sec": 1,
      "lease_heartbeat_sec": 1,
      "network_grace_sec": 1,
      "fingerprint_profile": {},
      "renewal_authority": "string",
      "billing_cycle": "string",
      "trial_days": 1,
      "entitlements": {},
      "status": "active",
      "created_at": "2026-09-21T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
POST /mgmt/v1/policies 利用ルールを作成

利用ルールを新しく作成します。送信するJSONと作成後の応答はExample Valueで確認できます。

認証
managementApiKey
必要な権限
policies:write
操作ID
mgmt_v1_policies_create

パラメーター

名前場所必須型・説明
Idempotency-Key ヘッダー 必須
string 最小文字数: 16 最大文字数: 255

Example Value

"stringxxxxxxxxxx"

リクエスト本文

必須
application/json

Schema

PolicyInput

Example Value

{
  "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
  "name": "Example name",
  "license_type": "string",
  "validation_mode": "string",
  "fail_mode": "string",
  "max_machines": 1,
  "max_concurrent": 1,
  "concurrency_unit": "string",
  "identity_mode": "string",
  "license_unit_limit": 1,
  "cert_ttl_sec": 1,
  "heartbeat_sec": 1,
  "lease_ttl_sec": 1,
  "lease_heartbeat_sec": 1,
  "network_grace_sec": 1,
  "fingerprint_profile": "standard",
  "renewal_authority": "string",
  "billing_cycle": "string",
  "trial_days": 1,
  "entitlements": {}
}

レスポンス

201

作成完了

利用ルールの操作に成功しました

application/json

Schema

PolicyResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "version": 1,
    "license_type": "perpetual",
    "validation_mode": "string",
    "perpetual_mode": "managed",
    "heartbeat_required": true,
    "revocation_guarantee_sec": 0,
    "fail_mode": "string",
    "identity_mode": "string",
    "license_unit_limit": 1,
    "max_machines": 1,
    "max_concurrent": 1,
    "concurrency_unit": "string",
    "cert_ttl_sec": 1,
    "heartbeat_sec": 1,
    "lease_ttl_sec": 1,
    "lease_heartbeat_sec": 1,
    "network_grace_sec": 1,
    "fingerprint_profile": {},
    "renewal_authority": "string",
    "billing_cycle": "string",
    "trial_days": 1,
    "entitlements": {},
    "status": "active",
    "created_at": "2026-09-21T00:00:00Z"
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
409

競合

冪等キー・バージョン・端末・同時利用の競合、または製品署名鍵の準備中です

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
GET /mgmt/v1/policies/{id} 利用ルールの詳細を取得

指定した利用ルールの現在の状態と設定を取得します。

認証
managementApiKey
必要な権限
policies:read
操作ID
mgmt_v1_policies_show

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

200

成功

利用ルールの操作に成功しました

application/json

Schema

PolicyResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "version": 1,
    "license_type": "perpetual",
    "validation_mode": "string",
    "perpetual_mode": "managed",
    "heartbeat_required": true,
    "revocation_guarantee_sec": 0,
    "fail_mode": "string",
    "identity_mode": "string",
    "license_unit_limit": 1,
    "max_machines": 1,
    "max_concurrent": 1,
    "concurrency_unit": "string",
    "cert_ttl_sec": 1,
    "heartbeat_sec": 1,
    "lease_ttl_sec": 1,
    "lease_heartbeat_sec": 1,
    "network_grace_sec": 1,
    "fingerprint_profile": {},
    "renewal_authority": "string",
    "billing_cycle": "string",
    "trial_days": 1,
    "entitlements": {},
    "status": "active",
    "created_at": "2026-09-21T00:00:00Z"
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
PATCH /mgmt/v1/policies/{id} 利用ルールを更新

指定した利用ルールを更新します。変更可能な項目はリクエスト本文のSchemaで確認できます。

古い If-Match は 409 VERSION_CONFLICT を返し、何も変更しません。現在の ETag は利用ルールをもう一度取得して確かめてください。

認証
managementApiKey
必要な権限
policies:write
操作ID
mgmt_v1_policies_update

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"
If-Match ヘッダー 任意
string

Example Value

"string"

条件付き更新に使うことを推奨します。製品とライセンスはversion、利用ルールと顧客の詳細取得はETag応答ヘッダーで同時更新確認用の値を返します。ETagを変更せず送ってください。利用ルールのversionは履歴上の版番号であり、このヘッダーには使えません。値が現在のものと一致しないときは 409 VERSION_CONFLICT を返し、何も変更しません。

リクエスト本文

必須
application/json

Schema

PolicyInput

Example Value

{
  "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
  "name": "Example name",
  "license_type": "string",
  "validation_mode": "string",
  "fail_mode": "string",
  "max_machines": 1,
  "max_concurrent": 1,
  "concurrency_unit": "string",
  "identity_mode": "string",
  "license_unit_limit": 1,
  "cert_ttl_sec": 1,
  "heartbeat_sec": 1,
  "lease_ttl_sec": 1,
  "lease_heartbeat_sec": 1,
  "network_grace_sec": 1,
  "fingerprint_profile": "standard",
  "renewal_authority": "string",
  "billing_cycle": "string",
  "trial_days": 1,
  "entitlements": {}
}

レスポンス

200

成功

利用ルールの操作に成功しました

application/json

Schema

PolicyResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "version": 1,
    "license_type": "perpetual",
    "validation_mode": "string",
    "perpetual_mode": "managed",
    "heartbeat_required": true,
    "revocation_guarantee_sec": 0,
    "fail_mode": "string",
    "identity_mode": "string",
    "license_unit_limit": 1,
    "max_machines": 1,
    "max_concurrent": 1,
    "concurrency_unit": "string",
    "cert_ttl_sec": 1,
    "heartbeat_sec": 1,
    "lease_ttl_sec": 1,
    "lease_heartbeat_sec": 1,
    "network_grace_sec": 1,
    "fingerprint_profile": {},
    "renewal_authority": "string",
    "billing_cycle": "string",
    "trial_days": 1,
    "entitlements": {},
    "status": "active",
    "created_at": "2026-09-21T00:00:00Z"
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
DELETE /mgmt/v1/policies/{id} 利用ルールを削除

指定した利用ルールを削除または無効化します。応答コードと制約を確認してから実行してください。

認証
managementApiKey
必要な権限
policies:write
操作ID
mgmt_v1_policies_destroy

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

204

内容なし

廃止しました

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}

Management API

顧客・ユーザー

5操作

顧客と、その顧客に紐づくユーザー情報を管理します。

GET /mgmt/v1/customers 顧客の一覧を取得

顧客を一覧で取得します。絞り込みやページングに使える値はパラメーター欄で確認できます。

認証
managementApiKey
必要な権限
customers:read
操作ID
mgmt_v1_customers_index

レスポンス

200

成功

顧客の操作に成功しました

application/json

Schema

CustomerListResponse

Example Value

{
  "data": [
    {
      "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
      "name": "Example name",
      "email": "developer@example.com",
      "external_ref": "string",
      "notes": "string",
      "status": "active",
      "created_at": "2026-09-21T00:00:00Z",
      "updated_at": "2026-09-21T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
POST /mgmt/v1/customers 顧客を作成

顧客を新しく作成します。送信するJSONと作成後の応答はExample Valueで確認できます。

認証
managementApiKey
必要な権限
customers:write
操作ID
mgmt_v1_customers_create

パラメーター

名前場所必須型・説明
Idempotency-Key ヘッダー 必須
string 最小文字数: 16 最大文字数: 255

Example Value

"stringxxxxxxxxxx"

リクエスト本文

必須
application/json

Schema

CustomerInput

Example Value

{
  "name": "Example name",
  "email": "developer@example.com",
  "external_ref": "string",
  "notes": "string"
}

レスポンス

201

作成完了

顧客の操作に成功しました

application/json

Schema

CustomerResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "email": "developer@example.com",
    "external_ref": "string",
    "notes": "string",
    "status": "active",
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
409

競合

冪等キー・バージョン・端末・同時利用の競合、または製品署名鍵の準備中です

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
GET /mgmt/v1/customers/{id} 顧客の詳細を取得

指定した顧客の現在の状態と設定を取得します。

認証
managementApiKey
必要な権限
customers:read
操作ID
mgmt_v1_customers_show

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

200

成功

顧客の操作に成功しました

application/json

Schema

CustomerResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "email": "developer@example.com",
    "external_ref": "string",
    "notes": "string",
    "status": "active",
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
PATCH /mgmt/v1/customers/{id} 顧客を更新

指定した顧客を更新します。変更可能な項目はリクエスト本文のSchemaで確認できます。

顧客は live と test の環境で共有されています。test のAPIキーからは、live のライセンスを持つ顧客を変更できません（403 ENVIRONMENT_MISMATCH）。古い If-Match は 409 VERSION_CONFLICT を返し、何も変更しません。現在の ETag は顧客をもう一度取得して確かめてください。

認証
managementApiKey
必要な権限
customers:write
操作ID
mgmt_v1_customers_update

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"
If-Match ヘッダー 任意
string

Example Value

"string"

条件付き更新に使うことを推奨します。製品とライセンスはversion、利用ルールと顧客の詳細取得はETag応答ヘッダーで同時更新確認用の値を返します。ETagを変更せず送ってください。利用ルールのversionは履歴上の版番号であり、このヘッダーには使えません。値が現在のものと一致しないときは 409 VERSION_CONFLICT を返し、何も変更しません。

リクエスト本文

必須
application/json

Schema

CustomerInput

Example Value

{
  "name": "Example name",
  "email": "developer@example.com",
  "external_ref": "string",
  "notes": "string"
}

レスポンス

200

成功

顧客の操作に成功しました

application/json

Schema

CustomerResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "email": "developer@example.com",
    "external_ref": "string",
    "notes": "string",
    "status": "active",
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
DELETE /mgmt/v1/customers/{id} 顧客を削除

指定した顧客を削除または無効化します。応答コードと制約を確認してから実行してください。

顧客は live と test の環境で共有されています。test のAPIキーからは、live のライセンスを持つ顧客をアーカイブできません（403 ENVIRONMENT_MISMATCH）。

認証
managementApiKey
必要な権限
customers:write
操作ID
mgmt_v1_customers_destroy

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

204

内容なし

アーカイブしました

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}

Management API

ライセンス

7操作

ライセンスの発行、変更、割り当てを管理します。

POST /mgmt/v1/licenses/{id}/offline-certificates 端末固定のオフラインライセンスを発行 OpenAPI原文: Issue a device-bound offline license package

指定した端末だけで利用できる署名済みオフラインライセンスパッケージを発行します。

同じ端末申請を再送した場合、同じ稼働中の端末・割当で有効な既存の利用ファイルを、200のZIPとして安全に再配布します。以前のファイルを再配布できない場合は、新しく作成した端末申請を送ってください。

認証
managementApiKey
必要な権限
licenses:write
操作ID
mgmt_v1_licenses_offline_certificates

パラメーター

名前場所必須型・説明
id パス 必須
PublicId

Example Value

"id_aaaaaaaaaaaaaaaaaaaa"

リクエスト本文

必須
application/json

Schema

OfflineCertificateIssueRequest

Example Value

{
  "request": {
    "format": "usakey-offline-request-v1",
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "device_signing_public_key": "string",
    "device_kem_public_key": "p256:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
    "device_proof": "string",
    "machine_info": {
      "os": "string",
      "arch": "string"
    },
    "nonce": "example_valuexxxxxxxxx",
    "generated_at": 1
  },
  "expires_at": "2026-09-21T00:00:00Z",
  "license_assignment_id": "license_assignment_id_aaaaaaaaaaaaaaaaaaaa"
}

レスポンス

200

成功

端末に結び付いたオフライン利用ファイル（ZIP）

application/vnd.usakey.offline+zip

Schema

string binary

Example Value

"string"
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
409

競合

冪等キー・バージョン・端末・同時利用の競合、または製品署名鍵の準備中です

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
POST /mgmt/v1/licenses/{id}/convert-trial トライアルライセンスを正式ライセンスへ変更

トライアル中のライセンスを、同じキーのまま正式なライセンスへ変更します。

認証
managementApiKey
必要な権限
licenses:write
操作ID
mgmt_v1_licenses_convert_trial

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

リクエスト本文

必須
application/json

Schema

TrialConversionInput

Example Value

{
  "target_policy_id": "target_policy_id_aaaaaaaaaaaaaaaaaaaa",
  "expires_at": "2026-09-21T00:00:00Z",
  "entitlement_overrides": {}
}

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
200

成功

ライセンスの操作に成功しました

application/json

Schema

LicenseResponse

Example Value

{
  "data": {}
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
GET /mgmt/v1/licenses ライセンスの一覧を取得

ライセンスを一覧で取得します。絞り込みやページングに使える値はパラメーター欄で確認できます。

認証
managementApiKey
必要な権限
licenses:read
操作ID
mgmt_v1_licenses_index

パラメーター

名前場所必須型・説明
limit クエリ 任意
integer 最小値: 1 最大値: 200

Example Value

50
cursor クエリ 任意
string

Example Value

"string"

レスポンス

200

成功

ライセンスの操作に成功しました

application/json

Schema

LicenseListResponse

Example Value

{
  "data": [
    {}
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
POST /mgmt/v1/licenses ライセンスを作成

ライセンスを新しく作成します。送信するJSONと作成後の応答はExample Valueで確認できます。

認証
managementApiKey
必要な権限
licenses:write
操作ID
mgmt_v1_licenses_create

パラメーター

名前場所必須型・説明
Idempotency-Key ヘッダー 必須
string 最小文字数: 16 最大文字数: 255

Example Value

"stringxxxxxxxxxx"

リクエスト本文

必須
application/json

Schema

LicenseIssueRequest

Example Value

{
  "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
  "policy_id": "policy_id_aaaaaaaaaaaaaaaaaaaa",
  "customer_id": "customer_id_aaaaaaaaaaaaaaaaaaaa",
  "license_type": "perpetual",
  "expires_at": "2026-09-21T00:00:00Z",
  "expiry": "2026-09-21T00:00:00Z",
  "renewal_authority": "external_billing",
  "max_machines": 0,
  "max_concurrent": 0,
  "entitlements": {},
  "metadata": {},
  "license_unit_limit_override": 1
}

レスポンス

201

作成完了

ライセンスの操作に成功しました

application/json

Schema

LicenseIssueResponse

Example Value

{
  "data": {}
}
409

競合

冪等キー・バージョン・端末・同時利用の競合、または製品署名鍵の準備中です

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
GET /mgmt/v1/licenses/{id} ライセンスの詳細を取得

指定したライセンスの現在の状態と設定を取得します。

認証
managementApiKey
必要な権限
licenses:read
操作ID
mgmt_v1_licenses_show

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

200

成功

ライセンスの操作に成功しました

application/json

Schema

LicenseResponse

Example Value

{
  "data": {}
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
PATCH /mgmt/v1/licenses/{id} ライセンスを更新

指定したライセンスを更新します。変更可能な項目はリクエスト本文のSchemaで確認できます。

認証
managementApiKey
必要な権限
licenses:write
操作ID
mgmt_v1_licenses_update

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"
If-Match ヘッダー 任意
string

Example Value

"string"

条件付き更新に使うことを推奨します。製品とライセンスはversion、利用ルールと顧客の詳細取得はETag応答ヘッダーで同時更新確認用の値を返します。ETagを変更せず送ってください。利用ルールのversionは履歴上の版番号であり、このヘッダーには使えません。値が現在のものと一致しないときは 409 VERSION_CONFLICT を返し、何も変更しません。

リクエスト本文

必須
application/json

Schema

LicenseUpdateInput

Example Value

{
  "expires_at": "2026-09-21T00:00:00Z",
  "expiry": "2026-09-21T00:00:00Z",
  "renewal_authority": "string",
  "max_machines_override": 1,
  "max_concurrent_override": 1,
  "license_unit_limit_override": 1,
  "entitlements": {},
  "metadata": {},
  "status_action": "active",
  "reason": "string"
}

レスポンス

200

成功

ライセンスの操作に成功しました

application/json

Schema

LicenseResponse

Example Value

{
  "data": {}
}
409

競合

冪等キー・バージョン・端末・同時利用の競合、または製品署名鍵の準備中です

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
DELETE /mgmt/v1/licenses/{id} ライセンスを削除

指定したライセンスを削除または無効化します。応答コードと制約を確認してから実行してください。

認証
managementApiKey
必要な権限
licenses:write
操作ID
mgmt_v1_licenses_destroy

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

204

内容なし

取り消しました

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}

Management API

認証済み端末

4操作

ライセンスに登録された端末を確認・解除します。

GET /mgmt/v1/licenses/{license_id}/activations 認証済み端末の一覧を取得

認証済み端末を一覧で取得します。絞り込みやページングに使える値はパラメーター欄で確認できます。

認証
managementApiKey
必要な権限
licenses:read
操作ID
mgmt_v1_activations_index

パラメーター

名前場所必須型・説明
license_id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"
id パス 必須
PublicId

Example Value

"id_aaaaaaaaaaaaaaaaaaaa"

レスポンス

200

成功

端末認証の操作に成功しました

application/json

Schema

ActivationListResponse

Example Value

{
  "data": [
    {
      "id": "id_aaaaaaaaaaaaaaaaaaaa",
      "license_id": "license_id_aaaaaaaaaaaaaaaaaaaa",
      "status": "active",
      "machine": {},
      "device_signing_key_thumbprint": "string",
      "first_seen_at": "2026-09-21T00:00:00Z",
      "last_seen_at": "2026-09-21T00:00:00Z",
      "deactivated_at": "2026-09-21T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
GET /mgmt/v1/activations/{id} 端末認証の詳細を取得

端末認証1件と、定期確認の状況（最後の確認・次に来るはずの時刻・遅れているか・証明書の期限・アプリとSDKの版）を取得します。

1件の端末認証と、その定期確認の状態です。製品アプリが登録され、定期確認を続けているかを確かめるために使います。拒否された Runtime API の要求はここに含まれません。GET /mgmt/v1/runtime_events で一覧できます。

認証
managementApiKey
必要な権限
licenses:read
操作ID
mgmt_v1_activations_show

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

200

成功

端末認証と定期確認の状況

application/json

Schema

ActivationDetailResponse

Example Value

{
  "data": {
    "id": "id_aaaaaaaaaaaaaaaaaaaa",
    "license_id": "license_id_aaaaaaaaaaaaaaaaaaaa",
    "status": "active",
    "machine": {},
    "device_signing_key_thumbprint": "string",
    "first_seen_at": "2026-09-21T00:00:00Z",
    "last_seen_at": "2026-09-21T00:00:00Z",
    "deactivated_at": "2026-09-21T00:00:00Z",
    "activated_at": "2026-09-21T00:00:00Z",
    "last_heartbeat_at": "2026-09-21T00:00:00Z",
    "heartbeat_interval_sec": 1,
    "next_heartbeat_due": {
      "earliest": "2026-09-21T00:00:00Z",
      "latest": "2026-09-21T00:00:00Z"
    },
    "heartbeat_overdue": true,
    "certificate_expires_at": "2026-09-21T00:00:00Z",
    "app_version": "string",
    "sdk_version": "string"
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
DELETE /mgmt/v1/activations/{id} 認証済み端末を削除

指定した認証済み端末を削除または無効化します。応答コードと制約を確認してから実行してください。

認証
managementApiKey
必要な権限
activations:delete
操作ID
mgmt_v1_activations_destroy

パラメーター

名前場所必須型・説明
id パス 必須
PublicId

Example Value

"id_aaaaaaaaaaaaaaaaaaaa"

レスポンス

204

内容なし

端末の認証を強制的に解除しました

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
GET /mgmt/v1/runtime_events 拒否された端末の要求を一覧

端末認証・定期確認・同時利用枠の要求のうち、直近7日に拒否・失敗したもの（署名の不一致・時刻のずれなど）を古い順に一覧します。同じ対象・同じ操作・同じ結果コードの拒否は1時間ごとに回数をまとめます。成功した要求は含みません。組み込みの動作確認で、製品アプリの要求が断られていないかを確かめるときに使います。暗号化したファイルの鍵の受け取りの拒否は含みません（管理画面の端末の詳細で確認できます）。

直近7日に拒否または失敗した、端末認証・定期確認・同時利用枠の Runtime API の要求を古い順に返します。製品アプリが断られていないか（例: DEVICE_PROOF_INVALID や CLOCK_SKEW）を確かめるために使います。成功した要求は含みません（最後の定期確認は GET /mgmt/v1/activations/{id} で確認できます）。同じ対象・操作・結果コードの要求は1時間ごとに1件にまとめて数え、1時間に多数の異なる記録がある契約組織では、それを超えた分を対象を省いた1件（details_omitted）にまとめて数えます。回数の上限で断った要求（RATE_LIMITED）と、既知の製品や端末認証を指さない要求は含みません。APIキーの環境の分だけを返します。暗号化したファイルの鍵の受け取りの拒否は含みません（管理画面の端末の詳細に出ます）。

認証
managementApiKey
必要な権限
licenses:read
操作ID
mgmt_v1_runtime_events_index

パラメーター

名前場所必須型・説明
license_id クエリ 任意
PublicId

Example Value

"license_id_aaaaaaaaaaaaaaaaaaaa"

このライセンスへの要求だけを返します。
activation_id クエリ 任意
PublicId

Example Value

"activation_id_aaaaaaaaaaaaaaaaaaaa"

この端末認証からの要求だけを返します。
product_id クエリ 任意
PublicId

Example Value

"product_id_aaaaaaaaaaaaaaaaaaaa"

この製品への要求だけを返します。
since クエリ 任意
string date-time

Example Value

"2026-09-21T00:00:00Z"

最後に発生した日時がこの日時（ISO 8601）以降の記録だけを返します。
limit クエリ 任意
integer 最小値: 1 最大値: 200

Example Value

50
cursor クエリ 任意
string

Example Value

"string"

レスポンス

200

成功

拒否または失敗した Runtime API の要求

application/json

Schema

RuntimeEventListResponse

Example Value

{
  "data": [
    {
      "operation": "activation_create",
      "outcome": "rejected",
      "code": "DEVICE_PROOF_INVALID",
      "http_status": 400,
      "occurrences": 1,
      "first_occurred_at": "2026-09-21T00:00:00Z",
      "last_occurred_at": "2026-09-21T00:00:00Z",
      "last_request_id": "01K5QWERTY1234567890ABCDEFG",
      "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
      "license_id": "license_id_aaaaaaaaaaaaaaaaaaaa",
      "activation_id": "activation_id_aaaaaaaaaaaaaaaaaaaa",
      "details_omitted": true
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}

Management API

Webhook

5操作

Webhook通知先と署名シークレットを管理します。

GET /mgmt/v1/webhooks Webhook通知先の一覧を取得

Webhook通知先を一覧で取得します。絞り込みやページングに使える値はパラメーター欄で確認できます。

署名シークレットは返しません。Slack・Microsoft Teams・Google Chatの通知先のURLは、それ自体がチャンネルへ誰でも投稿できる権限を持つため、返しません。

認証
managementApiKey
必要な権限
webhooks:read
操作ID
mgmt_v1_webhook_endpoints_index

レスポンス

200

成功

Webhook通知先の操作に成功しました

application/json

Schema

WebhookListResponse

Example Value

{
  "data": [
    {
      "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
      "name": "Example name",
      "url": "https://example.com/resource",
      "events": [
        "string"
      ],
      "status": "active",
      "secret_rotation": {
        "scheduled": true,
        "activates_at": "2026-09-21T00:00:00Z"
      },
      "created_at": "2026-09-21T00:00:00Z",
      "updated_at": "2026-09-21T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
POST /mgmt/v1/webhooks Webhook通知先を作成

Webhook通知先を新しく作成します。送信するJSONと作成後の応答はExample Valueで確認できます。

Webhook通知先を作成し、署名シークレットを一度だけ返します。この操作の Idempotency-Key は任意です。送った場合は、同じキーと同じ本文の再送に、通知先を増やさず最初の応答（署名シークレットを含む）を返します。live の製品がある契約組織では、Webhook通知先は live と test の環境で共有されているため、test のAPIキーから通知先を作成できません（403 ENVIRONMENT_MISMATCH）。

認証
managementApiKey
必要な権限
webhooks:write
操作ID
mgmt_v1_webhook_endpoints_create

パラメーター

名前場所必須型・説明
Idempotency-Key ヘッダー 任意
string 最小文字数: 16 最大文字数: 255

Example Value

"stringxxxxxxxxxx"

任意です。新しい操作ごとに一意な値を使い、結果が分からない同じ要求を再試行するときだけ同じ値を送ります。同じキーで別の本文を送ると 409 IDEMPOTENCY_CONFLICTになります。

リクエスト本文

必須
application/json

Schema

WebhookInput

Example Value

{
  "name": "Example name",
  "url": "https://example.com/resource",
  "events": [
    "string"
  ]
}

レスポンス

201

作成完了

Webhook通知先の操作に成功しました

application/json

Schema

WebhookSecretResponse

Example Value

{
  "data": {}
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
GET /mgmt/v1/webhooks/{id} Webhook通知先の詳細を取得

指定したWebhook通知先の現在の状態と設定を取得します。

署名シークレットは返しません。Slack・Microsoft Teams・Google Chatの通知先のURLは、それ自体がチャンネルへ誰でも投稿できる権限を持つため、返しません。

認証
managementApiKey
必要な権限
webhooks:read
操作ID
mgmt_v1_webhook_endpoints_show

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

200

成功

Webhook通知先の操作に成功しました

application/json

Schema

WebhookResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "url": "https://example.com/resource",
    "events": [
      "string"
    ],
    "status": "active",
    "secret_rotation": {
      "scheduled": true,
      "activates_at": "2026-09-21T00:00:00Z"
    },
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
PATCH /mgmt/v1/webhooks/{id} Webhook通知先を更新

指定したWebhook通知先を更新します。変更可能な項目はリクエスト本文のSchemaで確認できます。

Webhook通知先は live と test の環境で共有されていて、有効な通知先はどちらの環境の出来事も受け取ります。live の製品がある契約組織では、test のAPIキーから通知先を変更できません（403 ENVIRONMENT_MISMATCH）。

認証
managementApiKey
必要な権限
webhooks:write
操作ID
mgmt_v1_webhook_endpoints_update

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

リクエスト本文

必須
application/json

Schema

WebhookInput

Example Value

{
  "name": "Example name",
  "url": "https://example.com/resource",
  "events": [
    "string"
  ]
}

レスポンス

200

成功

Webhook通知先の操作に成功しました

application/json

Schema

WebhookResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "url": "https://example.com/resource",
    "events": [
      "string"
    ],
    "status": "active",
    "secret_rotation": {
      "scheduled": true,
      "activates_at": "2026-09-21T00:00:00Z"
    },
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
DELETE /mgmt/v1/webhooks/{id} Webhook通知先を削除

指定したWebhook通知先を削除または無効化します。応答コードと制約を確認してから実行してください。

Webhook通知先は live と test の環境で共有されていて、有効な通知先はどちらの環境の出来事も受け取ります。live の製品がある契約組織では、test のAPIキーから通知先を停止できません（403 ENVIRONMENT_MISMATCH）。

認証
managementApiKey
必要な権限
webhooks:write
操作ID
mgmt_v1_webhook_endpoints_destroy

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

204

内容なし

停止しました

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}

Management API

イベント・利用状況

3操作

監査イベントと利用状況レポートを取得します。

GET /mgmt/v1/events イベントの一覧を取得

イベントを一覧で取得します。絞り込みやページングに使える値はパラメーター欄で確認できます。

認証
managementApiKey
必要な権限
events:read
操作ID
mgmt_v1_audit_events_index

パラメーター

名前場所必須型・説明
limit クエリ 任意
integer 最小値: 1 最大値: 200

Example Value

50
cursor クエリ 任意
string

Example Value

"string"

レスポンス

200

成功

監査イベントの取得に成功しました

application/json

Schema

EventListResponse

Example Value

{
  "data": [
    {
      "id": "id_aaaaaaaaaaaaaaaaaaaa",
      "type": "string",
      "actor": {},
      "target": {
        "environment": "live"
      },
      "request_id": "01K5QWERTY1234567890ABCDEFG",
      "data": {},
      "created_at": "2026-09-21T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
GET /mgmt/v1/plan 契約プランの上限と使用量を取得

契約プランの上限、利用ルールの推奨値、今月の使用量を取得します。この呼び出しは月間回数に数えません。

契約プランの上限、利用ルールの推奨値、今月の使用量を返します。この呼び出しは Management API の月間回数に数えないため、月間回数を使い切った後も応答します。

認証
managementApiKey
必要な権限
reports:read
操作ID
mgmt_v1_plans_show

レスポンス

200

成功

プランの上限と使用量

application/json

Schema

PlanLimitsResponse

Example Value

{
  "data": {
    "plan": {
      "code": "string",
      "name": "Example name",
      "trial": true,
      "ends_at": "2026-09-21T00:00:00Z"
    },
    "quotas": {
      "property": {
        "limit": 1,
        "used": 1,
        "remaining": 1,
        "limit_with_overage": 1,
        "resets_at": "2026-09-21T00:00:00Z"
      }
    },
    "policy_constraints": {
      "activation_sync_min_sec": 1,
      "revocation_exposure_max_sec": 1,
      "cert_ttl_max_sec": 1,
      "floating_sync_min_sec": 1,
      "floating_lease_ttl_min_sec": 1
    },
    "policy_defaults": {
      "heartbeat_sec": 1,
      "cert_ttl_sec": 1,
      "network_grace_sec": 1
    },
    "revocation_exposure_max_sec_by_plan": {
      "property": 1
    },
    "license_duration_max_sec": 1,
    "unavailable_features": [
      {
        "key": "string",
        "minimum_plan": "string",
        "minimum_plan_name": "Example name"
      }
    ]
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
GET /mgmt/v1/reports/usage API利用状況を取得

期間内のAPI利用量と上限の集計を取得します。

認証
managementApiKey
必要な権限
reports:read
操作ID
mgmt_v1_reports_usage

レスポンス

200

成功

利用状況の集計に成功しました

application/json

Schema

UsageReportResponse

Example Value

{
  "data": {
    "period": {},
    "new_activations": 1,
    "active_machines": 1,
    "active_licenses": 1,
    "active_leases": 1
  }
}
429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}

Management API

販売店

5操作

販売店の登録と状態を管理します。

GET /mgmt/v1/resellers 販売店の一覧を取得

販売店を一覧で取得します。絞り込みやページングに使える値はパラメーター欄で確認できます。

認証
managementApiKey
必要な権限
customers:read
操作ID
mgmt_v1_resellers_index

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
200

成功

販売店の操作に成功しました

application/json

Schema

ResellerListResponse

Example Value

{
  "data": [
    {
      "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
      "name": "Example name",
      "email": "developer@example.com",
      "external_ref": "string",
      "organization_limit": 1,
      "user_limit": 1,
      "status": "active",
      "metadata": {},
      "archived_at": "2026-09-21T00:00:00Z",
      "created_at": "2026-09-21T00:00:00Z",
      "updated_at": "2026-09-21T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
POST /mgmt/v1/resellers 販売店を作成

販売店を新しく作成します。送信するJSONと作成後の応答はExample Valueで確認できます。

認証
managementApiKey
必要な権限
customers:write
操作ID
mgmt_v1_resellers_create

リクエスト本文

必須
application/json

Schema

ResellerInput

Example Value

{
  "name": "Example name",
  "email": "developer@example.com",
  "external_ref": "string",
  "organization_limit": 1,
  "user_limit": 1,
  "status": "active",
  "metadata": {}
}

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
201

作成完了

販売店の操作に成功しました

application/json

Schema

ResellerResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "email": "developer@example.com",
    "external_ref": "string",
    "organization_limit": 1,
    "user_limit": 1,
    "status": "active",
    "metadata": {},
    "archived_at": "2026-09-21T00:00:00Z",
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
GET /mgmt/v1/resellers/{id} 販売店の詳細を取得

指定した販売店の現在の状態と設定を取得します。

認証
managementApiKey
必要な権限
customers:read
操作ID
mgmt_v1_resellers_show

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
200

成功

販売店の操作に成功しました

application/json

Schema

ResellerResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "email": "developer@example.com",
    "external_ref": "string",
    "organization_limit": 1,
    "user_limit": 1,
    "status": "active",
    "metadata": {},
    "archived_at": "2026-09-21T00:00:00Z",
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
PATCH /mgmt/v1/resellers/{id} 販売店を更新

指定した販売店を更新します。変更可能な項目はリクエスト本文のSchemaで確認できます。

認証
managementApiKey
必要な権限
customers:write
操作ID
mgmt_v1_resellers_update

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

リクエスト本文

必須
application/json

Schema

ResellerInput

Example Value

{
  "name": "Example name",
  "email": "developer@example.com",
  "external_ref": "string",
  "organization_limit": 1,
  "user_limit": 1,
  "status": "active",
  "metadata": {}
}

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
200

成功

販売店の操作に成功しました

application/json

Schema

ResellerResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "email": "developer@example.com",
    "external_ref": "string",
    "organization_limit": 1,
    "user_limit": 1,
    "status": "active",
    "metadata": {},
    "archived_at": "2026-09-21T00:00:00Z",
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
DELETE /mgmt/v1/resellers/{id} 販売店を削除

指定した販売店を削除または無効化します。応答コードと制約を確認してから実行してください。

認証
managementApiKey
必要な権限
customers:write
操作ID
mgmt_v1_resellers_destroy

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
204

内容なし

処理が完了しました（応答本文なし）

402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}

Management API

組織

5操作

利用者を分離する組織を管理します。

GET /mgmt/v1/organizations 組織の一覧を取得

組織を一覧で取得します。絞り込みやページングに使える値はパラメーター欄で確認できます。

認証
managementApiKey
必要な権限
customers:read
操作ID
mgmt_v1_organizations_index

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
200

成功

顧客組織の操作に成功しました

application/json

Schema

OrganizationListResponse

Example Value

{
  "data": [
    {
      "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
      "name": "Example name",
      "email": "developer@example.com",
      "external_ref": "string",
      "user_limit": 1,
      "status": "active",
      "metadata": {},
      "reseller_id": "reseller_id_aaaaaaaaaaaaaaaaaaaa",
      "archived_at": "2026-09-21T00:00:00Z",
      "created_at": "2026-09-21T00:00:00Z",
      "updated_at": "2026-09-21T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
POST /mgmt/v1/organizations 組織を作成

組織を新しく作成します。送信するJSONと作成後の応答はExample Valueで確認できます。

認証
managementApiKey
必要な権限
customers:write
操作ID
mgmt_v1_organizations_create

リクエスト本文

必須
application/json

Schema

OrganizationInput

Example Value

{
  "name": "Example name",
  "email": "developer@example.com",
  "external_ref": "string",
  "user_limit": 1,
  "reseller_id": "reseller_id_aaaaaaaaaaaaaaaaaaaa",
  "status": "active",
  "metadata": {}
}

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
201

作成完了

顧客組織の操作に成功しました

application/json

Schema

OrganizationResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "email": "developer@example.com",
    "external_ref": "string",
    "user_limit": 1,
    "status": "active",
    "metadata": {},
    "reseller_id": "reseller_id_aaaaaaaaaaaaaaaaaaaa",
    "archived_at": "2026-09-21T00:00:00Z",
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
GET /mgmt/v1/organizations/{id} 組織の詳細を取得

指定した組織の現在の状態と設定を取得します。

認証
managementApiKey
必要な権限
customers:read
操作ID
mgmt_v1_organizations_show

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
200

成功

顧客組織の操作に成功しました

application/json

Schema

OrganizationResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "email": "developer@example.com",
    "external_ref": "string",
    "user_limit": 1,
    "status": "active",
    "metadata": {},
    "reseller_id": "reseller_id_aaaaaaaaaaaaaaaaaaaa",
    "archived_at": "2026-09-21T00:00:00Z",
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
PATCH /mgmt/v1/organizations/{id} 組織を更新

指定した組織を更新します。変更可能な項目はリクエスト本文のSchemaで確認できます。

顧客組織は live と test の環境で共有されています。test のAPIキーからは、live のライセンスに席を持つユーザーがいる顧客組織を変更できません（403 ENVIRONMENT_MISMATCH）。

認証
managementApiKey
必要な権限
customers:write
操作ID
mgmt_v1_organizations_update

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

リクエスト本文

必須
application/json

Schema

OrganizationInput

Example Value

{
  "name": "Example name",
  "email": "developer@example.com",
  "external_ref": "string",
  "user_limit": 1,
  "reseller_id": "reseller_id_aaaaaaaaaaaaaaaaaaaa",
  "status": "active",
  "metadata": {}
}

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
200

成功

顧客組織の操作に成功しました

application/json

Schema

OrganizationResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "email": "developer@example.com",
    "external_ref": "string",
    "user_limit": 1,
    "status": "active",
    "metadata": {},
    "reseller_id": "reseller_id_aaaaaaaaaaaaaaaaaaaa",
    "archived_at": "2026-09-21T00:00:00Z",
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
DELETE /mgmt/v1/organizations/{id} 組織を削除

指定した組織を削除または無効化します。応答コードと制約を確認してから実行してください。

顧客組織は live と test の環境で共有されています。test のAPIキーからは、live のライセンスに席を持つユーザーがいる顧客組織をアーカイブできません（403 ENVIRONMENT_MISMATCH）。

認証
managementApiKey
必要な権限
customers:write
操作ID
mgmt_v1_organizations_destroy

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
204

内容なし

処理が完了しました（応答本文なし）

402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}

Management API

組織グループの所属

3操作

グループに所属する利用者を管理します。

GET /mgmt/v1/organization_groups/{organization_group_id}/memberships 組織グループの所属の一覧を取得

組織グループの所属を一覧で取得します。絞り込みやページングに使える値はパラメーター欄で確認できます。

認証
managementApiKey
必要な権限
customers:read
操作ID
mgmt_v1_organization_group_memberships_index

パラメーター

名前場所必須型・説明
organization_group_id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
200

成功

組織グループの所属の操作に成功しました

application/json

Schema

OrganizationGroupMembershipListResponse

Example Value

{
  "data": [
    {
      "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
      "organization_group_id": "organization_group_id_aaaaaaaaaaaaaaaaaaaa",
      "license_user_id": "license_user_id_aaaaaaaaaaaaaaaaaaaa",
      "status": "active",
      "assigned_at": "2026-09-21T00:00:00Z",
      "revoked_at": "2026-09-21T00:00:00Z",
      "created_at": "2026-09-21T00:00:00Z",
      "updated_at": "2026-09-21T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
POST /mgmt/v1/organization_groups/{organization_group_id}/memberships 組織グループの所属を作成

組織グループの所属を新しく作成します。送信するJSONと作成後の応答はExample Valueで確認できます。

認証
managementApiKey
必要な権限
customers:write
操作ID
mgmt_v1_organization_group_memberships_create

パラメーター

名前場所必須型・説明
organization_group_id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

リクエスト本文

必須
application/json

Schema

OrganizationGroupMembershipInput

Example Value

{
  "license_user_id": "license_user_id_aaaaaaaaaaaaaaaaaaaa"
}

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
201

作成完了

組織グループの所属の操作に成功しました

application/json

Schema

OrganizationGroupMembershipResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "organization_group_id": "organization_group_id_aaaaaaaaaaaaaaaaaaaa",
    "license_user_id": "license_user_id_aaaaaaaaaaaaaaaaaaaa",
    "status": "active",
    "assigned_at": "2026-09-21T00:00:00Z",
    "revoked_at": "2026-09-21T00:00:00Z",
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
DELETE /mgmt/v1/organization_groups/{organization_group_id}/memberships/{id} 組織グループの所属を削除

指定した組織グループの所属を削除または無効化します。応答コードと制約を確認してから実行してください。

認証
managementApiKey
必要な権限
customers:write
操作ID
mgmt_v1_organization_group_memberships_destroy

パラメーター

名前場所必須型・説明
organization_group_id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
204

内容なし

処理が完了しました（応答本文なし）

402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}

Management API

組織グループ

5操作

組織内の利用者グループを管理します。

GET /mgmt/v1/organization_groups 組織グループの一覧を取得

組織グループを一覧で取得します。絞り込みやページングに使える値はパラメーター欄で確認できます。

認証
managementApiKey
必要な権限
customers:read
操作ID
mgmt_v1_organization_groups_index

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
200

成功

組織グループの操作に成功しました

application/json

Schema

OrganizationGroupListResponse

Example Value

{
  "data": [
    {
      "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
      "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
      "name": "Example name",
      "status": "active",
      "metadata": {},
      "created_at": "2026-09-21T00:00:00Z",
      "updated_at": "2026-09-21T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
POST /mgmt/v1/organization_groups 組織グループを作成

組織グループを新しく作成します。送信するJSONと作成後の応答はExample Valueで確認できます。

顧客組織の中にグループを作成します。顧客組織が有効である必要があり、一時停止中・アーカイブ済みの顧客組織を指定すると 422 DIRECTORY_VALIDATION_FAILED を返し、理由を details.errors.base に入れます。

認証
managementApiKey
必要な権限
customers:write
操作ID
mgmt_v1_organization_groups_create

リクエスト本文

必須
application/json

Schema

OrganizationGroupInput

Example Value

{
  "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
  "name": "Example name",
  "status": "active",
  "metadata": {}
}

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
201

作成完了

組織グループの操作に成功しました

application/json

Schema

OrganizationGroupResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "status": "active",
    "metadata": {},
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
GET /mgmt/v1/organization_groups/{id} 組織グループの詳細を取得

指定した組織グループの現在の状態と設定を取得します。

認証
managementApiKey
必要な権限
customers:read
操作ID
mgmt_v1_organization_groups_show

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
200

成功

組織グループの操作に成功しました

application/json

Schema

OrganizationGroupResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "status": "active",
    "metadata": {},
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
PATCH /mgmt/v1/organization_groups/{id} 組織グループを更新

指定した組織グループを更新します。変更可能な項目はリクエスト本文のSchemaで確認できます。

認証
managementApiKey
必要な権限
customers:write
操作ID
mgmt_v1_organization_groups_update

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

リクエスト本文

必須
application/json

Schema

OrganizationGroupInput

Example Value

{
  "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
  "name": "Example name",
  "status": "active",
  "metadata": {}
}

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
200

成功

組織グループの操作に成功しました

application/json

Schema

OrganizationGroupResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "status": "active",
    "metadata": {},
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
DELETE /mgmt/v1/organization_groups/{id} 組織グループを削除

指定した組織グループを削除または無効化します。応答コードと制約を確認してから実行してください。

認証
managementApiKey
必要な権限
customers:write
操作ID
mgmt_v1_organization_groups_destroy

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
204

内容なし

処理が完了しました（応答本文なし）

402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}

Management API

ライセンスユーザー

5操作

製品を利用する人のIDと状態を管理します。

GET /mgmt/v1/license_users ライセンスユーザーの一覧を取得

ライセンスユーザーを一覧で取得します。絞り込みやページングに使える値はパラメーター欄で確認できます。

認証
managementApiKey
必要な権限
customers:read
操作ID
mgmt_v1_license_users_index

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
200

成功

ライセンスユーザーの操作に成功しました

application/json

Schema

LicenseUserListResponse

Example Value

{
  "data": [
    {
      "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
      "issuer": "https://example.com/resource",
      "subject": "string",
      "email": "developer@example.com",
      "name": "Example name",
      "status": "active",
      "two_factor_state": "string",
      "two_factor_method": "string",
      "metadata": {},
      "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
      "oidc_connection_id": "oidc_connection_id_aaaaaaaaaaaaaaaaaaaa",
      "last_authenticated_at": "2026-09-21T00:00:00Z",
      "deprovisioned_at": "2026-09-21T00:00:00Z",
      "created_at": "2026-09-21T00:00:00Z",
      "updated_at": "2026-09-21T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
POST /mgmt/v1/license_users ライセンスユーザーを作成

ライセンスユーザーを新しく作成します。送信するJSONと作成後の応答はExample Valueで確認できます。

ライセンスユーザーを作成します。`oidc_connection_id`を指定してOIDC接続へ関連付ける操作はチーム以上のプランかつ`oidc_sso`の機能権限が必要で、利用できないプランではHTTP 403（`PLAN_ENTITLEMENT_REQUIRED`）を返します。個人プランではこの値を省略し、ローカル台帳・API割当として管理してください。

認証
managementApiKey
必要な権限
customers:write
操作ID
mgmt_v1_license_users_create

リクエスト本文

必須
application/json

Schema

LicenseUserInput

Example Value

{
  "issuer": "string",
  "subject": "string",
  "email": "developer@example.com",
  "name": "Example name",
  "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
  "oidc_connection_id": "oidc_connection_id_aaaaaaaaaaaaaaaaaaaa",
  "status": "active",
  "metadata": {}
}

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

スコープが不足しているか、`oidc_connection_id`の指定に必要なチーム以上のプランの`oidc_sso`機能権限がなく`PLAN_ENTITLEMENT_REQUIRED`となった場合

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
201

作成完了

ライセンスユーザーの操作に成功しました

application/json

Schema

LicenseUserResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "issuer": "https://example.com/resource",
    "subject": "string",
    "email": "developer@example.com",
    "name": "Example name",
    "status": "active",
    "two_factor_state": "string",
    "two_factor_method": "string",
    "metadata": {},
    "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
    "oidc_connection_id": "oidc_connection_id_aaaaaaaaaaaaaaaaaaaa",
    "last_authenticated_at": "2026-09-21T00:00:00Z",
    "deprovisioned_at": "2026-09-21T00:00:00Z",
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
GET /mgmt/v1/license_users/{id} ライセンスユーザーの詳細を取得

指定したライセンスユーザーの現在の状態と設定を取得します。

認証
managementApiKey
必要な権限
customers:read
操作ID
mgmt_v1_license_users_show

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
200

成功

ライセンスユーザーの操作に成功しました

application/json

Schema

LicenseUserResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "issuer": "https://example.com/resource",
    "subject": "string",
    "email": "developer@example.com",
    "name": "Example name",
    "status": "active",
    "two_factor_state": "string",
    "two_factor_method": "string",
    "metadata": {},
    "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
    "oidc_connection_id": "oidc_connection_id_aaaaaaaaaaaaaaaaaaaa",
    "last_authenticated_at": "2026-09-21T00:00:00Z",
    "deprovisioned_at": "2026-09-21T00:00:00Z",
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
PATCH /mgmt/v1/license_users/{id} ライセンスユーザーを更新

指定したライセンスユーザーを更新します。変更可能な項目はリクエスト本文のSchemaで確認できます。

ライセンスユーザーを更新します。`oidc_connection_id`を指定してOIDC接続へ関連付ける操作はチーム以上のプランかつ`oidc_sso`の機能権限が必要で、利用できないプランではHTTP 403（`PLAN_ENTITLEMENT_REQUIRED`）を返します。個人プランのローカル台帳・API割当はこの値を指定せずに更新します。`organization_id`に`null`または空文字を送ると、所属する顧客組織を外します（省略した場合は変えません）。

認証
managementApiKey
必要な権限
customers:write
操作ID
mgmt_v1_license_users_update

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

リクエスト本文

必須
application/json

Schema

LicenseUserInput

Example Value

{
  "issuer": "string",
  "subject": "string",
  "email": "developer@example.com",
  "name": "Example name",
  "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
  "oidc_connection_id": "oidc_connection_id_aaaaaaaaaaaaaaaaaaaa",
  "status": "active",
  "metadata": {}
}

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

スコープが不足しているか、`oidc_connection_id`の指定に必要なチーム以上のプランの`oidc_sso`機能権限がなく`PLAN_ENTITLEMENT_REQUIRED`となった場合

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
200

成功

ライセンスユーザーの操作に成功しました

application/json

Schema

LicenseUserResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "issuer": "https://example.com/resource",
    "subject": "string",
    "email": "developer@example.com",
    "name": "Example name",
    "status": "active",
    "two_factor_state": "string",
    "two_factor_method": "string",
    "metadata": {},
    "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
    "oidc_connection_id": "oidc_connection_id_aaaaaaaaaaaaaaaaaaaa",
    "last_authenticated_at": "2026-09-21T00:00:00Z",
    "deprovisioned_at": "2026-09-21T00:00:00Z",
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
DELETE /mgmt/v1/license_users/{id} ライセンスユーザーを削除

指定したライセンスユーザーを削除または無効化します。応答コードと制約を確認してから実行してください。

ライセンスユーザーは live と test の環境で共有されています。test のAPIキーからは、live のライセンスに席を持つライセンスユーザーの利用を終了できません（403 ENVIRONMENT_MISMATCH）。live のAPIキーはどのライセンスユーザーも利用を終了できます。

認証
managementApiKey
必要な権限
customers:write
操作ID
mgmt_v1_license_users_destroy

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
204

内容なし

処理が完了しました（応答本文なし）

402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}

Management API

OIDC接続

6操作

顧客のIDプロバイダー接続を管理します。

GET /mgmt/v1/oidc_connections OIDC接続の一覧を取得

OIDC接続を一覧で取得します。絞り込みやページングに使える値はパラメーター欄で確認できます。

認証
managementApiKey
必要な権限
sso:read
操作ID
mgmt_v1_oidc_connections_index

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
200

成功

OIDC接続の操作に成功しました

application/json

Schema

OidcConnectionListResponse

Example Value

{
  "data": [
    {
      "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
      "name": "Example name",
      "issuer": "https://example.com/resource",
      "client_id": "01K5QWERTY1234567890ABCDEFG",
      "authorization_endpoint": "https://example.com/resource",
      "token_endpoint": "https://example.com/resource",
      "jwks_uri": "https://example.com/resource",
      "scopes": [
        "string"
      ],
      "allowed_audiences": [
        "string"
      ],
      "pkce_required": true,
      "jit_provisioning": true,
      "status": "active",
      "metadata": {},
      "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
      "client_secret_rotated_at": "2026-09-21T00:00:00Z",
      "created_at": "2026-09-21T00:00:00Z",
      "updated_at": "2026-09-21T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
POST /mgmt/v1/oidc_connections OIDC接続を作成

OIDC接続を新しく作成します。送信するJSONと作成後の応答はExample Valueで確認できます。

OIDC接続を作成します。チーム以上のプランかつ`oidc_sso`の機能権限が必要で、個人プランではHTTP 403（`PLAN_ENTITLEMENT_REQUIRED`）を返します。

認証
managementApiKey
必要な権限
sso:write
操作ID
mgmt_v1_oidc_connections_create

リクエスト本文

必須
application/json

Schema

OidcConnectionCreateInput

Example Value

{
  "name": "Example name",
  "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
  "issuer": "string",
  "client_id": "01K5QWERTY1234567890ABCDEFG",
  "client_secret": "example-token",
  "authorization_endpoint": "https://example.com/resource",
  "token_endpoint": "https://example.com/resource",
  "jwks_uri": "https://example.com/resource",
  "pkce_required": true,
  "jit_provisioning": true,
  "status": "active",
  "scopes": [
    "string"
  ],
  "allowed_audiences": [
    "string"
  ],
  "metadata": {}
}

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

スコープが不足しているか、チーム以上のプランの`oidc_sso`機能権限がなく`PLAN_ENTITLEMENT_REQUIRED`となった場合

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
201

作成完了

OIDC接続の操作に成功しました

application/json

Schema

OidcConnectionResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "issuer": "https://example.com/resource",
    "client_id": "01K5QWERTY1234567890ABCDEFG",
    "authorization_endpoint": "https://example.com/resource",
    "token_endpoint": "https://example.com/resource",
    "jwks_uri": "https://example.com/resource",
    "scopes": [
      "string"
    ],
    "allowed_audiences": [
      "string"
    ],
    "pkce_required": true,
    "jit_provisioning": true,
    "status": "active",
    "metadata": {},
    "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
    "client_secret_rotated_at": "2026-09-21T00:00:00Z",
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
GET /mgmt/v1/oidc_connections/{id} OIDC接続の詳細を取得

指定したOIDC接続の現在の状態と設定を取得します。

認証
managementApiKey
必要な権限
sso:read
操作ID
mgmt_v1_oidc_connections_show

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
200

成功

OIDC接続の操作に成功しました

application/json

Schema

OidcConnectionResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "issuer": "https://example.com/resource",
    "client_id": "01K5QWERTY1234567890ABCDEFG",
    "authorization_endpoint": "https://example.com/resource",
    "token_endpoint": "https://example.com/resource",
    "jwks_uri": "https://example.com/resource",
    "scopes": [
      "string"
    ],
    "allowed_audiences": [
      "string"
    ],
    "pkce_required": true,
    "jit_provisioning": true,
    "status": "active",
    "metadata": {},
    "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
    "client_secret_rotated_at": "2026-09-21T00:00:00Z",
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
PATCH /mgmt/v1/oidc_connections/{id} OIDC接続を更新

指定したOIDC接続を更新します。Issuer・client_id・各Endpoint・jwks_uri・allowed_audiences・metadataのmfa_acr_values／max_age／trust_upstream_mfa／require_phishing_resistant_mfa／requested_acr_valuesを変えるときは、同じ要求でclient_secretを送ります（送らないとHTTP 422 `OIDC_CLIENT_SECRET_REENTRY_REQUIRED`）。これらの変更は契約組織のオーナー全員にメールで知らせます。IDプロバイダーの多要素認証は、IDトークンのamrにmfa・otp・sms・hwk・swk・popのどれかがあるか、acrがmfa_acr_valuesと一致すれば済んだものとして扱います。require_phishing_resistant_mfaがtrueなら、認めるのは鍵を使った方法（hwk・swk・pop。パスキーなど）とmfa_acr_valuesだけです。trust_upstream_mfaがtrueなら、Usakeyで2段階認証を設定していない利用者がIDプロバイダーで多要素認証を済ませてログインしたとき、2段階認証をIDプロバイダーでの管理に切り替えます。requested_acr_valuesの値は、認可の要求のacr_valuesに入ります。

OIDC接続を変更・再開する操作はチーム以上のプランかつ`oidc_sso`の機能権限が必要で、個人プランではHTTP 403（`PLAN_ENTITLEMENT_REQUIRED`）を返します。既存接続を安全に停止するため、`status`を`disabled`へ変更する操作だけは個人プランでも利用できます。顧客ポータルの利用者の本人確認を左右する設定（`issuer`・`client_id`・`authorization_endpoint`・`token_endpoint`・`jwks_uri`・`allowed_audiences`・`metadata`の`mfa_acr_values`・`max_age`・`trust_upstream_mfa`・`require_phishing_resistant_mfa`・`requested_acr_values`）を変えるときは、同じ要求で`client_secret`を送ってください。送った値で保存し直し、契約組織のオーナー全員にメールで知らせます。送らないとHTTP 422（`OIDC_CLIENT_SECRET_REENTRY_REQUIRED`、`details.fields`に該当項目）を返し、何も変えません。これらを変えない要求で`client_secret`を送るとHTTP 422（`OIDC_CLIENT_SECRET_ROTATION_REQUIRED`）です。Client Secretだけを入れ替えるときは専用のエンドポイントを使います。IDプロバイダー（IdP）の多要素認証の扱いは`metadata`で決めます。IDトークンの`amr`に`mfa`・`otp`・`sms`・`hwk`・`swk`・`pop`のどれかがあるか、`acr`が`mfa_acr_values`のどれかと一致すれば、IdPで多要素認証が済んだものとして扱います。`require_phishing_resistant_mfa`が`true`なら、認めるのは鍵を使った方法（`hwk`・`swk`・`pop`。パスキーやセキュリティキー）と`mfa_acr_values`だけです。`trust_upstream_mfa`が`true`なら、Usakeyで2段階認証を設定していない利用者がIdPで多要素認証を済ませて顧客ポータルにログインしたとき、その利用者の2段階認証をIdPでの管理に切り替え、以後のログインではIdPの多要素認証を毎回求めます。`requested_acr_values`（空白を含まない文字列の配列、10個まで）の値は、認可の要求の`acr_values`に入ります。

認証
managementApiKey
必要な権限
sso:write
操作ID
mgmt_v1_oidc_connections_update

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

リクエスト本文

必須
application/json

Schema

OidcConnectionUpdateInput

Example Value

{
  "client_secret": "example-token",
  "name": "Example name",
  "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
  "issuer": "string",
  "client_id": "01K5QWERTY1234567890ABCDEFG",
  "authorization_endpoint": "https://example.com/resource",
  "token_endpoint": "https://example.com/resource",
  "jwks_uri": "https://example.com/resource",
  "pkce_required": true,
  "jit_provisioning": true,
  "status": "active",
  "scopes": [
    "string"
  ],
  "allowed_audiences": [
    "string"
  ],
  "metadata": {}
}

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

スコープが不足しているか、停止以外の変更に必要なチーム以上のプランの`oidc_sso`機能権限がなく`PLAN_ENTITLEMENT_REQUIRED`となった場合

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
200

成功

OIDC接続の操作に成功しました

application/json

Schema

OidcConnectionResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "issuer": "https://example.com/resource",
    "client_id": "01K5QWERTY1234567890ABCDEFG",
    "authorization_endpoint": "https://example.com/resource",
    "token_endpoint": "https://example.com/resource",
    "jwks_uri": "https://example.com/resource",
    "scopes": [
      "string"
    ],
    "allowed_audiences": [
      "string"
    ],
    "pkce_required": true,
    "jit_provisioning": true,
    "status": "active",
    "metadata": {},
    "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
    "client_secret_rotated_at": "2026-09-21T00:00:00Z",
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
DELETE /mgmt/v1/oidc_connections/{id} OIDC接続を削除

指定したOIDC接続を削除または無効化します。応答コードと制約を確認してから実行してください。

認証
managementApiKey
必要な権限
sso:write
操作ID
mgmt_v1_oidc_connections_destroy

パラメーター

名前場所必須型・説明
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
204

内容なし

処理が完了しました（応答本文なし）

402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
POST /mgmt/v1/oidc_connections/{oidc_connection_id}/client-secret-rotation OIDCクライアントシークレットを更新

OIDC接続のクライアントシークレットを安全に差し替えます。

OIDC Client Secretを切り替えます。チーム以上のプランかつ`oidc_sso`の機能権限が必要で、個人プランではHTTP 403（`PLAN_ENTITLEMENT_REQUIRED`）を返します。

認証
managementApiKey
必要な権限
sso:write
操作ID
mgmt_v1_oidc_client_secret_rotations_create

パラメーター

名前場所必須型・説明
oidc_connection_id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

リクエスト本文

必須
application/json

Schema

OidcClientSecretRotationInput

Example Value

{
  "client_secret": "example-token"
}

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

スコープが不足しているか、チーム以上のプランの`oidc_sso`機能権限がなく`PLAN_ENTITLEMENT_REQUIRED`となった場合

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
200

成功

Client Secretを切り替えました（シークレットの値は返しません）

application/json

Schema

OidcConnectionResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "issuer": "https://example.com/resource",
    "client_id": "01K5QWERTY1234567890ABCDEFG",
    "authorization_endpoint": "https://example.com/resource",
    "token_endpoint": "https://example.com/resource",
    "jwks_uri": "https://example.com/resource",
    "scopes": [
      "string"
    ],
    "allowed_audiences": [
      "string"
    ],
    "pkce_required": true,
    "jit_provisioning": true,
    "status": "active",
    "metadata": {},
    "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
    "client_secret_rotated_at": "2026-09-21T00:00:00Z",
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}

Management API

ライセンス割り当て

3操作

ユーザー単位の利用権を割り当て・解除します。

GET /mgmt/v1/licenses/{license_id}/assignments ライセンス割り当ての一覧を取得

ライセンス割り当てを一覧で取得します。絞り込みやページングに使える値はパラメーター欄で確認できます。

認証
managementApiKey
必要な権限
licenses:read
操作ID
mgmt_v1_license_assignments_index

パラメーター

名前場所必須型・説明
license_id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
200

成功

ライセンスの割当の操作に成功しました

application/json

Schema

LicenseAssignmentListResponse

Example Value

{
  "data": [
    {
      "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
      "license_id": "license_id_aaaaaaaaaaaaaaaaaaaa",
      "license_user_id": "license_user_id_aaaaaaaaaaaaaaaaaaaa",
      "source_group_id": "source_group_id_aaaaaaaaaaaaaaaaaaaa",
      "tenant_plan_id": "tenant_plan_id_aaaaaaaaaaaaaaaaaaaa",
      "status": "active",
      "license_units": 1,
      "assigned_at": "2026-09-21T00:00:00Z",
      "expires_at": "2026-09-21T00:00:00Z",
      "revoked_at": "2026-09-21T00:00:00Z",
      "entitlement_overrides": {},
      "metadata": {},
      "created_at": "2026-09-21T00:00:00Z",
      "updated_at": "2026-09-21T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
POST /mgmt/v1/licenses/{license_id}/assignments ライセンス割り当てを作成

ライセンス割り当てを新しく作成します。送信するJSONと作成後の応答はExample Valueで確認できます。

認証
managementApiKey
必要な権限
licenses:write
操作ID
mgmt_v1_license_assignments_create

パラメーター

名前場所必須型・説明
license_id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

リクエスト本文

必須
application/json

Schema

LicenseAssignmentInput

Example Value

{
  "license_user_id": "license_user_id_aaaaaaaaaaaaaaaaaaaa",
  "source_group_id": "source_group_id_aaaaaaaaaaaaaaaaaaaa",
  "expires_at": "2026-09-21T00:00:00Z",
  "entitlement_overrides": {},
  "metadata": {}
}

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
201

作成完了

ライセンスの割当の操作に成功しました

application/json

Schema

LicenseAssignmentResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "license_id": "license_id_aaaaaaaaaaaaaaaaaaaa",
    "license_user_id": "license_user_id_aaaaaaaaaaaaaaaaaaaa",
    "source_group_id": "source_group_id_aaaaaaaaaaaaaaaaaaaa",
    "tenant_plan_id": "tenant_plan_id_aaaaaaaaaaaaaaaaaaaa",
    "status": "active",
    "license_units": 1,
    "assigned_at": "2026-09-21T00:00:00Z",
    "expires_at": "2026-09-21T00:00:00Z",
    "revoked_at": "2026-09-21T00:00:00Z",
    "entitlement_overrides": {},
    "metadata": {},
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
DELETE /mgmt/v1/licenses/{license_id}/assignments/{id} ライセンス割り当てを削除

指定したライセンス割り当てを削除または無効化します。応答コードと制約を確認してから実行してください。

認証
managementApiKey
必要な権限
licenses:write
操作ID
mgmt_v1_license_assignments_destroy

パラメーター

名前場所必須型・説明
license_id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"
id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
204

内容なし

処理が完了しました（応答本文なし）

402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}

Management API

Webhook署名鍵の更新

3操作

Webhook署名シークレットを安全に更新します。

POST /mgmt/v1/webhooks/{webhook_id}/secret-rotation/promote 次のWebhook署名鍵を有効化

ローテーション準備済みの署名シークレットを現在の署名鍵へ昇格します。

Webhook通知先は live と test の環境で共有されていて、有効な通知先はどちらの環境の出来事も受け取ります。live の製品がある契約組織では、test のAPIキーから予約済みの署名シークレットの切り替えを確定できません（403 ENVIRONMENT_MISMATCH）。

認証
managementApiKey
必要な権限
webhooks:write
操作ID
mgmt_v1_webhook_secret_rotations_promote

パラメーター

名前場所必須型・説明
webhook_id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
200

成功

Webhook通知先の操作に成功しました

application/json

Schema

WebhookResponse

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "url": "https://example.com/resource",
    "events": [
      "string"
    ],
    "status": "active",
    "secret_rotation": {
      "scheduled": true,
      "activates_at": "2026-09-21T00:00:00Z"
    },
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
POST /mgmt/v1/webhooks/{webhook_id}/secret-rotation Webhook署名鍵の更新を開始

現在の鍵を保ったまま次のWebhook署名シークレットを発行します。

Webhook通知先は live と test の環境で共有されていて、有効な通知先はどちらの環境の出来事も受け取ります。live の製品がある契約組織では、test のAPIキーから署名シークレットの切り替えを予約できません（403 ENVIRONMENT_MISMATCH）。

認証
managementApiKey
必要な権限
webhooks:write
操作ID
mgmt_v1_webhook_secret_rotations_create

パラメーター

名前場所必須型・説明
webhook_id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

リクエスト本文

必須
application/json

Schema

WebhookSecretRotationInput

Example Value

{
  "activates_at": "2026-09-21T00:00:00Z"
}

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
201

作成完了

Webhook通知先の操作に成功しました

application/json

Schema

WebhookSecretResponse

Example Value

{
  "data": {}
}
402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
400

不正なリクエスト

要求が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
422

処理できません

状態の変更または入力の検証に失敗しました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
DELETE /mgmt/v1/webhooks/{webhook_id}/secret-rotation Webhook署名鍵の更新を取り消し

準備中の署名シークレットを破棄し、ローテーションを取り消します。

Webhook通知先は live と test の環境で共有されていて、有効な通知先はどちらの環境の出来事も受け取ります。live の製品がある契約組織では、test のAPIキーから予約済みの署名シークレットの切り替えを取り消せません（403 ENVIRONMENT_MISMATCH）。

認証
managementApiKey
必要な権限
webhooks:write
操作ID
mgmt_v1_webhook_secret_rotations_destroy

パラメーター

名前場所必須型・説明
webhook_id パス 必須
string

Example Value

"01K5QWERTY1234567890ABCDEFG"

レスポンス

429

リクエスト上限超過

適用される時間枠の上限回数を超えました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
401

認証が必要

認証情報または署名が正しくありません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
403

権限不足

ライセンスの状態または権限により拒否されました

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
404

見つかりません

対象が見つかりません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
204

内容なし

処理が完了しました（応答本文なし）

402

支払いが必要

契約組織のトライアルまたは契約が終了しています

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
503

一時的に利用できません

APIの保護に必要な仕組みが一時的に使えません

application/json

Schema

Error

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}

OpenAPIの共通データ形式

データ形式

リクエストとレスポンスから参照される共通データ形式です。Example ValueでJSONの形を確認し、Schemaで必須項目、型、制約を確認できます。

PublicId 0項目

Schema

string 最大文字数: 64 形式: ^[a-z_]+[0-9a-f]{20,24}$

Example Value

"id_aaaaaaaaaaaaaaaaaaaa"
MachineInfoInventoryField 0項目

Schema

string 最小文字数: 1 最大文字数: 128

許容値: schema_version, collected_at, platform, app, app_version, app_build, sdk, sdk_version ほか37件

Example Value

"schema_version"
MachineInfo 47項目

サポートとリスク判定のために自己申告する端末情報の、安全な項目だけを許す一覧です。エンコード後のオブジェクトは16 KiB・JSONの値512個・入れ子8段・1オブジェクトのキー64個・1配列の値64個・キー128バイト・一般の文字列2 KiBまでで、下の名前付きの文字列項目は512バイトまでです。文字列の長さの制約はバイト数の目安で、サーバーはエンコード後のバイト数で判定します。生のシリアル番号、MACアドレス、端末のUUIDやID、ホスト名、利用者やホームの情報、環境変数の値、ファイルやアプリの一覧、プロセスの一覧、秘密情報は送れません。capabilities には存在する許可項目だけ、unavailable_fields には存在しない許可項目だけを入れ、両者が重ならないようにします。

Schema

object

Example Value

{
  "schema_version": 1,
  "collected_at": 0,
  "platform": "string",
  "app": "string",
  "app_version": "string",
  "app_build": "string",
  "sdk": "string",
  "sdk_version": "string",
  "os": "string",
  "os_version": "string",
  "os_build": "string",
  "os_edition": "string",
  "kernel_version": "string",
  "arch": "string",
  "cpu_vendor": "string",
  "cpu_model": "string",
  "cpu_physical_cores": 1,
  "cpu_logical_cores": 1,
  "cpu_load": 0.0,
  "memory_bytes": 1,
  "storage_bytes": 1,
  "manufacturer": "string",
  "model": "string",
  "chassis_type": "string",
  "locale": "string",
  "timezone": "string",
  "env_type": "string",
  "vm_detected": true,
  "vm_vendor": "string",
  "container_detected": true,
  "container_runtime": "string",
  "wsl_detected": true,
  "wsl_version": "string",
  "emulator_detected": true,
  "secure_boot_enabled": true,
  "tpm_present": true,
  "tpm_version": "string",
  "secure_enclave_present": true,
  "hardware_keystore_present": true,
  "root_detected": true,
  "jailbreak_detected": true,
  "debugger_detected": true,
  "clock_tamper_detected": true,
  "clock_rollback_detected": true,
  "capabilities": [
    "schema_version"
  ],
  "unavailable_fields": [
    "schema_version"
  ],
  "risk_signals": [
    {
      "kind": "clock_rollback",
      "confidence": 0,
      "source": "example.value"
    }
  ]
}
項目必須型・説明Example Value
schema_version 任意
integer 最小値: 1 最大値: 255
1
collected_at 任意
integer 最小値: 0 最大値: 9223372036854775807

Unix時刻（秒）

 0
platform 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
app 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
app_version 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
app_build 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
sdk 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
sdk_version 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
os 必須
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
os_version 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
os_build 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
os_edition 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
kernel_version 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
arch 必須
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
cpu_vendor 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
cpu_model 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
cpu_physical_cores 任意
integer 最小値: 1 最大値: 9223372036854775807
1
cpu_logical_cores 任意
integer 最小値: 1 最大値: 9223372036854775807
1
cpu_load 任意
number 最小値: 0 最大値: 100

定期確認では小数を含む有限の百分率を受け付けます。端末認証とオフライン申請では整数の百分率を使います。

 0.0
memory_bytes 任意
integer 最小値: 1 最大値: 9223372036854775807
1
storage_bytes 任意
integer 最小値: 1 最大値: 9223372036854775807
1
manufacturer 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
model 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
chassis_type 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
locale 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
timezone 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
env_type 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
vm_detected 任意
boolean
true
vm_vendor 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
container_detected 任意
boolean
true
container_runtime 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
wsl_detected 任意
boolean
true
wsl_version 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
emulator_detected 任意
boolean
true
secure_boot_enabled 任意
boolean
true
tpm_present 任意
boolean
true
tpm_version 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
secure_enclave_present 任意
boolean
true
hardware_keystore_present 任意
boolean
true
root_detected 任意
boolean
true
jailbreak_detected 任意
boolean
true
debugger_detected 任意
boolean
true
clock_tamper_detected 任意
boolean
true
clock_rollback_detected 任意
boolean
true
capabilities 任意
array<MachineInfoInventoryField> 最大要素数: 64 重複不可: はい
[ "schema_version" ]
unavailable_fields 任意
array<MachineInfoInventoryField> 最大要素数: 64 重複不可: はい
[ "schema_version" ]
risk_signals 任意
array<object> 最大要素数: 16
[ { "kind": "clock_rollback", "confidence": 0, "source": "example.value" } ]
StableMachineInfo 47項目

署名で守る端末認証・オフライン申請用の端末情報です。共通の許可項目を使いますが、SDKの言語をまたいで正規化した署名付きJSONを同じにするため、cpu_load は整数にします。

Schema

MachineInfo + object

Example Value

{
  "os": "string",
  "arch": "string"
}
項目必須型・説明Example Value
cpu_load 任意
number 最小値: 0 最大値: 100

定期確認では小数を含む有限の百分率を受け付けます。端末認証とオフライン申請では整数の百分率を使います。

 0.0
schema_version 任意
integer 最小値: 1 最大値: 255
1
collected_at 任意
integer 最小値: 0 最大値: 9223372036854775807

Unix時刻（秒）

 0
platform 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
app 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
app_version 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
app_build 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
sdk 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
sdk_version 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
os 必須
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
os_version 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
os_build 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
os_edition 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
kernel_version 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
arch 必須
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
cpu_vendor 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
cpu_model 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
cpu_physical_cores 任意
integer 最小値: 1 最大値: 9223372036854775807
1
cpu_logical_cores 任意
integer 最小値: 1 最大値: 9223372036854775807
1
memory_bytes 任意
integer 最小値: 1 最大値: 9223372036854775807
1
storage_bytes 任意
integer 最小値: 1 最大値: 9223372036854775807
1
manufacturer 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
model 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
chassis_type 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
locale 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
timezone 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
env_type 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
vm_detected 任意
boolean
true
vm_vendor 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
container_detected 任意
boolean
true
container_runtime 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
wsl_detected 任意
boolean
true
wsl_version 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
emulator_detected 任意
boolean
true
secure_boot_enabled 任意
boolean
true
tpm_present 任意
boolean
true
tpm_version 任意
string 最小文字数: 1 最大文字数: 512 形式: ^[^\x00-\x1F\x7F]+$
"string"
secure_enclave_present 任意
boolean
true
hardware_keystore_present 任意
boolean
true
root_detected 任意
boolean
true
jailbreak_detected 任意
boolean
true
debugger_detected 任意
boolean
true
clock_tamper_detected 任意
boolean
true
clock_rollback_detected 任意
boolean
true
capabilities 任意
array<MachineInfoInventoryField> 最大要素数: 64 重複不可: はい
[ "schema_version" ]
unavailable_fields 任意
array<MachineInfoInventoryField> 最大要素数: 64 重複不可: はい
[ "schema_version" ]
risk_signals 任意
array<object> 最大要素数: 16
[ { "kind": "clock_rollback", "confidence": 0, "source": "example.value" } ]
ActivationRequest 13項目

Schema

object

Example Value

{
  "license_key": "string",
  "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
  "device_signing_public_key": "string",
  "device_kem_public_key": "string",
  "device_proof": "string",
  "machine_signals": {
    "property": "string"
  },
  "machine_info": {
    "os": "string",
    "arch": "string"
  },
  "app_version": "string",
  "sdk_version": "string",
  "request_id": "01K5QWERTY1234567890ABCDEFG",
  "client_time": 1,
  "named_user_token": "Example name",
  "nonce": "stringxxxxxxxxxxxxxxxx"
}
項目必須型・説明Example Value
license_key 必須
string 最大文字数: 512
"string"
product_id 必須
PublicId
"product_id_aaaaaaaaaaaaaaaaaaaa"
device_signing_public_key 必須
string 最大文字数: 2048
"string"
device_kem_public_key 必須
string 最大文字数: 1024
"string"
device_proof 必須
string 最大文字数: 1024
"string"
machine_signals 任意
object
{ "property": "string" }
machine_info 必須
StableMachineInfo
{ "os": "string", "arch": "string" }
app_version 任意
string 最大文字数: 255
"string"
sdk_version 任意
string 最大文字数: 255
"string"
request_id 任意
string 最大文字数: 255
"01K5QWERTY1234567890ABCDEFG"
client_time 任意
integer
1
named_user_token 任意
string 最大文字数: 4096

名前付きユーザーの利用ルールで必須です。トークンは、製品アプリのメールアドレスでのライセンス確認（POST /runtime/v1/email-verifications、個人プラン以上）か、顧客ポータル（チーム以上）で発行します。無いときは 401 NAMED_USER_TOKEN_REQUIREDで、details.available_methodsに使える方法（email / portal）を返します。

 "Example name"
nonce 必須
string 最小文字数: 22 最大文字数: 255
"stringxxxxxxxxxxxxxxxx"
ActivationHeartbeatRequest 4項目

Schema

value

Example Value

{
  "machine_info": {
    "os": "string",
    "arch": "string"
  }
}
項目必須型・説明Example Value
app_version 任意
string 最大文字数: 255
"string"
sdk_version 任意
string 最大文字数: 255
"string"
machine_info 任意
MachineInfo

自己申告の完全な端末情報です。初回・内容が変わったとき・少なくとも24時間に1回送ります。os と arch を含め、サーバーの許可項目・16 KiB・JSONの値512個・入れ子8段・文字列の値2 KiBまでに収めます

 { "schema_version": 1, "collected_at": 0, "platform": "string", "app": "string", "app_version": "string", "app_build": "string", "sdk": "string", "sdk_version": "string", "os": "string", "os_version": "string", "os_build": "string", "os_edition": "string", "kernel_version": "string", "arch": "string", "cpu_vendor": "string", "cpu_model": "string", "cpu_physical_cores": 1, "cpu_logical_cores": 1, "cpu_load": 0.0, "memory_bytes": 1, "storage_bytes": 1, "manufacturer": "string", "model": "string", "chassis_type": "string", "locale": "string", "timezone": "string", "env_type": "string", "vm_detected": true, "vm_vendor": "string", "container_detected": true, "container_runtime": "string", "wsl_detected": true, "wsl_version": "string", "emulator_detected": true, "secure_boot_enabled": true, "tpm_present": true, "tpm_version": "string", "secure_enclave_present": true, "hardware_keystore_present": true, "root_detected": true, "jailbreak_detected": true, "debugger_detected": true, "clock_tamper_detected": true, "clock_rollback_detected": true, "capabilities": [ "schema_version" ], "unavailable_fields": [ "schema_version" ], "risk_signals": [ { "kind": "clock_rollback", "confidence": 0, "source": "example.value" } ] }
machine_info_digest 任意
string 形式: ^[0-9a-f]{64}$

変化していない完全な machine_info のSHA-256ハッシュ値です。直前の24時間以内に、サーバーが完全な machine_info を受け取っているときだけ受け付けます

 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
SealedFileKeyRequest 2項目

Schema

object

Example Value

{
  "header": "example_value",
  "sdk_version": "string"
}
項目必須型・説明Example Value
header 必須
string 最小文字数: 3 最大文字数: 2731 形式: ^[A-Za-z0-9_-]+$

暗号化したファイル（第1版）のヘッダーのバイト列そのものを、パディングなしのbase64urlにしたもの（正規形のJSONで2048バイトまで）

 "example_value"
sdk_version 任意
string 最大文字数: 255
"string"
LeaseAcquireRequest 2項目

Schema

object

Example Value

{
  "activation_id": "activation_id_aaaaaaaaaaaaaaaaaaaa",
  "instance_id": "01K5QWERTY1234567890ABCDEFG"
}
項目必須型・説明Example Value
activation_id 必須
PublicId
"activation_id_aaaaaaaaaaaaaaaaaaaa"
instance_id 必須
string 最小文字数: 16 最大文字数: 255
"01K5QWERTY1234567890ABCDEFG"
LeaseInstanceRequest 1項目

Schema

object

Example Value

{
  "instance_id": "01K5QWERTY1234567890ABCDEFG"
}
項目必須型・説明Example Value
instance_id 必須
string 最小文字数: 16 最大文字数: 255
"01K5QWERTY1234567890ABCDEFG"
OfflineRequest 16項目

端末が署名した usakey-offline-request-v1 形式のJSONです。エンコード後の要求全体は64 KiB・JSONの値1,024個・入れ子8段までです。

Schema

value

Example Value

{
  "format": "usakey-offline-request-v1",
  "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
  "device_signing_public_key": "string",
  "device_kem_public_key": "p256:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
  "device_proof": "string",
  "machine_info": {
    "os": "string",
    "arch": "string"
  },
  "nonce": "example_valuexxxxxxxxx",
  "generated_at": 1
}
項目必須型・説明Example Value
v 任意
integer
1
format 必須
string
"usakey-offline-request-v1"
product_id 必須
PublicId
"product_id_aaaaaaaaaaaaaaaaaaaa"
device_signing_public_key 必須
string 最小文字数: 1 最大文字数: 2048

Ed25519のSubjectPublicKeyInfo形式のPEM、または ed25519: で始まる生の公開鍵

 "string"
device_kem_public_key 必須
string 最小文字数: 1 最大文字数: 1024 形式: ^p256:[A-Za-z0-9_-]+$

非圧縮の65バイトのP-256 SEC1点を、パディングなしのBase64URLにしたもの

 "p256:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
device_proof 任意
string 最小文字数: 1 最大文字数: 1024
"string"
request_proof 任意
string 最小文字数: 1 最大文字数: 1024

device_proof の旧名です。証明の項目はどちらか1つだけ送ります。

 "string"
machine_signals 任意
object
{ "property": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }
machine_info 必須
StableMachineInfo
{ "os": "string", "arch": "string" }
sdk_version 任意
string 最大文字数: 255
"string"
app_version 任意
string 最大文字数: 255
"string"
request_id 任意
string 最大文字数: 255
"01K5QWERTY1234567890ABCDEFG"
nonce 必須
string 最小文字数: 22 最大文字数: 255 形式: ^[A-Za-z0-9_-]+$
"example_valuexxxxxxxxx"
generated_at 必須
integer

Unix時刻（秒）。7日より古いものと、5分より先の未来のものは受け付けません

 1
display 任意
object
{ "product_name": "Example name", "device_code": "string" }
sealed_file_headers 任意
array<string> 最小要素数: 1 最大要素数: 16 重複不可: はい

利用ファイルに鍵を入れたい暗号化したファイルのヘッダー（任意）。それぞれヘッダーのバイト列そのものをパディングなしのbase64urlにしたものです。ほかの項目と同じく端末の署名の対象です。指定すると利用ファイルに sealed-file-keys.json が入ります。1件でも鍵を渡せないファイルがあれば、利用ファイルは発行しません。

 [ "example_value" ]
OfflineCertificateIssueRequest 3項目

Schema

object

Example Value

{
  "request": {
    "format": "usakey-offline-request-v1",
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "device_signing_public_key": "string",
    "device_kem_public_key": "p256:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
    "device_proof": "string",
    "machine_info": {
      "os": "string",
      "arch": "string"
    },
    "nonce": "example_valuexxxxxxxxx",
    "generated_at": 1
  },
  "expires_at": "2026-09-21T00:00:00Z",
  "license_assignment_id": "license_assignment_id_aaaaaaaaaaaaaaaaaaaa"
}
項目必須型・説明Example Value
request 必須
OfflineRequest
{ "format": "usakey-offline-request-v1", "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa", "device_signing_public_key": "string", "device_kem_public_key": "p256:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", "device_proof": "string", "machine_info": { "os": "string", "arch": "string" }, "nonce": "example_valuexxxxxxxxx", "generated_at": 1 }
expires_at 任意
string date-time
"2026-09-21T00:00:00Z"
license_assignment_id 任意
PublicId

チーム以上のプランの名前付きユーザー向けオフライン利用ルールで必須です。署名済みパッケージは7日以内に失効し、期限後は利用できなくなります。

 "license_assignment_id_aaaaaaaaaaaaaaaaaaaa"
LicenseIssueRequest 12項目

Schema

object

Example Value

{
  "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
  "policy_id": "policy_id_aaaaaaaaaaaaaaaaaaaa",
  "customer_id": "customer_id_aaaaaaaaaaaaaaaaaaaa",
  "license_type": "perpetual",
  "expires_at": "2026-09-21T00:00:00Z",
  "expiry": "2026-09-21T00:00:00Z",
  "renewal_authority": "external_billing",
  "max_machines": 0,
  "max_concurrent": 0,
  "entitlements": {},
  "metadata": {},
  "license_unit_limit_override": 1
}
項目必須型・説明Example Value
product_id 必須
PublicId
"product_id_aaaaaaaaaaaaaaaaaaaa"
policy_id 必須
PublicId
"policy_id_aaaaaaaaaaaaaaaaaaaa"
customer_id 任意
PublicId
"customer_id_aaaaaaaaaaaaaaaaaaaa"
license_type 任意
value

許容値: perpetual, subscription, trial

"perpetual"
expires_at 任意
string date-time

契約期限。買い切り（perpetual）では指定しません。検証プランでは発行時刻から1時間以内である必要があります。

 "2026-09-21T00:00:00Z"
expiry 任意
string date-time

expires_atの旧名です。expires_atを使ってください。両方を指定した場合はexpires_atを採用します。

 "2026-09-21T00:00:00Z"
renewal_authority 任意
value

許容値: external_billing, calendar, manual

"external_billing"
max_machines 任意
integer 最小値: 0
0
max_concurrent 任意
integer 最小値: 0
0
entitlements 任意
object
{}
metadata 任意
object
{}
license_unit_limit_override 任意
integer | null
1
SignedEnvelope 4項目

Schema

object

Example Value

{
  "data": "string",
  "response_assertion": {
    "v": 1,
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "key_id": "01K5QWERTY1234567890ABCDEFG",
    "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "nonce": "string",
    "server_time": 1,
    "status": 1,
    "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "response_signature": "example-token",
  "signing_delegation": {
    "delegation": {
      "v": 1,
      "purpose": "runtime-response",
      "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
      "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
      "online_key_id": "01K5QWERTY1234567890ABCDEFG",
      "public_key": "string",
      "issued_at": 1,
      "expires_at": 1
    },
    "signature": "example-token"
  }
}
項目必須型・説明Example Value
data 必須
value
"string"
response_assertion 必須
object
{ "v": 1, "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa", "key_id": "01K5QWERTY1234567890ABCDEFG", "parent_key_id": "01K5QWERTY1234567890ABCDEFG", "request_id": "01K5QWERTY1234567890ABCDEFG", "nonce": "string", "server_time": 1, "status": 1, "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }
response_signature 必須
string
"example-token"
signing_delegation 必須
object
{ "delegation": { "v": 1, "purpose": "runtime-response", "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa", "parent_key_id": "01K5QWERTY1234567890ABCDEFG", "online_key_id": "01K5QWERTY1234567890ABCDEFG", "public_key": "string", "issued_at": 1, "expires_at": 1 }, "signature": "example-token" }
ActivationData 3項目

Schema

object

Example Value

{
  "activation_id": "activation_id_aaaaaaaaaaaaaaaaaaaa",
  "certificate": "string",
  "machine_info_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
項目必須型・説明Example Value
activation_id 必須
PublicId
"activation_id_aaaaaaaaaaaaaaaaaaaa"
certificate 必須
string

PASETO v4.public形式のライセンス証明書

 "string"
machine_info_digest 必須
string 形式: ^[0-9a-f]{64}$

この端末認証に保存した完全な machine_info のSHA-256ハッシュ値

 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
ActivationHeartbeatData 5項目

Schema

object

Example Value

{
  "activation_id": "activation_id_aaaaaaaaaaaaaaaaaaaa",
  "license_status": "active",
  "certificate": "string",
  "next_heartbeat_in": 10,
  "machine_info_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
項目必須型・説明Example Value
activation_id 必須
PublicId
"activation_id_aaaaaaaaaaaaaaaaaaaa"
license_status 必須
value

許容値: active, suspended, revoked, expired

"active"
certificate 必須
string

PASETO v4.public形式のライセンス証明書

 "string"
next_heartbeat_in 必須
integer 最小値: 10
10
machine_info_digest 必須
string 形式: ^[0-9a-f]{64}$

この端末認証に保存した完全な machine_info のSHA-256ハッシュ値

 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
SealedFileKeyData 5項目

Schema

object

Example Value

{
  "activation_id": "activation_id_aaaaaaaaaaaaaaaaaaaa",
  "file_id": "esNxn3TKNIsd_Dyi2XYojA",
  "header_sha256": "f7511808a1669a5481adebe399a96ad043d29ebb887207743368c3fb812717e5",
  "enc": "BC1G-oCCtQBTqm4VEolqWH6MHHbpugqlixdHLXLURww-71zLlbPAaperQqYpqsHIyF9bJ66JOqwcEaZ1yHqSNPI",
  "wrapped_key": "j4LNTalkfJFXswg_u9NXmazh7FZQHrAs4iqPQNp0hHCsdQIZWcS3AOpEkYp2mape"
}
項目必須型・説明Example Value
activation_id 必須
PublicId
"activation_id_aaaaaaaaaaaaaaaaaaaa"
file_id 必須
string 形式: ^[A-Za-z0-9_-]{22}$

ヘッダーにある、ファイルごとのランダムな識別子

 "esNxn3TKNIsd_Dyi2XYojA"
header_sha256 必須
string 形式: ^[0-9a-f]{64}$

ヘッダーのバイト列のSHA-256。端末はこの値で鍵を探します

 "f7511808a1669a5481adebe399a96ad043d29ebb887207743368c3fb812717e5"
enc 必須
string 形式: ^[A-Za-z0-9_-]{87}$

HPKEのカプセル化鍵（65バイトの非圧縮P-256点、base64url）

 "BC1G-oCCtQBTqm4VEolqWH6MHHbpugqlixdHLXLURww-71zLlbPAaperQqYpqsHIyF9bJ66JOqwcEaZ1yHqSNPI"
wrapped_key 必須
string 形式: ^[A-Za-z0-9_-]{64}$

端末認証のKEM公開鍵あてにHPKEで包んだ32バイトのデータ鍵（タグ込みで48バイト、base64url）。関連データで端末認証・端末のKEM鍵の拇印・製品・ヘッダーのdigestに結び付けています。

 "j4LNTalkfJFXswg_u9NXmazh7FZQHrAs4iqPQNp0hHCsdQIZWcS3AOpEkYp2mape"
LeaseData 4項目

Schema

object

Example Value

{
  "lease_id": "lease_id_aaaaaaaaaaaaaaaaaaaa",
  "instance_id": "01K5QWERTY1234567890ABCDEFG",
  "expires_at": 1,
  "heartbeat_in": 10
}
項目必須型・説明Example Value
lease_id 必須
PublicId
"lease_id_aaaaaaaaaaaaaaaaaaaa"
instance_id 必須
string 最小文字数: 16 最大文字数: 255
"01K5QWERTY1234567890ABCDEFG"
expires_at 必須
integer

Unix時刻（秒）

 1
heartbeat_in 必須
integer 最小値: 10
10
LeaseReleaseData 2項目

Schema

object

Example Value

{
  "lease_id": "lease_id_aaaaaaaaaaaaaaaaaaaa",
  "status": "released"
}
項目必須型・説明Example Value
lease_id 必須
PublicId
"lease_id_aaaaaaaaaaaaaaaaaaaa"
status 必須
value
"released"
SignedActivationResponse 4項目

Schema

SignedEnvelope + object

Example Value

{
  "data": {
    "activation_id": "activation_id_aaaaaaaaaaaaaaaaaaaa",
    "certificate": "string",
    "machine_info_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "response_assertion": {
    "v": 1,
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "key_id": "01K5QWERTY1234567890ABCDEFG",
    "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "nonce": "string",
    "server_time": 1,
    "status": 1,
    "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "response_signature": "example-token",
  "signing_delegation": {
    "delegation": {
      "v": 1,
      "purpose": "runtime-response",
      "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
      "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
      "online_key_id": "01K5QWERTY1234567890ABCDEFG",
      "public_key": "string",
      "issued_at": 1,
      "expires_at": 1
    },
    "signature": "example-token"
  }
}
項目必須型・説明Example Value
data 必須
value
"string"
response_assertion 必須
object
{ "v": 1, "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa", "key_id": "01K5QWERTY1234567890ABCDEFG", "parent_key_id": "01K5QWERTY1234567890ABCDEFG", "request_id": "01K5QWERTY1234567890ABCDEFG", "nonce": "string", "server_time": 1, "status": 1, "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }
response_signature 必須
string
"example-token"
signing_delegation 必須
object
{ "delegation": { "v": 1, "purpose": "runtime-response", "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa", "parent_key_id": "01K5QWERTY1234567890ABCDEFG", "online_key_id": "01K5QWERTY1234567890ABCDEFG", "public_key": "string", "issued_at": 1, "expires_at": 1 }, "signature": "example-token" }
SignedActivationHeartbeatResponse 4項目

Schema

SignedEnvelope + object

Example Value

{
  "data": {
    "activation_id": "activation_id_aaaaaaaaaaaaaaaaaaaa",
    "license_status": "active",
    "certificate": "string",
    "next_heartbeat_in": 10,
    "machine_info_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "response_assertion": {
    "v": 1,
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "key_id": "01K5QWERTY1234567890ABCDEFG",
    "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "nonce": "string",
    "server_time": 1,
    "status": 1,
    "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "response_signature": "example-token",
  "signing_delegation": {
    "delegation": {
      "v": 1,
      "purpose": "runtime-response",
      "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
      "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
      "online_key_id": "01K5QWERTY1234567890ABCDEFG",
      "public_key": "string",
      "issued_at": 1,
      "expires_at": 1
    },
    "signature": "example-token"
  }
}
項目必須型・説明Example Value
data 必須
value
"string"
response_assertion 必須
object
{ "v": 1, "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa", "key_id": "01K5QWERTY1234567890ABCDEFG", "parent_key_id": "01K5QWERTY1234567890ABCDEFG", "request_id": "01K5QWERTY1234567890ABCDEFG", "nonce": "string", "server_time": 1, "status": 1, "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }
response_signature 必須
string
"example-token"
signing_delegation 必須
object
{ "delegation": { "v": 1, "purpose": "runtime-response", "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa", "parent_key_id": "01K5QWERTY1234567890ABCDEFG", "online_key_id": "01K5QWERTY1234567890ABCDEFG", "public_key": "string", "issued_at": 1, "expires_at": 1 }, "signature": "example-token" }
SignedSealedFileKeyResponse 4項目

Schema

SignedEnvelope + object

Example Value

{
  "data": {
    "activation_id": "activation_id_aaaaaaaaaaaaaaaaaaaa",
    "file_id": "esNxn3TKNIsd_Dyi2XYojA",
    "header_sha256": "f7511808a1669a5481adebe399a96ad043d29ebb887207743368c3fb812717e5",
    "enc": "BC1G-oCCtQBTqm4VEolqWH6MHHbpugqlixdHLXLURww-71zLlbPAaperQqYpqsHIyF9bJ66JOqwcEaZ1yHqSNPI",
    "wrapped_key": "j4LNTalkfJFXswg_u9NXmazh7FZQHrAs4iqPQNp0hHCsdQIZWcS3AOpEkYp2mape"
  },
  "response_assertion": {
    "v": 1,
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "key_id": "01K5QWERTY1234567890ABCDEFG",
    "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "nonce": "string",
    "server_time": 1,
    "status": 1,
    "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "response_signature": "example-token",
  "signing_delegation": {
    "delegation": {
      "v": 1,
      "purpose": "runtime-response",
      "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
      "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
      "online_key_id": "01K5QWERTY1234567890ABCDEFG",
      "public_key": "string",
      "issued_at": 1,
      "expires_at": 1
    },
    "signature": "example-token"
  }
}
項目必須型・説明Example Value
data 必須
value
"string"
response_assertion 必須
object
{ "v": 1, "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa", "key_id": "01K5QWERTY1234567890ABCDEFG", "parent_key_id": "01K5QWERTY1234567890ABCDEFG", "request_id": "01K5QWERTY1234567890ABCDEFG", "nonce": "string", "server_time": 1, "status": 1, "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }
response_signature 必須
string
"example-token"
signing_delegation 必須
object
{ "delegation": { "v": 1, "purpose": "runtime-response", "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa", "parent_key_id": "01K5QWERTY1234567890ABCDEFG", "online_key_id": "01K5QWERTY1234567890ABCDEFG", "public_key": "string", "issued_at": 1, "expires_at": 1 }, "signature": "example-token" }
SignedLeaseResponse 4項目

Schema

SignedEnvelope + object

Example Value

{
  "data": {
    "lease_id": "lease_id_aaaaaaaaaaaaaaaaaaaa",
    "instance_id": "01K5QWERTY1234567890ABCDEFG",
    "expires_at": 1,
    "heartbeat_in": 10
  },
  "response_assertion": {
    "v": 1,
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "key_id": "01K5QWERTY1234567890ABCDEFG",
    "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "nonce": "string",
    "server_time": 1,
    "status": 1,
    "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "response_signature": "example-token",
  "signing_delegation": {
    "delegation": {
      "v": 1,
      "purpose": "runtime-response",
      "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
      "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
      "online_key_id": "01K5QWERTY1234567890ABCDEFG",
      "public_key": "string",
      "issued_at": 1,
      "expires_at": 1
    },
    "signature": "example-token"
  }
}
項目必須型・説明Example Value
data 必須
value
"string"
response_assertion 必須
object
{ "v": 1, "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa", "key_id": "01K5QWERTY1234567890ABCDEFG", "parent_key_id": "01K5QWERTY1234567890ABCDEFG", "request_id": "01K5QWERTY1234567890ABCDEFG", "nonce": "string", "server_time": 1, "status": 1, "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }
response_signature 必須
string
"example-token"
signing_delegation 必須
object
{ "delegation": { "v": 1, "purpose": "runtime-response", "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa", "parent_key_id": "01K5QWERTY1234567890ABCDEFG", "online_key_id": "01K5QWERTY1234567890ABCDEFG", "public_key": "string", "issued_at": 1, "expires_at": 1 }, "signature": "example-token" }
SignedLeaseReleaseResponse 4項目

Schema

SignedEnvelope + object

Example Value

{
  "data": {
    "lease_id": "lease_id_aaaaaaaaaaaaaaaaaaaa",
    "status": "released"
  },
  "response_assertion": {
    "v": 1,
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "key_id": "01K5QWERTY1234567890ABCDEFG",
    "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "nonce": "string",
    "server_time": 1,
    "status": 1,
    "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "response_signature": "example-token",
  "signing_delegation": {
    "delegation": {
      "v": 1,
      "purpose": "runtime-response",
      "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
      "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
      "online_key_id": "01K5QWERTY1234567890ABCDEFG",
      "public_key": "string",
      "issued_at": 1,
      "expires_at": 1
    },
    "signature": "example-token"
  }
}
項目必須型・説明Example Value
data 必須
value
"string"
response_assertion 必須
object
{ "v": 1, "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa", "key_id": "01K5QWERTY1234567890ABCDEFG", "parent_key_id": "01K5QWERTY1234567890ABCDEFG", "request_id": "01K5QWERTY1234567890ABCDEFG", "nonce": "string", "server_time": 1, "status": 1, "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }
response_signature 必須
string
"example-token"
signing_delegation 必須
object
{ "delegation": { "v": 1, "purpose": "runtime-response", "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa", "parent_key_id": "01K5QWERTY1234567890ABCDEFG", "online_key_id": "01K5QWERTY1234567890ABCDEFG", "public_key": "string", "issued_at": 1, "expires_at": 1 }, "signature": "example-token" }
EmailVerificationStartRequest 7項目

Schema

object

Example Value

{
  "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
  "license_key": "string",
  "email": "developer@example.com",
  "device_signing_public_key": "string",
  "nonce": "stringxxxxxxxxxxxxxxxx",
  "locale": "ja",
  "sdk_version": "string"
}
項目必須型・説明Example Value
product_id 必須
PublicId
"product_id_aaaaaaaaaaaaaaaaaaaa"
license_key 必須
string 最小文字数: 1 最大文字数: 512
"string"
email 必須
string email 最小文字数: 3 最大文字数: 254

ライセンスユーザーが製品アプリに入力したメールアドレスです。前後の空白を除き、小文字にしてから照合します

 "developer@example.com"
device_signing_public_key 必須
string 最小文字数: 1 最大文字数: 2048

このあと端末認証する端末のEd25519公開鍵（PEM か ed25519:base64url）です。確認でも同じ鍵を送る必要があります

 "string"
nonce 必須
string 最小文字数: 22 最大文字数: 255
"stringxxxxxxxxxxxxxxxx"
locale 任意
string 最小文字数: 2 最大文字数: 35

メールの言語（ja か en）です。無いときは Accept-Language、それも無ければ日本語です

 "ja"
sdk_version 任意
string 最大文字数: 255
"string"
EmailVerificationStartData 4項目

Schema

object

Example Value

{
  "verification_id": "verification_id_aaaaaaaaaaaaaaaaaaaa",
  "expires_at": "2026-09-21T00:00:00Z",
  "resend_after_sec": 1,
  "code_length": 1
}
項目必須型・説明Example Value
verification_id 必須
PublicId
"verification_id_aaaaaaaaaaaaaaaaaaaa"
expires_at 必須
string date-time

確認コードが使えなくなる日時

 "2026-09-21T00:00:00Z"
resend_after_sec 必須
integer 最小値: 1

同じアドレスで開始し直すまでに待つ秒数

 1
code_length 必須
integer 最小値: 1

メールで届く確認コードの桁数

 1
SignedEmailVerificationStartResponse 4項目

Schema

SignedEnvelope + object

Example Value

{
  "data": {
    "verification_id": "verification_id_aaaaaaaaaaaaaaaaaaaa",
    "expires_at": "2026-09-21T00:00:00Z",
    "resend_after_sec": 1,
    "code_length": 1
  },
  "response_assertion": {
    "v": 1,
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "key_id": "01K5QWERTY1234567890ABCDEFG",
    "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "nonce": "string",
    "server_time": 1,
    "status": 1,
    "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "response_signature": "example-token",
  "signing_delegation": {
    "delegation": {
      "v": 1,
      "purpose": "runtime-response",
      "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
      "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
      "online_key_id": "01K5QWERTY1234567890ABCDEFG",
      "public_key": "string",
      "issued_at": 1,
      "expires_at": 1
    },
    "signature": "example-token"
  }
}
項目必須型・説明Example Value
data 必須
value
"string"
response_assertion 必須
object
{ "v": 1, "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa", "key_id": "01K5QWERTY1234567890ABCDEFG", "parent_key_id": "01K5QWERTY1234567890ABCDEFG", "request_id": "01K5QWERTY1234567890ABCDEFG", "nonce": "string", "server_time": 1, "status": 1, "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }
response_signature 必須
string
"example-token"
signing_delegation 必須
object
{ "delegation": { "v": 1, "purpose": "runtime-response", "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa", "parent_key_id": "01K5QWERTY1234567890ABCDEFG", "online_key_id": "01K5QWERTY1234567890ABCDEFG", "public_key": "string", "issued_at": 1, "expires_at": 1 }, "signature": "example-token" }
EmailVerificationConfirmRequest 5項目

Schema

object

Example Value

{
  "code": "123456",
  "second_factor_code": "string",
  "device_signing_public_key": "string",
  "nonce": "stringxxxxxxxxxxxxxxxx",
  "sdk_version": "string"
}
項目必須型・説明Example Value
code 必須
string 最小文字数: 1 最大文字数: 32

メールで届いた6桁の確認コードです。空白とハイフンは無視します

 "123456"
second_factor_code 任意
string 最小文字数: 1 最大文字数: 64

認証アプリのコード、リカバリーコード、または確認メールのリンクを開いてパスキーで承認したときの承認コードです。2段階認証を使うライセンスユーザーのときだけ必要です。承認コードはこの確認だけに使え、有効期間は最長10分、使用は1回限りです

 "string"
device_signing_public_key 必須
string 最小文字数: 1 最大文字数: 2048

確認の開始で送ったものと同じEd25519公開鍵

 "string"
nonce 必須
string 最小文字数: 22 最大文字数: 255
"stringxxxxxxxxxxxxxxxx"
sdk_version 任意
string 最大文字数: 255
"string"
EmailVerificationConfirmData 2項目

Schema

object

Example Value

{
  "named_user_token": "Example name",
  "expires_at": "2026-09-21T00:00:00Z"
}
項目必須型・説明Example Value
named_user_token 必須
string 最大文字数: 4096

POST /runtime/v1/activations の named_user_token に渡します

 "Example name"
expires_at 必須
string date-time
"2026-09-21T00:00:00Z"
SignedEmailVerificationConfirmResponse 4項目

Schema

SignedEnvelope + object

Example Value

{
  "data": {
    "named_user_token": "Example name",
    "expires_at": "2026-09-21T00:00:00Z"
  },
  "response_assertion": {
    "v": 1,
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "key_id": "01K5QWERTY1234567890ABCDEFG",
    "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "nonce": "string",
    "server_time": 1,
    "status": 1,
    "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "response_signature": "example-token",
  "signing_delegation": {
    "delegation": {
      "v": 1,
      "purpose": "runtime-response",
      "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
      "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
      "online_key_id": "01K5QWERTY1234567890ABCDEFG",
      "public_key": "string",
      "issued_at": 1,
      "expires_at": 1
    },
    "signature": "example-token"
  }
}
項目必須型・説明Example Value
data 必須
value
"string"
response_assertion 必須
object
{ "v": 1, "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa", "key_id": "01K5QWERTY1234567890ABCDEFG", "parent_key_id": "01K5QWERTY1234567890ABCDEFG", "request_id": "01K5QWERTY1234567890ABCDEFG", "nonce": "string", "server_time": 1, "status": 1, "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }
response_signature 必須
string
"example-token"
signing_delegation 必須
object
{ "delegation": { "v": 1, "purpose": "runtime-response", "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa", "parent_key_id": "01K5QWERTY1234567890ABCDEFG", "online_key_id": "01K5QWERTY1234567890ABCDEFG", "public_key": "string", "issued_at": 1, "expires_at": 1 }, "signature": "example-token" }
EmailVerificationError 1項目

Schema

Error + object

Example Value

{
  "error": {
    "code": "EMAIL_VERIFICATION_CODE_INVALID",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "details": {
      "remaining_attempts": 0
    }
  }
}
項目必須型・説明Example Value
error 必須
object
{ "code": "string", "message": "string", "request_id": "01K5QWERTY1234567890ABCDEFG", "retryable": true, "doc_url": "https://example.com/resource", "details": {} }
TrialVerificationStartRequest 6項目

Schema

object

Example Value

{
  "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
  "email": "developer@example.com",
  "device_signing_public_key": "string",
  "nonce": "stringxxxxxxxxxxxxxxxx",
  "locale": "ja",
  "sdk_version": "string"
}
項目必須型・説明Example Value
product_id 必須
PublicId
"product_id_aaaaaaaaaaaaaaaaaaaa"
email 必須
string email 最小文字数: 3 最大文字数: 254

利用者が入力したメールアドレスです。前後の空白を除き、小文字にしてから照合します

 "developer@example.com"
device_signing_public_key 必須
string 最小文字数: 1 最大文字数: 2048

試用する端末のEd25519公開鍵（PEM か ed25519:base64url）です。確認でも同じ鍵を使う必要があります

 "string"
nonce 必須
string 最小文字数: 22 最大文字数: 255
"stringxxxxxxxxxxxxxxxx"
locale 任意
string 最小文字数: 2 最大文字数: 35

メールの言語（ja か en）です。無いときは Accept-Language、それも無ければ日本語です

 "ja"
sdk_version 任意
string 最大文字数: 255
"string"
TrialVerificationConfirmRequest 12項目

Schema

object

Example Value

{
  "code": "123456",
  "email": "developer@example.com",
  "device_signing_public_key": "string",
  "device_kem_public_key": "string",
  "device_proof": "string",
  "machine_signals": {
    "property": "string"
  },
  "machine_info": {
    "os": "string",
    "arch": "string"
  },
  "app_version": "string",
  "sdk_version": "string",
  "request_id": "01K5QWERTY1234567890ABCDEFG",
  "client_time": 1,
  "nonce": "stringxxxxxxxxxxxxxxxx"
}
項目必須型・説明Example Value
code 必須
string 最小文字数: 1 最大文字数: 32

メールで届いた6桁の確認コードです。空白とハイフンは無視します

 "123456"
email 必須
string email 最小文字数: 3 最大文字数: 254

開始のときと同じメールアドレス

 "developer@example.com"
device_signing_public_key 必須
string 最大文字数: 2048

開始のときと同じEd25519公開鍵

 "string"
device_kem_public_key 必須
string 最大文字数: 1024
"string"
device_proof 必須
string 最大文字数: 1024

端末の署名鍵による署名です。対象は、前置き Usakey-Trial-Proof-v1、改行、この本文から device_proof を除いた正規化JSON（JCS）をつなげたものです

 "string"
machine_signals 任意
object
{ "property": "string" }
machine_info 必須
StableMachineInfo
{ "os": "string", "arch": "string" }
app_version 任意
string 最大文字数: 255
"string"
sdk_version 任意
string 最大文字数: 255
"string"
request_id 任意
string 最大文字数: 255
"01K5QWERTY1234567890ABCDEFG"
client_time 任意
integer
1
nonce 必須
string 最小文字数: 22 最大文字数: 255
"stringxxxxxxxxxxxxxxxx"
TrialSignupData 4項目

Schema

ActivationData + object

Example Value

{
  "activation_id": "activation_id_aaaaaaaaaaaaaaaaaaaa",
  "certificate": "string",
  "machine_info_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "license_id": "license_id_aaaaaaaaaaaaaaaaaaaa"
}
項目必須型・説明Example Value
license_id 必須
PublicId
"license_id_aaaaaaaaaaaaaaaaaaaa"
activation_id 必須
PublicId
"activation_id_aaaaaaaaaaaaaaaaaaaa"
certificate 必須
string

PASETO v4.public形式のライセンス証明書

 "string"
machine_info_digest 必須
string 形式: ^[0-9a-f]{64}$

この端末認証に保存した完全な machine_info のSHA-256ハッシュ値

 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
SignedTrialSignupResponse 4項目

Schema

SignedEnvelope + object

Example Value

{
  "data": {
    "activation_id": "activation_id_aaaaaaaaaaaaaaaaaaaa",
    "certificate": "string",
    "machine_info_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "license_id": "license_id_aaaaaaaaaaaaaaaaaaaa"
  },
  "response_assertion": {
    "v": 1,
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "key_id": "01K5QWERTY1234567890ABCDEFG",
    "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "nonce": "string",
    "server_time": 1,
    "status": 1,
    "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "response_signature": "example-token",
  "signing_delegation": {
    "delegation": {
      "v": 1,
      "purpose": "runtime-response",
      "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
      "parent_key_id": "01K5QWERTY1234567890ABCDEFG",
      "online_key_id": "01K5QWERTY1234567890ABCDEFG",
      "public_key": "string",
      "issued_at": 1,
      "expires_at": 1
    },
    "signature": "example-token"
  }
}
項目必須型・説明Example Value
data 必須
value
"string"
response_assertion 必須
object
{ "v": 1, "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa", "key_id": "01K5QWERTY1234567890ABCDEFG", "parent_key_id": "01K5QWERTY1234567890ABCDEFG", "request_id": "01K5QWERTY1234567890ABCDEFG", "nonce": "string", "server_time": 1, "status": 1, "body_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }
response_signature 必須
string
"example-token"
signing_delegation 必須
object
{ "delegation": { "v": 1, "purpose": "runtime-response", "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa", "parent_key_id": "01K5QWERTY1234567890ABCDEFG", "online_key_id": "01K5QWERTY1234567890ABCDEFG", "public_key": "string", "issued_at": 1, "expires_at": 1 }, "signature": "example-token" }
TrustBundleResponse 1項目

Schema

object

Example Value

{
  "data": {
    "bundle": {},
    "root_signature": "example-token"
  }
}
項目必須型・説明Example Value
data 任意
object
{ "bundle": {}, "root_signature": "example-token" }
Error 1項目

Schema

object

Example Value

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "retryable": true,
    "doc_url": "https://example.com/resource",
    "details": {}
  }
}
項目必須型・説明Example Value
error 必須
object
{ "code": "string", "message": "string", "request_id": "01K5QWERTY1234567890ABCDEFG", "retryable": true, "doc_url": "https://example.com/resource", "details": {} }
Pagination 2項目

Schema

object

Example Value

{
  "next_cursor": "string",
  "has_more": true
}
項目必須型・説明Example Value
next_cursor 必須
string | null
"string"
has_more 必須
boolean
true
Product 11項目

Schema

object

Example Value

{
  "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
  "name": "Example name",
  "code": "string",
  "description": "Example description",
  "environment": "live",
  "status": "active",
  "trust_bundle_sequence": 1,
  "signing_status": "pending",
  "created_at": "2026-09-21T00:00:00Z",
  "updated_at": "2026-09-21T00:00:00Z",
  "version": 1
}
項目必須型・説明Example Value
public_id 任意
PublicId
"public_id_aaaaaaaaaaaaaaaaaaaa"
name 任意
string
"Example name"
code 任意
string
"string"
description 任意
string | null
"Example description"
environment 任意
value

許容値: live, test

"live"
status 任意
string
"active"
trust_bundle_sequence 任意
integer | null
1
signing_status 任意
string

許容値: pending, ready

ライセンスの発行に使う製品署名鍵の準備ができているか。

 "pending"
created_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
updated_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
version 任意
integer | null
1
ProductResponse 1項目

Schema

object

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "code": "string",
    "description": "Example description",
    "environment": "live",
    "status": "active",
    "trust_bundle_sequence": 1,
    "signing_status": "pending",
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z",
    "version": 1
  }
}
項目必須型・説明Example Value
data 必須
Product
{ "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa", "name": "Example name", "code": "string", "description": "Example description", "environment": "live", "status": "active", "trust_bundle_sequence": 1, "signing_status": "pending", "created_at": "2026-09-21T00:00:00Z", "updated_at": "2026-09-21T00:00:00Z", "version": 1 }
ProductListResponse 2項目

Schema

object

Example Value

{
  "data": [
    {
      "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
      "name": "Example name",
      "code": "string",
      "description": "Example description",
      "environment": "live",
      "status": "active",
      "trust_bundle_sequence": 1,
      "signing_status": "pending",
      "created_at": "2026-09-21T00:00:00Z",
      "updated_at": "2026-09-21T00:00:00Z",
      "version": 1
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
項目必須型・説明Example Value
data 必須
array<Product>
[ { "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa", "name": "Example name", "code": "string", "description": "Example description", "environment": "live", "status": "active", "trust_bundle_sequence": 1, "signing_status": "pending", "created_at": "2026-09-21T00:00:00Z", "updated_at": "2026-09-21T00:00:00Z", "version": 1 } ]
pagination 必須
Pagination
{ "next_cursor": "string", "has_more": true }
IntegrationConfig 10項目

usakey.config.json の中身。

Schema

object

Example Value

{
  "usakey_config_version": 1,
  "generated_at": "2026-09-21T00:00:00Z",
  "bundle_version": "string",
  "environment": "live",
  "api_url": "https://example.com/resource",
  "product": {
    "id": "id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name"
  },
  "trust_anchor": {
    "signing_mode": "string",
    "key_id": "01K5QWERTY1234567890ABCDEFG",
    "trust_bundle_url": "https://example.com/resource",
    "minimum_trust_bundle_sequence": 1,
    "root_public_key": "string",
    "development_root_public_key": "string",
    "public_key_unavailable_reason": "string",
    "signing_keys_pending_reason": "string"
  },
  "entitlements": [
    {
      "name": "Example name",
      "type": "boolean",
      "policies": [
        "string"
      ]
    }
  ],
  "license_key_delivery": "manual",
  "stripe_license_claim_url": "https://example.com/resource"
}
項目必須型・説明Example Value
usakey_config_version 必須
integer
1
generated_at 必須
string date-time
"2026-09-21T00:00:00Z"
bundle_version 必須
string
"string"
environment 必須
value

許容値: live, test

"live"
api_url 必須
string uri
"https://example.com/resource"
product 必須
object
{ "id": "id_aaaaaaaaaaaaaaaaaaaa", "name": "Example name" }
trust_anchor 必須
IntegrationTrustAnchor
{ "signing_mode": "string", "key_id": "01K5QWERTY1234567890ABCDEFG", "trust_bundle_url": "https://example.com/resource", "minimum_trust_bundle_sequence": 1, "root_public_key": "string", "development_root_public_key": "string", "public_key_unavailable_reason": "string", "signing_keys_pending_reason": "string" }
entitlements 必須
array<object>
[ { "name": "Example name", "type": "boolean", "policies": [ "string" ] } ]
license_key_delivery 必須
value

許容値: manual, stripe_checkout

"manual"
stripe_license_claim_url 任意
string uri

契約組織の自社Stripe連携が有効で、この製品に有効な価格の対応があるときだけ入ります。

 "https://example.com/resource"
IntegrationTrustAnchor 8項目

Schema

object

Example Value

{
  "signing_mode": "string",
  "key_id": "01K5QWERTY1234567890ABCDEFG",
  "trust_bundle_url": "https://example.com/resource",
  "minimum_trust_bundle_sequence": 1,
  "root_public_key": "string",
  "development_root_public_key": "string",
  "public_key_unavailable_reason": "string",
  "signing_keys_pending_reason": "string"
}
項目必須型・説明Example Value
signing_mode 必須
string
"string"
key_id 任意
string | null
"01K5QWERTY1234567890ABCDEFG"
trust_bundle_url 必須
string uri
"https://example.com/resource"
minimum_trust_bundle_sequence 必須
integer 最小値: 1
1
root_public_key 任意
string
"string"
development_root_public_key 任意
string

開発用サーバーの、テスト環境の製品だけに入ります。配布する製品には組み込まないでください。

 "string"
public_key_unavailable_reason 任意
string
"string"
signing_keys_pending_reason 任意
string
"string"
IntegrationConfigDocument 3項目

Schema

object

Example Value

{
  "file_name": "Example name",
  "content": "string",
  "config": {
    "usakey_config_version": 1,
    "generated_at": "2026-09-21T00:00:00Z",
    "bundle_version": "string",
    "environment": "live",
    "api_url": "https://example.com/resource",
    "product": {
      "id": "id_aaaaaaaaaaaaaaaaaaaa",
      "name": "Example name"
    },
    "trust_anchor": {
      "signing_mode": "string",
      "key_id": "01K5QWERTY1234567890ABCDEFG",
      "trust_bundle_url": "https://example.com/resource",
      "minimum_trust_bundle_sequence": 1,
      "root_public_key": "string",
      "development_root_public_key": "string",
      "public_key_unavailable_reason": "string",
      "signing_keys_pending_reason": "string"
    },
    "entitlements": [
      {
        "name": "Example name",
        "type": "boolean",
        "policies": [
          "string"
        ]
      }
    ],
    "license_key_delivery": "manual",
    "stripe_license_claim_url": "https://example.com/resource"
  }
}
項目必須型・説明Example Value
file_name 必須
string
"Example name"
content 必須
string

管理画面からダウンロードするファイルそのもの。

 "string"
config 必須
IntegrationConfig
{ "usakey_config_version": 1, "generated_at": "2026-09-21T00:00:00Z", "bundle_version": "string", "environment": "live", "api_url": "https://example.com/resource", "product": { "id": "id_aaaaaaaaaaaaaaaaaaaa", "name": "Example name" }, "trust_anchor": { "signing_mode": "string", "key_id": "01K5QWERTY1234567890ABCDEFG", "trust_bundle_url": "https://example.com/resource", "minimum_trust_bundle_sequence": 1, "root_public_key": "string", "development_root_public_key": "string", "public_key_unavailable_reason": "string", "signing_keys_pending_reason": "string" }, "entitlements": [ { "name": "Example name", "type": "boolean", "policies": [ "string" ] } ], "license_key_delivery": "manual", "stripe_license_claim_url": "https://example.com/resource" }
IntegrationConfigResponse 1項目

Schema

object

Example Value

{
  "data": {
    "file_name": "Example name",
    "content": "string",
    "config": {
      "usakey_config_version": 1,
      "generated_at": "2026-09-21T00:00:00Z",
      "bundle_version": "string",
      "environment": "live",
      "api_url": "https://example.com/resource",
      "product": {
        "id": "id_aaaaaaaaaaaaaaaaaaaa",
        "name": "Example name"
      },
      "trust_anchor": {
        "signing_mode": "string",
        "key_id": "01K5QWERTY1234567890ABCDEFG",
        "trust_bundle_url": "https://example.com/resource",
        "minimum_trust_bundle_sequence": 1,
        "root_public_key": "string",
        "development_root_public_key": "string",
        "public_key_unavailable_reason": "string",
        "signing_keys_pending_reason": "string"
      },
      "entitlements": [
        {
          "name": "Example name",
          "type": "boolean",
          "policies": [
            "string"
          ]
        }
      ],
      "license_key_delivery": "manual",
      "stripe_license_claim_url": "https://example.com/resource"
    }
  }
}
項目必須型・説明Example Value
data 必須
IntegrationConfigDocument
{ "file_name": "Example name", "content": "string", "config": { "usakey_config_version": 1, "generated_at": "2026-09-21T00:00:00Z", "bundle_version": "string", "environment": "live", "api_url": "https://example.com/resource", "product": { "id": "id_aaaaaaaaaaaaaaaaaaaa", "name": "Example name" }, "trust_anchor": { "signing_mode": "string", "key_id": "01K5QWERTY1234567890ABCDEFG", "trust_bundle_url": "https://example.com/resource", "minimum_trust_bundle_sequence": 1, "root_public_key": "string", "development_root_public_key": "string", "public_key_unavailable_reason": "string", "signing_keys_pending_reason": "string" }, "entitlements": [ { "name": "Example name", "type": "boolean", "policies": [ "string" ] } ], "license_key_delivery": "manual", "stripe_license_claim_url": "https://example.com/resource" } }
ProductSealedFiles 3項目

Schema

object

Example Value

{
  "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
  "status": "enabled",
  "current_key": {
    "key_id": "key_seal_0123456789abcdef0123",
    "public_key": "p256:BC8ylpFJ44nP01V3Ei2l5hm8iUAyxR8cepHBhlWWLzsAqCUpcNOfUa05MSFt28Z9RVc7yJO2cKyY_V1rZon_v6Y",
    "sealing_key": "usakey-sealing-key:v1:prod_0123456789abcdef0123:key_seal_0123456789abcdef0123:p256:BC8ylpFJ44nP01V3Ei2l5hm8iUAyxR8cepHBhlWWLzsAqCUpcNOfUa05MSFt28Z9RVc7yJO2cKyY_V1rZon_v6Y",
    "created_at": "2026-09-21T00:00:00Z"
  }
}
項目必須型・説明Example Value
product_id 必須
PublicId
"product_id_aaaaaaaaaaaaaaaaaaaa"
status 必須
string

許容値: enabled, disabled, not_entitled, unavailable

"enabled"
current_key 必須
ProductSealingKey | null
{ "key_id": "key_seal_0123456789abcdef0123", "public_key": "p256:BC8ylpFJ44nP01V3Ei2l5hm8iUAyxR8cepHBhlWWLzsAqCUpcNOfUa05MSFt28Z9RVc7yJO2cKyY_V1rZon_v6Y", "sealing_key": "usakey-sealing-key:v1:prod_0123456789abcdef0123:key_seal_0123456789abcdef0123:p256:BC8ylpFJ44nP01V3Ei2l5hm8iUAyxR8cepHBhlWWLzsAqCUpcNOfUa05MSFt28Z9RVc7yJO2cKyY_V1rZon_v6Y", "created_at": "2026-09-21T00:00:00Z" }
ProductSealingKey 4項目

Schema

object

Example Value

{
  "key_id": "key_seal_0123456789abcdef0123",
  "public_key": "p256:BC8ylpFJ44nP01V3Ei2l5hm8iUAyxR8cepHBhlWWLzsAqCUpcNOfUa05MSFt28Z9RVc7yJO2cKyY_V1rZon_v6Y",
  "sealing_key": "usakey-sealing-key:v1:prod_0123456789abcdef0123:key_seal_0123456789abcdef0123:p256:BC8ylpFJ44nP01V3Ei2l5hm8iUAyxR8cepHBhlWWLzsAqCUpcNOfUa05MSFt28Z9RVc7yJO2cKyY_V1rZon_v6Y",
  "created_at": "2026-09-21T00:00:00Z"
}
項目必須型・説明Example Value
key_id 必須
string

この鍵の版の識別子。この鍵で暗号化したすべてのファイルに書き込まれます

 "key_seal_0123456789abcdef0123"
public_key 必須
string 形式: ^p256:[A-Za-z0-9_-]{87}$

非圧縮のP-256公開鍵（パディングなしのbase64url）。配備先では全製品が同じ公開鍵（環境の暗号化用の鍵）を使い、製品は key_id と製品IDで区別します。

 "p256:BC8ylpFJ44nP01V3Ei2l5hm8iUAyxR8cepHBhlWWLzsAqCUpcNOfUa05MSFt28Z9RVc7yJO2cKyY_V1rZon_v6Y"
sealing_key 必須
string

暗号化ツールに渡す1行の公開鍵（usakey-seal --key）。秘密ではありません。

 "usakey-sealing-key:v1:prod_0123456789abcdef0123:key_seal_0123456789abcdef0123:p256:BC8ylpFJ44nP01V3Ei2l5hm8iUAyxR8cepHBhlWWLzsAqCUpcNOfUa05MSFt28Z9RVc7yJO2cKyY_V1rZon_v6Y"
created_at 必須
string date-time
"2026-09-21T00:00:00Z"
ProductSealedFilesResponse 1項目

Schema

object

Example Value

{
  "data": {
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "status": "enabled",
    "current_key": {
      "key_id": "key_seal_0123456789abcdef0123",
      "public_key": "p256:BC8ylpFJ44nP01V3Ei2l5hm8iUAyxR8cepHBhlWWLzsAqCUpcNOfUa05MSFt28Z9RVc7yJO2cKyY_V1rZon_v6Y",
      "sealing_key": "usakey-sealing-key:v1:prod_0123456789abcdef0123:key_seal_0123456789abcdef0123:p256:BC8ylpFJ44nP01V3Ei2l5hm8iUAyxR8cepHBhlWWLzsAqCUpcNOfUa05MSFt28Z9RVc7yJO2cKyY_V1rZon_v6Y",
      "created_at": "2026-09-21T00:00:00Z"
    }
  }
}
項目必須型・説明Example Value
data 必須
ProductSealedFiles
{ "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa", "status": "enabled", "current_key": { "key_id": "key_seal_0123456789abcdef0123", "public_key": "p256:BC8ylpFJ44nP01V3Ei2l5hm8iUAyxR8cepHBhlWWLzsAqCUpcNOfUa05MSFt28Z9RVc7yJO2cKyY_V1rZon_v6Y", "sealing_key": "usakey-sealing-key:v1:prod_0123456789abcdef0123:key_seal_0123456789abcdef0123:p256:BC8ylpFJ44nP01V3Ei2l5hm8iUAyxR8cepHBhlWWLzsAqCUpcNOfUa05MSFt28Z9RVc7yJO2cKyY_V1rZon_v6Y", "created_at": "2026-09-21T00:00:00Z" } }
ProductBrowserRuntime 4項目

Schema

object

Example Value

{
  "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
  "enabled": true,
  "allowed_origins": [
    "string"
  ],
  "version": 0
}
項目必須型・説明Example Value
product_id 必須
PublicId
"product_id_aaaaaaaaaaaaaaaaaaaa"
enabled 必須
boolean
true
allowed_origins 必須
array<string> 最大要素数: 20
[ "string" ]
version 必須
integer 最小値: 0
0
ProductBrowserRuntimeResponse 1項目

Schema

object

Example Value

{
  "data": {
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "enabled": true,
    "allowed_origins": [
      "string"
    ],
    "version": 0
  }
}
項目必須型・説明Example Value
data 必須
ProductBrowserRuntime
{ "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa", "enabled": true, "allowed_origins": [ "string" ], "version": 0 }
ProductTrialSignup 6項目

製品アプリからメール確認付きで始める試用を、製品がどう受け付けるか。

Schema

object

Example Value

{
  "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
  "policy_id": "01K5QWERTY1234567890ABCDEFG",
  "daily_limit": 1,
  "status": "accepting",
  "started_last_24_hours": 0,
  "version": 0
}
項目必須型・説明Example Value
product_id 必須
PublicId
"product_id_aaaaaaaaaaaaaaaaaaaa"
policy_id 必須
string | null 最大文字数: 64

アプリから始める試用に使う利用ルール（この製品の有効な、ライセンスキー方式のトライアルの利用ルール）です。受け付けていないときは null です。

 "01K5QWERTY1234567890ABCDEFG"
daily_limit 必須
integer 最小値: 1 最大値: 1000

この製品で、アプリから24時間に始められる試用の上限です。既定は20件です。

 1
status 必須
string

許容値: accepting, off, not_entitled, policy_unavailable, daily_limit_reached

accepting: 開始の要求で確認コードを送ります。off: 利用ルールが選ばれていません。not_entitled: いまの契約プランにトライアルが含まれていません。policy_unavailable: 選んだ利用ルールが廃止・変更されて使えません。別の利用ルールを選んでください。daily_limit_reached: started_last_24_hours が daily_limit に達しています。

 "accepting"
started_last_24_hours 必須
integer 最小値: 0

直近24時間にアプリから始まった試用の数で、daily_limit と比べる数です。同じ試用に2台目の端末が加わっても数えません。

 0
version 必須
integer 最小値: 0

製品の版です。読んだあとに製品が変わっていないときだけ変更するには、If-Match にこの値を送ります。

 0
ProductTrialSignupResponse 1項目

Schema

object

Example Value

{
  "data": {
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "policy_id": "01K5QWERTY1234567890ABCDEFG",
    "daily_limit": 1,
    "status": "accepting",
    "started_last_24_hours": 0,
    "version": 0
  }
}
項目必須型・説明Example Value
data 必須
ProductTrialSignup
{ "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa", "policy_id": "01K5QWERTY1234567890ABCDEFG", "daily_limit": 1, "status": "accepting", "started_last_24_hours": 0, "version": 0 }
PlanQuota 5項目

Schema

object

Example Value

{
  "limit": 1,
  "used": 1,
  "remaining": 1,
  "limit_with_overage": 1,
  "resets_at": "2026-09-21T00:00:00Z"
}
項目必須型・説明Example Value
limit 必須
integer | null

null は上限なしを表します。

 1
used 必須
integer
1
remaining 必須
integer | null
1
limit_with_overage 任意
integer

上限を超えた分を有償の超過として認めるプランで、新しい利用を断る点。

 1
resets_at 任意
string date-time

月ごとの枠だけに入ります。

 "2026-09-21T00:00:00Z"
PlanLimits 7項目

Schema

object

Example Value

{
  "plan": {
    "code": "string",
    "name": "Example name",
    "trial": true,
    "ends_at": "2026-09-21T00:00:00Z"
  },
  "quotas": {
    "property": {
      "limit": 1,
      "used": 1,
      "remaining": 1,
      "limit_with_overage": 1,
      "resets_at": "2026-09-21T00:00:00Z"
    }
  },
  "policy_constraints": {
    "activation_sync_min_sec": 1,
    "revocation_exposure_max_sec": 1,
    "cert_ttl_max_sec": 1,
    "floating_sync_min_sec": 1,
    "floating_lease_ttl_min_sec": 1
  },
  "policy_defaults": {
    "heartbeat_sec": 1,
    "cert_ttl_sec": 1,
    "network_grace_sec": 1
  },
  "revocation_exposure_max_sec_by_plan": {
    "property": 1
  },
  "license_duration_max_sec": 1,
  "unavailable_features": [
    {
      "key": "string",
      "minimum_plan": "string",
      "minimum_plan_name": "Example name"
    }
  ]
}
項目必須型・説明Example Value
plan 必須
object | null
{ "code": "string", "name": "Example name", "trial": true, "ends_at": "2026-09-21T00:00:00Z" }
quotas 必須
object
{ "property": { "limit": 1, "used": 1, "remaining": 1, "limit_with_overage": 1, "resets_at": "2026-09-21T00:00:00Z" } }
policy_constraints 必須
object
{ "activation_sync_min_sec": 1, "revocation_exposure_max_sec": 1, "cert_ttl_max_sec": 1, "floating_sync_min_sec": 1, "floating_lease_ttl_min_sec": 1 }
policy_defaults 必須
object
{ "heartbeat_sec": 1, "cert_ttl_sec": 1, "network_grace_sec": 1 }
revocation_exposure_max_sec_by_plan 必須
object
{ "property": 1 }
license_duration_max_sec 必須
integer | null
1
unavailable_features 必須
array<object>
[ { "key": "string", "minimum_plan": "string", "minimum_plan_name": "Example name" } ]
PlanLimitsResponse 1項目

Schema

object

Example Value

{
  "data": {
    "plan": {
      "code": "string",
      "name": "Example name",
      "trial": true,
      "ends_at": "2026-09-21T00:00:00Z"
    },
    "quotas": {
      "property": {
        "limit": 1,
        "used": 1,
        "remaining": 1,
        "limit_with_overage": 1,
        "resets_at": "2026-09-21T00:00:00Z"
      }
    },
    "policy_constraints": {
      "activation_sync_min_sec": 1,
      "revocation_exposure_max_sec": 1,
      "cert_ttl_max_sec": 1,
      "floating_sync_min_sec": 1,
      "floating_lease_ttl_min_sec": 1
    },
    "policy_defaults": {
      "heartbeat_sec": 1,
      "cert_ttl_sec": 1,
      "network_grace_sec": 1
    },
    "revocation_exposure_max_sec_by_plan": {
      "property": 1
    },
    "license_duration_max_sec": 1,
    "unavailable_features": [
      {
        "key": "string",
        "minimum_plan": "string",
        "minimum_plan_name": "Example name"
      }
    ]
  }
}
項目必須型・説明Example Value
data 必須
PlanLimits
{ "plan": { "code": "string", "name": "Example name", "trial": true, "ends_at": "2026-09-21T00:00:00Z" }, "quotas": { "property": { "limit": 1, "used": 1, "remaining": 1, "limit_with_overage": 1, "resets_at": "2026-09-21T00:00:00Z" } }, "policy_constraints": { "activation_sync_min_sec": 1, "revocation_exposure_max_sec": 1, "cert_ttl_max_sec": 1, "floating_sync_min_sec": 1, "floating_lease_ttl_min_sec": 1 }, "policy_defaults": { "heartbeat_sec": 1, "cert_ttl_sec": 1, "network_grace_sec": 1 }, "revocation_exposure_max_sec_by_plan": { "property": 1 }, "license_duration_max_sec": 1, "unavailable_features": [ { "key": "string", "minimum_plan": "string", "minimum_plan_name": "Example name" } ] }
ActivationDetail 16項目

Schema

object

Example Value

{
  "id": "id_aaaaaaaaaaaaaaaaaaaa",
  "license_id": "license_id_aaaaaaaaaaaaaaaaaaaa",
  "status": "active",
  "machine": {},
  "device_signing_key_thumbprint": "string",
  "first_seen_at": "2026-09-21T00:00:00Z",
  "last_seen_at": "2026-09-21T00:00:00Z",
  "deactivated_at": "2026-09-21T00:00:00Z",
  "activated_at": "2026-09-21T00:00:00Z",
  "last_heartbeat_at": "2026-09-21T00:00:00Z",
  "heartbeat_interval_sec": 1,
  "next_heartbeat_due": {
    "earliest": "2026-09-21T00:00:00Z",
    "latest": "2026-09-21T00:00:00Z"
  },
  "heartbeat_overdue": true,
  "certificate_expires_at": "2026-09-21T00:00:00Z",
  "app_version": "string",
  "sdk_version": "string"
}
項目必須型・説明Example Value
id 任意
PublicId
"id_aaaaaaaaaaaaaaaaaaaa"
license_id 任意
PublicId
"license_id_aaaaaaaaaaaaaaaaaaaa"
status 任意
string
"active"
machine 任意
object
{}
device_signing_key_thumbprint 任意
string
"string"
first_seen_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
last_seen_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
deactivated_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
activated_at 任意
string date-time
"2026-09-21T00:00:00Z"
last_heartbeat_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
heartbeat_interval_sec 任意
integer | null
1
next_heartbeat_due 任意
object | null

次の定期確認が届くはずの時刻です。earliest から latest の間（確認間隔に最大10%のゆらぎを足した範囲）です。

 { "earliest": "2026-09-21T00:00:00Z", "latest": "2026-09-21T00:00:00Z" }
heartbeat_overdue 任意
boolean

有効な端末が、定期確認の時間枠を過ぎても確認していないとき true です。

 true
certificate_expires_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
app_version 任意
string | null
"string"
sdk_version 任意
string | null
"string"
ActivationDetailResponse 1項目

Schema

object

Example Value

{
  "data": {
    "id": "id_aaaaaaaaaaaaaaaaaaaa",
    "license_id": "license_id_aaaaaaaaaaaaaaaaaaaa",
    "status": "active",
    "machine": {},
    "device_signing_key_thumbprint": "string",
    "first_seen_at": "2026-09-21T00:00:00Z",
    "last_seen_at": "2026-09-21T00:00:00Z",
    "deactivated_at": "2026-09-21T00:00:00Z",
    "activated_at": "2026-09-21T00:00:00Z",
    "last_heartbeat_at": "2026-09-21T00:00:00Z",
    "heartbeat_interval_sec": 1,
    "next_heartbeat_due": {
      "earliest": "2026-09-21T00:00:00Z",
      "latest": "2026-09-21T00:00:00Z"
    },
    "heartbeat_overdue": true,
    "certificate_expires_at": "2026-09-21T00:00:00Z",
    "app_version": "string",
    "sdk_version": "string"
  }
}
項目必須型・説明Example Value
data 必須
ActivationDetail
{ "id": "id_aaaaaaaaaaaaaaaaaaaa", "license_id": "license_id_aaaaaaaaaaaaaaaaaaaa", "status": "active", "machine": {}, "device_signing_key_thumbprint": "string", "first_seen_at": "2026-09-21T00:00:00Z", "last_seen_at": "2026-09-21T00:00:00Z", "deactivated_at": "2026-09-21T00:00:00Z", "activated_at": "2026-09-21T00:00:00Z", "last_heartbeat_at": "2026-09-21T00:00:00Z", "heartbeat_interval_sec": 1, "next_heartbeat_due": { "earliest": "2026-09-21T00:00:00Z", "latest": "2026-09-21T00:00:00Z" }, "heartbeat_overdue": true, "certificate_expires_at": "2026-09-21T00:00:00Z", "app_version": "string", "sdk_version": "string" }
RuntimeEvent 12項目

1時間以内の、同じ対象・操作・結果コードの拒否または失敗した Runtime API の要求です。要求の本文・ライセンスキー・署名・端末の鍵は保存しません。

Schema

object

Example Value

{
  "operation": "activation_create",
  "outcome": "rejected",
  "code": "DEVICE_PROOF_INVALID",
  "http_status": 400,
  "occurrences": 1,
  "first_occurred_at": "2026-09-21T00:00:00Z",
  "last_occurred_at": "2026-09-21T00:00:00Z",
  "last_request_id": "01K5QWERTY1234567890ABCDEFG",
  "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
  "license_id": "license_id_aaaaaaaaaaaaaaaaaaaa",
  "activation_id": "activation_id_aaaaaaaaaaaaaaaaaaaa",
  "details_omitted": true
}
項目必須型・説明Example Value
operation 必須
value

許容値: activation_create, activation_heartbeat, activation_deactivate, lease_acquire, lease_heartbeat, lease_release

"activation_create"
outcome 必須
value

許容値: rejected, error

rejected は製品アプリ側で直す必要がある 4xx の応答、error は Usakey 側の一時的な 5xx の失敗です。

 "rejected"
code 必須
string 形式: ^[A-Z][A-Z0-9_]{0,63}$

Runtime API が返した error.code です（例: DEVICE_PROOF_INVALID、CLOCK_SKEW、LICENSE_REVOKED）。

 "DEVICE_PROOF_INVALID"
http_status 必須
integer 最小値: 400 最大値: 599
400
occurrences 必須
integer 最小値: 1
1
first_occurred_at 必須
string date-time
"2026-09-21T00:00:00Z"
last_occurred_at 必須
string date-time
"2026-09-21T00:00:00Z"
last_request_id 必須
string | null

最後の要求の request_id（製品アプリが受け取ったもの）です。

 "01K5QWERTY1234567890ABCDEFG"
product_id 必須
PublicId | null
"product_id_aaaaaaaaaaaaaaaaaaaa"
license_id 必須
PublicId | null

ライセンスキーの誤りなど、要求がライセンスに届かなかったときは null です。

 "license_id_aaaaaaaaaaaaaaaaaaaa"
activation_id 必須
PublicId | null
"activation_id_aaaaaaaaaaaaaaaaaaaa"
details_omitted 必須
boolean

1時間あたりの記録の上限を超えた要求を、製品・ライセンス・端末認証を省いて数える記録のとき true です。

 true
RuntimeEventListResponse 2項目

Schema

object

Example Value

{
  "data": [
    {
      "operation": "activation_create",
      "outcome": "rejected",
      "code": "DEVICE_PROOF_INVALID",
      "http_status": 400,
      "occurrences": 1,
      "first_occurred_at": "2026-09-21T00:00:00Z",
      "last_occurred_at": "2026-09-21T00:00:00Z",
      "last_request_id": "01K5QWERTY1234567890ABCDEFG",
      "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
      "license_id": "license_id_aaaaaaaaaaaaaaaaaaaa",
      "activation_id": "activation_id_aaaaaaaaaaaaaaaaaaaa",
      "details_omitted": true
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
項目必須型・説明Example Value
data 必須
array<RuntimeEvent>
[ { "operation": "activation_create", "outcome": "rejected", "code": "DEVICE_PROOF_INVALID", "http_status": 400, "occurrences": 1, "first_occurred_at": "2026-09-21T00:00:00Z", "last_occurred_at": "2026-09-21T00:00:00Z", "last_request_id": "01K5QWERTY1234567890ABCDEFG", "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa", "license_id": "license_id_aaaaaaaaaaaaaaaaaaaa", "activation_id": "activation_id_aaaaaaaaaaaaaaaaaaaa", "details_omitted": true } ]
pagination 必須
Pagination
{ "next_cursor": "string", "has_more": true }
StripeIntegrationStatus 7項目

Schema

object

Example Value

{
  "registered": true,
  "mode": "test",
  "status": "active",
  "secure_claims_required": true,
  "license_claim_url": "https://example.com/resource",
  "last_event": {
    "type": "string",
    "result": "string",
    "at": "2026-09-21T00:00:00Z"
  },
  "offerings": [
    {
      "id": "id_aaaaaaaaaaaaaaaaaaaa",
      "name": "Example name",
      "stripe_price_id": "01K5QWERTY1234567890ABCDEFG",
      "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
      "policy_id": "policy_id_aaaaaaaaaaaaaaaaaaaa",
      "status": "active",
      "license_duration_days": 1
    }
  ]
}
項目必須型・説明Example Value
registered 必須
boolean
true
mode 任意
value

許容値: test, live

"test"
status 任意
value

許容値: active, disabled

"active"
secure_claims_required 任意
boolean
true
license_claim_url 任意
string | null uri
"https://example.com/resource"
last_event 任意
object | null
{ "type": "string", "result": "string", "at": "2026-09-21T00:00:00Z" }
offerings 必須
array<object>
[ { "id": "id_aaaaaaaaaaaaaaaaaaaa", "name": "Example name", "stripe_price_id": "01K5QWERTY1234567890ABCDEFG", "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa", "policy_id": "policy_id_aaaaaaaaaaaaaaaaaaaa", "status": "active", "license_duration_days": 1 } ]
StripeIntegrationResponse 1項目

Schema

object

Example Value

{
  "data": {
    "registered": true,
    "mode": "test",
    "status": "active",
    "secure_claims_required": true,
    "license_claim_url": "https://example.com/resource",
    "last_event": {
      "type": "string",
      "result": "string",
      "at": "2026-09-21T00:00:00Z"
    },
    "offerings": [
      {
        "id": "id_aaaaaaaaaaaaaaaaaaaa",
        "name": "Example name",
        "stripe_price_id": "01K5QWERTY1234567890ABCDEFG",
        "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
        "policy_id": "policy_id_aaaaaaaaaaaaaaaaaaaa",
        "status": "active",
        "license_duration_days": 1
      }
    ]
  }
}
項目必須型・説明Example Value
data 必須
StripeIntegrationStatus
{ "registered": true, "mode": "test", "status": "active", "secure_claims_required": true, "license_claim_url": "https://example.com/resource", "last_event": { "type": "string", "result": "string", "at": "2026-09-21T00:00:00Z" }, "offerings": [ { "id": "id_aaaaaaaaaaaaaaaaaaaa", "name": "Example name", "stripe_price_id": "01K5QWERTY1234567890ABCDEFG", "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa", "policy_id": "policy_id_aaaaaaaaaaaaaaaaaaaa", "status": "active", "license_duration_days": 1 } ] }
Policy 27項目

Schema

object

Example Value

{
  "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
  "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
  "name": "Example name",
  "version": 1,
  "license_type": "perpetual",
  "validation_mode": "string",
  "perpetual_mode": "managed",
  "heartbeat_required": true,
  "revocation_guarantee_sec": 0,
  "fail_mode": "string",
  "identity_mode": "string",
  "license_unit_limit": 1,
  "max_machines": 1,
  "max_concurrent": 1,
  "concurrency_unit": "string",
  "cert_ttl_sec": 1,
  "heartbeat_sec": 1,
  "lease_ttl_sec": 1,
  "lease_heartbeat_sec": 1,
  "network_grace_sec": 1,
  "fingerprint_profile": {},
  "renewal_authority": "string",
  "billing_cycle": "string",
  "trial_days": 1,
  "entitlements": {},
  "status": "active",
  "created_at": "2026-09-21T00:00:00Z"
}
項目必須型・説明Example Value
public_id 任意
PublicId
"public_id_aaaaaaaaaaaaaaaaaaaa"
product_id 任意
PublicId
"product_id_aaaaaaaaaaaaaaaaaaaa"
name 任意
string
"Example name"
version 任意
integer | null

利用ルールの履歴上の版番号です。If-MatchにはGET policies/{id}で返るETagを使ってください。

 1
license_type 任意
value

許容値: perpetual, subscription, trial

"perpetual"
validation_mode 任意
string
"string"
perpetual_mode 任意
string | null

許容値: managed, offline_unmanaged, null

買い切りの利用ルールで求めた値です。offline と license_key の組み合わせは offline_unmanaged、それ以外の買い切りは managed です。

 "managed"
heartbeat_required 任意
boolean

端末に結び付いた offline_unmanaged の買い切りの利用ルールだけ false です。

 true
revocation_guarantee_sec 任意
integer | null 最小値: 0

署名付きのオフラインで取消が反映されるまでの最長時間です。null は、オンラインでの取消の反映を約束しないことを表します。

 0
fail_mode 任意
string
"string"
identity_mode 任意
string
"string"
license_unit_limit 任意
integer | null
1
max_machines 任意
integer | null
1
max_concurrent 任意
integer | null
1
concurrency_unit 任意
string
"string"
cert_ttl_sec 任意
integer | null
1
heartbeat_sec 任意
integer | null
1
lease_ttl_sec 任意
integer | null
1
lease_heartbeat_sec 任意
integer | null
1
network_grace_sec 任意
integer | null
1
fingerprint_profile 任意
object
{}
renewal_authority 任意
string
"string"
billing_cycle 任意
string
"string"
trial_days 任意
integer | null
1
entitlements 任意
object
{}
status 任意
string
"active"
created_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
PolicyResponse 1項目

Schema

object

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "version": 1,
    "license_type": "perpetual",
    "validation_mode": "string",
    "perpetual_mode": "managed",
    "heartbeat_required": true,
    "revocation_guarantee_sec": 0,
    "fail_mode": "string",
    "identity_mode": "string",
    "license_unit_limit": 1,
    "max_machines": 1,
    "max_concurrent": 1,
    "concurrency_unit": "string",
    "cert_ttl_sec": 1,
    "heartbeat_sec": 1,
    "lease_ttl_sec": 1,
    "lease_heartbeat_sec": 1,
    "network_grace_sec": 1,
    "fingerprint_profile": {},
    "renewal_authority": "string",
    "billing_cycle": "string",
    "trial_days": 1,
    "entitlements": {},
    "status": "active",
    "created_at": "2026-09-21T00:00:00Z"
  }
}
項目必須型・説明Example Value
data 必須
Policy
{ "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa", "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa", "name": "Example name", "version": 1, "license_type": "perpetual", "validation_mode": "string", "perpetual_mode": "managed", "heartbeat_required": true, "revocation_guarantee_sec": 0, "fail_mode": "string", "identity_mode": "string", "license_unit_limit": 1, "max_machines": 1, "max_concurrent": 1, "concurrency_unit": "string", "cert_ttl_sec": 1, "heartbeat_sec": 1, "lease_ttl_sec": 1, "lease_heartbeat_sec": 1, "network_grace_sec": 1, "fingerprint_profile": {}, "renewal_authority": "string", "billing_cycle": "string", "trial_days": 1, "entitlements": {}, "status": "active", "created_at": "2026-09-21T00:00:00Z" }
PolicyListResponse 2項目

Schema

object

Example Value

{
  "data": [
    {
      "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
      "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
      "name": "Example name",
      "version": 1,
      "license_type": "perpetual",
      "validation_mode": "string",
      "perpetual_mode": "managed",
      "heartbeat_required": true,
      "revocation_guarantee_sec": 0,
      "fail_mode": "string",
      "identity_mode": "string",
      "license_unit_limit": 1,
      "max_machines": 1,
      "max_concurrent": 1,
      "concurrency_unit": "string",
      "cert_ttl_sec": 1,
      "heartbeat_sec": 1,
      "lease_ttl_sec": 1,
      "lease_heartbeat_sec": 1,
      "network_grace_sec": 1,
      "fingerprint_profile": {},
      "renewal_authority": "string",
      "billing_cycle": "string",
      "trial_days": 1,
      "entitlements": {},
      "status": "active",
      "created_at": "2026-09-21T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
項目必須型・説明Example Value
data 必須
array<Policy>
[ { "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa", "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa", "name": "Example name", "version": 1, "license_type": "perpetual", "validation_mode": "string", "perpetual_mode": "managed", "heartbeat_required": true, "revocation_guarantee_sec": 0, "fail_mode": "string", "identity_mode": "string", "license_unit_limit": 1, "max_machines": 1, "max_concurrent": 1, "concurrency_unit": "string", "cert_ttl_sec": 1, "heartbeat_sec": 1, "lease_ttl_sec": 1, "lease_heartbeat_sec": 1, "network_grace_sec": 1, "fingerprint_profile": {}, "renewal_authority": "string", "billing_cycle": "string", "trial_days": 1, "entitlements": {}, "status": "active", "created_at": "2026-09-21T00:00:00Z" } ]
pagination 必須
Pagination
{ "next_cursor": "string", "has_more": true }
Customer 8項目

Schema

object

Example Value

{
  "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
  "name": "Example name",
  "email": "developer@example.com",
  "external_ref": "string",
  "notes": "string",
  "status": "active",
  "created_at": "2026-09-21T00:00:00Z",
  "updated_at": "2026-09-21T00:00:00Z"
}
項目必須型・説明Example Value
public_id 任意
PublicId
"public_id_aaaaaaaaaaaaaaaaaaaa"
name 任意
string
"Example name"
email 任意
string | null
"developer@example.com"
external_ref 任意
string | null
"string"
notes 任意
string | null
"string"
status 任意
string
"active"
created_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
updated_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
CustomerResponse 1項目

Schema

object

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "email": "developer@example.com",
    "external_ref": "string",
    "notes": "string",
    "status": "active",
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
項目必須型・説明Example Value
data 必須
Customer
{ "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa", "name": "Example name", "email": "developer@example.com", "external_ref": "string", "notes": "string", "status": "active", "created_at": "2026-09-21T00:00:00Z", "updated_at": "2026-09-21T00:00:00Z" }
CustomerListResponse 2項目

Schema

object

Example Value

{
  "data": [
    {
      "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
      "name": "Example name",
      "email": "developer@example.com",
      "external_ref": "string",
      "notes": "string",
      "status": "active",
      "created_at": "2026-09-21T00:00:00Z",
      "updated_at": "2026-09-21T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
項目必須型・説明Example Value
data 必須
array<Customer>
[ { "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa", "name": "Example name", "email": "developer@example.com", "external_ref": "string", "notes": "string", "status": "active", "created_at": "2026-09-21T00:00:00Z", "updated_at": "2026-09-21T00:00:00Z" } ]
pagination 必須
Pagination
{ "next_cursor": "string", "has_more": true }
License 29項目

Schema

object

Example Value

{
  "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
  "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
  "policy_id": "policy_id_aaaaaaaaaaaaaaaaaaaa",
  "policy_version": 1,
  "customer_id": "customer_id_aaaaaaaaaaaaaaaaaaaa",
  "license_type": "perpetual",
  "perpetual_mode": "managed",
  "heartbeat_required": true,
  "revocation_guarantee_sec": 0,
  "status": "active",
  "expires_at": "2026-09-21T00:00:00Z",
  "expiry": "2026-09-21T00:00:00Z",
  "renewal_authority": "string",
  "entitlements": {},
  "metadata": {},
  "current_period_start": "2026-09-21T00:00:00Z",
  "current_period_end": "2026-09-21T00:00:00Z",
  "renewal_count": 1,
  "key_hint": "string",
  "max_machines": 1,
  "max_concurrent": 1,
  "license_unit_limit": 1,
  "trial_days": 1,
  "trial_started_at": "2026-09-21T00:00:00Z",
  "trial_converted_at": "2026-09-21T00:00:00Z",
  "active_activations": 1,
  "created_at": "2026-09-21T00:00:00Z",
  "updated_at": "2026-09-21T00:00:00Z",
  "version": 1
}
項目必須型・説明Example Value
public_id 任意
PublicId
"public_id_aaaaaaaaaaaaaaaaaaaa"
product_id 任意
PublicId
"product_id_aaaaaaaaaaaaaaaaaaaa"
policy_id 任意
PublicId
"policy_id_aaaaaaaaaaaaaaaaaaaa"
policy_version 任意
integer | null
1
customer_id 任意
PublicId | null
"customer_id_aaaaaaaaaaaaaaaaaaaa"
license_type 任意
value

許容値: perpetual, subscription, trial

"perpetual"
perpetual_mode 任意
string | null

許容値: managed, offline_unmanaged, null

"managed"
heartbeat_required 任意
boolean
true
revocation_guarantee_sec 任意
integer | null 最小値: 0

offline_unmanaged と fail-open のライセンスは null です。これらのライセンスには、オンラインでの取消の反映の約束がありません。

 0
status 任意
string
"active"
expires_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
expiry 任意
string | null date-time

expires_atと同じ値です。expires_atを使ってください。

 "2026-09-21T00:00:00Z"
renewal_authority 任意
string
"string"
entitlements 任意
object
{}
metadata 任意
object
{}
current_period_start 任意
string | null date-time
"2026-09-21T00:00:00Z"
current_period_end 任意
string | null date-time
"2026-09-21T00:00:00Z"
renewal_count 任意
integer | null
1
key_hint 任意
string
"string"
max_machines 任意
integer | null
1
max_concurrent 任意
integer | null
1
license_unit_limit 任意
integer | null
1
trial_days 任意
integer | null
1
trial_started_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
trial_converted_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
active_activations 任意
integer | null
1
created_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
updated_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
version 任意
integer | null
1
LicenseResponse 1項目

Schema

object

Example Value

{
  "data": {}
}
項目必須型・説明Example Value
data 必須
License
{}
LicenseListResponse 2項目

Schema

object

Example Value

{
  "data": [
    {}
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
項目必須型・説明Example Value
data 必須
array<License>
[ {} ]
pagination 必須
Pagination
{ "next_cursor": "string", "has_more": true }
Activation 8項目

Schema

object

Example Value

{
  "id": "id_aaaaaaaaaaaaaaaaaaaa",
  "license_id": "license_id_aaaaaaaaaaaaaaaaaaaa",
  "status": "active",
  "machine": {},
  "device_signing_key_thumbprint": "string",
  "first_seen_at": "2026-09-21T00:00:00Z",
  "last_seen_at": "2026-09-21T00:00:00Z",
  "deactivated_at": "2026-09-21T00:00:00Z"
}
項目必須型・説明Example Value
id 任意
PublicId
"id_aaaaaaaaaaaaaaaaaaaa"
license_id 任意
PublicId
"license_id_aaaaaaaaaaaaaaaaaaaa"
status 任意
string
"active"
machine 任意
object
{}
device_signing_key_thumbprint 任意
string
"string"
first_seen_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
last_seen_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
deactivated_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
ActivationResponse 1項目

Schema

object

Example Value

{
  "data": {
    "id": "id_aaaaaaaaaaaaaaaaaaaa",
    "license_id": "license_id_aaaaaaaaaaaaaaaaaaaa",
    "status": "active",
    "machine": {},
    "device_signing_key_thumbprint": "string",
    "first_seen_at": "2026-09-21T00:00:00Z",
    "last_seen_at": "2026-09-21T00:00:00Z",
    "deactivated_at": "2026-09-21T00:00:00Z"
  }
}
項目必須型・説明Example Value
data 必須
Activation
{ "id": "id_aaaaaaaaaaaaaaaaaaaa", "license_id": "license_id_aaaaaaaaaaaaaaaaaaaa", "status": "active", "machine": {}, "device_signing_key_thumbprint": "string", "first_seen_at": "2026-09-21T00:00:00Z", "last_seen_at": "2026-09-21T00:00:00Z", "deactivated_at": "2026-09-21T00:00:00Z" }
ActivationListResponse 2項目

Schema

object

Example Value

{
  "data": [
    {
      "id": "id_aaaaaaaaaaaaaaaaaaaa",
      "license_id": "license_id_aaaaaaaaaaaaaaaaaaaa",
      "status": "active",
      "machine": {},
      "device_signing_key_thumbprint": "string",
      "first_seen_at": "2026-09-21T00:00:00Z",
      "last_seen_at": "2026-09-21T00:00:00Z",
      "deactivated_at": "2026-09-21T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
項目必須型・説明Example Value
data 必須
array<Activation>
[ { "id": "id_aaaaaaaaaaaaaaaaaaaa", "license_id": "license_id_aaaaaaaaaaaaaaaaaaaa", "status": "active", "machine": {}, "device_signing_key_thumbprint": "string", "first_seen_at": "2026-09-21T00:00:00Z", "last_seen_at": "2026-09-21T00:00:00Z", "deactivated_at": "2026-09-21T00:00:00Z" } ]
pagination 必須
Pagination
{ "next_cursor": "string", "has_more": true }
Webhook 8項目

Schema

object

Example Value

{
  "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
  "name": "Example name",
  "url": "https://example.com/resource",
  "events": [
    "string"
  ],
  "status": "active",
  "secret_rotation": {
    "scheduled": true,
    "activates_at": "2026-09-21T00:00:00Z"
  },
  "created_at": "2026-09-21T00:00:00Z",
  "updated_at": "2026-09-21T00:00:00Z"
}
項目必須型・説明Example Value
public_id 任意
PublicId
"public_id_aaaaaaaaaaaaaaaaaaaa"
name 任意
string
"Example name"
url 任意
string uri
"https://example.com/resource"
events 任意
array<string>
[ "string" ]
status 任意
string
"active"
secret_rotation 任意
object
{ "scheduled": true, "activates_at": "2026-09-21T00:00:00Z" }
created_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
updated_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
WebhookResponse 1項目

Schema

object

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "url": "https://example.com/resource",
    "events": [
      "string"
    ],
    "status": "active",
    "secret_rotation": {
      "scheduled": true,
      "activates_at": "2026-09-21T00:00:00Z"
    },
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
項目必須型・説明Example Value
data 必須
Webhook
{ "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa", "name": "Example name", "url": "https://example.com/resource", "events": [ "string" ], "status": "active", "secret_rotation": { "scheduled": true, "activates_at": "2026-09-21T00:00:00Z" }, "created_at": "2026-09-21T00:00:00Z", "updated_at": "2026-09-21T00:00:00Z" }
WebhookListResponse 2項目

Schema

object

Example Value

{
  "data": [
    {
      "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
      "name": "Example name",
      "url": "https://example.com/resource",
      "events": [
        "string"
      ],
      "status": "active",
      "secret_rotation": {
        "scheduled": true,
        "activates_at": "2026-09-21T00:00:00Z"
      },
      "created_at": "2026-09-21T00:00:00Z",
      "updated_at": "2026-09-21T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
項目必須型・説明Example Value
data 必須
array<Webhook>
[ { "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa", "name": "Example name", "url": "https://example.com/resource", "events": [ "string" ], "status": "active", "secret_rotation": { "scheduled": true, "activates_at": "2026-09-21T00:00:00Z" }, "created_at": "2026-09-21T00:00:00Z", "updated_at": "2026-09-21T00:00:00Z" } ]
pagination 必須
Pagination
{ "next_cursor": "string", "has_more": true }
Event 7項目

Schema

object

Example Value

{
  "id": "id_aaaaaaaaaaaaaaaaaaaa",
  "type": "string",
  "actor": {},
  "target": {
    "environment": "live"
  },
  "request_id": "01K5QWERTY1234567890ABCDEFG",
  "data": {},
  "created_at": "2026-09-21T00:00:00Z"
}
項目必須型・説明Example Value
id 任意
PublicId
"id_aaaaaaaaaaaaaaaaaaaa"
type 任意
string
"string"
actor 任意
object
{}
target 任意
object
{ "environment": "live" }
request_id 任意
string | null
"01K5QWERTY1234567890ABCDEFG"
data 任意
object
{}
created_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
EventResponse 1項目

Schema

object

Example Value

{
  "data": {
    "id": "id_aaaaaaaaaaaaaaaaaaaa",
    "type": "string",
    "actor": {},
    "target": {
      "environment": "live"
    },
    "request_id": "01K5QWERTY1234567890ABCDEFG",
    "data": {},
    "created_at": "2026-09-21T00:00:00Z"
  }
}
項目必須型・説明Example Value
data 必須
Event
{ "id": "id_aaaaaaaaaaaaaaaaaaaa", "type": "string", "actor": {}, "target": { "environment": "live" }, "request_id": "01K5QWERTY1234567890ABCDEFG", "data": {}, "created_at": "2026-09-21T00:00:00Z" }
EventListResponse 2項目

Schema

object

Example Value

{
  "data": [
    {
      "id": "id_aaaaaaaaaaaaaaaaaaaa",
      "type": "string",
      "actor": {},
      "target": {
        "environment": "live"
      },
      "request_id": "01K5QWERTY1234567890ABCDEFG",
      "data": {},
      "created_at": "2026-09-21T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
項目必須型・説明Example Value
data 必須
array<Event>
[ { "id": "id_aaaaaaaaaaaaaaaaaaaa", "type": "string", "actor": {}, "target": { "environment": "live" }, "request_id": "01K5QWERTY1234567890ABCDEFG", "data": {}, "created_at": "2026-09-21T00:00:00Z" } ]
pagination 必須
Pagination
{ "next_cursor": "string", "has_more": true }
Reseller 11項目

Schema

object

Example Value

{
  "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
  "name": "Example name",
  "email": "developer@example.com",
  "external_ref": "string",
  "organization_limit": 1,
  "user_limit": 1,
  "status": "active",
  "metadata": {},
  "archived_at": "2026-09-21T00:00:00Z",
  "created_at": "2026-09-21T00:00:00Z",
  "updated_at": "2026-09-21T00:00:00Z"
}
項目必須型・説明Example Value
public_id 任意
PublicId
"public_id_aaaaaaaaaaaaaaaaaaaa"
name 任意
string
"Example name"
email 任意
string | null
"developer@example.com"
external_ref 任意
string | null
"string"
organization_limit 任意
integer | null
1
user_limit 任意
integer | null
1
status 任意
string
"active"
metadata 任意
object
{}
archived_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
created_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
updated_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
ResellerResponse 1項目

Schema

object

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "email": "developer@example.com",
    "external_ref": "string",
    "organization_limit": 1,
    "user_limit": 1,
    "status": "active",
    "metadata": {},
    "archived_at": "2026-09-21T00:00:00Z",
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
項目必須型・説明Example Value
data 必須
Reseller
{ "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa", "name": "Example name", "email": "developer@example.com", "external_ref": "string", "organization_limit": 1, "user_limit": 1, "status": "active", "metadata": {}, "archived_at": "2026-09-21T00:00:00Z", "created_at": "2026-09-21T00:00:00Z", "updated_at": "2026-09-21T00:00:00Z" }
ResellerListResponse 2項目

Schema

object

Example Value

{
  "data": [
    {
      "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
      "name": "Example name",
      "email": "developer@example.com",
      "external_ref": "string",
      "organization_limit": 1,
      "user_limit": 1,
      "status": "active",
      "metadata": {},
      "archived_at": "2026-09-21T00:00:00Z",
      "created_at": "2026-09-21T00:00:00Z",
      "updated_at": "2026-09-21T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
項目必須型・説明Example Value
data 必須
array<Reseller>
[ { "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa", "name": "Example name", "email": "developer@example.com", "external_ref": "string", "organization_limit": 1, "user_limit": 1, "status": "active", "metadata": {}, "archived_at": "2026-09-21T00:00:00Z", "created_at": "2026-09-21T00:00:00Z", "updated_at": "2026-09-21T00:00:00Z" } ]
pagination 必須
Pagination
{ "next_cursor": "string", "has_more": true }
Organization 11項目

Schema

object

Example Value

{
  "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
  "name": "Example name",
  "email": "developer@example.com",
  "external_ref": "string",
  "user_limit": 1,
  "status": "active",
  "metadata": {},
  "reseller_id": "reseller_id_aaaaaaaaaaaaaaaaaaaa",
  "archived_at": "2026-09-21T00:00:00Z",
  "created_at": "2026-09-21T00:00:00Z",
  "updated_at": "2026-09-21T00:00:00Z"
}
項目必須型・説明Example Value
public_id 任意
PublicId
"public_id_aaaaaaaaaaaaaaaaaaaa"
name 任意
string
"Example name"
email 任意
string | null
"developer@example.com"
external_ref 任意
string | null
"string"
user_limit 任意
integer | null
1
status 任意
string
"active"
metadata 任意
object
{}
reseller_id 任意
PublicId | null
"reseller_id_aaaaaaaaaaaaaaaaaaaa"
archived_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
created_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
updated_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
OrganizationResponse 1項目

Schema

object

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "email": "developer@example.com",
    "external_ref": "string",
    "user_limit": 1,
    "status": "active",
    "metadata": {},
    "reseller_id": "reseller_id_aaaaaaaaaaaaaaaaaaaa",
    "archived_at": "2026-09-21T00:00:00Z",
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
項目必須型・説明Example Value
data 必須
Organization
{ "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa", "name": "Example name", "email": "developer@example.com", "external_ref": "string", "user_limit": 1, "status": "active", "metadata": {}, "reseller_id": "reseller_id_aaaaaaaaaaaaaaaaaaaa", "archived_at": "2026-09-21T00:00:00Z", "created_at": "2026-09-21T00:00:00Z", "updated_at": "2026-09-21T00:00:00Z" }
OrganizationListResponse 2項目

Schema

object

Example Value

{
  "data": [
    {
      "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
      "name": "Example name",
      "email": "developer@example.com",
      "external_ref": "string",
      "user_limit": 1,
      "status": "active",
      "metadata": {},
      "reseller_id": "reseller_id_aaaaaaaaaaaaaaaaaaaa",
      "archived_at": "2026-09-21T00:00:00Z",
      "created_at": "2026-09-21T00:00:00Z",
      "updated_at": "2026-09-21T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
項目必須型・説明Example Value
data 必須
array<Organization>
[ { "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa", "name": "Example name", "email": "developer@example.com", "external_ref": "string", "user_limit": 1, "status": "active", "metadata": {}, "reseller_id": "reseller_id_aaaaaaaaaaaaaaaaaaaa", "archived_at": "2026-09-21T00:00:00Z", "created_at": "2026-09-21T00:00:00Z", "updated_at": "2026-09-21T00:00:00Z" } ]
pagination 必須
Pagination
{ "next_cursor": "string", "has_more": true }
OrganizationGroup 7項目

Schema

object

Example Value

{
  "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
  "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
  "name": "Example name",
  "status": "active",
  "metadata": {},
  "created_at": "2026-09-21T00:00:00Z",
  "updated_at": "2026-09-21T00:00:00Z"
}
項目必須型・説明Example Value
public_id 任意
PublicId
"public_id_aaaaaaaaaaaaaaaaaaaa"
organization_id 任意
PublicId
"organization_id_aaaaaaaaaaaaaaaaaaaa"
name 任意
string
"Example name"
status 任意
string
"active"
metadata 任意
object
{}
created_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
updated_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
OrganizationGroupResponse 1項目

Schema

object

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "status": "active",
    "metadata": {},
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
項目必須型・説明Example Value
data 必須
OrganizationGroup
{ "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa", "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa", "name": "Example name", "status": "active", "metadata": {}, "created_at": "2026-09-21T00:00:00Z", "updated_at": "2026-09-21T00:00:00Z" }
OrganizationGroupListResponse 2項目

Schema

object

Example Value

{
  "data": [
    {
      "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
      "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
      "name": "Example name",
      "status": "active",
      "metadata": {},
      "created_at": "2026-09-21T00:00:00Z",
      "updated_at": "2026-09-21T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
項目必須型・説明Example Value
data 必須
array<OrganizationGroup>
[ { "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa", "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa", "name": "Example name", "status": "active", "metadata": {}, "created_at": "2026-09-21T00:00:00Z", "updated_at": "2026-09-21T00:00:00Z" } ]
pagination 必須
Pagination
{ "next_cursor": "string", "has_more": true }
OrganizationGroupMembership 8項目

Schema

object

Example Value

{
  "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
  "organization_group_id": "organization_group_id_aaaaaaaaaaaaaaaaaaaa",
  "license_user_id": "license_user_id_aaaaaaaaaaaaaaaaaaaa",
  "status": "active",
  "assigned_at": "2026-09-21T00:00:00Z",
  "revoked_at": "2026-09-21T00:00:00Z",
  "created_at": "2026-09-21T00:00:00Z",
  "updated_at": "2026-09-21T00:00:00Z"
}
項目必須型・説明Example Value
public_id 任意
PublicId
"public_id_aaaaaaaaaaaaaaaaaaaa"
organization_group_id 任意
PublicId
"organization_group_id_aaaaaaaaaaaaaaaaaaaa"
license_user_id 任意
PublicId
"license_user_id_aaaaaaaaaaaaaaaaaaaa"
status 任意
string
"active"
assigned_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
revoked_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
created_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
updated_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
OrganizationGroupMembershipResponse 1項目

Schema

object

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "organization_group_id": "organization_group_id_aaaaaaaaaaaaaaaaaaaa",
    "license_user_id": "license_user_id_aaaaaaaaaaaaaaaaaaaa",
    "status": "active",
    "assigned_at": "2026-09-21T00:00:00Z",
    "revoked_at": "2026-09-21T00:00:00Z",
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
項目必須型・説明Example Value
data 必須
OrganizationGroupMembership
{ "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa", "organization_group_id": "organization_group_id_aaaaaaaaaaaaaaaaaaaa", "license_user_id": "license_user_id_aaaaaaaaaaaaaaaaaaaa", "status": "active", "assigned_at": "2026-09-21T00:00:00Z", "revoked_at": "2026-09-21T00:00:00Z", "created_at": "2026-09-21T00:00:00Z", "updated_at": "2026-09-21T00:00:00Z" }
OrganizationGroupMembershipListResponse 2項目

Schema

object

Example Value

{
  "data": [
    {
      "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
      "organization_group_id": "organization_group_id_aaaaaaaaaaaaaaaaaaaa",
      "license_user_id": "license_user_id_aaaaaaaaaaaaaaaaaaaa",
      "status": "active",
      "assigned_at": "2026-09-21T00:00:00Z",
      "revoked_at": "2026-09-21T00:00:00Z",
      "created_at": "2026-09-21T00:00:00Z",
      "updated_at": "2026-09-21T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
項目必須型・説明Example Value
data 必須
array<OrganizationGroupMembership>
[ { "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa", "organization_group_id": "organization_group_id_aaaaaaaaaaaaaaaaaaaa", "license_user_id": "license_user_id_aaaaaaaaaaaaaaaaaaaa", "status": "active", "assigned_at": "2026-09-21T00:00:00Z", "revoked_at": "2026-09-21T00:00:00Z", "created_at": "2026-09-21T00:00:00Z", "updated_at": "2026-09-21T00:00:00Z" } ]
pagination 必須
Pagination
{ "next_cursor": "string", "has_more": true }
LicenseUser 15項目

Schema

object

Example Value

{
  "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
  "issuer": "https://example.com/resource",
  "subject": "string",
  "email": "developer@example.com",
  "name": "Example name",
  "status": "active",
  "two_factor_state": "string",
  "two_factor_method": "string",
  "metadata": {},
  "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
  "oidc_connection_id": "oidc_connection_id_aaaaaaaaaaaaaaaaaaaa",
  "last_authenticated_at": "2026-09-21T00:00:00Z",
  "deprovisioned_at": "2026-09-21T00:00:00Z",
  "created_at": "2026-09-21T00:00:00Z",
  "updated_at": "2026-09-21T00:00:00Z"
}
項目必須型・説明Example Value
public_id 任意
PublicId
"public_id_aaaaaaaaaaaaaaaaaaaa"
issuer 任意
string uri
"https://example.com/resource"
subject 任意
string
"string"
email 任意
string | null
"developer@example.com"
name 任意
string | null
"Example name"
status 任意
string
"active"
two_factor_state 任意
string
"string"
two_factor_method 任意
string | null
"string"
metadata 任意
object
{}
organization_id 任意
PublicId | null
"organization_id_aaaaaaaaaaaaaaaaaaaa"
oidc_connection_id 任意
PublicId | null

関連付けられたOIDC接続ID。OIDCと顧客ポータルを利用できない個人プランのローカル台帳ユーザーでは通常`null`です。

 "oidc_connection_id_aaaaaaaaaaaaaaaaaaaa"
last_authenticated_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
deprovisioned_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
created_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
updated_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
LicenseUserResponse 1項目

Schema

object

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "issuer": "https://example.com/resource",
    "subject": "string",
    "email": "developer@example.com",
    "name": "Example name",
    "status": "active",
    "two_factor_state": "string",
    "two_factor_method": "string",
    "metadata": {},
    "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
    "oidc_connection_id": "oidc_connection_id_aaaaaaaaaaaaaaaaaaaa",
    "last_authenticated_at": "2026-09-21T00:00:00Z",
    "deprovisioned_at": "2026-09-21T00:00:00Z",
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
項目必須型・説明Example Value
data 必須
LicenseUser
{ "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa", "issuer": "https://example.com/resource", "subject": "string", "email": "developer@example.com", "name": "Example name", "status": "active", "two_factor_state": "string", "two_factor_method": "string", "metadata": {}, "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa", "oidc_connection_id": "oidc_connection_id_aaaaaaaaaaaaaaaaaaaa", "last_authenticated_at": "2026-09-21T00:00:00Z", "deprovisioned_at": "2026-09-21T00:00:00Z", "created_at": "2026-09-21T00:00:00Z", "updated_at": "2026-09-21T00:00:00Z" }
LicenseUserListResponse 2項目

Schema

object

Example Value

{
  "data": [
    {
      "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
      "issuer": "https://example.com/resource",
      "subject": "string",
      "email": "developer@example.com",
      "name": "Example name",
      "status": "active",
      "two_factor_state": "string",
      "two_factor_method": "string",
      "metadata": {},
      "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
      "oidc_connection_id": "oidc_connection_id_aaaaaaaaaaaaaaaaaaaa",
      "last_authenticated_at": "2026-09-21T00:00:00Z",
      "deprovisioned_at": "2026-09-21T00:00:00Z",
      "created_at": "2026-09-21T00:00:00Z",
      "updated_at": "2026-09-21T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
項目必須型・説明Example Value
data 必須
array<LicenseUser>
[ { "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa", "issuer": "https://example.com/resource", "subject": "string", "email": "developer@example.com", "name": "Example name", "status": "active", "two_factor_state": "string", "two_factor_method": "string", "metadata": {}, "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa", "oidc_connection_id": "oidc_connection_id_aaaaaaaaaaaaaaaaaaaa", "last_authenticated_at": "2026-09-21T00:00:00Z", "deprovisioned_at": "2026-09-21T00:00:00Z", "created_at": "2026-09-21T00:00:00Z", "updated_at": "2026-09-21T00:00:00Z" } ]
pagination 必須
Pagination
{ "next_cursor": "string", "has_more": true }
OidcConnection 17項目

Schema

object

Example Value

{
  "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
  "name": "Example name",
  "issuer": "https://example.com/resource",
  "client_id": "01K5QWERTY1234567890ABCDEFG",
  "authorization_endpoint": "https://example.com/resource",
  "token_endpoint": "https://example.com/resource",
  "jwks_uri": "https://example.com/resource",
  "scopes": [
    "string"
  ],
  "allowed_audiences": [
    "string"
  ],
  "pkce_required": true,
  "jit_provisioning": true,
  "status": "active",
  "metadata": {},
  "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
  "client_secret_rotated_at": "2026-09-21T00:00:00Z",
  "created_at": "2026-09-21T00:00:00Z",
  "updated_at": "2026-09-21T00:00:00Z"
}
項目必須型・説明Example Value
public_id 任意
PublicId
"public_id_aaaaaaaaaaaaaaaaaaaa"
name 任意
string
"Example name"
issuer 任意
string uri
"https://example.com/resource"
client_id 任意
string
"01K5QWERTY1234567890ABCDEFG"
authorization_endpoint 任意
string uri
"https://example.com/resource"
token_endpoint 任意
string uri
"https://example.com/resource"
jwks_uri 任意
string uri
"https://example.com/resource"
scopes 任意
array<string>
[ "string" ]
allowed_audiences 任意
array<string>
[ "string" ]
pkce_required 任意
boolean
true
jit_provisioning 任意
boolean
true
status 任意
string
"active"
metadata 任意
object
{}
organization_id 任意
PublicId | null
"organization_id_aaaaaaaaaaaaaaaaaaaa"
client_secret_rotated_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
created_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
updated_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
OidcConnectionResponse 1項目

Schema

object

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "name": "Example name",
    "issuer": "https://example.com/resource",
    "client_id": "01K5QWERTY1234567890ABCDEFG",
    "authorization_endpoint": "https://example.com/resource",
    "token_endpoint": "https://example.com/resource",
    "jwks_uri": "https://example.com/resource",
    "scopes": [
      "string"
    ],
    "allowed_audiences": [
      "string"
    ],
    "pkce_required": true,
    "jit_provisioning": true,
    "status": "active",
    "metadata": {},
    "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
    "client_secret_rotated_at": "2026-09-21T00:00:00Z",
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
項目必須型・説明Example Value
data 必須
OidcConnection
{ "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa", "name": "Example name", "issuer": "https://example.com/resource", "client_id": "01K5QWERTY1234567890ABCDEFG", "authorization_endpoint": "https://example.com/resource", "token_endpoint": "https://example.com/resource", "jwks_uri": "https://example.com/resource", "scopes": [ "string" ], "allowed_audiences": [ "string" ], "pkce_required": true, "jit_provisioning": true, "status": "active", "metadata": {}, "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa", "client_secret_rotated_at": "2026-09-21T00:00:00Z", "created_at": "2026-09-21T00:00:00Z", "updated_at": "2026-09-21T00:00:00Z" }
OidcConnectionListResponse 2項目

Schema

object

Example Value

{
  "data": [
    {
      "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
      "name": "Example name",
      "issuer": "https://example.com/resource",
      "client_id": "01K5QWERTY1234567890ABCDEFG",
      "authorization_endpoint": "https://example.com/resource",
      "token_endpoint": "https://example.com/resource",
      "jwks_uri": "https://example.com/resource",
      "scopes": [
        "string"
      ],
      "allowed_audiences": [
        "string"
      ],
      "pkce_required": true,
      "jit_provisioning": true,
      "status": "active",
      "metadata": {},
      "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
      "client_secret_rotated_at": "2026-09-21T00:00:00Z",
      "created_at": "2026-09-21T00:00:00Z",
      "updated_at": "2026-09-21T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
項目必須型・説明Example Value
data 必須
array<OidcConnection>
[ { "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa", "name": "Example name", "issuer": "https://example.com/resource", "client_id": "01K5QWERTY1234567890ABCDEFG", "authorization_endpoint": "https://example.com/resource", "token_endpoint": "https://example.com/resource", "jwks_uri": "https://example.com/resource", "scopes": [ "string" ], "allowed_audiences": [ "string" ], "pkce_required": true, "jit_provisioning": true, "status": "active", "metadata": {}, "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa", "client_secret_rotated_at": "2026-09-21T00:00:00Z", "created_at": "2026-09-21T00:00:00Z", "updated_at": "2026-09-21T00:00:00Z" } ]
pagination 必須
Pagination
{ "next_cursor": "string", "has_more": true }
LicenseAssignment 14項目

Schema

object

Example Value

{
  "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
  "license_id": "license_id_aaaaaaaaaaaaaaaaaaaa",
  "license_user_id": "license_user_id_aaaaaaaaaaaaaaaaaaaa",
  "source_group_id": "source_group_id_aaaaaaaaaaaaaaaaaaaa",
  "tenant_plan_id": "tenant_plan_id_aaaaaaaaaaaaaaaaaaaa",
  "status": "active",
  "license_units": 1,
  "assigned_at": "2026-09-21T00:00:00Z",
  "expires_at": "2026-09-21T00:00:00Z",
  "revoked_at": "2026-09-21T00:00:00Z",
  "entitlement_overrides": {},
  "metadata": {},
  "created_at": "2026-09-21T00:00:00Z",
  "updated_at": "2026-09-21T00:00:00Z"
}
項目必須型・説明Example Value
public_id 任意
PublicId
"public_id_aaaaaaaaaaaaaaaaaaaa"
license_id 任意
PublicId
"license_id_aaaaaaaaaaaaaaaaaaaa"
license_user_id 任意
PublicId
"license_user_id_aaaaaaaaaaaaaaaaaaaa"
source_group_id 任意
PublicId | null
"source_group_id_aaaaaaaaaaaaaaaaaaaa"
tenant_plan_id 任意
PublicId | null
"tenant_plan_id_aaaaaaaaaaaaaaaaaaaa"
status 任意
string
"active"
license_units 任意
integer | null
1
assigned_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
expires_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
revoked_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
entitlement_overrides 任意
object
{}
metadata 任意
object
{}
created_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
updated_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
LicenseAssignmentResponse 1項目

Schema

object

Example Value

{
  "data": {
    "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
    "license_id": "license_id_aaaaaaaaaaaaaaaaaaaa",
    "license_user_id": "license_user_id_aaaaaaaaaaaaaaaaaaaa",
    "source_group_id": "source_group_id_aaaaaaaaaaaaaaaaaaaa",
    "tenant_plan_id": "tenant_plan_id_aaaaaaaaaaaaaaaaaaaa",
    "status": "active",
    "license_units": 1,
    "assigned_at": "2026-09-21T00:00:00Z",
    "expires_at": "2026-09-21T00:00:00Z",
    "revoked_at": "2026-09-21T00:00:00Z",
    "entitlement_overrides": {},
    "metadata": {},
    "created_at": "2026-09-21T00:00:00Z",
    "updated_at": "2026-09-21T00:00:00Z"
  }
}
項目必須型・説明Example Value
data 必須
LicenseAssignment
{ "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa", "license_id": "license_id_aaaaaaaaaaaaaaaaaaaa", "license_user_id": "license_user_id_aaaaaaaaaaaaaaaaaaaa", "source_group_id": "source_group_id_aaaaaaaaaaaaaaaaaaaa", "tenant_plan_id": "tenant_plan_id_aaaaaaaaaaaaaaaaaaaa", "status": "active", "license_units": 1, "assigned_at": "2026-09-21T00:00:00Z", "expires_at": "2026-09-21T00:00:00Z", "revoked_at": "2026-09-21T00:00:00Z", "entitlement_overrides": {}, "metadata": {}, "created_at": "2026-09-21T00:00:00Z", "updated_at": "2026-09-21T00:00:00Z" }
LicenseAssignmentListResponse 2項目

Schema

object

Example Value

{
  "data": [
    {
      "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa",
      "license_id": "license_id_aaaaaaaaaaaaaaaaaaaa",
      "license_user_id": "license_user_id_aaaaaaaaaaaaaaaaaaaa",
      "source_group_id": "source_group_id_aaaaaaaaaaaaaaaaaaaa",
      "tenant_plan_id": "tenant_plan_id_aaaaaaaaaaaaaaaaaaaa",
      "status": "active",
      "license_units": 1,
      "assigned_at": "2026-09-21T00:00:00Z",
      "expires_at": "2026-09-21T00:00:00Z",
      "revoked_at": "2026-09-21T00:00:00Z",
      "entitlement_overrides": {},
      "metadata": {},
      "created_at": "2026-09-21T00:00:00Z",
      "updated_at": "2026-09-21T00:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
項目必須型・説明Example Value
data 必須
array<LicenseAssignment>
[ { "public_id": "public_id_aaaaaaaaaaaaaaaaaaaa", "license_id": "license_id_aaaaaaaaaaaaaaaaaaaa", "license_user_id": "license_user_id_aaaaaaaaaaaaaaaaaaaa", "source_group_id": "source_group_id_aaaaaaaaaaaaaaaaaaaa", "tenant_plan_id": "tenant_plan_id_aaaaaaaaaaaaaaaaaaaa", "status": "active", "license_units": 1, "assigned_at": "2026-09-21T00:00:00Z", "expires_at": "2026-09-21T00:00:00Z", "revoked_at": "2026-09-21T00:00:00Z", "entitlement_overrides": {}, "metadata": {}, "created_at": "2026-09-21T00:00:00Z", "updated_at": "2026-09-21T00:00:00Z" } ]
pagination 必須
Pagination
{ "next_cursor": "string", "has_more": true }
UsageReport 5項目

Schema

object

Example Value

{
  "period": {},
  "new_activations": 1,
  "active_machines": 1,
  "active_licenses": 1,
  "active_leases": 1
}
項目必須型・説明Example Value
period 任意
object
{}
new_activations 任意
integer | null
1
active_machines 任意
integer | null

期間内に作られ、認証を解除されていない端末認証の、重複しない端末の数です。一時停止中・期限切れのライセンスの端末も含みます（ライセンスの再開後に同じ端末をまた使えるよう、端末認証を残すため）。今この製品を使える端末の数ではありません。

 1
active_licenses 任意
integer | null
1
active_leases 任意
integer | null
1
UsageReportResponse 1項目

Schema

object

Example Value

{
  "data": {
    "period": {},
    "new_activations": 1,
    "active_machines": 1,
    "active_licenses": 1,
    "active_leases": 1
  }
}
項目必須型・説明Example Value
data 必須
UsageReport
{ "period": {}, "new_activations": 1, "active_machines": 1, "active_licenses": 1, "active_leases": 1 }
UsageReportListResponse 2項目

Schema

object

Example Value

{
  "data": [
    {
      "period": {},
      "new_activations": 1,
      "active_machines": 1,
      "active_licenses": 1,
      "active_leases": 1
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
項目必須型・説明Example Value
data 必須
array<UsageReport>
[ { "period": {}, "new_activations": 1, "active_machines": 1, "active_licenses": 1, "active_leases": 1 } ]
pagination 必須
Pagination
{ "next_cursor": "string", "has_more": true }
ProductInput 4項目

Schema

object

Example Value

{
  "name": "Example name",
  "code": "string",
  "description": "Example description",
  "environment": "string"
}
項目必須型・説明Example Value
name 任意
string
"Example name"
code 任意
string
"string"
description 任意
string
"Example description"
environment 任意
string
"string"
ProductBrowserRuntimeInput 2項目

Schema

object

Example Value

{
  "enabled": true,
  "allowed_origins": [
    "string"
  ]
}
項目必須型・説明Example Value
enabled 任意
boolean
true
allowed_origins 任意
array<string> 最大要素数: 20
[ "string" ]
ProductTrialSignupInput 2項目

Schema

object

Example Value

{
  "policy_id": "01K5QWERTY1234567890ABCDEFG",
  "daily_limit": 1
}
項目必須型・説明Example Value
policy_id 任意
string | null 最大文字数: 64

試用の受付に使う利用ルール（この製品の有効な、ライセンスキー方式のトライアルの利用ルール）です。null か空文字で受付を止めます。

 "01K5QWERTY1234567890ABCDEFG"
daily_limit 任意
integer | null 最小値: 1 最大値: 1000

アプリから24時間に始められる試用の上限（1〜1000）です。null で既定の20件に戻します。

 1
PolicyInput 20項目

Schema

object

Example Value

{
  "product_id": "product_id_aaaaaaaaaaaaaaaaaaaa",
  "name": "Example name",
  "license_type": "string",
  "validation_mode": "string",
  "fail_mode": "string",
  "max_machines": 1,
  "max_concurrent": 1,
  "concurrency_unit": "string",
  "identity_mode": "string",
  "license_unit_limit": 1,
  "cert_ttl_sec": 1,
  "heartbeat_sec": 1,
  "lease_ttl_sec": 1,
  "lease_heartbeat_sec": 1,
  "network_grace_sec": 1,
  "fingerprint_profile": "standard",
  "renewal_authority": "string",
  "billing_cycle": "string",
  "trial_days": 1,
  "entitlements": {}
}
項目必須型・説明Example Value
product_id 任意
PublicId
"product_id_aaaaaaaaaaaaaaaaaaaa"
name 任意
string
"Example name"
license_type 任意
string
"string"
validation_mode 任意
string

端末固定の買い切りの利用ルールでは、offline を選ぶと offline_unmanaged になります。管理付きの買い切りには periodic か online を使います。ユーザー単位の買い切りの利用ルールは、管理付きにする必要があります。

 "string"
fail_mode 任意
string
"string"
max_machines 任意
integer | null
1
max_concurrent 任意
integer | null
1
concurrency_unit 任意
string
"string"
identity_mode 任意
string
"string"
license_unit_limit 任意
integer | null
1
cert_ttl_sec 任意
integer | null
1
heartbeat_sec 任意
integer | null
1
lease_ttl_sec 任意
integer | null
1
lease_heartbeat_sec 任意
integer | null
1
network_grace_sec 任意
integer | null
1
fingerprint_profile 任意
string | object

端末を見分ける方法（プロファイル）の名前を、standard のような文字列で送ります。{"profile": 名前} の形で保存して返します。オブジェクトは以前のスキーマとの互換のために型に残しているだけで、オブジェクトや配列は 422 VALIDATION_FAILED で拒否します。risk_policy はこの API では設定できません。

 "standard"
renewal_authority 任意
string
"string"
billing_cycle 任意
string
"string"
trial_days 任意
integer | null
1
entitlements 任意
object
{}
CustomerInput 4項目

Schema

object

Example Value

{
  "name": "Example name",
  "email": "developer@example.com",
  "external_ref": "string",
  "notes": "string"
}
項目必須型・説明Example Value
name 任意
string
"Example name"
email 任意
string
"developer@example.com"
external_ref 任意
string
"string"
notes 任意
string
"string"
LicenseUpdateInput 10項目

Schema

object

Example Value

{
  "expires_at": "2026-09-21T00:00:00Z",
  "expiry": "2026-09-21T00:00:00Z",
  "renewal_authority": "string",
  "max_machines_override": 1,
  "max_concurrent_override": 1,
  "license_unit_limit_override": 1,
  "entitlements": {},
  "metadata": {},
  "status_action": "active",
  "reason": "string"
}
項目必須型・説明Example Value
expires_at 任意
string | null date-time

契約期限。nullで期限なしにします。検証プランでは発行時刻から1時間以内である必要があります。

 "2026-09-21T00:00:00Z"
expiry 任意
string | null date-time

expires_atの旧名です。expires_atを使ってください。両方を指定した場合はexpires_atを採用します。

 "2026-09-21T00:00:00Z"
renewal_authority 任意
string
"string"
max_machines_override 任意
integer | null
1
max_concurrent_override 任意
integer | null
1
license_unit_limit_override 任意
integer | null
1
entitlements 任意
object
{}
metadata 任意
object
{}
status_action 任意
string
"active"
reason 任意
string
"string"
ResellerInput 7項目

Schema

object

Example Value

{
  "name": "Example name",
  "email": "developer@example.com",
  "external_ref": "string",
  "organization_limit": 1,
  "user_limit": 1,
  "status": "active",
  "metadata": {}
}
項目必須型・説明Example Value
name 任意
string
"Example name"
email 任意
string
"developer@example.com"
external_ref 任意
string
"string"
organization_limit 任意
integer | null
1
user_limit 任意
integer | null
1
status 任意
string
"active"
metadata 任意
object
{}
OrganizationInput 7項目

Schema

object

Example Value

{
  "name": "Example name",
  "email": "developer@example.com",
  "external_ref": "string",
  "user_limit": 1,
  "reseller_id": "reseller_id_aaaaaaaaaaaaaaaaaaaa",
  "status": "active",
  "metadata": {}
}
項目必須型・説明Example Value
name 任意
string
"Example name"
email 任意
string
"developer@example.com"
external_ref 任意
string
"string"
user_limit 任意
integer | null
1
reseller_id 任意
PublicId | null
"reseller_id_aaaaaaaaaaaaaaaaaaaa"
status 任意
string
"active"
metadata 任意
object
{}
OrganizationGroupInput 4項目

Schema

object

Example Value

{
  "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
  "name": "Example name",
  "status": "active",
  "metadata": {}
}
項目必須型・説明Example Value
organization_id 任意
PublicId
"organization_id_aaaaaaaaaaaaaaaaaaaa"
name 任意
string
"Example name"
status 任意
string
"active"
metadata 任意
object
{}
OrganizationGroupMembershipInput 1項目

Schema

object

Example Value

{
  "license_user_id": "license_user_id_aaaaaaaaaaaaaaaaaaaa"
}
項目必須型・説明Example Value
license_user_id 任意
PublicId
"license_user_id_aaaaaaaaaaaaaaaaaaaa"
LicenseUserInput 8項目

ライセンスユーザーは live と test の環境で共有されています。test のAPIキーからは、live のライセンスに席を持つライセンスユーザーを、停止・利用終了も含めて変更できません（403 ENVIRONMENT_MISMATCH）。すでにあるissuerとsubjectでPOSTするとそのユーザーを更新するため、POSTにも同じ拒否が適用されます。

Schema

object

Example Value

{
  "issuer": "string",
  "subject": "string",
  "email": "developer@example.com",
  "name": "Example name",
  "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
  "oidc_connection_id": "oidc_connection_id_aaaaaaaaaaaaaaaaaaaa",
  "status": "active",
  "metadata": {}
}
項目必須型・説明Example Value
issuer 任意
string
"string"
subject 任意
string
"string"
email 任意
string
"developer@example.com"
name 任意
string
"Example name"
organization_id 任意
PublicId | null
"organization_id_aaaaaaaaaaaaaaaaaaaa"
oidc_connection_id 任意
PublicId | null

OIDC接続へ関連付ける場合に指定します。チーム以上のプランかつ`oidc_sso`の機能権限が必要です。個人プランでは省略または`null`とし、指定した場合はHTTP 403（`PLAN_ENTITLEMENT_REQUIRED`）を返します。

 "oidc_connection_id_aaaaaaaaaaaaaaaaaaaa"
status 任意
string
"active"
metadata 任意
object
{}
OidcConnectionCreateInput 14項目

Schema

object

Example Value

{
  "name": "Example name",
  "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
  "issuer": "string",
  "client_id": "01K5QWERTY1234567890ABCDEFG",
  "client_secret": "example-token",
  "authorization_endpoint": "https://example.com/resource",
  "token_endpoint": "https://example.com/resource",
  "jwks_uri": "https://example.com/resource",
  "pkce_required": true,
  "jit_provisioning": true,
  "status": "active",
  "scopes": [
    "string"
  ],
  "allowed_audiences": [
    "string"
  ],
  "metadata": {}
}
項目必須型・説明Example Value
name 任意
string
"Example name"
organization_id 任意
PublicId | null
"organization_id_aaaaaaaaaaaaaaaaaaaa"
issuer 任意
string
"string"
client_id 任意
string
"01K5QWERTY1234567890ABCDEFG"
client_secret 必須
string
"example-token"
authorization_endpoint 任意
string
"https://example.com/resource"
token_endpoint 任意
string
"https://example.com/resource"
jwks_uri 任意
string
"https://example.com/resource"
pkce_required 任意
boolean
true
jit_provisioning 任意
boolean
true
status 任意
string
"active"
scopes 任意
array<string>
[ "string" ]
allowed_audiences 任意
array<string>
[ "string" ]
metadata 任意
object
{}
OidcConnectionUpdateInput 14項目

Schema

object

Example Value

{
  "client_secret": "example-token",
  "name": "Example name",
  "organization_id": "organization_id_aaaaaaaaaaaaaaaaaaaa",
  "issuer": "string",
  "client_id": "01K5QWERTY1234567890ABCDEFG",
  "authorization_endpoint": "https://example.com/resource",
  "token_endpoint": "https://example.com/resource",
  "jwks_uri": "https://example.com/resource",
  "pkce_required": true,
  "jit_provisioning": true,
  "status": "active",
  "scopes": [
    "string"
  ],
  "allowed_audiences": [
    "string"
  ],
  "metadata": {}
}
項目必須型・説明Example Value
client_secret 任意
string

本人確認を左右する設定を変えるときだけ送ります。送った値で保存し直します。応答には含めません。

 "example-token"
name 任意
string
"Example name"
organization_id 任意
PublicId | null
"organization_id_aaaaaaaaaaaaaaaaaaaa"
issuer 任意
string
"string"
client_id 任意
string
"01K5QWERTY1234567890ABCDEFG"
authorization_endpoint 任意
string
"https://example.com/resource"
token_endpoint 任意
string
"https://example.com/resource"
jwks_uri 任意
string
"https://example.com/resource"
pkce_required 任意
boolean
true
jit_provisioning 任意
boolean
true
status 任意
string
"active"
scopes 任意
array<string>
[ "string" ]
allowed_audiences 任意
array<string>
[ "string" ]
metadata 任意
object
{}
OidcClientSecretRotationInput 1項目

Schema

object

Example Value

{
  "client_secret": "example-token"
}
項目必須型・説明Example Value
client_secret 必須
string
"example-token"
LicenseAssignmentInput 5項目

Schema

object

Example Value

{
  "license_user_id": "license_user_id_aaaaaaaaaaaaaaaaaaaa",
  "source_group_id": "source_group_id_aaaaaaaaaaaaaaaaaaaa",
  "expires_at": "2026-09-21T00:00:00Z",
  "entitlement_overrides": {},
  "metadata": {}
}
項目必須型・説明Example Value
license_user_id 任意
PublicId
"license_user_id_aaaaaaaaaaaaaaaaaaaa"
source_group_id 任意
PublicId | null
"source_group_id_aaaaaaaaaaaaaaaaaaaa"
expires_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
entitlement_overrides 任意
object
{}
metadata 任意
object
{}
WebhookInput 3項目

Schema

object

Example Value

{
  "name": "Example name",
  "url": "https://example.com/resource",
  "events": [
    "string"
  ]
}
項目必須型・説明Example Value
name 任意
string
"Example name"
url 任意
string uri
"https://example.com/resource"
events 任意
array<string>
[ "string" ]
WebhookSecretRotationInput 1項目

Schema

object

Example Value

{
  "activates_at": "2026-09-21T00:00:00Z"
}
項目必須型・説明Example Value
activates_at 任意
string date-time
"2026-09-21T00:00:00Z"
TrialConversionInput 3項目

Schema

object

Example Value

{
  "target_policy_id": "target_policy_id_aaaaaaaaaaaaaaaaaaaa",
  "expires_at": "2026-09-21T00:00:00Z",
  "entitlement_overrides": {}
}
項目必須型・説明Example Value
target_policy_id 任意
PublicId
"target_policy_id_aaaaaaaaaaaaaaaaaaaa"
expires_at 任意
string | null date-time
"2026-09-21T00:00:00Z"
entitlement_overrides 任意
object
{}
LicenseIssueResponse 1項目

Schema

object

Example Value

{
  "data": {}
}
項目必須型・説明Example Value
data 必須
License + object
{}
WebhookSecretResponse 1項目

Schema

object

Example Value

{
  "data": {}
}
項目必須型・説明Example Value
data 必須
Webhook + object
{}