API キーとスコープ
ClearScreen には、スコープを設定できるキーはありません。キーの種類ごとに用途は 1 つです。
| キー | 先頭の文字列 | 用途 |
|---|---|---|
| 登録キー | csk_ | clearscreen enroll でデバイスを登録するためのキーです。ワークスペースごとに 1 つで、ローテーション時に一度だけ表示されます。 |
| デバイスキー | csk_ | デバイスごとに 1 つ。エージェントがポリシーの取得とブロックの報告に使います。デバイス上ではパーミッション 0600 で、サーバー上ではハッシュとして保存されます。 |
| エクスポートトークン | csat_ | ログ転送のために、ブロックイベントとレビュー報告を読み取るトークンです。管理者がコンソール API で作成および失効できます。 |
キーの取り扱い
- 登録キーは秘密情報として扱ってください。ローテーションすると、古いキーでの新規登録はできなくなります。すでに登録済みのデバイスは引き続き動作します。
- 同じコンピューター名で再度登録すると、新しいデバイスキーが発行され、古いキーは使えなくなります。
- 登録キーのローテーションとエクスポートトークンの管理ができるのは、ワークスペースの管理者だけです。
- キーをチケット、チャット、スクリーンショットに載せないでください。
ドメインを確認する
公開チェックエンドポイントは、共有フィードとカテゴリに基づいて応答します。キーは不要で、レート制限があります。
curl "https://clearscreen.spot-suite.com/v1/check?domain=example.org"