firebase-admin.security-rules package

Cloud Firestore と Cloud Storage のセキュリティ ルール

関数

関数 説明
getSecurityRules(app) デフォルト アプリまたは特定のアプリの SecurityRules サービスを取得します。デフォルト アプリの SecurityRules サービスにアクセスするには、引数なしで admin.securityRules() を呼び出すか、特定のアプリに関連付けられた SecurityRules サービスにアクセスする admin.securityRules(app) として呼び出します。

クラス

クラス 説明
ルールセット Firebase セキュリティ ルールのセット。
RulesetMetadataList ルールセット メタデータのページ。
SecurityRules Firebase SecurityRules サービス インターフェース。

インターフェース

インターフェース 説明
RulesetMetadata ルールセットに関連付けられた必須のメタデータ。
RulesFile いくつかの Firebase セキュリティ ルールを含むソースファイル。コンテンツには、テキストの書式設定、インデント、コメントなどの未加工のソースコードが含まれます。SecurityRules.createRulesFileFromSource() メソッドを使用して、このタイプの新しいインスタンスを作成します。

getSecurityRules(アプリ)

デフォルト アプリまたは特定のアプリの SecurityRules サービスを取得します。

admin.securityRules() を引数なしで呼び出すと、デフォルト アプリの SecurityRules サービスにアクセスできます。admin.securityRules(app) として呼び出すと、特定のアプリに関連付けられた SecurityRules サービスにアクセスできるようになります。

署名:

export declare function getSecurityRules(app?: App): SecurityRules;

パラメータ

パラメータ 説明
アプリ アプリ SecurityRules サービスを返すオプションのアプリ。指定しない場合は、デフォルトの SecurityRules サービスが返されます。

戻り値:

SecurityRules

アプリが指定されていない場合は、デフォルトの SecurityRules サービス、または指定されたアプリに関連付けられた SecurityRules サービス。

例 1

// Get the SecurityRules service for the default app
const defaultSecurityRules = getSecurityRules();

例 2

// Get the SecurityRules service for a given app
const otherSecurityRules = getSecurityRules(otherApp);