ルールを作成する | MongoDB Atlas App Services Admin API 3.0 のドキュメント

ルールを作成する非推奨

POST /groups/{groupId}/apps/{appId}/services/{serviceId}/rules

tokenAuth

データアクセスルールを作成します。

path パラメータ

グループ ID string 必須

Atlas Project/Group ID。
appId string 必須

アプリケーションの ObjectID。App Services API プロジェクトとアプリケーション ID のセクションでは、この値を見つける方法が示されています。
serviceId string 必須

サービスのユニークな _id 値。

application/ JSON

body オブジェクト必須

作成するルール。

リンクされたデータソース内のコレクションのユーザーロールとクエリフィルターを定義するデータアクセスルール。

_id string

ルールのユニークな ObjectId 識別子。
役割 array[オブジェクト]

データアクセスロールの一覧。
ロール属性を非表示にするロール属性の表示オブジェクト
- _id string
  
  ロールの一意の ObjectId 識別子。
- document_filters オブジェクト
  document_filters 属性を非表示 document_filters 属性の表示オブジェクト
  
  読み取り
  
  次の 1 つ：
  オブジェクト-1 ブール値-2
  
  ロールがドキュメントを読み取ることができる場合に true と評価されるルール式。
  
  ロールがドキュメントを読み取ることができる場合に true と評価されるルール式。
  
  書込み (write)
  
  次の 1 つ：
  オブジェクト-1 ブール値-2
  
  ロールがドキュメントに書込み (write) できる場合に true と評価されるルール式。
  
  ロールがドキュメントに書込み (write) できる場合に true と評価されるルール式。
- name string
  
  ロールの名前。
- apply_when
  
  次の 1 つ：
  オブジェクト-1 ブール値-2
  
  このロールが特定のドキュメントのユーザーに適用される場合に true と評価されるルール式。
  
  このロールが特定のドキュメントのユーザーに適用される場合に true と評価されるルール式。
- 読み取り
  
  次の 1 つ：
  オブジェクト-1 ブール値-2
  
  ロールがドキュメント内のすべてのフィールドを読み取る権限を持つ場合に true と評価されるルール式。 Device Sync が有効になっている場合は、代わりに document_filters.read を使用します。
  
  ロールがドキュメント内のすべてのフィールドを読み取る権限を持つ場合に true と評価されるルール式。 Device Sync が有効になっている場合は、代わりに document_filters.read を使用します。
- 書込み (write)
  
  次の 1 つ：
  オブジェクト-1 ブール値-2
  
  ドキュメント内のすべてのフィールドを追加、変更、または削除する権限がある場合、true と評価されるルール式。 Device Sync が有効になっている場合は、代わりに document_filters.write を使用します。
  
  ドキュメント内のすべてのフィールドを追加、変更、または削除する権限がある場合、true と評価されるルール式。 Device Sync が有効になっている場合は、代わりに document_filters.write を使用します。
- insert
  
  次の 1 つ：
  オブジェクト-1 ブール値-2
  
  ロールに新しいドキュメントをコレクションに挿入する権限がある場合、true と評価されるルール式。
  
  ロールに新しいドキュメントをコレクションに挿入する権限がある場合、true と評価されるルール式。
- 削除
  
  次の 1 つ：
  オブジェクト-1 ブール値-2
  
  ロールにコレクションからドキュメントを削除する権限がある場合、true と評価されるルール式。
  
  ロールにコレクションからドキュメントを削除する権限がある場合、true と評価されるルール式。
- 検索
  
  次の 1 つ：
  オブジェクト-1 ブール値-2
  
  Atlas trueSearch を使用してコレクションを検索する権限がある場合、と評価されるルール式。
  
  Atlas trueSearch を使用してコレクションを検索する権限がある場合、と評価されるルール式。
- フィールドオブジェクト
  
  ロールの properties で明示的に設定されていないフィールドのフィールドレベルのルール。
- additional_fields オブジェクト
  
  ロールの properties で明示的に設定されていないフィールドのフィールドレベルのルール。
  additional_fields 属性を非表示にする additional_fields 属性を表示オブジェクト
  
  読み取り
  
  次の 1 つ：
  オブジェクト-1 ブール値-2
  
  ロールがフィールドの値を読み取ることができる場合に true と評価されるルール式。
  
  ロールがフィールドの値を読み取ることができる場合に true と評価されるルール式。
  
  書込み (write)
  
  次の 1 つ：
  オブジェクト-1 ブール値-2
  
  ロールがフィールドの値を書き込むことができる場合に true と評価されるルール式。
  
  ロールがフィールドの値を書き込むことができる場合に true と評価されるルール式。
フィルター array[オブジェクト]

受信操作のフィルターのリスト。
フィルター属性を非表示フィルター属性の表示オブジェクト
- _id string
  
  フィルターの一意の ObjectId 識別子。
- name string
  
  フィルターの名前。
- apply_when
  
  次の 1 つ：
  オブジェクト-1 ブール値-2
  
  フィルターが受信クエリに適用される場合に true と評価されるルール式。
  
  フィルターが受信クエリに適用される場合に true と評価されるルール式。
- クエリオブジェクト
  
  操作が実行される前に受信クエリにマージされるMongoDBクエリオブジェクト。
- プロジェクションオブジェクト
  
  操作が実行される前に受信クエリにマージされるMongoDBプロジェクションオブジェクト。
  プロジェクション属性を非表示プロジェクション属性の表示オブジェクト
  
  * 数値 additionalProperties
  
  値は 0 または 1 です。
database string 必須

リンクされたデータソース内のデータベースの名前。
コレクション string 必須

指定した database 内のコレクションの名前。

応答

201 application/ JSON

正常に作成されました。
応答属性の非表示応答属性の表示オブジェクト
- _id string
- name string
409

指定された name を持つルールはすでに存在します。

POST /groups/{groupId}/apps/{appId}/services/{serviceId}/rules

curl \
 --request POST 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/services/{serviceId}/rules' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{
  "_id": "string",
  "roles": [
    {
      "_id": "string",
      "document_filters": {},
      "name": "string",
      "fields": {},
      "additional_fields": {}
    }
  ],
  "filters": [
    {
      "_id": "string",
      "name": "string",
      "query": {},
      "projection": {
        "additionalProperty1": 0,
        "additionalProperty2": 0
      }
    }
  ],
  "database": "string",
  "collection": "string"
}'

リクエスト例

{
  "_id": "string",
  "roles": [
    {
      "_id": "string",
      "document_filters": {},
      "name": "string",
      "fields": {},
      "additional_fields": {}
    }
  ],
  "filters": [
    {
      "_id": "string",
      "name": "string",
      "query": {},
      "projection": {
        "additionalProperty1": 0,
        "additionalProperty2": 0
      }
    }
  ],
  "database": "string",
  "collection": "string"
}

{
  "name": "string",
  "actions": [
    "string"
  ],
  "when": {}
}

応答の例（201）

{
  "_id": "string",
  "name": "string"
}

ルールを作成する 非推奨

path パラメータ

body オブジェクト 必須

読み取り

書込み (write)

読み取り

書込み (write)

応答

ルールを作成する非推奨

body オブジェクト必須