Criar uma regra | Documentação da API de Administrador do MongoDB Atlas App Services Admin API 3.0

Criar uma regra Obsoleto(a)

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

tokenAuth

Crie uma regra de acesso aos dados.

parâmetros de caminho

groupId string Obrigatório

Uma ID de projeto/grupo do Atlas.
appId string Obrigatório

O ObjectID do seu aplicativo. A seção de ID de projeto e aplicativo do App Services API mostra como localizar esse valor.
serviceId string Obrigatório

O valor _id exclusivo de um serviço.

aplicação/json

corpo, corpo

objeto Obrigatório

A regra a ser criada.

Uma regra de acesso a dados que define roles de usuário e filtros de query para uma collection em uma fonte de dados vinculada.

_id string

O identificador ObjectId único da regra.
roles array[objeto]

Uma lista de funções de acesso a dados.
Ocultar atributos de roles Mostrar atributos de funções objeto
- _id string
  
  O identificador ObjectId exclusivo da função.
- document_filters objeto
  Ocultar atributos de document_filters Mostrar atributos de document_filters objeto
  
  ler
  
  Um dos seguintes:
  objeto-1 boolean-2
  
  Uma expressão de regra que avalia para true se o role pode ler o documento.
  
  Uma expressão de regra que avalia para true se o role pode ler o documento.
  
  escrever
  
  Um dos seguintes:
  objeto-1 boolean-2
  
  Uma expressão de regra que avalia para true se a função puder escrever no documento.
  
  Uma expressão de regra que avalia para true se a função puder escrever no documento.
- name string
  
  O nome da função.
- apply_when
  
  Um dos seguintes:
  objeto-1 boolean-2
  
  Uma expressão de regra que avalia para true quando esta função se aplica a um usuário para um documento específico.
  
  Uma expressão de regra que avalia para true quando esta função se aplica a um usuário para um documento específico.
- ler
  
  Um dos seguintes:
  objeto-1 boolean-2
  
  Uma expressão de regra que avalia como true se a função tiver permissão para ler todos os campos no documento. Se o Device Sync estiver ativado, use document_filters.read.
  
  Uma expressão de regra que avalia como true se a função tiver permissão para ler todos os campos no documento. Se o Device Sync estiver ativado, use document_filters.read.
- escrever
  
  Um dos seguintes:
  objeto-1 boolean-2
  
  Uma expressão de regra que é avaliada como true se a role tiver permissão para adicionar, modificar ou remover todos os campos no documento. Se o Device Sync estiver ativado, use document_filters.write.
  
  Uma expressão de regra que é avaliada como true se a role tiver permissão para adicionar, modificar ou remover todos os campos no documento. Se o Device Sync estiver ativado, use document_filters.write.
- insert
  
  Um dos seguintes:
  objeto-1 boolean-2
  
  Uma expressão de regra que avalia como true se a função tiver permissão para inserir um novo documento na coleção.
  
  Uma expressão de regra que avalia como true se a função tiver permissão para inserir um novo documento na coleção.
- excluir
  
  Um dos seguintes:
  objeto-1 boolean-2
  
  Uma expressão de regra que avalia como true se a função tiver permissão para excluir um documento da coleção.
  
  Uma expressão de regra que avalia como true se a função tiver permissão para excluir um documento da coleção.
- Pesquisar
  
  Um dos seguintes:
  objeto-1 boolean-2
  
  Uma expressão de regra que é avaliada como true se a função tiver permissão para pesquisar a coleção usando o Atlas Search.
  
  Uma expressão de regra que é avaliada como true se a função tiver permissão para pesquisar a coleção usando o Atlas Search.
- Campos objeto
  
  Regras de nível de campo para quaisquer campos que não estejam explicitamente configurados no properties da função.
- campos_adicionais objeto
  
  Regras de nível de campo para quaisquer campos que não estejam explicitamente configurados no properties da função.
  Ocultar atributos additional_fields Mostrar atributos additional_fields objeto
  
  ler
  
  Um dos seguintes:
  objeto-1 boolean-2
  
  Uma expressão de regra que avalia para true se o papel pode ler o valor do campo.
  
  Uma expressão de regra que avalia para true se o papel pode ler o valor do campo.
  
  escrever
  
  Um dos seguintes:
  objeto-1 boolean-2
  
  Uma expressão de regra que avalia para true se o papel pode escrever o valor do campo.
  
  Uma expressão de regra que avalia para true se o papel pode escrever o valor do campo.
filtros array[objeto]

Uma lista de filtros para operações de entrada.
Ocultar atributos de filtros Mostrar atributos de filtros objeto
- _id string
  
  O identificador ObjectId exclusivo do filtro.
- name string
  
  O nome do filtro.
- apply_when
  
  Um dos seguintes:
  objeto-1 boolean-2
  
  Uma expressão de regra que avalia para true se o filtro se aplica a uma consulta recebida.
  
  Uma expressão de regra que avalia para true se o filtro se aplica a uma consulta recebida.
- Query objeto
  
  Um objeto de query do MongoDB que é mesclado em uma query de entrada antes da execução da operação.
- projeção objeto
  
  Um objeto de projeção do MongoDB que é mesclado em uma query de entrada antes da execução da operação.
  Ocultar atributo de projeção Mostrar atributo de projeção objeto
  
  * número Propriedades adicionais
  
  Os valores são 0 ou 1.
database string Obrigatório

O nome de um banco de dados na fonte de dados vinculada.
collection string Obrigatório

O nome de uma collection no database especificado.

Respostas

201 aplicação/json

Criado com sucesso.
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- _id string
- name string
409

Já existe uma regra com o name fornecido.

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"
}'

Exemplos de solicitação

{
  "_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": {}
}

Exemplos de resposta (201)

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