object CasesResponse

{
  "type": "object",
  "title": "CasesResponse",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Case"
      }
    },
    "totalCount": {
      "type": "integer"
    }
  },
  "description": "Response for retrieving the cases (support/feature requests)"
}

object ConfiguredPolicyTemplate

{
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "values": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ConfiguredPolicyTemplateValue"
      }
    },
    "policyTemplateId": {
      "type": "string"
    }
  }
}

object ConfiguredPolicyTemplateValue

{
  "example": {
    "id": "63e6722746d3949ea9c073cc",
    "name": "setallowDeviceNameModification",
    "value": true
  },
  "properties": {
    "name": {
      "type": "string"
    },
    "value": {
      "description": "The value of this Configured Policy Template Value"
    },
    "configFieldId": {
      "type": "string",
      "description": "The ObjectId of the corresponding Policy Template configuration field."
    }
  }
}

object ConnectWiseMappingRequest

{
  "type": "object",
  "minItems": 1,
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "organization",
          "company"
        ],
        "properties": {
          "delete": {
            "type": "boolean"
          },
          "company": {
            "type": "object",
            "required": [
              "id",
              "name"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            }
          },
          "addition": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "nullable": true
              },
              "name": {
                "type": "string",
                "nullable": true
              }
            }
          },
          "agreement": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "nullable": true
              },
              "name": {
                "type": "string",
                "nullable": true
              }
            }
          },
          "organization": {
            "type": "object",
            "required": [
              "id",
              "name"
            ],
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1
              },
              "name": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  },
  "x-examples": {
    "Delete Mapping": {
      "data": [
        {
          "delete": true,
          "organization": {
            "id": "orgId-1",
            "name": "string"
          }
        },
        {
          "delete": true,
          "organization": {
            "id": "orgId-2",
            "name": "string"
          }
        },
        {
          "delete": true,
          "organization": {
            "id": "orgId-3",
            "name": "string"
          }
        }
      ]
    },
    "Create\\Edit Existing Mapping example": [
      {
        "company": {
          "id": "string",
          "name": "string"
        },
        "addition": {
          "id": "string",
          "name": "string"
        },
        "agreement": {
          "id": "string",
          "name": "string"
        },
        "organization": {
          "id": "newOrganizationId",
          "name": "string"
        }
      },
      {
        "company": {
          "id": "string",
          "name": "string"
        },
        "addition": {
          "id": "string",
          "name": "string"
        },
        "agreement": {
          "id": "string",
          "name": "string"
        },
        "organization": {
          "id": "existingOrganizationId",
          "name": "string"
        }
      }
    ]
  },
  "description": "Request object for creating ConnectWise mappings"
}

object ConnectWiseMappingResponse

{
  "type": "object",
  "title": "ConnectWiseMappingResponse",
  "properties": {
    "company": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "addition": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "agreement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "organization": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "lastSyncStatus": {
      "type": "string"
    },
    "lastSyncDateTime": {
      "type": "string"
    }
  },
  "description": "ConnectWise mapping GET response"
}

object ConnectWiseSettings

{
  "type": "object",
  "title": "Get ConnectWise integration settings GET object",
  "properties": {
    "companyTypeIds": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "The array of ConnectWise companyType IDs applicable to the Provider."
    },
    "automaticTicketing": {
      "type": "boolean",
      "description": "Determine whether ConnectWise uses automatic ticketing"
    }
  },
  "description": "ConnectWise integration settings"
}

object ConnectWiseSettingsPatchReq

{
  "type": "object",
  "title": "Update ConnectWise Integration's Settings PATCH object",
  "properties": {
    "companyTypeIds": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "maxItems": 150,
      "description": "The array of ConnectWise companyType IDs applicable to the Provider."
    },
    "automaticTicketing": {
      "type": "boolean",
      "description": "Determine whether ConnectWise uses automatic ticketing"
    }
  },
  "x-examples": {
    "example-1": {
      "companyTypeIds": [
        0,
        1
      ],
      "automaticTicketing": true
    }
  },
  "description": "Request for updating a ConnectWise integration's settings"
}

object ConnectWiseTicketingAlertConfiguration

{
  "type": "object",
  "required": [
    "shouldCreateTickets"
  ],
  "properties": {
    "id": {
      "type": "integer"
    },
    "source": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "dueDays": {
      "type": "integer"
    },
    "category": {
      "type": "string"
    },
    "priority": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "description": {
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "shouldCreateTickets": {
      "type": "boolean"
    }
  }
}

object ConnectWiseTicketingAlertConfigurationList

{
  "type": "object",
  "required": [
    "records"
  ],
  "properties": {
    "records": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "alertId": {
                "type": "string"
              }
            }
          },
          {
            "$ref": "#/components/schemas/ConnectWiseTicketingAlertConfiguration"
          }
        ]
      }
    }
  }
}

object ConnectWiseTicketingAlertConfigurationOption

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "values": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string"
          },
          "value": {
            "type": "integer"
          }
        }
      }
    }
  }
}

object ConnectWiseTicketingAlertConfigurationOptions

{
  "type": "object",
  "required": [
    "records"
  ],
  "properties": {
    "records": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ConnectWiseTicketingAlertConfigurationOption"
      }
    }
  }
}

object ConnectWiseTicketingAlertConfigurationRequest

{
  "type": "object",
  "required": [
    "shouldCreateTickets"
  ],
  "properties": {
    "source": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "dueDays": {
      "type": "integer"
    },
    "priority": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "shouldCreateTickets": {
      "type": "boolean"
    }
  }
}

object ConnectwiseAddition

{
  "type": "object",
  "required": [
    "id",
    "name"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The addition identifier."
    },
    "name": {
      "type": "string",
      "description": "The addition name."
    }
  },
  "description": "Connectwise addition details"
}

object ConnectwiseAgreement

{
  "type": "object",
  "required": [
    "id",
    "name",
    "companyId"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The agreement identifier."
    },
    "name": {
      "type": "string",
      "description": "The agreement name."
    },
    "companyId": {
      "type": "string",
      "description": "The ConnectWise company identifier linked to agreement."
    }
  },
  "description": "Connectwise agreement details"
}

object ConnectwiseCompany

{
  "type": "object",
  "required": [
    "id",
    "name"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The company identifier."
    },
    "name": {
      "type": "string",
      "description": "The company name."
    }
  },
  "description": "Connectwise company details"
}

object ConnectwiseCompanyResp

{
  "type": "object",
  "required": [
    "totalCount",
    "records"
  ],
  "properties": {
    "records": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ConnectwiseCompany"
      }
    },
    "totalCount": {
      "type": "integer"
    }
  },
  "description": "Response for retrieving ConnectWise companies"
}

object ConnectwiseCompanyTypeResp

{
  "type": "object",
  "required": [
    "totalCount",
    "records"
  ],
  "properties": {
    "records": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/BillingIntegrationCompanyType"
      }
    },
    "totalCount": {
      "type": "integer"
    }
  },
  "description": "Response for retrieving ConnectWise company types"
}

object ConnectwiseCreateConfiguration422Response

{
  "type": "object",
  "properties": {}
}

object ConnectwiseCreateConfigurationResponse

{
  "type": "object",
  "required": [
    "integrationId"
  ],
  "properties": {
    "integrationId": {
      "type": "string",
      "description": "The identifier of the created integration"
    }
  }
}

object ConnectwiseIntegration

{
  "type": "object",
  "title": "Get ConnectWise integration GET object",
  "required": [
    "id",
    "url",
    "companyId"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The identifier for this ConnectWise integration."
    },
    "url": {
      "type": "string",
      "description": "The base url for connecting to ConnectWise."
    },
    "companyId": {
      "type": "string",
      "description": "The ConnectWise company identifier."
    },
    "isMspAuthConfigured": {
      "type": "boolean",
      "description": "Has the msp-api been configured with auth data yet"
    }
  },
  "description": "ConnectWise integration configuration details"
}

object ConnectwiseIntegrationPatchReq

{
  "type": "object",
  "title": "Create ConnectWise Integration PATCH object",
  "properties": {
    "url": {
      "type": "string",
      "description": "The base url for connecting to ConnectWise."
    },
    "companyId": {
      "type": "string",
      "description": "The ConnectWise company identifier."
    },
    "publicKey": {
      "type": "string",
      "description": "The ConnectWise public key for authentication."
    },
    "privateKey": {
      "type": "string",
      "description": "The ConnectWise private key for authentication"
    }
  },
  "description": "Request for updating a ConnectWise integration"
}

object ConnectwiseIntegrationReq

{
  "type": "object",
  "title": "Create ConnectWise Integration POST object",
  "required": [
    "url",
    "companyId",
    "publicKey",
    "privateKey"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "The base url for connecting to ConnectWise."
    },
    "companyId": {
      "type": "string",
      "description": "The ConnectWise company identifier."
    },
    "publicKey": {
      "type": "string",
      "description": "The ConnectWise public key for authentication."
    },
    "privateKey": {
      "type": "string",
      "description": "The ConnectWise private key for authentication"
    }
  },
  "description": "Request for creating a ConnectWise integration"
}

object ConnectwiseRetrieveAdditionsResponse

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ConnectwiseAddition"
      }
    },
    "totalCount": {
      "type": "integer"
    }
  }
}

object ConnectwiseRetrieveAgreementsResponse

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ConnectwiseAgreement"
      }
    },
    "totalCount": {
      "type": "integer"
    }
  }
}

object ConnectwiseRetrieveMappingsResponse

{
  "type": "object",
  "properties": {
    "records": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ConnectWiseMappingResponse"
      }
    },
    "totalCount": {
      "type": "number"
    }
  }
}

object ConnectwiseUpdateConfigurationResponse

{
  "type": "object",
  "properties": {}
}

object CreateOrganization

{
  "type": "object",
  "title": "CreateOrganization",
  "example": {
    "name": "Acme Inc",
    "maxSystemUsers": 10
  },
  "properties": {
    "name": {
      "type": "string"
    },
    "maxSystemUsers": {
      "type": "integer",
      "description": "The maximum number of users allowed in this organization. Requires organizations.billing scope to modify."
    }
  }
}

object CustomEmail

{
  "type": "object",
  "title": "CustomEmail",
  "required": [
    "type",
    "subject"
  ],
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "body": {
      "type": "string",
      "minLength": 0
    },
    "type": {
      "$ref": "#/components/schemas/CustomEmailType"
    },
    "title": {
      "type": "string",
      "minLength": 0
    },
    "button": {
      "type": "string",
      "minLength": 0
    },
    "header": {
      "type": "string",
      "minLength": 0
    },
    "subject": {
      "type": "string",
      "minLength": 0
    },
    "nextStepContactInfo": {
      "type": "string",
      "minLength": 0
    }
  },
  "description": "Custom email content created by the admin user to personalize emails sent to their system users."
}

object CustomEmailTemplate

{
  "type": "object",
  "title": "CustomEmailTemplate",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/CustomEmailType"
    },
    "fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CustomEmailTemplateField"
      }
    },
    "description": {
      "type": "string"
    },
    "displayName": {
      "type": "string"
    }
  }
}

object CustomEmailTemplateField

{
  "type": "object",
  "title": "CustomEmailTemplateField",
  "properties": {
    "field": {
      "type": "string"
    },
    "multiline": {
      "type": "boolean"
    },
    "displayName": {
      "type": "string"
    },
    "defaultValue": {
      "type": "string"
    }
  }
}

string CustomEmailType

{
  "enum": [
    "activate_gapps_user",
    "activate_o365_user",
    "lockout_notice_user",
    "password_expiration",
    "password_expiration_warning",
    "password_reset_confirmation",
    "user_change_password",
    "activate_user_custom"
  ],
  "type": "string"
}

array CustomEmailsGetTemplatesResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/CustomEmailTemplate"
  }
}

object DEP

{
  "type": "object",
  "title": "DEP",
  "properties": {
    "welcomeScreen": {
      "$ref": "#/components/schemas/DEPWelcomeScreen"
    },
    "setupAssistantOptions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DEPSetupAssistantOption"
      }
    },
    "enableZeroTouchEnrollment": {
      "type": "boolean",
      "description": "A toggle to determine if DEP registered devices should go through JumpCloud Zero Touch Enrollment."
    }
  },
  "x-deprecated": true
}

object DEPSetupAssistantOption

{
  "type": "object",
  "title": "DEP Setup Assistant Option",
  "properties": {
    "option": {
      "$ref": "#/components/schemas/SetupAssistantOption"
    }
  }
}

object DEPWelcomeScreen

{
  "type": "object",
  "title": "DEPWelcomeScreen",
  "properties": {
    "title": {
      "type": "string",
      "maxLength": 255,
      "description": "The title to display on the DEP Welcome Screen."
    },
    "button": {
      "type": "string",
      "maxLength": 64,
      "description": "Text to display on the button on the DEP Welcome Screen."
    },
    "paragraph": {
      "type": "string",
      "maxLength": 1024,
      "description": "A message to display on the DEP Welcome Screen."
    }
  },
  "x-examples": {
    "defaults": {
      "title": "Welcome",
      "button": "continue",
      "paragraph": "In just a few steps, you will be working securely from your Mac."
    }
  }
}

object DevicesEraseDeviceRequest

{
  "type": "object"
}

object DevicesEraseDeviceResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object DevicesLockDeviceResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object DevicesRebootDeviceResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object DevicesResetPasswordRequest

{
  "type": "object",
  "properties": {
    "flags": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "newPassword": {
      "type": "string",
      "description": "Not logging as it contains sensitive information."
    }
  }
}

object DevicesResetPasswordResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

array DirectoriesListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Directory"
  }
}

object Directory

{
  "type": "object",
  "title": "Directory",
  "required": [
    "id",
    "name",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The ObjectID of the directory."
    },
    "name": {
      "type": "string",
      "description": "The name of the directory."
    },
    "type": {
      "enum": [
        "active_directory",
        "g_suite",
        "ldap_server",
        "office_365",
        "workday"
      ],
      "type": "string",
      "description": "The type of directory."
    },
    "oAuthStatus": {
      "type": "object",
      "description": "the expiry and error status of the bearer token"
    },
    "defaultDomain": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "domain": {
          "type": "string"
        }
      },
      "description": "The default domain object if exists, contains id and name of the domain."
    }
  },
  "description": ""
}

object DomainsInsertRequest

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string"
    }
  }
}

object DuoAccount

{
  "type": "object",
  "title": "DuoAccount",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "object ID"
    },
    "name": {
      "type": "string",
      "description": "Duo application name."
    }
  }
}

array DuoAccountListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DuoAccount"
  }
}

object DuoApplication

{
  "type": "object",
  "title": "DuoApplication",
  "required": [
    "id",
    "name",
    "apiHost",
    "integrationKey"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "apiHost": {
      "type": "string"
    },
    "integrationKey": {
      "type": "string"
    }
  }
}

array DuoApplicationListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DuoApplication"
  }
}

object DuoApplicationReq

{
  "type": "object",
  "title": "DuoApplicationReq",
  "required": [
    "name",
    "apiHost",
    "integrationKey",
    "secretKey"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "apiHost": {
      "type": "string"
    },
    "secretKey": {
      "type": "string"
    },
    "integrationKey": {
      "type": "string"
    }
  }
}

object DuoApplicationUpdateReq

{
  "type": "object",
  "title": "DuoApplicationUpdateReq",
  "required": [
    "name",
    "apiHost",
    "integrationKey"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "apiHost": {
      "type": "string"
    },
    "secretKey": {
      "type": "string"
    },
    "integrationKey": {
      "type": "string"
    }
  }
}