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.

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • _id string

    The default rule's unique ObjectId identifier.

  • roles array[object]

    An ordered list of default user 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

        One of:

        object-1 boolean-2

        A rule expression that evaluates to true if the role can read the document.

        A rule expression that evaluates to true if the role can read the document.

      • write

        One of:

        object-1 boolean-2

        A rule expression that evaluates to true if the role can write to the document.

        A rule expression that evaluates to true if the role can write to the document.

    • name string

      The role's name.

    • apply_when

      One of:

      object-1 boolean-2

      A rule expression that evaluates to true when this role applies to a user for a specific document.

      A rule expression that evaluates to true when this role applies to a user for a specific document.

    • read

      One of:

      object-1 boolean-2

      A rule expression that evaluates to true if the role has permission to read all fields in the document. If Device Sync is enabled, use document_filters.read instead.

      A rule expression that evaluates to true if the role has permission to read all fields in the document. If Device Sync is enabled, use document_filters.read instead.

    • write

      One of:

      object-1 boolean-2

      A rule expression that evaluates to true if the role has permission to add, modify, or remove all fields in the document. If Device Sync is enabled, use document_filters.write instead.

      A rule expression that evaluates to true if the role has permission to add, modify, or remove all fields in the document. If Device Sync is enabled, use document_filters.write instead.

    • insert

      One of:

      object-1 boolean-2

      A rule expression that evaluates to true if the role has permission to insert a new document into the collection.

      A rule expression that evaluates to true if the role has permission to insert a new document into the collection.

    • delete

      One of:

      object-1 boolean-2

      A rule expression that evaluates to true if the role has permission to delete a document from the collection.

      A rule expression that evaluates to true if the role has permission to delete a document from the collection.

    • search

      One of:

      object-1 boolean-2

      A rule expression that evaluates to true if the role has permission to search the collection using Atlas Search.

      A rule expression that evaluates to true if the role has permission to search the collection using Atlas Search.

    • fields object

      Field-level rules for any fields that are not explicitly configured in the role's properties.

    • additional_fields object

      Field-level rules for any fields that are not explicitly configured in the role's properties.

      Hide additional_fields attributes Show additional_fields attributes object

      • read

        One of:

        object-1 boolean-2

        A rule expression that evaluates to true if the role can read the field's value.

        A rule expression that evaluates to true if the role can read the field's value.

      • write

        One of:

        object-1 boolean-2

        A rule expression that evaluates to true if the role can write the field's value.

        A rule expression that evaluates to true if the role can write the field's value.

  • filters array[object]

    A list of default query filters.

    Hide filters attributes Show filters attributes object

    • _id string

      The filter's unique ObjectId identifier.

    • name string

      The filter's name.

    • apply_when

      One of:

      object-1 boolean-2

      A rule expression that evaluates to true if the filter applies to an incoming query.

      A rule expression that evaluates to true if the filter applies to an incoming query.

    • query object

      A MongoDB query object that is merged into an incoming query before the operation runs.

    • projection object

      A MongoDB projection object that is merged into an incoming query before the operation runs.

      Hide projection attribute Show projection attribute object

      • * number Additional properties

        Values are 0 or 1.

• 404 application/json

  No default rule is defined.

  Hide response attribute Show response attribute object

  • error string

    Value is default rule does not exist on service.