Firebase Rules API

Firebase セキュリティ ルールが有効なサービスがリクエストを許可するタイミングを決定するルールを作成および管理します。

この REST API を含むセキュリティ ルールの管理に使用できるツールの説明については、 「 Firebase セキュリティ ルールの管理とデプロイ 」を参照してください。

概要

Firebase セキュリティ ルールは、言語と API で構成されます。開発者は言語でルールを作成し、API 経由で公開して、Firebase セキュリティ ルール対応サービスにリクエストを送信します。サービスは、提供されたルールセットを使用してリクエストを評価し、リクエストを許可するかどうかを決定します。

このリファレンス ドキュメントでは次の用語が使用されます。

  • Source : 特定のrequest operationが許可される条件を記述するserviceとpathにスコープされたルールを含むドメイン固有の言語。

  • Ruleset : 永続的で不変のコピー 生成された名前を持つSourceコンテンツ。

  • Release : Rulesetへの名前付き参照。これにより、Firebase セキュリティ ルール対応サービスによるRulesetの使用と適用が可能になります。

サービス: firebaserules.googleapis.com

このサービスを呼び出すには、Google が提供するクライアント ライブラリを使用することをお勧めします。アプリケーションが独自のライブラリを使用してこのサービスを呼び出す必要がある場合は、API リクエストを行うときに次の情報を使用します。

発見文書

Discovery Document は、 REST API を記述および使用するための機械可読仕様です。これは、クライアント ライブラリ、IDE プラグイン、および Google API と対話するその他のツールを構築するために使用されます。 1 つのサービスが複数の検出ドキュメントを提供する場合があります。このサービスは、次の検出ドキュメントを提供します。

サービスエンドポイント

サービス エンドポイントは、API サービスのネットワーク アドレスを指定するベース URL です。 1 つのサービスに複数のサービス エンドポイントがある場合があります。このサービスには次のサービス エンドポイントがあり、以下のすべての URI はこのサービス エンドポイントに関連しています。

  • https://firebaserules.googleapis.com

REST リソース: v1.projects

メソッド
test POST /v1/{name=projects/**}:test
Sourceの構文的および意味的正確性をテストします。

REST リソース: v1.projects.releases

メソッド
create POST /v1/{name=projects/*}/releases
Releaseを作成します。
delete DELETE /v1/{name=projects/*/releases/**}
リソース名ごとにReleaseを削除します。
get GET /v1/{name=projects/*/releases/**}
名前でRelease取得します。
getExecutable GET /v1/{name=projects/*/releases/**}:getExecutable
ルールを適用するときに使用するRelease実行可能ファイルを取得します。
list GET /v1/{name=projects/*}/releases
プロジェクトのRelease値をリストします。
patch PATCH /v1/{name=projects/*/releases/**}
PATCH 経由でReleaseを更新します。

REST リソース: v1.projects.rulesets

メソッド
create POST /v1/{name=projects/*}/rulesets
SourceからRulesetを作成します。
delete DELETE /v1/{name=projects/*/rulesets/*}
リソース名に基づいてRulesetを削除します。
get GET /v1/{name=projects/*/rulesets/*}
Source完全な内容を含むRulesetを名前で取得します。
list GET /v1/{name=projects/*}/rulesets
Rulesetメタデータのみをリストし、必要に応じてRuleset名で結果をフィルタリングします。