GET/desk/api/v2/settings/hipaa.json

Get your installation's HIPAA settings

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    HIPAASettingsAPIBody handles the get/create/update request/response for HIPAASettings.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.

Examples

200 OK

HIPAASettingsAPIBody
{
  "hipaaSettings": {
    "autoLogout": true,
    "autoLogoutExpiry": 0,
    "createdAt": "2024-04-24T00:52:04.633Z",
    "createdBy": {
      "delete": true,
      "id": 0,
      "meta": {},
      "type": 0
    },
    "customNotificationBody": "string",
    "deletedAt": "2024-04-24T00:52:04.633Z",
    "deletedBy": {
      "delete": true,
      "id": 0,
      "meta": {},
      "type": 0
    },
    "filter_args": {
      "aggregate": {
        "Distinct": true,
        "Field": "string",
        "Operation": "string"
      },
      "bulkDryExecute": true,
      "fields": [
        "string"
      ],
      "filter": [
        "string"
      ],
      "id": 0,
      "ids": [
        0
      ],
      "includes": [
        "string"
      ],
      "orderBy": "string",
      "orderMode": "asc",
      "page": 0,
      "pageOffset": 0,
      "pageSize": 0,
      "skipAggregation": true
    },
    "id": 0,
    "inboxes": [
      {
        "delete": true,
        "id": 0,
        "meta": {},
        "type": 0
      }
    ],
    "ipWhiteList": "string",
    "mobileLoginEnabled": true,
    "newInboxesNotificationsOnly": true,
    "notificationsOnly": true,
    "preventBulkDownload": true,
    "preventCompanyPortalAccess": true,
    "samlRequired": true,
    "state": "string",
    "updatedAt": "2024-04-24T00:52:04.633Z",
    "updatedBy": {
      "delete": true,
      "id": 0,
      "meta": {},
      "type": 0
    }
  }
}