Sign in

v1

latestOpenAPI 3.0.02026-08-041353104.2 KB
sharing settings

Update sharing toggle settings

Patches the toggle settings for sharing tasks, reports, and other related configuration in the tenant. User must be assigned the TenantAdmin role.

patch/api/v1/sharing-tasks/settings

Request body

op'replace' required

The operation to be performed.

path'/enable-sharing' | '/enable-report-subscription' required

The path for the given resource field to patch.

valueobject

The value to be used for this operation.

Example request

[
  {
    "op": "replace",
    "path": "/enable-sharing",
    "value": true
  },
  {
    "op": "replace",
    "path": "/enable-sharing",
    "value": false
  },
  {
    "op": "replace",
    "path": "/enable-report-subscription",
    "value": true
  },
  {
    "op": "replace",
    "path": "/enable-report-subscription",
    "value": false
  }
]

Response

Sharing settings have been successfully updated.