APIキー
APIキーはちょうど1つのプロジェクトに属し、スコープに挙げられたことを実行できます。さらに、名前を付けたモデルやオペレーションに絞り込んだり、1つの組織に限定したりできます。
公開キーとシークレットキー
種類は2つで、プレフィックスで区別します。公開キー(pk_)は、ブラウザーに含めても安全です。単独では読み取り専用で公開済みのコンテンツを返し、サインイン済みのユーザーは自分のロールのスコープを加えます。シークレットキー(sk_)はサーバー用で、ブラウザーのOriginヘッダーを含むリクエストに対しては、APIが拒否します。どちらの種類もプロジェクト内で作成され、そのプロジェクトだけに対応します。
スコープ
スコープは、キーが持つアクセスの種類を決めます。たとえばrecords:readやオペレーションの実行です。チェックは許可リスト方式なので、キーにないスコープの呼び出しは拒否されます。スコープは呼び出しを許可するだけで、クエリが返す行を広げることはありません。公開キーが一切持てないスコープもあり、作成時にそれを要求すると拒否されます。
モデルとオペレーションへの絞り込み
キーが届くリソースは、モデルアクセスとオペレーションアクセスの2つのセレクターで決まります。どちらも既定はすべてで、キーのスコープが及ぶものすべてを意味するため、絞り込みは任意です。特定のモデルを選ぶと、ほかのすべてのモデルの型付きフィールドはそのキーが見るスキーマから消え、それらへの呼び出しは拒否されます。特定のオペレーションを選ぶと、リストにないオペレーションのミューテーションは、イントロスペクションを含め、そのキーのスキーマにありません。
1つの組織への限定
キーは、作成時に1つの組織に限定できます。そのキーは、その組織、その配下のすべて、プロジェクト全体で共有されている行を読み取り、書き込めるのは自分の組織のみです。少なくとも1つのスコープを指定する必要があり、キーを発行することはできず、組織とともに削除されます。
ローテーションと後からの変更
キーをローテーションすると、古いシークレットは24時間有効なままです。取り消すと、すべてのシークレットがただちに無効になります。スコープ、許可するモデル、名前は既存のキーでも編集でき、保存した時点で反映されます。キーの種類、限定、有効期限は作成時に固定されます。
詳細を読む
APIキーのガイドでは、2種類のキー、そのスコープ、キーの範囲の制限、ローテーションを説明しています。