Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

A newer version of this documentation is available.

View Latest

Access Control Configuration

      +
      Pre-3.0 Legacy Configuration Equivalents

      This content describes configuration for Sync Gateway 3.0 and higher — for legacy configuration, see: Legacy Pre-3.0 Configuration

      Introduction

      The sync function is crucial to the security of your application. It is in charge of data validation, access control and routing. The function executes every time a new revision/update is made to a document.

      For more on the Sync Function and access control see: Sync Function Overview

      Set database sync function

      PUT /{keyspace}/_config/sync

      Description

      This will allow you to update the sync function.

      Required Sync Gateway RBAC roles:

      • Sync Gateway Architect
      Consumes

      • application/javascript

      Produces

      • application/json

      Parameters

      Path Parameters

      Name Description Schema

      keyspace
      required

      The keyspace to run the operation against.

      A keyspace is a dot-separated string, comprised of a database name, and optionally a named scope and collection.

      String
      Query Parameters

      Name Description Schema

      disable_oidc_validation
      optional

      If set, will not attempt to validate the configured OpenID Connect providers are reachable.

      Boolean
      Header Parameters

      Name Description Schema

      If-Match
      optional

      If set to a configuration's Etag value, enables optimistic concurrency control for the request. Returns HTTP 412 if another update happened underneath this one.

      String
      Body Parameter

      Name Description Schema

      Body
      optional

      The new sync function to use

      String

      Responses

      HTTP Code Description Schema

      200

      Updated sync function successfully

      400

      There was a problem with your request

      HTTPError

      404

      Resource could not be found

      HTTPError

      412

      Precondition Failed The supplied If-Match header did not match the current version of the configuration. Returned when optimistic concurrency control is used, and there has been an update to the configuration in between this update.

      HTTPError

      Errors

      This section shows possible error responses returned by the Admin REST API.

      Property Schema

      error
      required

      The error name.

      String

      reason
      required

      The error description.

      String

      Related Content

      API Topics
      Reference
      Community

      Mobile Forum | Blog | Blog (Mobile) | Tutorials