Actualiza una regla | MongoDB Atlas App Services Admin API 3.0 documentation

Actualiza una regla Obsoleto

PUT /grupos/{groupId}/aplicaciones/{appId}/servicios/{serviceId}/reglas/{ruleId}

Token auth

Update a data access rule.

Parámetros de path

ID del grupo string Requerido

An Atlas Project/Group ID.
appId string Requerido

El ObjectID de tu aplicación. La sección de ID de Proyecto y ID de la aplicación de App Services API muestra cómo encontrar este valor.
serviceId string Requerido

The unique _id value of a service.
ruleId string Requerido

El valor único _id de una regla.

application/json

Cuerpo Objeto Requerido

The new state of the rule.

A data access rule that defines user roles and query filters for a collection in a linked data source.

_id string

The rule's unique ObjectId identifier.
Roles arreglo[objeto]

A list of data access roles.
Hide roles attributes Mostrar atributos de roles Objeto
- _id string
  
  The role's unique ObjectId identifier.
- document_filters Objeto
  Hide document_filters attributes Mostrar atributos document_filters Objeto
  
  Lea
  
  Uno de los siguientes:
  objeto-1 booleano-2
  
  Una expresión de regla que evalúa a true si el rol puede leer el documento.
  
  Una expresión de regla que evalúa a true si el rol puede leer el documento.
  
  guardar
  
  Uno de los siguientes:
  objeto-1 booleano-2
  
  Una expresión de regla que se evalúa como true si el rol puede guardar en el documento.
  
  Una expresión de regla que se evalúa como true si el rol puede guardar en el documento.
- Nombre string
  
  El nombre del rol.
- apply_when
  
  Uno de los siguientes:
  objeto-1 booleano-2
  
  Una expresión de regla que se evalúa como true cuando este rol se aplica a un usuario para un documento específico.
  
  Una expresión de regla que se evalúa como true cuando este rol se aplica a un usuario para un documento específico.
- Lea
  
  Uno de los siguientes:
  objeto-1 booleano-2
  
  Una expresión de regla que evalúa como true si el rol tiene permiso para leer todos los campos del documento. Si Device Sync está habilitado, utilice document_filters.read en su lugar.
  
  Una expresión de regla que evalúa como true si el rol tiene permiso para leer todos los campos del documento. Si Device Sync está habilitado, utilice document_filters.read en su lugar.
- guardar
  
  Uno de los siguientes:
  objeto-1 booleano-2
  
  Una expresión de regla que se evalúa como true si el rol tiene permiso para agregar, modificar o remover todos los campos del documento. Si Device Sync está habilitado, utilice document_filters.write en su lugar.
  
  Una expresión de regla que se evalúa como true si el rol tiene permiso para agregar, modificar o remover todos los campos del documento. Si Device Sync está habilitado, utilice document_filters.write en su lugar.
- insert
  
  Uno de los siguientes:
  objeto-1 booleano-2
  
  Una Expresión de regla que evalúa a true si el rol tiene permiso para insertar un nuevo documento en la colección.
  
  Una Expresión de regla que evalúa a true si el rol tiene permiso para insertar un nuevo documento en la colección.
- borrar
  
  Uno de los siguientes:
  objeto-1 booleano-2
  
  Una expresión de regla que evalúa a true si el rol tiene permiso para borrar un documento de la colección.
  
  Una expresión de regla que evalúa a true si el rol tiene permiso para borrar un documento de la colección.
- Search
  
  Uno de los siguientes:
  objeto-1 booleano-2
  
  Una expresión de regla que evalúa a true si el rol tiene permiso para buscar la colección utilizando Atlas Search.
  
  Una expresión de regla que evalúa a true si el rol tiene permiso para buscar la colección utilizando Atlas Search.
- Campos Objeto
  
  Reglas de nivel de campo para cualquier campo que no esté configurado explícitamente en el properties del rol.
- additional_fields Objeto
  
  Reglas de nivel de campo para cualquier campo que no esté configurado explícitamente en el properties del rol.
  Ocultar atributos de additional_fields Show additional_fields attributes Objeto
  
  Lea
  
  Uno de los siguientes:
  objeto-1 booleano-2
  
  Una expresión de regla que se evalúa como true si el rol puede leer el valor del campo.
  
  Una expresión de regla que se evalúa como true si el rol puede leer el valor del campo.
  
  guardar
  
  Uno de los siguientes:
  objeto-1 booleano-2
  
  Una Expresión de regla que se evalúa como true si el rol puede guardar el valor del campo.
  
  Una Expresión de regla que se evalúa como true si el rol puede guardar el valor del campo.
filtro arreglo[objeto]

Una lista de filtros para operaciones entrantes.
Ocultar atributos de los filtros Mostrar atributos de filtros Objeto
- _id string
  
  El identificador único del filtro ObjectId.
- Nombre string
  
  The filter's name.
- apply_when
  
  Uno de los siguientes:
  objeto-1 booleano-2
  
  Una expresión de regla que se evalúa como true si el filtro se aplica a una query entrante.
  
  Una expresión de regla que se evalúa como true si el filtro se aplica a una query entrante.
- Consulta Objeto
  
  Un objeto de query de MongoDB que se fusiona en una query entrante antes de que se ejecute la operación.
- proyección Objeto
  
  Un objeto de proyección de MongoDB que se fusiona en una query entrante antes de que se ejecute la operación.
  Ocultar el atributo de proyección Mostrar atributo de proyección Objeto
  
  * Número Propiedades adicionales
  
  Los valores son 0 o 1.
database string Requerido

El nombre de una base de datos en la fuente de datos vinculada.
Colección string Requerido

El nombre de una colección en el database especificado.

Respuestas

200

Successfully updated.

PUT /groups/{groupId}/apps/{appId}/services/{serviceId}/rules/{ruleId}

curl \
 --request PUT 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/services/{serviceId}/rules/{ruleId}' \
 --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"
}'

Solicitar ejemplos

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

Actualiza una regla Obsoleto

Parámetros de path

Cuerpo Objeto Requerido

Lea

guardar

Lea

guardar

Respuestas