데이터 API 구성 가져오기 | MongoDB Atlas App Services Admin API 3.0 문서

데이터 API 구성 가져오기 더 이상 사용되지 않습니다.

얻다 /groups/{groupId}/apps/{appId}/data_api/config

tokenAuth

앱의 데이터 API 구성을 가져옵니다.

경로 매개변수

groupId 문자열 필수 사항

Atlas 프로젝트/그룹 ID입니다.
appId 문자열 필수 사항

애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.

응답

200 application/json

확인
응답 속성 숨기기 응답 속성 표시 객체 | null
- 비활성화 부울 필수 사항
- versions array[string] 필수 사항
  
  데이터 API 의 지원되는 버전입니다.
  
  값은 v1입니다.
- return_type 문자열 필수 사항
  
  데이터 API 및 사용자 지정 엔드포인트에서 지원하는 데이터 형식입니다.
  
  값은 JSON 또는 EJSON입니다.
- create_user_on_auth 부울
- run_as_user_id 문자열
  
  애플리케이션 사용자의 계정 ID. 정의된 경우 엔드포인트는 항상 지정된 사용자로 실행됩니다.
- run_as_user_id_script_source 문자열
  
  애플리케이션 사용자의 계정 ID를 반환하는 함수에 대한 문자열화된 소스 코드입니다. 정의된 경우 엔드포인트는 모든 요청에서 함수를 실행하고 함수에서 반환된 ID를 가진 사용자로 실행됩니다.
- validation_method 문자열 필수 사항
  
  값은 NO_VALIDATION, SECRET_AS_QUERY_PARAM 또는 VERIFY_PAYLOAD입니다.
- secret_name 문자열
  
  validation_method가 "SECRET_AS_QUERY_PARAM" 또는 "VERIFY_PAYLOAD"로 설정된 경우 요청을 승인하는 시크릿의 name 니다.
- can_evaluate 객체
  
  수신 요청에 대한 응답으로 엔드포인트의 실행이 허용되는 경우 true로 평가되는 JSON 표현식입니다.

GET /groups/{groupId}/apps/{appId}/data_api/config

curl \
 --request GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/data_api/config' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

응답 예시(200)

{
  "disabled": true,
  "versions": [
    "v1"
  ],
  "return_type": "JSON",
  "create_user_on_auth": true,
  "run_as_user_id": "string",
  "run_as_user_id_script_source": "string",
  "validation_method": "NO_VALIDATION",
  "secret_name": "string",
  "can_evaluate": {}
}