{
  "type": "object",
  "title": "Auth Input Object",
  "example": {
    "auth": {
      "basic": {
        "password": "mollit cillum",
        "username": "veniam dolore"
      },
      "oauth": {
        "code": "minim ad ea dolor"
      }
    }
  },
  "properties": {
    "auth": {
      "$ref": "#/components/schemas/auth-input"
    }
  }
}

{
  "type": "object",
  "title": "Bulk Schedule User State Change Create",
  "required": [
    "user_ids",
    "state",
    "start_date"
  ],
  "properties": {
    "state": {
      "enum": [
        "ACTIVATED",
        "SUSPENDED"
      ],
      "type": "string",
      "description": "The state to move the user(s) to"
    },
    "user_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array of system user ids to schedule for a state change"
    },
    "start_date": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time that scheduled action should occur"
    },
    "send_activation_emails": {
      "type": "boolean",
      "description": "Set to true to send activation or welcome email(s) to each user_id upon activation. Set to false to suppress emails. Can only be used with scheduled activation(s)."
    },
    "activation_email_override": {
      "type": "string",
      "description": "Send the activation or welcome email to the specified email address upon activation. Can only be used with a single user_id and scheduled activation. This field will be ignored if `send_activation_emails` is explicitly set to false."
    }
  },
  "x-examples": {
    "example-1": {
      "state": "SUSPENDED",
      "user_ids": [
        "666f6f2d6261722d71757578",
        "0123456789ab0123456789ab",
        "666f6f2d6261722d71757555"
      ],
      "start_date": "2020-01-01T02:00:00"
    },
    "example-2": {
      "state": "ACTIVATED",
      "user_ids": [
        "666f6f2d6261722d71757578",
        "0123456789ab0123456789ab",
        "666f6f2d6261722d71757555"
      ],
      "start_date": "2020-01-01T02:00:00",
      "send_activation_emails": true
    },
    "example-3": {
      "state": "ACTIVATED",
      "user_ids": [
        "666f6f2d6261722d71757578"
      ],
      "start_date": "2020-01-01T02:00:00",
      "activation_email_override": "alternate-activation-email@email.com"
    }
  },
  "description": "Model to support bulk scheduling of a state change for one or more users"
}

{
  "type": "object",
  "title": "Bulk User Create",
  "properties": {
    "email": {
      "type": "string"
    },
    "lastname": {
      "type": "string"
    },
    "username": {
      "type": "string"
    },
    "firstname": {
      "type": "string"
    },
    "attributes": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Map of additional attributes."
    }
  },
  "description": "See [V1 system user creation](https://docs.jumpcloud.com/api/1.0/index.html#operation/systemusers_post) for full list of attributes."
}

{
  "type": "object",
  "title": "Bulk User Expire",
  "properties": {
    "id": {
      "type": "string",
      "description": "Object ID of the systemuser to expire"
    },
    "attributes": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Map of additional attributes."
    },
    "organization": {
      "type": "string",
      "description": "The identifier for an organization to link this systemuser to"
    }
  }
}

{
  "type": "object",
  "title": "Bulk User Unlock",
  "properties": {
    "id": {
      "type": "string",
      "description": "Object ID of the systemuser to unlock"
    },
    "attributes": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Map of additional attributes."
    },
    "organization": {
      "type": "string",
      "description": "The identifier for an organization to link this systemuser"
    }
  }
}

{
  "type": "object",
  "title": "Bulk User Update",
  "properties": {
    "id": {
      "type": "string",
      "description": "Object ID of the user being updated"
    },
    "email": {
      "type": "string"
    },
    "lastname": {
      "type": "string"
    },
    "username": {
      "type": "string"
    },
    "firstname": {
      "type": "string"
    },
    "attributes": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Map of additional attributes."
    },
    "organization": {
      "type": "string",
      "description": "Organization object id of the user"
    }
  },
  "description": "See [V1 system user update](https://docs.jumpcloud.com/api/1.0/index.html#operation/systemusers_put) for full list of attributes."
}

{
  "type": "object",
  "title": "commandsGraphObjectWithPaths",
  "required": [
    "type",
    "id",
    "paths"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Object ID of this graph object."
    },
    "name": {
      "type": "string"
    },
    "type": {
      "$ref": "#/components/schemas/GraphType"
    },
    "paths": {
      "type": "array",
      "items": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/GraphConnection"
        }
      },
      "description": "A path through the graph between two graph objects."
    },
    "command": {
      "type": "string"
    },
    "timeout": {
      "type": "string"
    },
    "schedule": {
      "type": "string"
    },
    "launchType": {
      "type": "string"
    },
    "commandType": {
      "type": "string"
    },
    "organization": {
      "type": "string"
    },
    "timeToLiveSeconds": {
      "type": "integer"
    },
    "compiledAttributes": {
      "$ref": "#/components/schemas/GraphAttributes"
    },
    "scheduleRepeatType": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "domain": {
      "type": "string",
      "readOnly": true
    }
  }
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "osName": {
      "type": "string"
    },
    "userUuid": {
      "type": "string"
    },
    "createdAt": {
      "type": "string"
    },
    "publicKey": {
      "type": "string"
    },
    "updatedAt": {
      "type": "string"
    },
    "appVersion": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/device_package.v1.Device"
      }
    },
    "totalCount": {
      "type": "integer",
      "format": "int32"
    }
  }
}

{
  "type": "object",
  "title": "Responses",
  "properties": {
    "total": {
      "type": "integer",
      "format": "int64",
      "description": "the count of all the policies attached to the system."
    },
    "failed": {
      "type": "integer",
      "format": "int64",
      "description": "the count of failing policies."
    },
    "pending": {
      "type": "integer",
      "format": "int64",
      "description": "the count of pending policies."
    },
    "success": {
      "type": "integer",
      "format": "int64",
      "description": "the count of successful policies."
    },
    "duplicate": {
      "type": "integer",
      "format": "int64",
      "description": "the count of duplicate policies."
    },
    "unsupportedOs": {
      "type": "integer",
      "format": "int64",
      "description": "the count of policies for which os is unsupported."
    }
  }
}

{
  "type": "object",
  "properties": {
    "failedPolicies": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "pendingPolicies": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "policyCountData": {
      "$ref": "#/components/schemas/devices.AggregatedPolicyCount"
    }
  }
}

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

{
  "type": "object",
  "properties": {
    "settings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/devices.SignInWithJumpCloudSetting"
      }
    },
    "organizationObjectId": {
      "type": "string",
      "format": "byte"
    }
  }
}

{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "organizationObjectId": {
      "type": "string",
      "format": "byte"
    }
  }
}

{
  "type": "object",
  "properties": {
    "settings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/devices.SignInWithJumpCloudSetting"
      }
    },
    "organizationObjectId": {
      "type": "string",
      "format": "byte"
    }
  }
}

{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "osFamily": {
      "$ref": "#/components/schemas/devices.SignInWithJumpCloudSetting.OSFamily"
    },
    "defaultPermission": {
      "$ref": "#/components/schemas/devices.SignInWithJumpCloudSetting.Permission"
    }
  }
}

{
  "enum": [
    "UNKNOWN",
    "WINDOWS",
    "MACOS"
  ],
  "type": "string",
  "default": "UNKNOWN"
}

{
  "enum": [
    "STANDARD",
    "ADMIN"
  ],
  "type": "string",
  "default": "STANDARD"
}

{
  "type": "object",
  "properties": {
    "name": {
      "enum": [
        "cloudDirectory",
        "cloudInsights",
        "deviceManagement",
        "directoryInsightsPremium",
        "federatedDeviceIdentity",
        "implementationQuickstart",
        "jcManagedDeviceIdentity",
        "jumpcloudGo",
        "jumpcloudProtect",
        "ldap",
        "mdm",
        "mfa",
        "osPatchManagement",
        "passwordManagement",
        "premiumSupport",
        "primePass",
        "radius",
        "remoteAccess",
        "sso",
        "systemInsights",
        "userLifecycle",
        "zeroTrust"
      ],
      "type": "string",
      "description": "The unique identifier for this feature."
    }
  },
  "description": "A feature represents JumpCloud functionality."
}

{
  "type": "object",
  "properties": {
    "@type": {
      "type": "string",
      "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."
    }
  },
  "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\nExample 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\nExample 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := anypb.New(foo)\n     if err != nil {\n       ...\n     }\n     ...\n     foo := &pb.Foo{}\n     if err := any.UnmarshalTo(foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }",
  "additionalProperties": {}
}

{
  "type": "object",
  "properties": {
    "code": {
      "type": "integer",
      "format": "int32"
    },
    "details": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/google.protobuf.Any"
      }
    },
    "message": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "title": "GSuite",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "type": "string"
    },
    "defaultDomain": {
      "$ref": "#/components/schemas/defaultDomain"
    },
    "groupsEnabled": {
      "type": "boolean"
    },
    "userLockoutAction": {
      "enum": [
        "suspend",
        "maintain"
      ],
      "type": "string"
    },
    "userPasswordExpirationAction": {
      "enum": [
        "suspend",
        "maintain",
        "remove_access"
      ],
      "type": "string"
    }
  }
}

{
  "type": "object",
  "title": "Import User",
  "properties": {
    "id": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "company": {
      "type": "string"
    },
    "manager": {
      "type": "string"
    },
    "jobTitle": {
      "type": "string"
    },
    "lastname": {
      "type": "string"
    },
    "location": {
      "type": "string"
    },
    "username": {
      "type": "string"
    },
    "addresses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/importUserAddress"
      }
    },
    "firstname": {
      "type": "string"
    },
    "costCenter": {
      "type": "string"
    },
    "department": {
      "type": "string"
    },
    "middlename": {
      "type": "string"
    },
    "displayname": {
      "type": "string"
    },
    "employeeType": {
      "type": "string"
    },
    "phoneNumbers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/importUserPhoneNumber"
      }
    },
    "alternateEmail": {
      "type": "string"
    },
    "employeeIdentifier": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "title": "Import User Address",
  "properties": {
    "type": {
      "type": "string"
    },
    "region": {
      "type": "string"
    },
    "country": {
      "type": "string"
    },
    "locality": {
      "type": "string"
    },
    "postalCode": {
      "type": "string"
    },
    "streetAddress": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "title": "Import User Address",
  "properties": {
    "type": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "title": "Import Users Response",
  "properties": {
    "users": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/importUser"
      }
    },
    "total_count": {
      "type": "number"
    }
  }
}

{
  "type": "object",
  "title": "Job ID",
  "properties": {
    "jobId": {
      "type": "string"
    }
  },
  "x-examples": {
    "example-1": {
      "jobId": "string"
    }
  }
}

{
  "type": "object",
  "title": "Job WorkResult",
  "properties": {
    "id": {
      "type": "string"
    },
    "meta": {
      "type": "object"
    },
    "status": {
      "type": "string"
    },
    "createdAt": {
      "type": "string"
    },
    "statusMsg": {
      "type": "string"
    },
    "updatedAt": {
      "type": "string"
    },
    "persistedFields": {
      "type": "object"
    }
  }
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "status": {
      "$ref": "#/components/schemas/jumpcloud.auth.PushVerification.Status"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time"
    },
    "initiatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "userObjectId": {
      "type": "string",
      "format": "byte"
    },
    "failureStatus": {
      "$ref": "#/components/schemas/google.rpc.Status"
    },
    "pushEndpointId": {
      "type": "string",
      "format": "byte"
    },
    "confirmationCode": {
      "type": "string"
    }
  }
}

{
  "enum": [
    "SENT",
    "ACCEPTED",
    "EXPIRED",
    "DENIED",
    "ERRORED"
  ],
  "type": "string",
  "default": "SENT"
}

{
  "type": "object",
  "properties": {
    "scheduledJobId": {
      "type": "string",
      "format": "hex",
      "description": "ObjectID of the created Scheduled Job"
    }
  }
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "name of the domain"
    },
    "default": {
      "type": "boolean",
      "description": "Suggests if the domain is default"
    },
    "objectId": {
      "type": "string",
      "format": "byte",
      "description": "Unique identifier of the Domain."
    },
    "accountObjectId": {
      "type": "string",
      "format": "byte",
      "description": "Unique identifier of the GSuite."
    }
  }
}

{
  "type": "object",
  "properties": {
    "domains": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/jumpcloud.gapps.Domain"
      }
    },
    "totalCount": {
      "type": "integer",
      "format": "int64"
    }
  }
}

{
  "type": "object",
  "properties": {
    "domain": {
      "$ref": "#/components/schemas/jumpcloud.gapps.Domain"
    }
  }
}

{
  "type": "object",
  "properties": {
    "schedules": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/jumpcloud.gapps.ScheduledImport"
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "scheduledJobId": {
      "type": "string",
      "format": "hex",
      "description": "ObjectID of the Scheduled Job"
    }
  }
}

{
  "enum": [
    "PERSONAL_USAGE_ALLOWED",
    "PERSONAL_USAGE_DISALLOWED",
    "DEDICATED_DEVICE"
  ],
  "type": "string",
  "title": "Controls whether personal usage is allowed on a device provisioned\nRefer https://developers.google.com/android/management/reference/rest/v1/enterprises.enrollmentTokens",
  "default": "PERSONAL_USAGE_ALLOWED"
}

{
  "type": "object"
}

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

{
  "type": "object",
  "properties": {
    "isConnected": {
      "type": "boolean"
    },
    "enterpriseId": {
      "type": "string",
      "format": "byte"
    },
    "organizationObjectId": {
      "type": "string",
      "format": "byte"
    }
  }
}

{
  "type": "object",
  "properties": {
    "duration": {
      "type": "string",
      "title": "duration format as mentioned in https://developers.google.com/android/management/reference/rest/v1/enterprises.enrollmentTokens"
    },
    "zeroTouch": {
      "type": "boolean"
    },
    "displayName": {
      "type": "string",
      "title": "Name as set by admin"
    },
    "oneTimeOnly": {
      "type": "boolean",
      "title": "If the flag is set to true, only one device can use generated token for\nenrollment"
    },
    "createdWhere": {
      "$ref": "#/components/schemas/jumpcloud.google_emm.CreatedWhere"
    },
    "userObjectId": {
      "type": "string",
      "format": "byte"
    },
    "enrollmentType": {
      "$ref": "#/components/schemas/jumpcloud.google_emm.EnrollmentType"
    },
    "allowPersonalUsage": {
      "$ref": "#/components/schemas/jumpcloud.google_emm.AllowPersonalUsage"
    },
    "enterpriseObjectId": {
      "type": "string",
      "format": "byte"
    },
    "provisioningExtras": {
      "$ref": "#/components/schemas/jumpcloud.google_emm.ProvisioningExtras"
    }
  }
}

{
  "type": "object",
  "title": "Logging only expiration time of the token. others contain enrollment token information",
  "properties": {
    "name": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "metadata": {
      "type": "string"
    },
    "qrCodeImage": {
      "type": "string",
      "format": "byte"
    },
    "enrollmentLink": {
      "type": "string"
    },
    "expirationTime": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "properties": {
    "signupUrlName": {
      "type": "string",
      "title": "not logging because it contains sensitive information"
    },
    "enrollmentToken": {
      "type": "string",
      "title": "not logging because it contains sensitive information"
    }
  }
}

{
  "type": "object",
  "properties": {
    "iframeFeature": {
      "$ref": "#/components/schemas/jumpcloud.google_emm.Feature"
    },
    "parentFrameUrl": {
      "type": "string"
    },
    "enterpriseObjectId": {
      "type": "string",
      "format": "byte"
    }
  }
}

{
  "enum": [
    "API",
    "ADMIN_PORTAL",
    "USER_PORTAL"
  ],
  "type": "string",
  "title": "Identifies where create enrollment token request originated",
  "default": "API"
}

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

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "deviceId": {
      "type": "string",
      "format": "byte"
    },
    "deviceInformation": {
      "$ref": "#/components/schemas/jumpcloud.google_emm.DeviceInformation"
    }
  }
}

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

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "deviceId": {
      "type": "string",
      "format": "byte"
    }
  }
}