기본 역할 및 필터 만들기 | MongoDB Atlas App Services Admin API 3.0 문서

기본 역할 및 필터 만들기 더 이상 사용되지 않습니다.

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

tokenAuth

데이터 소스에 대한 기본 역할 및 필터를 만듭니다.

경로 매개변수

groupId 문자열 필수 사항

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

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

서비스의 고유한 _id 값입니다.

application/json

body 필수 사항

기본 규칙 구성 객체입니다.

roles 배열[객체]

기본 사용자 역할의 정렬된 목록입니다.
역할 속성 숨기기 역할 속성 표시 객체
- document_filters 객체
  document_filters 속성 숨기기 document_filters 속성 표시 객체
  
  읽기
  
  다음 중 하나입니다.
  객체-1 부울-2
  
  역할 문서 읽을 수 있는 경우 true 로 평가되는 규칙 표현식 입니다.
  
  역할 문서 읽을 수 있는 경우 true 로 평가되는 규칙 표현식 입니다.
  
  쓰기
  
  다음 중 하나입니다.
  객체-1 부울-2
  
  역할 문서 에 쓰기 (write) 수 있는 경우 true 로 평가되는 규칙 표현식 입니다.
  
  역할 문서 에 쓰기 (write) 수 있는 경우 true 로 평가되는 규칙 표현식 입니다.
- 이름 문자열
  
  역할의 이름입니다.
- apply_when
  
  다음 중 하나입니다.
  객체-1 부울-2
  
  특정 문서 의 사용자에게 이 역할 적용될 때 true 로 평가되는 규칙 표현식 입니다.
  
  특정 문서 의 사용자에게 이 역할 적용될 때 true 로 평가되는 규칙 표현식 입니다.
- 읽기
  
  다음 중 하나입니다.
  객체-1 부울-2
  
  역할 에 문서 의 모든 필드를 읽을 수 있는 권한이 있는 경우 true 로 평가되는 규칙 표현식 입니다. Device Sync 활성화된 경우 document_filters.read을 대신 사용합니다.
  
  역할 에 문서 의 모든 필드를 읽을 수 있는 권한이 있는 경우 true 로 평가되는 규칙 표현식 입니다. Device Sync 활성화된 경우 document_filters.read을 대신 사용합니다.
- 쓰기
  
  다음 중 하나입니다.
  객체-1 부울-2
  
  역할 에 문서 의 모든 필드를 추가, 수정 또는 제거 수 있는 권한이 있는 경우 true 로 평가되는 규칙 표현식 입니다. Device Sync 활성화된 경우 document_filters.write을 대신 사용합니다.
  
  역할 에 문서 의 모든 필드를 추가, 수정 또는 제거 수 있는 권한이 있는 경우 true 로 평가되는 규칙 표현식 입니다. Device Sync 활성화된 경우 document_filters.write을 대신 사용합니다.
- insert
  
  다음 중 하나입니다.
  객체-1 부울-2
  
  역할 에 새 문서 컬렉션 에 삽입할 수 있는 권한이 있는 경우 true 로 평가되는 규칙 표현식 입니다.
  
  역할 에 새 문서 컬렉션 에 삽입할 수 있는 권한이 있는 경우 true 로 평가되는 규칙 표현식 입니다.
- 삭제
  
  다음 중 하나입니다.
  객체-1 부울-2
  
  역할 에 컬렉션 에서 문서 삭제 수 있는 권한이 있는 경우 true 로 평가되는 규칙 표현식 입니다.
  
  역할 에 컬렉션 에서 문서 삭제 수 있는 권한이 있는 경우 true 로 평가되는 규칙 표현식 입니다.
- 검색
  
  다음 중 하나입니다.
  객체-1 부울-2
  
  역할 에 Atlas Search 사용하여 컬렉션 검색 할 수 있는 권한이 있는 경우 true(으)로 평가되는 규칙 표현식 입니다.
  
  역할 에 Atlas Search 사용하여 컬렉션 검색 할 수 있는 권한이 있는 경우 true(으)로 평가되는 규칙 표현식 입니다.
- 필드 객체
  
  역할의 properties에 명시적으로 구성되지 않은 모든 필드에 대한 필드 수준 규칙입니다.
- additional_fields 객체
  
  역할의 properties에 명시적으로 구성되지 않은 모든 필드에 대한 필드 수준 규칙입니다.
  additional_fields 속성 숨기기 additional_fields 속성 표시 객체
  
  읽기
  
  다음 중 하나입니다.
  객체-1 부울-2
  
  역할 이 필드 값을 읽을 수 있는 경우 true로 평가되는 규칙 표현식 입니다.
  
  역할 이 필드 값을 읽을 수 있는 경우 true로 평가되는 규칙 표현식 입니다.
  
  쓰기
  
  다음 중 하나입니다.
  객체-1 부울-2
  
  역할 이 필드 값을 쓰기 (write) 수 있는 경우 true로 평가되는 규칙 표현식 입니다.
  
  역할 이 필드 값을 쓰기 (write) 수 있는 경우 true로 평가되는 규칙 표현식 입니다.
필터 배열[객체]

기본 쿼리 필터 목록입니다.
필터 속성 숨기기 필터 속성 표시 객체
들어오는 쿼리 작업을 실행 전에 조건부로 수정하는 필터하다 입니다.
- 이름 문자열
  
  필터의 이름입니다.
- apply_when
  
  다음 중 하나입니다.
  객체-1 부울-2
  
  필터하다 수신 쿼리 에 적용되는 경우 true 로 평가되는 규칙 표현식 입니다.
  
  필터하다 수신 쿼리 에 적용되는 경우 true 로 평가되는 규칙 표현식 입니다.
- 쿼리 객체
  
  작업이 실행되기 전에 들어오는 쿼리 에 병합되는 MongoDB 쿼리 객체 입니다.
- 프로젝션 객체
  
  작업이 실행되기 전에 들어오는 쿼리 에 병합되는 MongoDB 프로젝션 객체 .
  프로젝션 속성 숨기기 프로젝션 속성 표시 객체
  
  * 숫자 additionalProperties
  
  값은 0 또는 1입니다.

응답

201 application/json

기본 규칙이 생성되었습니다.
응답 속성 숨기기 응답 속성 표시 객체
- _id 문자열
  
  기본 규칙의 고유 ObjectId 식별자입니다.
- roles 배열[객체]
  
  기본 사용자 역할의 정렬된 목록입니다.
  
  역할 속성 숨기기 역할 속성 표시 객체
  
  _id 문자열
  
  역할의 고유한 ObjectId 식별자입니다.
  
  document_filters 객체
  
  document_filters 속성 숨기기 document_filters 속성 표시 객체
  
  읽기
  
  다음 중 하나입니다.
  객체-1 부울-2
  
  역할 문서 읽을 수 있는 경우 true 로 평가되는 규칙 표현식 입니다.
  
  역할 문서 읽을 수 있는 경우 true 로 평가되는 규칙 표현식 입니다.
  
  쓰기
  
  다음 중 하나입니다.
  객체-1 부울-2
  
  역할 문서 에 쓰기 (write) 수 있는 경우 true 로 평가되는 규칙 표현식 입니다.
  
  역할 문서 에 쓰기 (write) 수 있는 경우 true 로 평가되는 규칙 표현식 입니다.
  
  이름 문자열
  
  역할의 이름입니다.
  
  apply_when
  
  다음 중 하나입니다.
  객체-1 부울-2
  
  특정 문서 의 사용자에게 이 역할 적용될 때 true 로 평가되는 규칙 표현식 입니다.
  
  특정 문서 의 사용자에게 이 역할 적용될 때 true 로 평가되는 규칙 표현식 입니다.
  
  읽기
  
  다음 중 하나입니다.
  객체-1 부울-2
  
  역할 에 문서 의 모든 필드를 읽을 수 있는 권한이 있는 경우 true 로 평가되는 규칙 표현식 입니다. Device Sync 활성화된 경우 document_filters.read을 대신 사용합니다.
  
  역할 에 문서 의 모든 필드를 읽을 수 있는 권한이 있는 경우 true 로 평가되는 규칙 표현식 입니다. Device Sync 활성화된 경우 document_filters.read을 대신 사용합니다.
  
  쓰기
  
  다음 중 하나입니다.
  객체-1 부울-2
  
  역할 에 문서 의 모든 필드를 추가, 수정 또는 제거 수 있는 권한이 있는 경우 true 로 평가되는 규칙 표현식 입니다. Device Sync 활성화된 경우 document_filters.write을 대신 사용합니다.
  
  역할 에 문서 의 모든 필드를 추가, 수정 또는 제거 수 있는 권한이 있는 경우 true 로 평가되는 규칙 표현식 입니다. Device Sync 활성화된 경우 document_filters.write을 대신 사용합니다.
  
  insert
  
  다음 중 하나입니다.
  객체-1 부울-2
  
  역할 에 새 문서 컬렉션 에 삽입할 수 있는 권한이 있는 경우 true 로 평가되는 규칙 표현식 입니다.
  
  역할 에 새 문서 컬렉션 에 삽입할 수 있는 권한이 있는 경우 true 로 평가되는 규칙 표현식 입니다.
  
  삭제
  
  다음 중 하나입니다.
  객체-1 부울-2
  
  역할 에 컬렉션 에서 문서 삭제 수 있는 권한이 있는 경우 true 로 평가되는 규칙 표현식 입니다.
  
  역할 에 컬렉션 에서 문서 삭제 수 있는 권한이 있는 경우 true 로 평가되는 규칙 표현식 입니다.
  
  검색
  
  다음 중 하나입니다.
  객체-1 부울-2
  
  역할 에 Atlas Search 사용하여 컬렉션 검색 할 수 있는 권한이 있는 경우 true(으)로 평가되는 규칙 표현식 입니다.
  
  역할 에 Atlas Search 사용하여 컬렉션 검색 할 수 있는 권한이 있는 경우 true(으)로 평가되는 규칙 표현식 입니다.
  
  필드 객체
  
  역할의 properties에 명시적으로 구성되지 않은 모든 필드에 대한 필드 수준 규칙입니다.
  
  additional_fields 객체
  
  역할의 properties에 명시적으로 구성되지 않은 모든 필드에 대한 필드 수준 규칙입니다.
  
  additional_fields 속성 숨기기 additional_fields 속성 표시 객체
  
  읽기
  
  다음 중 하나입니다.
  객체-1 부울-2
  
  역할 이 필드 값을 읽을 수 있는 경우 true로 평가되는 규칙 표현식 입니다.
  
  역할 이 필드 값을 읽을 수 있는 경우 true로 평가되는 규칙 표현식 입니다.
  
  쓰기
  
  다음 중 하나입니다.
  객체-1 부울-2
  
  역할 이 필드 값을 쓰기 (write) 수 있는 경우 true로 평가되는 규칙 표현식 입니다.
  
  역할 이 필드 값을 쓰기 (write) 수 있는 경우 true로 평가되는 규칙 표현식 입니다.
- 필터 배열[객체]
  
  기본 쿼리 필터 목록입니다.
  
  필터 속성 숨기기 필터 속성 표시 객체
  
  _id 문자열
  
  필터의 고유한 ObjectId 식별자입니다.
  
  이름 문자열
  
  필터의 이름입니다.
  
  apply_when
  
  다음 중 하나입니다.
  객체-1 부울-2
  
  필터하다 수신 쿼리 에 적용되는 경우 true 로 평가되는 규칙 표현식 입니다.
  
  필터하다 수신 쿼리 에 적용되는 경우 true 로 평가되는 규칙 표현식 입니다.
  
  쿼리 객체
  
  작업이 실행되기 전에 들어오는 쿼리 에 병합되는 MongoDB 쿼리 객체 입니다.
  
  프로젝션 객체
  
  작업이 실행되기 전에 들어오는 쿼리 에 병합되는 MongoDB 프로젝션 객체 .
  
  프로젝션 속성 숨기기 프로젝션 속성 표시 객체
  
  * 숫자 additionalProperties
  
  값은 0 또는 1입니다.
400 application/json

기본 규칙이 이미 존재합니다.
응답 속성 숨기기 응답 속성 표시 객체
- 오류 문자열
  
  값은 default rule already exists입니다.

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

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

요청 예시

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

응답 예시(201)

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

응답 예시(400)

{
  "error": "default rule already exists"
}