Criar roles e filtros padrão Obsoleto(a)

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

Crie roles e filtros padrão para uma fonte de dados.

parâmetros de caminho

aplicação/json

corpo, corpo Obrigatório

Um objeto de configuração de regra padrão.

  • roles array[objeto]

    Uma lista ordenada de funções de usuário padrão.

    Ocultar atributos de função Mostrar atributos de funções objeto
    • document_filters objeto
      Ocultar atributos de document_filters Mostrar atributos de document_filters objeto
      • ler
        Um dos seguintes:

        Uma expressão de regra que avalia como true se a função puder ler o documento.

        Uma expressão de regra que avalia como true se a função puder ler o documento.

      • escrever
        Um dos seguintes:

        Uma expressão de regra que resulta em true se a função puder gravar no documento.

        Uma expressão de regra que resulta em true se a função puder gravar no documento.

    • name string

      O nome da função.

    • apply_when
      Um dos seguintes:

      Uma expressão de regra que avalia como true quando esta função se aplica a um usuário para um documento específico.

      Uma expressão de regra que avalia como true quando esta função se aplica a um usuário para um documento específico.

    • ler
      Um dos seguintes:

      Uma expressão de regra que é avaliada 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 em vez disso.

      Uma expressão de regra que é avaliada 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 em vez disso.

    • escrever
      Um dos seguintes:

      Uma expressão de regra que resulta em true se a função tiver permissão para adicionar, modificar ou remover todos os campos no documento. Se o Device Sync estiver ativado, use document_filters.write em vez disso.

      Uma expressão de regra que resulta em true se a função tiver permissão para adicionar, modificar ou remover todos os campos no documento. Se o Device Sync estiver ativado, use document_filters.write em vez disso.

    • insert
      Um dos seguintes:

      Uma expressão de regra que avalia para true se a função tiver permissão para inserir um novo documento na coleção.

      Uma expressão de regra que avalia para true se a função tiver permissão para inserir um novo documento na coleção.

    • excluir
      Um dos seguintes:

      Uma expressão de regra que avalia para true se a função tiver permissão para excluir um documento da coleção.

      Uma expressão de regra que avalia para true se a função tiver permissão para excluir um documento da coleção.

    • Campos objeto

      Regras de nível de campo para campos que não estão explicitamente configurados na properties da função.

    • campos_adicionais objeto

      Regras de nível de campo para campos que não estão explicitamente configurados na properties da função.

      Ocultar atributos additional_fields Mostrar atributos additional_fields objeto
      • ler
        Um dos seguintes:

        Uma expressão de regra que é avaliada como true se a função puder ler o valor do campo.

        Uma expressão de regra que é avaliada como true se a função puder ler o valor do campo.

      • escrever
        Um dos seguintes:

        Uma expressão de regra que retorna true se a função puder gravar o valor do campo.

        Uma expressão de regra que retorna true se a função puder gravar o valor do campo.

  • filtros array[objeto]

    Uma lista de filtros de queries padrão.

    Ocultar atributos de filtros Mostrar atributos de filtros objeto

    Um filtro que modifica condicionalmente as operações de query de entrada antes de serem executadas.

    • name string

      O nome do filtro.

    • apply_when
      Um dos seguintes:

      Uma expressão de regra que avalia como true se o filtro aplicar a uma query de entrada.

      Uma expressão de regra que avalia como true se o filtro aplicar a uma query de entrada.

    • Query objeto

      Um objeto de query MongoDB que é mesclado em uma query de entrada antes que a operação seja executada.

    • projeção objeto

      Um objeto de projeção do MongoDB que é mesclado em uma query de entrada antes da operação executar.

      Ocultar atributo de projeção Mostrar atributo de projeção objeto
      • * número Propriedades adicionais

        Os valores são 0 ou 1.

Respostas

  • 201 aplicação/json

    Regra padrão criada.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • _id string

      O identificador ObjectId exclusivo da regra padrão.

    • roles array[objeto]

      Uma lista ordenada de funções de usuário padrão.

      Ocultar atributos de função 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:

          Uma expressão de regra que avalia como true se a função puder ler o documento.

          Uma expressão de regra que avalia como true se a função puder ler o documento.

        • escrever
          Um dos seguintes:

          Uma expressão de regra que resulta em true se a função puder gravar no documento.

          Uma expressão de regra que resulta em true se a função puder gravar no documento.

      • name string

        O nome da função.

      • apply_when
        Um dos seguintes:

        Uma expressão de regra que avalia como true quando esta função se aplica a um usuário para um documento específico.

        Uma expressão de regra que avalia como true quando esta função se aplica a um usuário para um documento específico.

      • ler
        Um dos seguintes:

        Uma expressão de regra que é avaliada 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 em vez disso.

        Uma expressão de regra que é avaliada 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 em vez disso.

      • escrever
        Um dos seguintes:

        Uma expressão de regra que resulta em true se a função tiver permissão para adicionar, modificar ou remover todos os campos no documento. Se o Device Sync estiver ativado, use document_filters.write em vez disso.

        Uma expressão de regra que resulta em true se a função tiver permissão para adicionar, modificar ou remover todos os campos no documento. Se o Device Sync estiver ativado, use document_filters.write em vez disso.

      • insert
        Um dos seguintes:

        Uma expressão de regra que avalia para true se a função tiver permissão para inserir um novo documento na coleção.

        Uma expressão de regra que avalia para true se a função tiver permissão para inserir um novo documento na coleção.

      • excluir
        Um dos seguintes:

        Uma expressão de regra que avalia para true se a função tiver permissão para excluir um documento da coleção.

        Uma expressão de regra que avalia para true se a função tiver permissão para excluir um documento da coleção.

      • Campos objeto

        Regras de nível de campo para campos que não estão explicitamente configurados na properties da função.

      • campos_adicionais objeto

        Regras de nível de campo para campos que não estão explicitamente configurados na properties da função.

        Ocultar atributos additional_fields Mostrar atributos additional_fields objeto
        • ler
          Um dos seguintes:

          Uma expressão de regra que é avaliada como true se a função puder ler o valor do campo.

          Uma expressão de regra que é avaliada como true se a função puder ler o valor do campo.

        • escrever
          Um dos seguintes:

          Uma expressão de regra que retorna true se a função puder gravar o valor do campo.

          Uma expressão de regra que retorna true se a função puder gravar o valor do campo.

    • filtros array[objeto]

      Uma lista de filtros de queries padrão.

      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:

        Uma expressão de regra que avalia como true se o filtro aplicar a uma query de entrada.

        Uma expressão de regra que avalia como true se o filtro aplicar a uma query de entrada.

      • Query objeto

        Um objeto de query MongoDB que é mesclado em uma query de entrada antes que a operação seja executada.

      • projeção objeto

        Um objeto de projeção do MongoDB que é mesclado em uma query de entrada antes da operação executar.

        Ocultar atributo de projeção Mostrar atributo de projeção objeto
        • * número Propriedades adicionais

          Os valores são 0 ou 1.

  • 400 aplicação/json

    A regra padrão já existe.

    Ocultar atributo de resposta Mostrar atributo de resposta objeto
    • Erro string

      O valor é 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
      }
    }
  ]
}'
Exemplos de solicitação
{
  "roles": [
    {
      "document_filters": {},
      "name": "string",
      "fields": {},
      "additional_fields": {}
    }
  ],
  "filters": [
    {
      "name": "string",
      "query": {},
      "projection": {
        "additionalProperty1": 0,
        "additionalProperty2": 0
      }
    }
  ]
}
Exemplos de resposta (201)
{
  "_id": "string",
  "roles": [
    {
      "_id": "string",
      "document_filters": {},
      "name": "string",
      "fields": {},
      "additional_fields": {}
    }
  ],
  "filters": [
    {
      "_id": "string",
      "name": "string",
      "query": {},
      "projection": {
        "additionalProperty1": 0,
        "additionalProperty2": 0
      }
    }
  ]
}
Exemplos de resposta (400)
{
  "error": "default rule already exists"
}