POST/desk/api/v2/settings/hipaaipwhitelists.json

Create the HIPAAA whitelist of an installation.

Create a resource. Any omitted propertie will be unchanged.

Body Params

HIPAAWhitelistAPIBody handles the get/create/update request/response for HIPAAWhitelist.

    • Name
      hipaaWhitelist
      Type
      object
      Description
      HIPAAWhitelist contains a whitelist entry from the database

    Responses

    • Code
      200
      Type
      object
      Schema
      Description
      200 OK
      HIPAAWhitelistAPIBody handles the get/create/update request/response for HIPAAWhitelist.
    • 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

    HIPAAWhitelistAPIBody
    {
  "hipaaWhitelist": {
    "createdAt": "2024-07-26T20:26:26.553Z",
    "createdBy": {
      "delete": true,
      "id": 0,
      "meta": {},
      "type": 0
    },
    "deletedAt": "2024-07-26T20:26:26.553Z",
    "deletedBy": {
      "delete": true,
      "id": 0,
      "meta": {},
      "type": 0
    },
    "endAt": "string",
    "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
    },
    "hipaaSettingsId": 0,
    "id": 0,
    "name": "string",
    "startAt": "string",
    "state": "string",
    "updatedAt": "2024-07-26T20:26:26.553Z",
    "updatedBy": {
      "delete": true,
      "id": 0,
      "meta": {},
      "type": 0
    }
  }
}
    Download Swagger