APIキー

イベント一覧

イベント	リソース	説明
api_key.create	api_key	APIキーが作成された。
api_key.rename	api_key	APIキー名が変更された。
api_key.delete	api_key	APIキーが削除された。
api_key.used	api_key	APIキーが API の呼び出しに使用された。

イベント詳細

api_key.create 準備中

APIキーが作成された。

フィールド	値
event.code	api_key.create
scope.type	workspace
resource.type	api_key
references	（なし）
query	（なし）
change	（なし）
grant	（なし）
extra	（なし）

サンプル

{
  "event": {
    "code": "api_key.create",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "api_key",
    "uid": "63e1be654aa70ad689601bee",
    "name": "Embed Key",
    "path": "api_key/63e1be654aa70ad689601bee",
    "parts": [
      {
        "type": "api_key",
        "uid": "63e1be654aa70ad689601bee",
        "name": "Embed Key"
      }
    ],
    ...
  },
  ...
}

api_key.rename 準備中

APIキー名が変更された。

フィールド	値
event.code	api_key.rename
scope.type	workspace
resource.type	api_key
references	（なし）
query	（なし）
change	name
grant	（なし）
extra	（なし）

change

名前	モード	型	必須	説明
name	値	string	必須	—

サンプル

{
  "event": {
    "code": "api_key.rename",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "api_key",
    "uid": "63e1be654aa70ad689601bee",
    "name": "Embed Key",
    "path": "api_key/63e1be654aa70ad689601bee",
    "parts": [
      {
        "type": "api_key",
        "uid": "63e1be654aa70ad689601bee",
        "name": "Embed Key"
      }
    ],
    ...
  },
  "change": {
    "fields": [
      {
        "name": "name",
        "old": "Old",
        "new": "Embed Key"
      }
    ]
  },
  ...
}

api_key.delete 準備中

APIキーが削除された。

フィールド	値
event.code	api_key.delete
scope.type	workspace
resource.type	api_key
references	（なし）
query	（なし）
change	（なし）
grant	（なし）
extra	（なし）

サンプル

{
  "event": {
    "code": "api_key.delete",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "api_key",
    "uid": "63e1be654aa70ad689601bee",
    "name": "Embed Key",
    "path": "api_key/63e1be654aa70ad689601bee",
    "parts": [
      {
        "type": "api_key",
        "uid": "63e1be654aa70ad689601bee",
        "name": "Embed Key"
      }
    ],
    ...
  },
  ...
}

api_key.used 準備中

APIキーが API の呼び出しに使用された。

フィールド	値
event.code	api_key.used
scope.type	workspace
resource.type	api_key
references	（なし）
query	（なし）
change	（なし）
grant	（なし）
extra	（なし）

サンプル

{
  "event": {
    "code": "api_key.used",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "api_key",
    "uid": "63e1be654aa70ad689601bee",
    "name": null,
    "path": "api_key/63e1be654aa70ad689601bee",
    "parts": [
      {
        "type": "api_key",
        "uid": "63e1be654aa70ad689601bee",
        "name": null
      }
    ],
    ...
  },
  ...
}