HTTPS endpoints 構成ファイル

Atlas App Services はサポート終了のステータスに達し、 MongoDBでアクティブにサポートされなくなりました。Atlas UIでは引き続き trigger を利用できます。詳細については、の廃止ページを参照してください。

app/
└── https_endpoints/
    ├── config.json
    └── data_api_config.json

カスタム HTTPS エンドポイント構成

アプリのすべてのカスタムの構成を HTTPS endpoints{2https_endpoints/config.json の配列として定義します。

[
  {
    "route": "<Endpoint Route Name>",
    "http_method": "<HTTP method>",
    "function_name": "<Endpoint function name",
    "validation_method": "<Authorization scheme>",
    "secret_name": "<Validation Secret Name>",
    "respond_result": <boolean>,
    "fetch_custom_user_data": <boolean>,
    "create_user_on_auth": <boolean>,
    "disabled": <boolean>
  }
]

フィールド	説明
`route` `string`	エンドポイントルート。
`http_method` `string`	エンドポイントが取り扱うHTTPメソッドのタイプ。エンドポイントが 1 つのすべてのメソッドを処理するには、`` を指定します。次の 1 つ： `"GET"` `"POST"` `"PUT"` `"PATCH"` `"DELETE"` `"DELETE"` `""`
`function_name` `string`	エンドポイントに関連付けられている関数の名前。関数はエンドポイント関数署名を使用する必要があります。
`validation_method` `string`	受信リクエストを検証するために使用されるエンドポイント認可スキーム。次の 1 つ： `"SECRET_AS_QUERY_PARAM"` `"VERIFY_PAYLOAD"` `"NO_VALIDATION"`
`secret_name` `string`	string を含むシークレットの名前。 `validation_method`が`SECRET_AS_QUERY_PARAM`または`VERIFY_PAYLOAD`に設定されている場合、このシークレットはリクエストを承認するために使用されます。
`respond_result` `boolean`	`true`の場合、エンドポイントはクライアントにカスタマイズ可能な HTTP レスポンスを返します。 Responseオブジェクトのメソッドを呼び出すことで、応答を構成します。レスポンスを設定しない場合、エンドポイントはエンドポイント関数から返された値をリクエスト本文として持つ`200 - Ok`レスポンスを返します。 `false`の場合、リクエストは本体にデータを含まない`204 - No Content`応答を返します。
`fetch_custom_user_data` `boolean`	`true`の場合、認証されたユーザーのカスタムユーザーデータドキュメントは`context.user.custom_data`経由で利用できます。 `false`の場合、ユーザーのカスタムデータはクエリされず、 `context.user.custom_data`は空のオブジェクトです。
`create_user_on_auth` `boolean`	`true`の場合、提供されたユーザー認証情報が正常に認証され、かつ既存のユーザーに関連付けられていない場合には、アプリは新しいユーザーを自動的に作成します。この設定は、カスタムJSON web token認証プロバイダーを介して外部認証システムと統合するアプリに便利です。リクエストに、登録されているユーザーに対応していない外部システムからの有効なJSON web tokenが含まれている場合、 JSON web tokenを ID として持つ新しいユーザーが作成されます。
`disabled` `boolean`	エンドポイントを有効にする（ `false` ）または無効にする（ `true` ）。

データ API 構成

アプリで生成されたデータ API エンドポイントの構成をhttps_endpoints/data_api_config.jsonで定義します。

{
  "disabled": <boolean>,
  "versions": ["v1"],
  "return_type": "EJSON" | "JSON",
  "create_user_on_auth": <boolean>,
  "run_as_system": <boolean>,
  "run_as_user_id": "<User Account ID>",
  "run_as_user_id_script_source": "<Function Source Code>"
}

フィールド	説明
`disabled` `boolean`	`false`の場合、データ API は有効になっていません。生成されたエンドポイントは、リクエストを処理したり応答したりしません。
`versions` `string[]`	アプリがサポートする Data API バージョンのリスト。リストには可能なすべてのバージョンのサブセットを含めることができますが、バージョンは昇順で一覧表示する必要があります。最新バージョン以外のバージョンを有効にすることはできませんが、ここにリストされている以前に有効になっているバージョンは引き続き機能します。利用可能なバージョン: `"v1"`
`return_type` `string`	HTTPS レスポンスボディのエンドポイントによって返されるデータに使用するデータ形式。次の 1 つ： `"EJSON"` `"JSON"`
`create_user_on_auth` `boolean`	`true`の場合、提供されたユーザー認証情報が正常に認証され、かつ既存のユーザーに関連付けられていない場合には、アプリは新しいユーザーを自動的に作成します。この設定は、カスタムJSON web token認証プロバイダーを介して外部認証システムと統合するアプリに便利です。リクエストに、登録されているユーザーに対応していない外部システムからの有効なJSON web tokenが含まれている場合、 JSON web tokenを ID として持つ新しいユーザーが作成されます。
`run_as_user_id` `string`	アプリケーションユーザーのアカウントID。定義されている場合、エンドポイントは常に指定されたユーザーとして実行されます。 `run_as_user_id_script_source` とは併用できません。
`run_as_user_id_script_source` `string`	アプリケーションユーザーのアカウント ID を返す関数の文字列化されたソースコード。定義されている場合、エンドポイントはリクエストごとに関数を実行し、関数から返された ID を持つユーザーとして実行されます。 `run_as_user_id` とは併用できません。

戻る

静的ホスティング

ログフォワーダー