Appearance
APIキー
APIキーは、ワークスペースに紐づく認証情報で、署名付き埋め込み で利用されます。
イベント一覧
| イベント | リソース | 説明 |
|---|---|---|
api_key.create | api_key | APIキーが作成された |
api_key.rename | api_key | APIキー名が変更された |
api_key.create_secret | api_key_secret | APIキーのシークレットが追加された |
api_key.retrieve_secret | api_key_secret | APIキーのシークレットが取得された |
api_key.delete_secret | api_key_secret | APIキーのシークレットが削除された |
api_key.delete | api_key | APIキーが削除された |
イベント詳細
api_key.create プレビュー
記録期間: 2026-09-15 〜
APIキーの作成を記録します。
| フィールド | 値 |
|---|---|
event.code | api_key.create |
scope.type | workspace |
resource.type | api_key |
references | （なし） |
query | （なし） |
outbound | （なし） |
change | （なし） |
grant | （なし） |
extra | （なし） |
サンプル
json
{
"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 プレビュー
記録期間: 2026-09-15 〜
APIキーの表示名の変更を記録します。
| フィールド | 値 |
|---|---|
event.code | api_key.rename |
scope.type | workspace |
resource.type | api_key |
references | （なし） |
query | （なし） |
outbound | （なし） |
change | name |
grant | （なし） |
extra | （なし） |
change
| 名前 | モード | 型 | 必須 | 説明 |
|---|---|---|---|---|
name | 値 | string | 必須 | 変更前後の表示名 |
サンプル
json
{
"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.create_secret プレビュー
記録期間: 2026-09-15 〜
APIキーのシークレットの追加を記録します。
| フィールド | 値 |
|---|---|
event.code | api_key.create_secret |
scope.type | workspace |
resource.type | api_key_secret |
references | （なし） |
query | （なし） |
outbound | （なし） |
change | （なし） |
grant | （なし） |
extra | （なし） |
サンプル
json
{
"event": {
"code": "api_key.create_secret",
...
},
"scope": {
"type": "workspace",
...
},
"resource": {
"type": "api_key_secret",
"uid": "2",
"name": null,
"path": "api_key/63e1be654aa70ad689601bee/api_key_secret/2",
"parts": [
{
"type": "api_key",
"uid": "63e1be654aa70ad689601bee",
"name": "Embed Key"
},
{
"type": "api_key_secret",
"uid": "2",
"name": null
}
],
...
},
...
}api_key.retrieve_secret プレビュー
記録期間: 2026-09-15 〜
APIキーのシークレットの取得を記録します。
| フィールド | 値 |
|---|---|
event.code | api_key.retrieve_secret |
scope.type | workspace |
resource.type | api_key_secret |
references | （なし） |
query | （なし） |
outbound | （なし） |
change | （なし） |
grant | （なし） |
extra | （なし） |
サンプル
json
{
"event": {
"code": "api_key.retrieve_secret",
...
},
"scope": {
"type": "workspace",
...
},
"resource": {
"type": "api_key_secret",
"uid": "1",
"name": null,
"path": "api_key/63e1be654aa70ad689601bee/api_key_secret/1",
"parts": [
{
"type": "api_key",
"uid": "63e1be654aa70ad689601bee",
"name": "Embed Key"
},
{
"type": "api_key_secret",
"uid": "1",
"name": null
}
],
...
},
...
}api_key.delete_secret プレビュー
記録期間: 2026-09-15 〜
APIキーのシークレットの削除を記録します。
| フィールド | 値 |
|---|---|
event.code | api_key.delete_secret |
scope.type | workspace |
resource.type | api_key_secret |
references | （なし） |
query | （なし） |
outbound | （なし） |
change | （なし） |
grant | （なし） |
extra | （なし） |
サンプル
json
{
"event": {
"code": "api_key.delete_secret",
...
},
"scope": {
"type": "workspace",
...
},
"resource": {
"type": "api_key_secret",
"uid": "1",
"name": null,
"path": "api_key/63e1be654aa70ad689601bee/api_key_secret/1",
"parts": [
{
"type": "api_key",
"uid": "63e1be654aa70ad689601bee",
"name": "Embed Key"
},
{
"type": "api_key_secret",
"uid": "1",
"name": null
}
],
...
},
...
}api_key.delete プレビュー
記録期間: 2026-09-15 〜
APIキーの削除を記録します。
| フィールド | 値 |
|---|---|
event.code | api_key.delete |
scope.type | workspace |
resource.type | api_key |
references | （なし） |
query | （なし） |
outbound | （なし） |
change | （なし） |
grant | （なし） |
extra | （なし） |
サンプル
json
{
"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"
}
],
...
},
...
}