HTTPS 엔드포인트 구성 파일

Atlas Device Sync, Atlas Edge Server, Data API 및 HTTPS endpoints 는 더 이상 사용되지 않습니다. 자세한 내용은 지원 중단 페이지를 참조하세요.

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

사용자 지정 HTTPS 엔드포인트 구성

앱의 모든 HTTPS endpoints 에 대한 구성을 https_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 메서드 의 유형 엔드포인트가 처리합니다. 단일 엔드포인트로 모든 메서드를 처리하다 하려면 `` 를 지정합니다. 다음 중 하나입니다. `"GET"` `"POST"` `"PUT"` `"PATCH"` `"DELETE"` `"DELETE"` `""`
`function_name` `string`	엔드포인트와 연결된 함수 의 이름입니다. 함수는 엔드포인트 함수 서명을 사용해야 합니다.
`validation_method` `string`	들어오는 요청의 유효성을 검사하는 데 사용되는 엔드포인트 권한 부여 체계 입니다. 다음 중 하나입니다. `"SECRET_AS_QUERY_PARAM"` `"VERIFY_PAYLOAD"` `"NO_VALIDATION"`
`secret_name` `string`	문자열이 포함된 시크릿 의 이름입니다. `validation_method` 로 설정된 경우 `SECRET_AS_QUERY_PARAM` 또는 `VERIFY_PAYLOAD` 이 시크릿이 요청을 승인하는 데 사용됩니다.
`respond_result` `boolean`	`true` 인 경우 엔드포인트가 사용자 지정 가능한 HTTP 응답을 클라이언트에 반환합니다. Response 객체에서 메서드를 호출하여 응답을 구성합니다. 응답을 구성하지 않으면 엔드포인트는 요청 본문인 endpont 함수에서 반환된 값을 사용하여 `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 구성

https_endpoints/data_api_config.json 에서 앱에서 생성된 데이터 API 엔드포인트 에 대한 구성을 정의합니다.

{
  "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[]`	앱이 지원하는 데이터 API 버전 목록입니다. 목록에는 가능한 모든 버전의 하위 집합이 포함될 수 있지만 버전은 오름차순으로 나열해야 합니다. 가장 최근 버전 이외의 버전을 활성화할 수는 없지만 여기에 나열된 이전에 활성화한 버전은 계속 작동합니다. 사용 가능한 버전: `"v1"`
`return_type` `string`	HTTPS 응답 본문에서 엔드포인트가 반환한 데이터에 사용할 데이터 형식입니다. 다음 중 하나입니다. `"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`와 함께 사용할 수 없습니다.

돌아가기

정적 호스팅

로그 전달자