
{
  "openapi": "3.1.0",
  "info": {
    "title": "Cambrionix Connect Communications API",
    "description": "The communication service facilitates the Connect platform's communication-based features.",
    "version": "1.0"
  },
  "servers": [
    {
      "description": "Cambrionix Connect",
      "url": "/api"
    }
  ],
  "tags": [
    {
      "name": "Settings",
      "description": "View and manage communications settings for your organization."
    },
    {
      "name": "Banners",
      "description": "Add, remove and list platform-wide banner notifications."
    },
    {
      "name": "Notifications",
      "description": "View and manage Connect notifications."
    },
    {
      "name": "Audit Logs",
      "description": "Retrieve audit logs for your organization."
    }
  ],
  "paths": {
    "/communications/v1/audit-logs": {
      "get": {
        "summary": "List Organization audit logs",
        "description": "Get all audit logs for the given organization.",
        "tags": [
          "Audit Logs"
        ],
        "parameters": [
          {
            "description": "Returns only the items that match, written as `(path::operator::value)`, such as `(name::co::Lab)`. Operators are `eq`, `co`, `sw`, `ew`, `gt` and `pr`, and the case-insensitive `ieq`, `ico`, `isw` and `iew`. Combine conditions as `((a)::and::(b))` or `((a)::or::(b))`.",
            "in": "query",
            "name": "filter",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Orders the items, written as `(path::asc)` or `(path::desc)`. Combine orders as `((a)::and::(b))`.",
            "in": "query",
            "name": "sort",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "The maximum number of items to return.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "Returns the next page: the `_metadata.continuationToken` of the previous response.",
            "in": "query",
            "name": "token",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "security": [
          {
            "bearerAuth": [
              "Organization.AuditLog.Read"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Response schema with result and metadata",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "_metadata": {
                      "type": "object",
                      "properties": {
                        "continuationToken": {
                          "type": "string"
                        },
                        "limit": {
                          "type": "number"
                        },
                        "total": {
                          "type": "number"
                        }
                      },
                      "additionalProperties": false,
                      "description": "Metadata for paginated responses. This includes total count, limit, and continuation token.",
                      "title": "Connect API Response Metadata"
                    },
                    "result": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/OrganizationAuditLog"
                      }
                    }
                  },
                  "required": [
                    "result"
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "listOrganizationAuditLogs"
      }
    },
    "/communications/v1/audit-logs/{auditLogId}": {
      "get": {
        "summary": "Get Organization audit log",
        "description": "Get an audit log for the given organization.",
        "tags": [
          "Audit Logs"
        ],
        "parameters": [
          {
            "name": "auditLogId",
            "in": "path",
            "required": true,
            "description": "Path parameter",
            "example": "00000000-0000-0000-0000-000000000000",
            "deprecated": false,
            "schema": {
              "type": "string",
              "description": "Path parameter",
              "deprecated": false,
              "example": "00000000-0000-0000-0000-000000000000",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
            }
          }
        ],
        "security": [
          {
            "bearerAuth": [
              "Organization.AuditLog.Read"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Response schema with result and metadata",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "_metadata": {
                      "type": "object",
                      "properties": {
                        "continuationToken": {
                          "type": "string"
                        },
                        "limit": {
                          "type": "number"
                        },
                        "total": {
                          "type": "number"
                        }
                      },
                      "additionalProperties": false,
                      "description": "Metadata for paginated responses. This includes total count, limit, and continuation token.",
                      "title": "Connect API Response Metadata"
                    },
                    "result": {
                      "$ref": "#/components/schemas/OrganizationAuditLog"
                    }
                  },
                  "required": [
                    "result"
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "getOrganizationAuditLog"
      }
    },
    "/communications/v1/banners": {
      "get": {
        "summary": "List Banners",
        "description": "Get all banners.",
        "tags": [
          "Banners"
        ],
        "parameters": [
          {
            "description": "Returns only the items that match, written as `(path::operator::value)`, such as `(name::co::Lab)`. Operators are `eq`, `co`, `sw`, `ew`, `gt` and `pr`, and the case-insensitive `ieq`, `ico`, `isw` and `iew`. Combine conditions as `((a)::and::(b))` or `((a)::or::(b))`.",
            "in": "query",
            "name": "filter",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Orders the items, written as `(path::asc)` or `(path::desc)`. Combine orders as `((a)::and::(b))`.",
            "in": "query",
            "name": "sort",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "The maximum number of items to return.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "Returns the next page: the `_metadata.continuationToken` of the previous response.",
            "in": "query",
            "name": "token",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "security": [
          {
            "bearerAuth": [
              "Banner.Read"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Response schema with result and metadata",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "_metadata": {
                      "type": "object",
                      "properties": {
                        "continuationToken": {
                          "type": "string"
                        },
                        "limit": {
                          "type": "number"
                        },
                        "total": {
                          "type": "number"
                        }
                      },
                      "additionalProperties": false,
                      "description": "Metadata for paginated responses. This includes total count, limit, and continuation token.",
                      "title": "Connect API Response Metadata"
                    },
                    "result": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Banner"
                      }
                    }
                  },
                  "required": [
                    "result"
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "listBanners"
      }
    },
    "/communications/v1/banners/{bannerId}": {
      "get": {
        "summary": "Get a Banner",
        "description": "Get a banner by id.",
        "tags": [
          "Banners"
        ],
        "parameters": [
          {
            "name": "bannerId",
            "in": "path",
            "required": true,
            "description": "Path parameter",
            "example": "00000000-0000-0000-0000-000000000000",
            "deprecated": false,
            "schema": {
              "type": "string",
              "description": "Path parameter",
              "deprecated": false,
              "example": "00000000-0000-0000-0000-000000000000",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
            }
          }
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "responses": {
          "200": {
            "description": "Response schema with result and metadata",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "_metadata": {
                      "type": "object",
                      "properties": {
                        "continuationToken": {
                          "type": "string"
                        },
                        "limit": {
                          "type": "number"
                        },
                        "total": {
                          "type": "number"
                        }
                      },
                      "additionalProperties": false,
                      "description": "Metadata for paginated responses. This includes total count, limit, and continuation token.",
                      "title": "Connect API Response Metadata"
                    },
                    "result": {
                      "$ref": "#/components/schemas/Banner"
                    }
                  },
                  "required": [
                    "result"
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "getABanner"
      }
    },
    "/communications/v1/banners/active": {
      "get": {
        "summary": "List Active Banners",
        "description": "Get all active banners.",
        "tags": [
          "Banners"
        ],
        "parameters": [],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "responses": {
          "200": {
            "description": "Response schema with result and metadata",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "_metadata": {
                      "type": "object",
                      "properties": {
                        "continuationToken": {
                          "type": "string"
                        },
                        "limit": {
                          "type": "number"
                        },
                        "total": {
                          "type": "number"
                        }
                      },
                      "additionalProperties": false,
                      "description": "Metadata for paginated responses. This includes total count, limit, and continuation token.",
                      "title": "Connect API Response Metadata"
                    },
                    "result": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Banner"
                      }
                    }
                  },
                  "required": [
                    "result"
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "listActiveBanners"
      }
    },
    "/communications/v1/notifications": {
      "get": {
        "summary": "List Available Notifications",
        "description": "Get all available notifications.",
        "tags": [
          "Notifications"
        ],
        "parameters": [
          {
            "description": "Returns only the items that match, written as `(path::operator::value)`, such as `(name::co::Lab)`. Operators are `eq`, `co`, `sw`, `ew`, `gt` and `pr`, and the case-insensitive `ieq`, `ico`, `isw` and `iew`. Combine conditions as `((a)::and::(b))` or `((a)::or::(b))`.",
            "in": "query",
            "name": "filter",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Orders the items, written as `(path::asc)` or `(path::desc)`. Combine orders as `((a)::and::(b))`.",
            "in": "query",
            "name": "sort",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "The maximum number of items to return.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "Returns the next page: the `_metadata.continuationToken` of the previous response.",
            "in": "query",
            "name": "token",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "security": [
          {
            "bearerAuth": [
              "Global.Notification.Read"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListAvailableNotificationsResponse"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "listAvailableNotifications"
      }
    },
    "/communications/v1/notifications/{notificationId}": {
      "get": {
        "summary": "Get a Notification",
        "description": "Get a notification by id.",
        "tags": [
          "Notifications"
        ],
        "parameters": [
          {
            "name": "notificationId",
            "in": "path",
            "required": true,
            "description": "Path parameter",
            "example": "00000000-0000-0000-0000-000000000000",
            "deprecated": false,
            "schema": {
              "type": "string",
              "description": "Path parameter",
              "deprecated": false,
              "example": "00000000-0000-0000-0000-000000000000",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
            }
          }
        ],
        "security": [
          {
            "bearerAuth": [
              "Global.Notification.Read"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetANotificationResponse"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "getANotification"
      }
    },
    "/communications/v1/organization/user/notifications/in-app": {
      "get": {
        "summary": "List User In-App Notifications",
        "description": "Returns all in-app notifications for the current user in the organization.",
        "tags": [
          "Notifications"
        ],
        "parameters": [
          {
            "description": "Returns only the items that match, written as `(path::operator::value)`, such as `(name::co::Lab)`. Operators are `eq`, `co`, `sw`, `ew`, `gt` and `pr`, and the case-insensitive `ieq`, `ico`, `isw` and `iew`. Combine conditions as `((a)::and::(b))` or `((a)::or::(b))`.",
            "in": "query",
            "name": "filter",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Orders the items, written as `(path::asc)` or `(path::desc)`. Combine orders as `((a)::and::(b))`.",
            "in": "query",
            "name": "sort",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "The maximum number of items to return.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "Returns the next page: the `_metadata.continuationToken` of the previous response.",
            "in": "query",
            "name": "token",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "security": [
          {
            "bearerAuth": [
              "Organization.User.Notifications.InApp.Read"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Response schema with result and metadata",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "_metadata": {
                      "type": "object",
                      "properties": {
                        "continuationToken": {
                          "type": "string"
                        },
                        "limit": {
                          "type": "number"
                        },
                        "total": {
                          "type": "number"
                        }
                      },
                      "additionalProperties": false,
                      "description": "Metadata for paginated responses. This includes total count, limit, and continuation token.",
                      "title": "Connect API Response Metadata"
                    },
                    "result": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/OrganizationUserInAppNotification"
                      }
                    }
                  },
                  "required": [
                    "result"
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "listUserInAppNotifications"
      }
    },
    "/communications/v1/organization/user/notifications/in-app/{notificationId}": {
      "get": {
        "summary": "Get User In-App Notification",
        "description": "Get a user in-app notification by id.",
        "tags": [
          "Notifications"
        ],
        "parameters": [
          {
            "name": "notificationId",
            "in": "path",
            "required": true,
            "description": "Path parameter",
            "example": "00000000-0000-0000-0000-000000000000",
            "deprecated": false,
            "schema": {
              "type": "string",
              "description": "Path parameter",
              "deprecated": false,
              "example": "00000000-0000-0000-0000-000000000000",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
            }
          }
        ],
        "security": [
          {
            "bearerAuth": [
              "Organization.User.Notifications.InApp.Read"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Response schema with result and metadata",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "_metadata": {
                      "type": "object",
                      "properties": {
                        "continuationToken": {
                          "type": "string"
                        },
                        "limit": {
                          "type": "number"
                        },
                        "total": {
                          "type": "number"
                        }
                      },
                      "additionalProperties": false,
                      "description": "Metadata for paginated responses. This includes total count, limit, and continuation token.",
                      "title": "Connect API Response Metadata"
                    },
                    "result": {
                      "$ref": "#/components/schemas/OrganizationUserInAppNotification"
                    }
                  },
                  "required": [
                    "result"
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "getUserInAppNotification"
      },
      "patch": {
        "summary": "Update User In-App Notification",
        "description": "Update a user in-app notification by id.",
        "tags": [
          "Notifications"
        ],
        "parameters": [
          {
            "name": "notificationId",
            "in": "path",
            "required": true,
            "description": "Path parameter",
            "example": "00000000-0000-0000-0000-000000000000",
            "deprecated": false,
            "schema": {
              "type": "string",
              "description": "Path parameter",
              "deprecated": false,
              "example": "00000000-0000-0000-0000-000000000000",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "description": "",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateUserInAppNotificationRequest"
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": [
              "Organization.User.Notifications.InApp.Read"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Response schema with result and metadata",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "_metadata": {
                      "type": "object",
                      "properties": {
                        "continuationToken": {
                          "type": "string"
                        },
                        "limit": {
                          "type": "number"
                        },
                        "total": {
                          "type": "number"
                        }
                      },
                      "additionalProperties": false,
                      "description": "Metadata for paginated responses. This includes total count, limit, and continuation token.",
                      "title": "Connect API Response Metadata"
                    },
                    "result": {
                      "$ref": "#/components/schemas/OrganizationUserInAppNotification"
                    }
                  },
                  "required": [
                    "result"
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "updateUserInAppNotification"
      }
    },
    "/communications/v1/organization/user/settings": {
      "get": {
        "summary": "Get Organization User Communications Settings",
        "description": "Get all organization user communications settings for the current authenticated user.",
        "tags": [
          "Settings"
        ],
        "parameters": [
          {
            "description": "Returns only the items that match, written as `(path::operator::value)`, such as `(name::co::Lab)`. Operators are `eq`, `co`, `sw`, `ew`, `gt` and `pr`, and the case-insensitive `ieq`, `ico`, `isw` and `iew`. Combine conditions as `((a)::and::(b))` or `((a)::or::(b))`.",
            "in": "query",
            "name": "filter",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Orders the items, written as `(path::asc)` or `(path::desc)`. Combine orders as `((a)::and::(b))`.",
            "in": "query",
            "name": "sort",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "The maximum number of items to return.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "Returns the next page: the `_metadata.continuationToken` of the previous response.",
            "in": "query",
            "name": "token",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "security": [
          {
            "bearerAuth": [
              "Organization.Communications.User.Settings.Read"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Response schema with result and metadata",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "_metadata": {
                      "type": "object",
                      "properties": {
                        "continuationToken": {
                          "type": "string"
                        },
                        "limit": {
                          "type": "number"
                        },
                        "total": {
                          "type": "number"
                        }
                      },
                      "additionalProperties": false,
                      "description": "Metadata for paginated responses. This includes total count, limit, and continuation token.",
                      "title": "Connect API Response Metadata"
                    },
                    "result": {
                      "$ref": "#/components/schemas/OrganizationUserCommunicationsSettings"
                    }
                  },
                  "required": [
                    "result"
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "getOrganizationUserCommunicationsSettings"
      }
    },
    "/communications/v1/settings": {
      "get": {
        "summary": "Get Organization Communications Settings",
        "description": "Get all organization communications settings.",
        "tags": [
          "Settings"
        ],
        "parameters": [],
        "security": [
          {
            "bearerAuth": [
              "Organization.Communications.Settings.Read"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Response schema with result and metadata",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "_metadata": {
                      "type": "object",
                      "properties": {
                        "continuationToken": {
                          "type": "string"
                        },
                        "limit": {
                          "type": "number"
                        },
                        "total": {
                          "type": "number"
                        }
                      },
                      "additionalProperties": false,
                      "description": "Metadata for paginated responses. This includes total count, limit, and continuation token.",
                      "title": "Connect API Response Metadata"
                    },
                    "result": {
                      "$ref": "#/components/schemas/OrganizationCommunicationsSettings"
                    }
                  },
                  "required": [
                    "result"
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "getOrganizationCommunicationsSettings"
      },
      "patch": {
        "summary": "Update Organization Communications Settings",
        "description": "Update organization communications settings.",
        "tags": [
          "Settings"
        ],
        "parameters": [],
        "requestBody": {
          "required": true,
          "description": "",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateOrganizationCommunicationsSettingsRequest"
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": [
              "Organization.Communications.Settings.Write"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Response schema with result and metadata",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "_metadata": {
                      "type": "object",
                      "properties": {
                        "continuationToken": {
                          "type": "string"
                        },
                        "limit": {
                          "type": "number"
                        },
                        "total": {
                          "type": "number"
                        }
                      },
                      "additionalProperties": false,
                      "description": "Metadata for paginated responses. This includes total count, limit, and continuation token.",
                      "title": "Connect API Response Metadata"
                    },
                    "result": {
                      "$ref": "#/components/schemas/OrganizationCommunicationsSettings"
                    }
                  },
                  "required": [
                    "result"
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "updateOrganizationCommunicationsSettings"
      }
    },
    "/communications/v1/version": {
      "get": {
        "summary": "Get Version",
        "description": "Get the version of the API.",
        "tags": [
          "Version"
        ],
        "parameters": [],
        "security": [],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetVersionResponse"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "default": {
            "$ref": "#/components/responses/Error"
          }
        },
        "operationId": "getVersion"
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "bearerFormat": "JWT",
        "description": "Access token from the organization token endpoint, `POST /api/v1/organizations/{organizationId}/oauth2/token` on the Connect host, using the `client_credentials` grant with a service account.",
        "scheme": "bearer",
        "type": "http"
      }
    },
    "schemas": {
      "Banner": {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "type": "object",
        "properties": {
          "category": {
            "type": "string",
            "enum": [
              "incident",
              "maintenance",
              "news"
            ]
          },
          "id": {
            "type": "string",
            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
          },
          "isActive": {
            "type": "boolean"
          },
          "message": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255
          },
          "metadata": {
            "type": "object",
            "properties": {
              "dismissable": {
                "type": "boolean"
              },
              "hyperlink": {
                "type": "string"
              }
            },
            "additionalProperties": false
          },
          "revoked": {
            "type": "object",
            "properties": {
              "entity": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
                  }
                },
                "required": [
                  "id"
                ],
                "additionalProperties": false
              },
              "globalService": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  }
                },
                "required": [
                  "id"
                ],
                "additionalProperties": false
              },
              "time": {
                "type": "number",
                "minimum": 0
              },
              "user": {
                "type": "object",
                "properties": {
                  "detail": {
                    "type": "object",
                    "properties": {
                      "displayName": {
                        "type": "string"
                      },
                      "email": {
                        "type": "string"
                      },
                      "givenName": {
                        "type": "string"
                      },
                      "surname": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "displayName",
                      "email"
                    ],
                    "additionalProperties": false,
                    "description": "UserDetail"
                  },
                  "id": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 255
                  }
                },
                "required": [
                  "id"
                ],
                "additionalProperties": false
              }
            },
            "required": [
              "time"
            ],
            "additionalProperties": false,
            "description": "ChangeAudit - Used to track changes to an object."
          },
          "severity": {
            "type": "string",
            "enum": [
              "critical",
              "error",
              "warning",
              "informational"
            ]
          },
          "title": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255
          },
          "type": {
            "type": "string",
            "enum": [
              "banner",
              "card"
            ]
          },
          "valid": {
            "type": "object",
            "properties": {
              "end": {
                "type": "number",
                "minimum": 0
              },
              "start": {
                "type": "number",
                "minimum": 0
              }
            },
            "required": [
              "end",
              "start"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "category",
          "id",
          "isActive",
          "message",
          "severity",
          "title",
          "type"
        ],
        "additionalProperties": false
      },
      "Error": {
        "type": "object",
        "required": [
          "code",
          "message",
          "detail"
        ],
        "properties": {
          "code": {
            "type": "integer"
          },
          "message": {
            "type": "string"
          },
          "detail": {
            "type": "string"
          }
        },
        "additionalProperties": false
      },
      "GetANotificationResponse": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "_metadata": {
            "type": "object",
            "properties": {
              "continuationToken": {
                "type": "string"
              },
              "limit": {
                "type": "number"
              },
              "total": {
                "type": "number"
              }
            },
            "additionalProperties": false,
            "description": "Metadata for paginated responses. This includes total count, limit, and continuation token.",
            "title": "Connect API Response Metadata"
          },
          "result": {
            "type": "object",
            "properties": {
              "category": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
                  }
                },
                "required": [
                  "id"
                ],
                "additionalProperties": false
              },
              "description": {
                "type": "string",
                "minLength": 1,
                "maxLength": 255
              },
              "id": {
                "type": "string",
                "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
              },
              "routes": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "method": {
                      "type": "string"
                    },
                    "path": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "method",
                    "path"
                  ],
                  "additionalProperties": false
                }
              },
              "schema": {
                "$ref": "#/components/schemas/SharedSchema182"
              },
              "severity": {
                "type": "string",
                "enum": [
                  "critical",
                  "error",
                  "warning",
                  "informational"
                ]
              },
              "templates": {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "object",
                    "properties": {
                      "attachments": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "html": {
                        "type": "string"
                      },
                      "layout": {
                        "default": {
                          "components": [],
                          "container": {}
                        },
                        "type": "object",
                        "properties": {
                          "components": {
                            "$ref": "#/components/schemas/SharedSchema185"
                          },
                          "container": {
                            "type": "object",
                            "properties": {
                              "style": {
                                "type": "object",
                                "propertyNames": {
                                  "type": "string"
                                },
                                "additionalProperties": {
                                  "type": "string"
                                }
                              }
                            },
                            "additionalProperties": false
                          }
                        },
                        "required": [
                          "components",
                          "container"
                        ],
                        "additionalProperties": false
                      },
                      "metadata": {
                        "type": "object",
                        "propertyNames": {
                          "type": "string"
                        },
                        "additionalProperties": {
                          "type": "string"
                        }
                      },
                      "preview": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 90
                      },
                      "subject": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 70
                      },
                      "text": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "attachments",
                      "html",
                      "layout",
                      "preview",
                      "subject",
                      "text"
                    ],
                    "additionalProperties": false
                  },
                  "inApp": {
                    "type": "object",
                    "properties": {
                      "links": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "href": {
                              "type": "string",
                              "format": "uri"
                            },
                            "text": {
                              "type": "string"
                            },
                            "type": {
                              "type": "string"
                            }
                          },
                          "required": [
                            "href",
                            "text",
                            "type"
                          ],
                          "additionalProperties": false
                        }
                      },
                      "metadata": {
                        "type": "object",
                        "propertyNames": {
                          "type": "string"
                        },
                        "additionalProperties": {
                          "type": "string"
                        }
                      },
                      "subject": {
                        "type": "string"
                      },
                      "text": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "links",
                      "subject",
                      "text"
                    ],
                    "additionalProperties": false
                  }
                },
                "required": [
                  "email"
                ],
                "additionalProperties": false
              },
              "title": {
                "type": "string",
                "minLength": 1,
                "maxLength": 255
              },
              "type": {
                "type": "string",
                "enum": [
                  "alert",
                  "scheduled"
                ]
              }
            },
            "required": [
              "category",
              "description",
              "id",
              "routes",
              "schema",
              "severity",
              "templates",
              "title",
              "type"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "result"
        ],
        "additionalProperties": false
      },
      "GetVersionResponse": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "_metadata": {
            "type": "object",
            "properties": {
              "continuationToken": {
                "type": "string"
              },
              "limit": {
                "type": "number"
              },
              "total": {
                "type": "number"
              }
            },
            "additionalProperties": false,
            "description": "Metadata for paginated responses. This includes total count, limit, and continuation token.",
            "title": "Connect API Response Metadata"
          },
          "result": {
            "type": "object",
            "properties": {
              "releaseNotes": {
                "type": "string"
              },
              "version": {
                "type": "string"
              }
            },
            "required": [
              "releaseNotes",
              "version"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "result"
        ],
        "additionalProperties": false
      },
      "InternalServerError": {
        "type": "object",
        "required": [
          "code",
          "message",
          "detail"
        ],
        "properties": {
          "code": {
            "type": "integer",
            "enum": [
              500
            ]
          },
          "message": {
            "type": "string",
            "enum": [
              "Unauthorized"
            ]
          },
          "detail": {
            "type": "string"
          }
        },
        "additionalProperties": false
      },
      "ListAvailableNotificationsResponse": {
        "$schema": "https://json-schema.org/draft/2020-12/schema",
        "type": "object",
        "properties": {
          "_metadata": {
            "type": "object",
            "properties": {
              "continuationToken": {
                "type": "string"
              },
              "limit": {
                "type": "number"
              },
              "total": {
                "type": "number"
              }
            },
            "additionalProperties": false,
            "description": "Metadata for paginated responses. This includes total count, limit, and continuation token.",
            "title": "Connect API Response Metadata"
          },
          "result": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "category": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
                    }
                  },
                  "required": [
                    "id"
                  ],
                  "additionalProperties": false
                },
                "description": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 255
                },
                "id": {
                  "type": "string",
                  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
                },
                "routes": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "method": {
                        "type": "string"
                      },
                      "path": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "method",
                      "path"
                    ],
                    "additionalProperties": false
                  }
                },
                "schema": {
                  "$ref": "#/components/schemas/SharedSchema182"
                },
                "severity": {
                  "type": "string",
                  "enum": [
                    "critical",
                    "error",
                    "warning",
                    "informational"
                  ]
                },
                "templates": {
                  "type": "object",
                  "properties": {
                    "email": {
                      "type": "object",
                      "properties": {
                        "attachments": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "html": {
                          "type": "string"
                        },
                        "layout": {
                          "default": {
                            "components": [],
                            "container": {}
                          },
                          "type": "object",
                          "properties": {
                            "components": {
                              "$ref": "#/components/schemas/SharedSchema185"
                            },
                            "container": {
                              "type": "object",
                              "properties": {
                                "style": {
                                  "type": "object",
                                  "propertyNames": {
                                    "type": "string"
                                  },
                                  "additionalProperties": {
                                    "type": "string"
                                  }
                                }
                              },
                              "additionalProperties": false
                            }
                          },
                          "required": [
                            "components",
                            "container"
                          ],
                          "additionalProperties": false
                        },
                        "metadata": {
                          "type": "object",
                          "propertyNames": {
                            "type": "string"
                          },
                          "additionalProperties": {
                            "type": "string"
                          }
                        },
                        "preview": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 90
                        },
                        "subject": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 70
                        },
                        "text": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "attachments",
                        "html",
                        "layout",
                        "preview",
                        "subject",
                        "text"
                      ],
                      "additionalProperties": false
                    },
                    "inApp": {
                      "type": "object",
                      "properties": {
                        "links": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "href": {
                                "type": "string",
                                "format": "uri"
                              },
                              "text": {
                                "type": "string"
                              },
                              "type": {
                                "type": "string"
                              }
                            },
                            "required": [
                              "href",
                              "text",
                              "type"
                            ],
                            "additionalProperties": false
                          }
                        },
                        "metadata": {
                          "type": "object",
                          "propertyNames": {
                            "type": "string"
                          },
                          "additionalProperties": {
                            "type": "string"
                          }
                        },
                        "subject": {
                          "type": "string"
                        },
                        "text": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "links",
                        "subject",
                        "text"
                      ],
                      "additionalProperties": false
                    }
                  },
                  "required": [
                    "email"
                  ],
                  "additionalProperties": false
                },
                "title": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 255
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "alert",
                    "scheduled"
                  ]
                }
              },
              "required": [
                "category",
                "description",
                "id",
                "routes",
                "schema",
                "severity",
                "templates",
                "title",
                "type"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "result"
        ],
        "additionalProperties": false
      },
      "OrganizationAuditLog": {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "type": "object",
        "properties": {
          "category": {
            "type": "string",
            "enum": [
              "computers",
              "devices",
              "groups",
              "hubs",
              "locations",
              "notifications",
              "organization",
              "other",
              "roles",
              "services",
              "settings",
              "users",
              "workflows"
            ]
          },
          "detail": {
            "type": "object",
            "properties": {
              "entityId": {
                "type": "string",
                "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
              },
              "organizationId": {
                "type": "string",
                "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
              },
              "payload": {
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {}
              },
              "serviceId": {
                "type": "string"
              },
              "time": {
                "type": "number",
                "minimum": 0
              },
              "userId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 255
              },
              "method": {
                "type": "string",
                "enum": [
                  "GET",
                  "POST",
                  "PATCH",
                  "DELETE",
                  "PUT"
                ]
              },
              "origin": {
                "type": "string",
                "format": "uri"
              }
            },
            "required": [
              "payload",
              "time",
              "method",
              "origin"
            ],
            "additionalProperties": false
          },
          "id": {
            "type": "string",
            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
          },
          "organization": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
              }
            },
            "required": [
              "id"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "category",
          "detail",
          "id",
          "organization"
        ],
        "additionalProperties": false
      },
      "OrganizationCommunicationsSettings": {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "type": "object",
        "properties": {
          "auditLog": {
            "type": "object",
            "properties": {
              "settings": {
                "type": "object",
                "properties": {
                  "computers": {
                    "default": true,
                    "type": "boolean"
                  },
                  "devices": {
                    "default": true,
                    "type": "boolean"
                  },
                  "groups": {
                    "default": true,
                    "type": "boolean"
                  },
                  "hubs": {
                    "default": true,
                    "type": "boolean"
                  },
                  "locations": {
                    "default": true,
                    "type": "boolean"
                  },
                  "organization": {
                    "default": true,
                    "type": "boolean"
                  },
                  "other": {
                    "default": true,
                    "type": "boolean"
                  },
                  "roles": {
                    "default": true,
                    "type": "boolean"
                  },
                  "services": {
                    "default": true,
                    "type": "boolean"
                  },
                  "settings": {
                    "default": true,
                    "type": "boolean"
                  },
                  "users": {
                    "default": true,
                    "type": "boolean"
                  },
                  "workflows": {
                    "default": true,
                    "type": "boolean"
                  }
                },
                "required": [
                  "computers",
                  "devices",
                  "groups",
                  "hubs",
                  "locations",
                  "organization",
                  "other",
                  "roles",
                  "services",
                  "settings",
                  "users",
                  "workflows"
                ],
                "additionalProperties": false
              }
            },
            "required": [
              "settings"
            ],
            "additionalProperties": false
          },
          "id": {
            "type": "string",
            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
          },
          "notifications": {
            "default": {
              "email": {},
              "inApp": {},
              "push": {},
              "sms": {}
            },
            "type": "object",
            "properties": {
              "email": {
                "default": {},
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "type": "object",
                  "properties": {
                    "enabled": {
                      "default": true,
                      "type": "boolean"
                    },
                    "roles": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "schedule": {
                      "type": "object",
                      "properties": {
                        "frequency": {
                          "default": 0,
                          "type": "number"
                        },
                        "nextRun": {
                          "type": "number",
                          "minimum": 0
                        }
                      },
                      "required": [
                        "frequency",
                        "nextRun"
                      ],
                      "additionalProperties": false
                    },
                    "users": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 255
                      }
                    }
                  },
                  "required": [
                    "enabled",
                    "roles",
                    "users"
                  ],
                  "additionalProperties": false
                }
              },
              "inApp": {
                "default": {},
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "type": "object",
                  "properties": {
                    "enabled": {
                      "default": true,
                      "type": "boolean"
                    },
                    "roles": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "schedule": {
                      "type": "object",
                      "properties": {
                        "frequency": {
                          "default": 0,
                          "type": "number"
                        },
                        "nextRun": {
                          "type": "number",
                          "minimum": 0
                        }
                      },
                      "required": [
                        "frequency",
                        "nextRun"
                      ],
                      "additionalProperties": false
                    },
                    "users": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 255
                      }
                    }
                  },
                  "required": [
                    "enabled",
                    "roles",
                    "users"
                  ],
                  "additionalProperties": false
                }
              },
              "push": {
                "default": {},
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "type": "object",
                  "properties": {
                    "enabled": {
                      "default": true,
                      "type": "boolean"
                    },
                    "roles": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "schedule": {
                      "type": "object",
                      "properties": {
                        "frequency": {
                          "default": 0,
                          "type": "number"
                        },
                        "nextRun": {
                          "type": "number",
                          "minimum": 0
                        }
                      },
                      "required": [
                        "frequency",
                        "nextRun"
                      ],
                      "additionalProperties": false
                    },
                    "users": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 255
                      }
                    }
                  },
                  "required": [
                    "enabled",
                    "roles",
                    "users"
                  ],
                  "additionalProperties": false
                }
              },
              "sms": {
                "default": {},
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "type": "object",
                  "properties": {
                    "enabled": {
                      "default": true,
                      "type": "boolean"
                    },
                    "roles": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "schedule": {
                      "type": "object",
                      "properties": {
                        "frequency": {
                          "default": 0,
                          "type": "number"
                        },
                        "nextRun": {
                          "type": "number",
                          "minimum": 0
                        }
                      },
                      "required": [
                        "frequency",
                        "nextRun"
                      ],
                      "additionalProperties": false
                    },
                    "users": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 255
                      }
                    }
                  },
                  "required": [
                    "enabled",
                    "roles",
                    "users"
                  ],
                  "additionalProperties": false
                }
              }
            },
            "required": [
              "email",
              "inApp",
              "push",
              "sms"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "auditLog",
          "id",
          "notifications"
        ],
        "additionalProperties": false
      },
      "OrganizationCommunicationsSettingsPatchPayload": {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "type": "object",
        "properties": {
          "auditLog": {
            "type": "object",
            "properties": {
              "settings": {
                "type": "object",
                "properties": {
                  "computers": {
                    "default": true,
                    "type": "boolean"
                  },
                  "devices": {
                    "default": true,
                    "type": "boolean"
                  },
                  "groups": {
                    "default": true,
                    "type": "boolean"
                  },
                  "hubs": {
                    "default": true,
                    "type": "boolean"
                  },
                  "locations": {
                    "default": true,
                    "type": "boolean"
                  },
                  "organization": {
                    "default": true,
                    "type": "boolean"
                  },
                  "other": {
                    "default": true,
                    "type": "boolean"
                  },
                  "roles": {
                    "default": true,
                    "type": "boolean"
                  },
                  "services": {
                    "default": true,
                    "type": "boolean"
                  },
                  "settings": {
                    "default": true,
                    "type": "boolean"
                  },
                  "users": {
                    "default": true,
                    "type": "boolean"
                  },
                  "workflows": {
                    "default": true,
                    "type": "boolean"
                  }
                },
                "required": [
                  "computers",
                  "devices",
                  "groups",
                  "hubs",
                  "locations",
                  "organization",
                  "other",
                  "roles",
                  "services",
                  "settings",
                  "users",
                  "workflows"
                ],
                "additionalProperties": false
              }
            },
            "required": [
              "settings"
            ],
            "additionalProperties": false
          },
          "notifications": {
            "type": "object",
            "properties": {
              "email": {
                "default": {},
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "type": "object",
                  "properties": {
                    "enabled": {
                      "default": true,
                      "type": "boolean"
                    },
                    "roles": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "schedule": {
                      "type": "object",
                      "properties": {
                        "frequency": {
                          "default": 0,
                          "type": "number"
                        },
                        "nextRun": {
                          "type": "number",
                          "minimum": 0
                        }
                      },
                      "required": [
                        "frequency",
                        "nextRun"
                      ],
                      "additionalProperties": false
                    },
                    "users": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 255
                      }
                    }
                  },
                  "required": [
                    "enabled",
                    "roles",
                    "users"
                  ],
                  "additionalProperties": false
                }
              },
              "inApp": {
                "default": {},
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "type": "object",
                  "properties": {
                    "enabled": {
                      "default": true,
                      "type": "boolean"
                    },
                    "roles": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "schedule": {
                      "type": "object",
                      "properties": {
                        "frequency": {
                          "default": 0,
                          "type": "number"
                        },
                        "nextRun": {
                          "type": "number",
                          "minimum": 0
                        }
                      },
                      "required": [
                        "frequency",
                        "nextRun"
                      ],
                      "additionalProperties": false
                    },
                    "users": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 255
                      }
                    }
                  },
                  "required": [
                    "enabled",
                    "roles",
                    "users"
                  ],
                  "additionalProperties": false
                }
              },
              "push": {
                "default": {},
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "type": "object",
                  "properties": {
                    "enabled": {
                      "default": true,
                      "type": "boolean"
                    },
                    "roles": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "schedule": {
                      "type": "object",
                      "properties": {
                        "frequency": {
                          "default": 0,
                          "type": "number"
                        },
                        "nextRun": {
                          "type": "number",
                          "minimum": 0
                        }
                      },
                      "required": [
                        "frequency",
                        "nextRun"
                      ],
                      "additionalProperties": false
                    },
                    "users": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 255
                      }
                    }
                  },
                  "required": [
                    "enabled",
                    "roles",
                    "users"
                  ],
                  "additionalProperties": false
                }
              },
              "sms": {
                "default": {},
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "type": "object",
                  "properties": {
                    "enabled": {
                      "default": true,
                      "type": "boolean"
                    },
                    "roles": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "schedule": {
                      "type": "object",
                      "properties": {
                        "frequency": {
                          "default": 0,
                          "type": "number"
                        },
                        "nextRun": {
                          "type": "number",
                          "minimum": 0
                        }
                      },
                      "required": [
                        "frequency",
                        "nextRun"
                      ],
                      "additionalProperties": false
                    },
                    "users": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 255
                      }
                    }
                  },
                  "required": [
                    "enabled",
                    "roles",
                    "users"
                  ],
                  "additionalProperties": false
                }
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "OrganizationUserCommunicationsSettings": {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255
          },
          "notifications": {
            "type": "object",
            "properties": {
              "email": {
                "default": {},
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "type": "object",
                  "properties": {
                    "enabled": {
                      "default": true,
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "enabled"
                  ],
                  "additionalProperties": false
                }
              },
              "inApp": {
                "default": {},
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "type": "object",
                  "properties": {
                    "enabled": {
                      "default": true,
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "enabled"
                  ],
                  "additionalProperties": false
                }
              },
              "push": {
                "default": {},
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "type": "object",
                  "properties": {
                    "enabled": {
                      "default": true,
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "enabled"
                  ],
                  "additionalProperties": false
                }
              },
              "sms": {
                "default": {},
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "type": "object",
                  "properties": {
                    "enabled": {
                      "default": true,
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "enabled"
                  ],
                  "additionalProperties": false
                }
              }
            },
            "required": [
              "email",
              "inApp",
              "push",
              "sms"
            ],
            "additionalProperties": false
          },
          "organization": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
              }
            },
            "required": [
              "id"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "id",
          "notifications",
          "organization"
        ],
        "additionalProperties": false
      },
      "OrganizationUserInAppNotification": {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "type": "object",
        "properties": {
          "hash": {
            "type": "string"
          },
          "id": {
            "type": "string",
            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
          },
          "links": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "href": {
                  "type": "string",
                  "format": "uri"
                },
                "text": {
                  "type": "string"
                },
                "type": {
                  "type": "string"
                }
              },
              "required": [
                "href",
                "text",
                "type"
              ],
              "additionalProperties": false
            }
          },
          "message": {
            "type": "string"
          },
          "metadata": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {}
          },
          "notification": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
              }
            },
            "required": [
              "id"
            ],
            "additionalProperties": false
          },
          "organization": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
              }
            },
            "required": [
              "id"
            ],
            "additionalProperties": false
          },
          "read": {
            "default": false,
            "type": "boolean"
          },
          "title": {
            "type": "string"
          },
          "user": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 255
              }
            },
            "required": [
              "id"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "hash",
          "id",
          "links",
          "message",
          "notification",
          "organization",
          "read",
          "title",
          "user"
        ],
        "additionalProperties": false
      },
      "OrganizationUserInAppNotificationPatchPayload": {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "type": "object",
        "properties": {
          "read": {
            "default": false,
            "type": "boolean"
          }
        },
        "required": [
          "read"
        ],
        "additionalProperties": false
      },
      "SharedSchema182": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "default": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {}
          },
          "properties": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "anyOf": [
                {
                  "anyOf": [
                    {
                      "type": "object",
                      "properties": {
                        "description": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "default": {
                          "type": "boolean"
                        },
                        "type": {
                          "type": "string",
                          "const": "boolean"
                        }
                      },
                      "required": [
                        "default",
                        "type"
                      ],
                      "additionalProperties": false
                    },
                    {
                      "type": "object",
                      "properties": {
                        "description": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "default": {
                          "type": "string"
                        },
                        "enum": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "type": {
                          "type": "string",
                          "const": "string"
                        }
                      },
                      "required": [
                        "default",
                        "type"
                      ],
                      "additionalProperties": false
                    },
                    {
                      "type": "object",
                      "properties": {
                        "description": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "default": {
                          "type": "number"
                        },
                        "maximum": {
                          "type": "number"
                        },
                        "minimum": {
                          "type": "number"
                        },
                        "type": {
                          "type": "string",
                          "const": "number"
                        }
                      },
                      "required": [
                        "default",
                        "type"
                      ],
                      "additionalProperties": false
                    }
                  ]
                },
                {
                  "$ref": "#/components/schemas/SharedSchema182"
                }
              ]
            }
          },
          "type": {
            "type": "string",
            "const": "object"
          }
        },
        "required": [
          "default",
          "properties",
          "type"
        ],
        "additionalProperties": false
      },
      "SharedSchema185": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/SharedSchema186"
        }
      },
      "SharedSchema186": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "format": {
                "type": "string",
                "const": "section"
              },
              "label": {
                "type": "string"
              },
              "style": {
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "type": "string"
                }
              },
              "children": {
                "anyOf": [
                  {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/SharedSchema186"
                    }
                  },
                  {}
                ]
              },
              "content": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {}
                ]
              }
            },
            "required": [
              "format"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "format": {
                "type": "string",
                "const": "row"
              },
              "label": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {}
                ]
              },
              "style": {
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "type": "string"
                }
              },
              "children": {
                "anyOf": [
                  {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/SharedSchema186"
                    }
                  },
                  {}
                ]
              }
            },
            "required": [
              "format"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "format": {
                "type": "string",
                "const": "column"
              },
              "label": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {}
                ]
              },
              "style": {
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "type": "string"
                }
              },
              "children": {
                "anyOf": [
                  {
                    "$ref": "#/components/schemas/SharedSchema185"
                  },
                  {}
                ]
              }
            },
            "required": [
              "format"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "format": {
                "type": "string",
                "const": "text"
              },
              "label": {
                "type": "string"
              },
              "style": {
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "type": "string"
                }
              },
              "content": {
                "type": "string"
              }
            },
            "required": [
              "format",
              "content"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "format": {
                "type": "string",
                "const": "image"
              },
              "label": {
                "type": "string"
              },
              "style": {
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "type": "string"
                }
              },
              "alt": {
                "type": "string"
              },
              "url": {
                "type": "string"
              }
            },
            "required": [
              "format",
              "url"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "format": {
                "type": "string",
                "const": "link"
              },
              "label": {
                "type": "string"
              },
              "style": {
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "type": "string"
                }
              },
              "url": {
                "type": "string"
              }
            },
            "required": [
              "format",
              "url"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "format": {
                "type": "string",
                "const": "heading"
              },
              "label": {
                "type": "string"
              },
              "style": {
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "type": "string"
                }
              },
              "content": {
                "type": "string"
              },
              "size": {
                "type": "number",
                "minimum": 1,
                "maximum": 6
              }
            },
            "required": [
              "format",
              "content",
              "size"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "format": {
                "type": "string",
                "const": "hr"
              },
              "label": {
                "type": "string"
              },
              "style": {
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {
                  "type": "string"
                }
              }
            },
            "required": [
              "format"
            ],
            "additionalProperties": false
          }
        ]
      },
      "UnauthorizedError": {
        "type": "object",
        "required": [
          "code",
          "message",
          "detail"
        ],
        "properties": {
          "code": {
            "type": "integer",
            "enum": [
              401
            ]
          },
          "message": {
            "type": "string",
            "enum": [
              "Unauthorized"
            ]
          },
          "detail": {
            "type": "string"
          }
        },
        "additionalProperties": false
      },
      "UpdateOrganizationCommunicationsSettingsRequest": {
        "$ref": "#/components/schemas/OrganizationCommunicationsSettingsPatchPayload",
        "$schema": "https://json-schema.org/draft/2020-12/schema"
      },
      "UpdateUserInAppNotificationRequest": {
        "$ref": "#/components/schemas/OrganizationUserInAppNotificationPatchPayload",
        "$schema": "https://json-schema.org/draft/2020-12/schema"
      }
    },
    "responses": {
      "Error": {
        "description": "Error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/InternalServerError"
            }
          }
        }
      },
      "ForbiddenError": {
        "description": "Forbidden: the token is valid but does not allow this request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "UnauthorizedError": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/UnauthorizedError"
            }
          }
        }
      }
    }
  }
}
