Path parameters

• groupId string Required

  An Atlas Project/Group ID.

• appId string Required

  The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

• serviceId string Required

  The unique _id value of a service.

• ruleId string Required

  The unique _id value of a rule.

Responses

• 200 application/json

  Successfully retrieved.

  One of:

  RuleConstructor object ThirdPartyServiceRule object

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

  Hide attributes Show attributes

  • _id string

    The rule's unique ObjectId identifier.

  • roles array[object]

    A list of data access roles.

    Hide roles attributes Show roles attributes object

    • _id string

      The role's unique ObjectId identifier.

    • document_filters object
      Hide document_filters attributes Show document_filters attributes object

      • read object | boolean Required

        A rule expression.

        One of:

        Expression object Expression boolean

      • write object | boolean Required

        A rule expression.

        One of:

        Expression object Expression boolean
    • name string

      The role's name.

    • apply_when object | boolean

      A rule expression.

      One of:

      Expression object Expression boolean

    • read object | boolean

      A rule expression.

      One of:

      Expression object Expression boolean

    • write object | boolean

      A rule expression.

      One of:

      Expression object Expression boolean

    • insert object | boolean

      A rule expression.

      One of:

      Expression object Expression boolean

    • delete object | boolean

      A rule expression.

      One of:

      Expression object Expression boolean

    • search object | boolean

      A rule expression.

      One of:

      Expression object Expression boolean
    • fields object

      An object that maps document field names to read and write permissions for the field and its children.

    • additional_fields object

      Read and write permissions for a field.

      Hide additional_fields attributes Show additional_fields attributes object

      • read object | boolean Required

        A rule expression.

        One of:

        Expression object Expression boolean

      • write object | boolean Required

        A rule expression.

        One of:

        Expression object Expression boolean
  • filters array[object]

    A list of filters for incoming operations.

    Hide filters attributes Show filters attributes object

    • _id string

      The filter's unique ObjectId identifier.

    • name string

      The filter's name.

    • apply_when object | boolean

      A rule expression.

      One of:

      Expression object Expression boolean
    • query object

      A MongoDB query object.

    • projection object

      A MongoDB projection object.

      Hide projection attribute Show projection attribute object

      • * number Additional properties

        Values are 0 or 1.

  • database string Required

    The name of a database in the linked data source.

  • collection string Required

    The name of a collection in the specified database.

  [Deprecated] A rule for a third-party service.

  Hide attributes Show attributes

  • name string Required
  • actions array[string]
  • when object Required