フィールドレベルのアクセス

フィールドごとに、どの種類の呼び出し元が読み取れるか、どの種類が書き込めるかを指定できます。社内向けのメモはチームだけに限定でき、オペレーションが設定する値はユーザーのブラウザーから隠せます。

フィールドの読み取りリストと書き込みリスト

フィールドには、読み取りリストと書き込みリストを持つ任意のaccessオブジェクトを指定できます。エントリのある書き込みリストは許可リストとなり、プラットフォームはすべての書き込み経路で、それ以外の呼び出し元を拒否します。読み取りリストは、クライアントAPIがそのフィールドを公開する呼び出し元を決めます。accessオブジェクトのないフィールドは、認証済みであればどの呼び出し元でも書き込めます。

5種類の呼び出し元

すべてのリクエストは、持っている認証情報によって決まる5種類のいずれかです。サインインしていない訪問者はpublicです。公開キーで、自分のトークンを使って書き込むサインイン済みのユーザーはselfです。オペレーションが実行のために発行されたトークンで動く場合は、そのトークンをトリガーしたユーザーが含まれていてもscopedです。シークレットキーはserviceです。コンソールまたはCLIを使うチームの一員はadminです。

オペレーションだけが触れるフィールド

オペレーションを実行するユーザーは、所有権、行ルール、監査上のアクター、クォータについては引き続きそのユーザーです。オペレーションが読み書きするものはscopedとして扱われ、selfとしては扱われません。そのため、scopedを挙げてselfを含めないフィールドは、オペレーションが読み取り、設定でき、ユーザーのブラウザーはどちらもできません。

読み取りの判定方法

データAPIは、同じ5種類で読み取りを判定します。オペレーションはscopedとして、サインイン済みユーザー自身のリクエストはselfとして読み取ります。訪問者とシークレットキーはどちらもpublicとして読み取り、コンソールでプレビューするチームメンバーはすべてのフィールドを読み取ります。ある種類の呼び出し元向けに計算されたキャッシュされたレスポンスが、別の種類の呼び出し元に返されることはありません。

詳細を読む

モデルリファレンスでは、フィールドのaccessオブジェクト、5種類の呼び出し元、オペレーションの実例を示しています。