メインコンテンツへスキップ
API keyは、1台のマシン(またはそのマシンのCogno CLI)をbrowser sessionなしでワークスペースに認証させるための鍵です。appで作成し、raw keyを1回だけコピーしてマシンに設定し、不要になったらワークスペース settingsからrevokeします。

​
前提

  • keyを作成できるrole — Member、Admin、Ownerのいずれか。Viewerに 設定 → APIキー は表示されません。
  • keyを使うマシンにCogno CLIがインストールされていること。

​
API keyの用途

​
Keyを作成する

1

ページを開く

Cognoを開き、ワークスペースを選び、設定 → APIキー を開きます。
2

作成を始める

作成 を選びます。API key を作成 dialogが開きます。
3

名前を付ける

名前（任意） に alice-macbook や ci-runner のような名前を入力し、作成 を選びます。
4

すぐにコピーする

API key を作成しました にraw keyとコピーボタン、使用コマンドが表示されます。コピーしてから 完了 を選びます。
raw keyが表示されるのは1回だけです。dialogを閉じた後、Cognoはname、prefix、日付しか表示しません — key自体をもう一度読む方法はありません。

​
マシンでkeyを使う

作業をさせるマシンで次を実行します。
認証できたかを確認するには次を実行します。
credential チェックが workspace API key と表示し、backend がそのkeyで認証されるワークスペースを表示します。

​
一覧の見かた

各行にkeyのidentityと履歴が並ぶので、何をrevokeするかはページを開いたまま判断できます。 管理者とオーナーには一覧の上に切り替えが出ます。自分のキー は自分のkey、すべてのキー はmember全員のkeyを所有者名つきで表示します。

​
Key formatと制限

​
Key名を付ける

revoke判断がすぐできるnameにします。 ワークスペースを複数人で運用する場合、test、key、machine のような名前は避けます。

​
Keyを保存する

raw keyはpasswordと同じ扱いにします。
  • local secret manager、CI secret store、environment variableに保存します。
  • task comments、docs、chat、tickets、screenshotsに貼らないでください。
  • repositoryにcommitしないでください。
  • machineやserviceごとに別keyを作成します。
  • 一時的なkeyは作業完了後にrevokeします。

​
Keyをrevokeする

1

keyを見つける

設定 → APIキー を開き、nameまたはprefixでkeyを探します。
2

取り消す

行のゴミ箱アイコン(ラベルは <name> を取り消す)を選びます。行に確認が出ます — 「この key を取り消しますか？使用中のマシンはすぐに access を失います。」 取り消す を選びます。
revokeは即時で、取り消しできません。そのkeyを使っているマシンはすぐにaccessを失います。マシンを止めたくない場合は、先にreplacement keyを作成してください。
memberは自分のkeyをrevokeできます。AdminとOwnerは すべてのキー からワークスペースのどのkeyでもrevokeできます。

​
Keyをrotateする

1

新しいkeyを作る

新しいkeyを作成してコピーします。
2

マシンに設定する

マシンで cogno login --token <new key> を実行し、保存されているcredentialを差し替えます。
3

確認する

マシンで cogno doctor を実行し、credential と backend が通ることを確認します。
4

古いkeyを止める

設定 → APIキー で古いkeyをrevokeします。

​
Troubleshooting

ここにない症状は Troubleshooting を参照してください。