{
  "enum": [
    "user_alternate_email",
    "user_business_phones",
    "user_city",
    "user_country",
    "user_department",
    "user_job_title",
    "user_manager",
    "user_mobile_phone",
    "user_office_location",
    "user_postal_code",
    "user_principal_name_from_alternate_email",
    "user_state",
    "user_street_address"
  ],
  "type": "string",
  "title": "Office 365 BuiltIn Translation",
  "description": "Built-in translations for Office 365 (Microsoft Graph) export:\n* `user_alternate_email` - Translate `alternateEmail` field of JumpCloud user to `otherMails` field of Microsoft Graph `user`\n* `user_business_phones` - Translate `number` field of first JumpCloud user `phoneNumber` of type `work` to `businessPhones` field of Microsoft Graph `user`\n* `user_city` - Translate `locality` field of JumpCloud user address of type `work` to `city` field of Microsoft Graph user\n* `user_country` - Translate `country` field of JumpCloud user address of type `work` to `country` field of Microsoft Graph `user`\n* `user_department` - Translate `department` field of JumpCloud user to `department` field of Microsoft Graph `user`\n* `user_job_title` - Translate `jobTitle` field of JumpCloud user to `jobTitle` field of Microsoft Graph `user`\n* `user_manager` - Translate `manager` field of JumpCloud user to `manager` field of Microsoft Graph `user`\n* `user_mobile_phone` - Translate `number` field of first JumpCloud user `phoneNumber` of type `mobile` to `mobilePhone` field of Microsoft Graph `user`\n* `user_office_location` - Translate `location` field of JumpCloud user to `officeLocation` field of Microsoft Graph `user`\n* `user_postal_code` - Translate `postalCode` field of JumpCloud user address of type `work` to `postalCode` field of Microsoft Graph `user`\n* `user_principal_name_from_alternate_email` - Translate user `alternateEmail` field of Jumpcloud user to `userPrincipalName` field of Microsoft Graph `user`\n* `user_state` - Translate `region` field of JumpCloud user address of type `work` to `state` field of Microsoft Graph `user`\n* `user_street_address` - Translate `streetAddress` field of JumpCloud user address of type `work` to `streetAddress` field of Microsoft Graph user"
}

{
  "enum": [
    "export"
  ],
  "type": "string",
  "title": "Office 365 Direction translation",
  "default": "export",
  "description": "Direction identify if a attribute is going to be exported or imported from Office365\n* `Export`- The data will exported from the user modal to Office365\n"
}

{
  "type": "object",
  "properties": {
    "top": {
      "type": "integer"
    },
    "users": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "surname": {
            "type": "string"
          },
          "givenName": {
            "type": "string"
          },
          "userPrincipalName": {
            "type": "string"
          }
        }
      }
    },
    "skipToken": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "title": "Office 365 Translation Rule",
  "properties": {
    "id": {
      "type": "string",
      "description": "ObjectId uniquely identifying a Translation Rule."
    },
    "builtIn": {
      "$ref": "#/components/schemas/Office365BuiltinTranslation"
    },
    "direction": {
      "$ref": "#/components/schemas/Office365DirectionTranslation"
    }
  }
}

{
  "type": "object",
  "title": "Office 365 Translation Rule Request",
  "example": {
    "builtIn": "user_department",
    "direction": "export"
  },
  "properties": {
    "builtIn": {
      "$ref": "#/components/schemas/Office365BuiltinTranslation"
    },
    "direction": {
      "$ref": "#/components/schemas/Office365DirectionTranslation"
    }
  }
}

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

{
  "type": "object",
  "properties": {
    "oldPasswords": {
      "type": "integer",
      "format": "int32",
      "example": 10
    },
    "weakPasswords": {
      "type": "integer",
      "format": "int32",
      "example": 10
    },
    "reusedPasswords": {
      "type": "integer",
      "format": "int32",
      "example": 10
    },
    "compromisedPasswords": {
      "type": "integer",
      "format": "int32",
      "example": 10
    }
  }
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "maxLength": 1024
    },
    "number": {
      "type": "string",
      "maxLength": 1024
    }
  }
}

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

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

{
  "type": "object",
  "title": "Policy",
  "properties": {
    "id": {
      "type": "string",
      "description": "ObjectId uniquely identifying a Policy."
    },
    "name": {
      "type": "string",
      "description": "The description for this specific Policy."
    },
    "template": {
      "$ref": "#/components/schemas/PolicyTemplate"
    }
  },
  "description": "An instance of a policy template."
}

{
  "type": "object",
  "title": "PolicyCreateRequest",
  "required": [
    "name",
    "template"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The description for this specific Policy."
    },
    "notes": {
      "type": "string",
      "description": "The notes for this specific Policy."
    },
    "values": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PolicyValue"
      }
    },
    "template": {
      "type": "object",
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "ObjectId uniquely identifying a Policy instance."
        }
      }
    }
  },
  "description": "A request to create an instance of a policy template."
}

{
  "type": "object",
  "title": "PolicyGroup",
  "properties": {
    "id": {
      "type": "string",
      "description": "ObjectId uniquely identifying a Policy Group."
    },
    "name": {
      "type": "string",
      "description": "Display name of a Policy Group."
    },
    "type": {
      "enum": [
        "policy_group"
      ],
      "type": "string",
      "description": "The type of the group; always 'policy' for a Policy Group."
    },
    "email": {
      "type": "string",
      "description": "E-mail address associated with a Policy Group"
    },
    "attributes": {
      "$ref": "#/components/schemas/GraphAttributes"
    },
    "description": {
      "type": "string",
      "description": "Description of a Policy Group"
    }
  }
}

{
  "type": "object",
  "title": "PolicyGroupData",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Display name of a Policy Group."
    }
  }
}

{
  "type": "object",
  "title": "PolicyGroupTemplate",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "members": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PolicyGroupTemplateMember"
      }
    },
    "description": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "title": "PolicyGroupTemplateMember",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "policyTemplateId": {
      "type": "string"
    }
  }
}

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

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

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

{
  "type": "object",
  "properties": {
    "records": {
      "$ref": "#/components/schemas/ConfiguredPolicyTemplate"
    },
    "totalCount": {
      "type": "integer"
    }
  }
}

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

{
  "type": "object",
  "title": "PolicyResult",
  "properties": {
    "id": {
      "type": "string",
      "description": "ObjectId uniquely identifying a Policy Result."
    },
    "state": {
      "type": "string",
      "description": "Enumeration describing the state of the policy. Success, failed, or pending."
    },
    "detail": {
      "type": "string",
      "description": "Details pertaining to the policy result."
    },
    "stdErr": {
      "type": "string",
      "description": "The STDERR output from applying the policy."
    },
    "stdOut": {
      "type": "string",
      "description": "The STDOUT output from applying the policy."
    },
    "endedAt": {
      "type": "string",
      "format": "date-time",
      "description": "The end of the policy application."
    },
    "success": {
      "type": "boolean",
      "description": "True if the policy was successfully applied; false otherwise."
    },
    "policyID": {
      "type": "string",
      "description": "ObjectId uniquely identifying the parent Policy."
    },
    "systemID": {
      "type": "string",
      "description": "ObjectId uniquely identifying the parent System."
    },
    "startedAt": {
      "type": "string",
      "format": "date-time",
      "description": "The start of the policy application."
    },
    "exitStatus": {
      "type": "integer",
      "format": "uint32",
      "description": "The 32-bit unsigned exit status from the applying the policy."
    }
  }
}

{
  "type": "object",
  "title": "PolicyTemplate",
  "properties": {
    "id": {
      "type": "string",
      "description": "ObjectId uniquely identifying a Policy Template."
    },
    "name": {
      "type": "string",
      "description": "The unique name for the Policy Template."
    },
    "alert": {
      "type": "string",
      "description": "Text to describe any risk associated with this policy."
    },
    "state": {
      "type": "string",
      "default": "",
      "description": "String describing the release status of the policy template."
    },
    "behavior": {
      "type": "string",
      "description": "Specifics about the behavior of the policy."
    },
    "reference": {
      "type": "string",
      "description": "URL to visit for further information."
    },
    "activation": {
      "type": "string",
      "description": "Requirements before the policy can be activated."
    },
    "description": {
      "type": "string",
      "description": "The default description for the Policy."
    },
    "displayName": {
      "type": "string",
      "description": "The default display name for the Policy."
    },
    "osMetaFamily": {
      "enum": [
        "linux",
        "darwin",
        "windows",
        "ios",
        "universal",
        "android"
      ],
      "type": "string"
    },
    "deliveryTypes": {
      "type": "array",
      "items": {
        "enum": [
          "agent",
          "mdm"
        ],
        "type": "string",
        "default": "agent"
      },
      "description": "The supported delivery mechanisms for this policy template."
    },
    "osRestrictions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OSRestriction"
      }
    }
  },
  "x-examples": {
    "example-1": {
      "id": "string",
      "name": "string",
      "alert": "string",
      "state": "",
      "behavior": "string",
      "reference": "string",
      "activation": "string",
      "description": "string",
      "displayName": "string",
      "osMetaFamily": "linux",
      "deliveryTypes": [
        "agent"
      ],
      "osRestrictions": [
        {
          "osName": "string",
          "earliestVersion": "string",
          "deprecatedVersion": "string",
          "supportedEnrollmentTypes": [
            "automated"
          ]
        }
      ]
    }
  },
  "description": "The shallow information about a Policy Template."
}

{
  "type": "object",
  "title": "PolicyTemplateConfigField",
  "required": [
    "id",
    "name"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "ObjectId uniquely identifying a Policy Template Configuration Field"
    },
    "name": {
      "type": "string",
      "description": "A unique name identifying this config field."
    },
    "label": {
      "type": "string",
      "description": "The default label for this field."
    },
    "tooltip": {
      "type": "object",
      "properties": {
        "template": {
          "type": "string"
        },
        "variables": {
          "type": "object",
          "properties": {
            "icon": {
              "type": "string"
            },
            "message": {
              "type": "string"
            }
          }
        }
      }
    },
    "position": {
      "type": "number",
      "description": "The default position to render this field."
    },
    "readOnly": {
      "type": "boolean",
      "description": "If an admin is allowed to modify this field."
    },
    "required": {
      "type": "boolean",
      "description": "If this field is required for this field."
    },
    "sensitive": {
      "type": "boolean",
      "description": "Defines if the policy template config field is sensitive or not."
    },
    "validators": {
      "type": "object",
      "description": "Descriptors to perform extended assertions on the supplied config field value."
    },
    "displayType": {
      "enum": [
        "checkbox",
        "date",
        "email",
        "file",
        "number",
        "select",
        "text",
        "textarea",
        "singlelistbox",
        "doublelistbox",
        "table",
        "segmentedbutton",
        "radio",
        "copywell",
        "timeinput",
        "datepickerrange",
        "multilist"
      ],
      "type": "string",
      "description": "The default rendering for this field."
    },
    "defaultValue": {
      "type": "string",
      "description": "The default value for this field."
    },
    "displayOptions": {
      "type": "object",
      "description": "The options that correspond to the display_type."
    }
  }
}

{
  "type": "object",
  "title": "PolicyTemplateWithDetails",
  "properties": {
    "id": {
      "type": "string",
      "description": "ObjectId uniquely identifying a Policy Template."
    },
    "name": {
      "type": "string",
      "description": "The unique name for the Policy Template."
    },
    "behavior": {
      "type": "string",
      "description": "Specifics about the behavior of the policy."
    },
    "activation": {
      "type": "string",
      "description": "Requirements before the policy can be activated."
    },
    "description": {
      "type": "string",
      "description": "The default description for the Policy."
    },
    "displayName": {
      "type": "string",
      "description": "The default display name for the Policy."
    },
    "configFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PolicyTemplateConfigField"
      },
      "description": "An unordered list of all the fields that can be configured for this Policy Template."
    },
    "osMetaFamily": {
      "enum": [
        "linux",
        "darwin",
        "windows",
        "ios",
        "universal",
        "android"
      ],
      "type": "string"
    },
    "osRestrictions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OSRestriction"
      }
    }
  },
  "description": "The shallow information about a Policy Template."
}

{
  "type": "object",
  "title": "PolicyRequest",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The description for this specific Policy."
    },
    "notes": {
      "type": "string",
      "description": "The notes for this specific Policy."
    },
    "values": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PolicyValue"
      }
    }
  },
  "description": "A request to update an instance of a policy template."
}

{
  "type": "object",
  "title": "PolicyValue",
  "properties": {
    "value": {
      "type": "string",
      "items": {},
      "description": "The value for the configuration field for this Policy instance."
    },
    "sensitive": {
      "type": "boolean",
      "description": "Defines if the value is sensitive or not."
    },
    "configFieldID": {
      "type": "string",
      "description": "The ObjectId of the corresponding Policy Template configuration field."
    }
  }
}

{
  "type": "object",
  "title": "PolicyWithDetails",
  "properties": {
    "id": {
      "type": "string",
      "description": "ObjectId uniquely identifying a Policy."
    },
    "name": {
      "type": "string",
      "description": "The description for this specific Policy."
    },
    "notes": {
      "type": "string",
      "description": "The notes for this specific Policy."
    },
    "values": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PolicyValue"
      }
    },
    "template": {
      "$ref": "#/components/schemas/PolicyTemplate"
    },
    "configFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PolicyTemplateConfigField"
      }
    }
  },
  "description": "An instance of a policy template."
}

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

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

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

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

{
  "example": {
    "id": "5c3536e9e0a6840001872799",
    "disallowOrgCreation": true
  },
  "properties": {
    "id": {
      "type": "string"
    },
    "disallowOrgCreation": {
      "type": "boolean"
    }
  }
}

{
  "type": "object",
  "title": "ProviderAdminReq",
  "example": {
    "role": "5c3536e9e0a6840001872799",
    "email": "joe@example.com",
    "lastname": "Blough",
    "roleName": "Administrator",
    "firstname": "Joe",
    "bindNoOrgs": false,
    "enableMultiFactor": true
  },
  "required": [
    "email"
  ],
  "properties": {
    "role": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "lastname": {
      "type": "string"
    },
    "roleName": {
      "type": "string"
    },
    "firstname": {
      "type": "string"
    },
    "bindNoOrgs": {
      "type": "boolean",
      "default": false
    },
    "apiKeyAllowed": {
      "type": "boolean"
    },
    "enableMultiFactor": {
      "type": "boolean"
    }
  }
}

{
  "type": "object",
  "title": "ProviderInvoice",
  "example": {
    "id": "234324",
    "status": "Partially Paid",
    "dueDate": "2021-08-07",
    "currency": "USD",
    "amountPaid": "10.9",
    "amountBilled": "200.0",
    "amountRemaining": "189.1"
  },
  "properties": {
    "id": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "dueDate": {
      "type": "string"
    },
    "currency": {
      "type": "string"
    },
    "amountPaid": {
      "type": "string"
    },
    "amountBilled": {
      "type": "string"
    },
    "amountRemaining": {
      "type": "string"
    }
  },
  "description": "Details of a an invoice"
}

{
  "type": "object",
  "title": "ProviderInvoiceResponse",
  "properties": {
    "records": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ProviderInvoice"
      }
    },
    "totalCount": {
      "type": "integer"
    }
  },
  "description": "Response for retrieve provider invoices"
}

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

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

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

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

{
  "type": "string",
  "format": "binary"
}

{
  "type": "object",
  "title": "PushEndpointResponse",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "state": {
      "type": "string"
    },
    "device": {
      "type": "object",
      "properties": {
        "os": {
          "type": "string"
        },
        "make": {
          "type": "string"
        },
        "model": {
          "type": "string"
        },
        "osVersion": {
          "type": "string"
        },
        "uvEnabled": {
          "type": "boolean"
        },
        "appVersion": {
          "type": "string"
        }
      }
    },
    "lastUsedDate": {
      "type": "string",
      "format": "date-time"
    },
    "enrollmentDate": {
      "type": "string",
      "format": "date-time"
    }
  },
  "description": "A push endpoint response from the auth service."
}

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

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "state": {
      "enum": [
        "active",
        "inactive"
      ],
      "type": "string"
    }
  }
}

{
  "type": "object",
  "title": "SendVerificationPushRequest represents a create request",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "required": [
    "results",
    "totalCount"
  ],
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "$ref": "#/components/schemas/PwmUser"
          },
          {
            "$ref": "#/components/schemas/PasswordsSecurity"
          }
        ]
      }
    },
    "totalCount": {
      "type": "integer",
      "format": "int32",
      "example": 50
    }
  }
}

{
  "type": "object",
  "properties": {
    "approved": {
      "type": "integer",
      "format": "int32"
    },
    "requested": {
      "type": "integer",
      "format": "int32"
    }
  }
}

{
  "type": "object",
  "properties": {
    "createdBy": {
      "type": "string",
      "format": "uuid"
    },
    "updatedBy": {
      "type": "string",
      "format": "uuid"
    },
    "dateCreated": {
      "type": "string"
    },
    "dateUpdated": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "properties": {
    "type": {
      "type": "integer",
      "format": "int32"
    },
    "count": {
      "type": "integer",
      "format": "int32"
    }
  }
}

{
  "type": "object",
  "required": [
    "results",
    "totalCount"
  ],
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PwmItemsCountByType"
      }
    },
    "results": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "$ref": "#/components/schemas/PwmUserItem"
          },
          {
            "$ref": "#/components/schemas/PwmItemHistory"
          }
        ]
      }
    },
    "totalCount": {
      "type": "integer",
      "format": "int32",
      "example": 50
    }
  }
}