custom/JumpCloud.SDK.V2.json
|
{
"basePath": "/api/v2/", "consumes": [ "application/json" ], "definitions": { "ActivateProvisionUpdateReq": { "description": "Request to update session state.", "properties": { "state": { "type": "string" }, "vanity_url": { "type": "string" } }, "required": [ "vanity_url", "state" ], "title": "ActivateProvisionUpdateReq", "type": "object" }, "active-directory-agent-get-output": { "properties": { "connectKey": { "description": "The connect key to use when installing the Agent on a Domain Controller.", "type": "string" }, "contactAt": { "type": "string" }, "hostname": { "type": "string" }, "id": { "description": "ObjectID of this Active Directory Agent.", "type": "string" }, "source_ip": { "type": "string" }, "state": { "x-ms-enum": { "name": "state", "modelAsString": true, "values": [ { "name": "unsealed", "value": "unsealed" }, { "name": "active", "value": "active" }, { "name": "inactive", "value": "inactive" } ] }, "enum": [ "unsealed", "active", "inactive" ], "type": "string" }, "version": { "type": "string" } }, "required": [ "id" ], "title": "Active Directory Agent Get Output", "type": "object" }, "active-directory-agent-input": { "title": "Active Directory Agent Input", "type": "object" }, "active-directory-agent-list-output": { "properties": { "contactAt": { "type": "string" }, "hostname": { "type": "string" }, "id": { "description": "ObjectID of this Active Directory Agent.", "type": "string" }, "source_ip": { "type": "string" }, "state": { "x-ms-enum": { "name": "state", "modelAsString": true, "values": [ { "name": "unsealed", "value": "unsealed" }, { "name": "active", "value": "active" }, { "name": "inactive", "value": "inactive" } ] }, "enum": [ "unsealed", "active", "inactive" ], "type": "string" }, "version": { "type": "string" } }, "title": "Active Directory Agent List Output", "type": "object" }, "active-directory-input": { "properties": { "domain": { "description": "Domain name for this Active Directory instance.", "type": "string" } }, "title": "Active Directory Input", "type": "object" }, "active-directory-output": { "allOf": [ { "properties": { "id": { "description": "ObjectID of this Active Directory instance.", "type": "string" } }, "required": [ "id" ], "type": "object" }, { "$ref": "#/definitions/active-directory-input" } ], "title": "Active Directory Output" }, "Administrator": { "example": { "registered": false, "email": "joe@example.com", "enableMultiFactor": true, "firstname": "Joe", "id": "0123456789abcdef01234567", "lastname": "Blough" }, "properties": { "email": { "type": "string" }, "enableMultiFactor": { "type": "boolean" }, "firstname": { "type": "string" }, "id": { "type": "string" }, "lastname": { "type": "string" }, "registered": { "type": "boolean" }, "suspended": { "type": "boolean" } }, "title": "Administrator", "type": "object" }, "AppleMDM": { "properties": { "apnsCertExpiry": { "description": "The expiration date and time for the APNS Certificate.", "type": "string" }, "apnsPushTopic": { "description": "The push topic assigned to this enrollment by Apple after uploading the Signed CSR plist.", "type": "string" }, "defaultSystemGroupID": { "description": "ObjectId uniquely identifying the MDM default System Group.", "type": "string" }, "dep": { "$ref": "#/definitions/DEP" }, "depAccessTokenExpiry": { "description": "The expiration date and time for the DEP Access Token. This aligns with the DEP Server Token State.", "type": "string" }, "depServerTokenState": { "description": "The state of the dep server token, presence and expiry.", "x-ms-enum": { "name": "depServerTokenState", "modelAsString": true, "values": [ { "name": "unknown", "value": "unknown" }, { "name": "missing", "value": "missing" }, { "name": "valid", "value": "valid" }, { "name": "expired", "value": "expired" } ] }, "enum": [ "unknown", "missing", "valid", "expired" ], "type": "string" }, "id": { "description": "ObjectId uniquely identifying an MDM Enrollment,", "type": "string" }, "name": { "description": "A friendly name to identify this enrollment. Not required to be unique.", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "title": "AppleMDM", "type": "object" }, "apple-mdm-device": { "properties": { "createdAt": { "type": "string" }, "depRegistered": { "type": "boolean" }, "enrolled": { "type": "boolean" }, "id": { "type": "string" }, "osVersion": { "type": "string" }, "serialNumber": { "type": "string" }, "udid": { "type": "string" } }, "title": "Apple MDM Device", "type": "object" }, "apple-mdm-patch-input": { "properties": { "appleSignedCert": { "description": "A signed certificate obtained from Apple after providing Apple with the plist file provided on POST.", "type": "string" }, "defaultSystemGroupID": { "description": "ObjectId uniquely identifying the MDM default System Group.", "type": "string" }, "dep": { "$ref": "#/definitions/DEP" }, "encryptedDepServerToken": { "description": "The S/MIME encoded DEP Server Token returned by Apple Business Manager when creating an MDM instance.", "type": "string" }, "name": { "description": "A new name for the Apple MDM configuration.", "maxLength": 255, "type": "string" } }, "title": "Apple MDM Patch Input", "type": "object" }, "apple-mdm-public-key-cert": { "title": "Apple MDM Public Key Certificate", "type": "string" }, "apple-mdm-signed-csr-plist": { "title": "Apple MDM Signed CSR PList", "type": "string" }, "application": { "properties": { "_id": { "type": "string" }, "catalogItem": { "type": "string" }, "color": { "type": "string" }, "description": { "maxLength": 256, "type": "string" }, "displayLabel": { "type": "string" }, "displayName": { "type": "string" }, "logo": { "properties": { "color": { "x-ms-enum": { "name": "color", "modelAsString": true, "values": [ { "name": "202D38", "value": "'#202D38'" }, { "name": "005466", "value": "'#005466'" }, { "name": "3E8696", "value": "'#3E8696'" }, { "name": "006CAC", "value": "'#006CAC'" }, { "name": "0617AC", "value": "'#0617AC'" }, { "name": "7C6ADA", "value": "'#7C6ADA'" }, { "name": "D5779D", "value": "'#D5779D'" }, { "name": "9E2F00", "value": "'#9E2F00'" }, { "name": "FFB000", "value": "'#FFB000'" }, { "name": "58C469", "value": "'#58C469'" }, { "name": "57C49F", "value": "'#57C49F'" }, { "name": "FF6C03", "value": "'#FF6C03'" } ] }, "enum": [ "", "#202D38", "#005466", "#3E8696", "#006CAC", "#0617AC", "#7C6ADA", "#D5779D", "#9E2F00", "#FFB000", "#58C469", "#57C49F", "#FF6C03" ], "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "name": { "type": "string" }, "provision": { "properties": { "_id": { "type": "string" }, "beta": { "type": "boolean" }, "type": { "type": "string" } }, "type": "object" }, "sso": { "properties": { "_id": { "type": "string" }, "beta": { "type": "boolean" }, "jit": { "type": "boolean" }, "type": { "type": "string" } }, "type": "object" } }, "title": "Application", "type": "object" }, "auth-info": { "properties": { "expiry": { "type": "string" }, "isValid": { "type": "boolean" }, "message": { "type": "string" } }, "title": "Auth Info", "type": "object" }, "auth-input": { "properties": { "basic": { "properties": { "password": { "type": "string" }, "username": { "type": "string" } }, "type": "object" }, "oauth": { "properties": { "code": { "type": "string" } }, "type": "object" } }, "title": "Auth Input", "type": "object" }, "auth-input-object": { "example": { "auth": { "basic": { "password": "mollit cillum", "username": "veniam dolore" }, "oauth": { "code": "minim ad ea dolor" } } }, "properties": { "auth": { "$ref": "#/definitions/auth-input" } }, "title": "Auth Input Object", "type": "object" }, "bulk-user-create": { "description": "See [V1 system user creation](https://docs.jumpcloud.com/1.0/systemusers/create-a-system-user) for full list of attributes.", "properties": { "attributes": { "description": "Map of additional attributes.", "items": { "type": "object" }, "type": "array" }, "email": { "type": "string" }, "firstname": { "type": "string" }, "lastname": { "type": "string" }, "username": { "type": "string" } }, "title": "Bulk User Create", "type": "object" }, "bulk-user-update": { "description": "See [V1 system user update](https://docs.jumpcloud.com/1.0/systemusers/update-a-system-user) for full list of attributes.", "properties": { "attributes": { "description": "Map of additional attributes.", "items": { "type": "object" }, "type": "array" }, "email": { "type": "string" }, "firstname": { "type": "string" }, "id": { "description": "Object ID of the systemuser being updated", "type": "string" }, "lastname": { "type": "string" }, "username": { "type": "string" } }, "title": "Bulk User Update", "type": "object" }, "DEP": { "properties": { "setupAssistantOptions": { "items": { "$ref": "#/definitions/DEPSetupAssistantOption" }, "type": "array" }, "welcomeScreen": { "$ref": "#/definitions/DEPWelcomeScreen" } }, "title": "DEP", "type": "object" }, "DEPSetupAssistantOption": { "properties": { "option": { "$ref": "#/definitions/SetupAssistantOption" } }, "title": "DEP Setup Assistant Option", "type": "object" }, "DEPWelcomeScreen": { "properties": { "button": { "description": "Text to display on the button on the DEP Welcome Screen.", "maxLength": 64, "type": "string" }, "paragraph": { "description": "A message to display on the DEP Welcome Screen.", "maxLength": 1024, "type": "string" }, "title": { "description": "The title to display on the DEP Welcome Screen.", "maxLength": 255, "type": "string" } }, "title": "DEPWelcomeScreen", "type": "object" }, "Directory": { "description": "", "properties": { "id": { "description": "The ObjectID of the directory.", "type": "string" }, "name": { "description": "The name of the directory.", "type": "string" }, "oAuthStatus": { "description": "the expiry and error status of the bearer token", "type": "object" }, "type": { "description": "The type of directory.", "x-ms-enum": { "name": "type", "modelAsString": true, "values": [ { "name": "active_directory", "value": "active_directory" }, { "name": "g_suite", "value": "g_suite" }, { "name": "ldap_server", "value": "ldap_server" }, { "name": "office_365", "value": "office_365" }, { "name": "workday", "value": "workday" } ] }, "enum": [ "active_directory", "g_suite", "ldap_server", "office_365", "workday" ], "type": "string" } }, "required": [ "id", "name", "type" ], "title": "Directory", "type": "object" }, "directory-insights-saved-view": { "description": "Directory Insights saved view", "properties": { "columns": { "items": { "type": "string" }, "type": "array" }, "description": { "description": "Description ID of saved view", "type": "string" }, "filters": { "items": { "$ref": "#/definitions/directory-insights-saved-view-filter" }, "type": "array" }, "id": { "description": "ID of saved view", "type": "string" }, "name": { "description": "Name of saved view", "type": "string" }, "time_range": { "type": "integer" }, "user_id": { "description": "User ID of saved view", "type": "string" } }, "title": "Directory Insights Saved View", "type": "object" }, "directory-insights-saved-view-filter": { "description": "One filter in a DI Saved view", "properties": { "field": { "type": "string" }, "values": { "items": { "type": "string" }, "type": "array" } }, "title": "One filter in a DI Saved view", "type": "object" }, "directory-insights-saved-view-post": { "description": "Properties of a Directory Insights saved view POST object", "properties": { "columns": { "items": { "type": "string" }, "type": "array" }, "description": { "description": "Description ID of saved view", "type": "string" }, "filters": { "items": { "$ref": "#/definitions/directory-insights-saved-view-filter" }, "type": "array" }, "name": { "description": "Name of saved view", "type": "string" }, "time_range": { "type": "integer" }, "user_id": { "description": "User ID of saved view", "type": "string" } }, "title": "Directory Insights Saved View POST object", "type": "object" }, "DuoAccount": { "properties": { "id": { "description": "object ID", "type": "string" }, "name": { "description": "Duo application name.", "type": "string" } }, "required": [ "id" ], "title": "DuoAccount", "type": "object" }, "DuoApplication": { "properties": { "apiHost": { "type": "string" }, "id": { "type": "string" }, "integrationKey": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name", "apiHost", "integrationKey" ], "title": "DuoApplication", "type": "object" }, "DuoApplicationReq": { "properties": { "apiHost": { "type": "string" }, "integrationKey": { "type": "string" }, "name": { "type": "string" }, "secretKey": { "type": "string" } }, "required": [ "name", "apiHost", "integrationKey", "secretKey" ], "title": "DuoApplicationReq", "type": "object" }, "DuoApplicationUpdateReq": { "properties": { "apiHost": { "type": "string" }, "integrationKey": { "type": "string" }, "name": { "type": "string" }, "secretKey": { "type": "string" } }, "required": [ "name", "apiHost", "integrationKey" ], "title": "DuoApplicationUpdateReq", "type": "object" }, "emailrequest": { "example": { "emailType": "activation" }, "properties": { "emailType": { "x-ms-enum": { "name": "emailType", "modelAsString": true, "values": [ { "name": "activation", "value": "activation" } ] }, "enum": [ "activation" ], "type": "string" } }, "title": "EmailRequest", "type": "object" }, "Error": { "properties": { "code": { "format": "int32", "type": "integer" }, "fields": { "type": "string" }, "message": { "type": "string" } }, "title": "Error", "type": "object" }, "errorresponse": { "properties": { "message": { "type": "string" } }, "title": "ErrorResponse", "type": "object" }, "GraphConnection": { "description": "Represents an edge between two graph objects. From can be omitted if it is clear from context.", "properties": { "attributes": { "description": "The graph connection's attributes.", "type": "object" }, "from": { "$ref": "#/definitions/GraphObject" }, "to": { "$ref": "#/definitions/GraphObject" } }, "required": [ "to" ], "title": "GraphConnection", "type": "object" }, "GraphManagementReq": { "properties": { "attributes": { "description": "The graph connection's attributes.", "type": "object" }, "id": { "description": "The ObjectID of graph object being added or removed as an association.", "type": "string" }, "op": { "description": "How to modify the graph connection.", "x-ms-enum": { "name": "op", "modelAsString": true, "values": [ { "name": "add", "value": "add" }, { "name": "remove", "value": "remove" }, { "name": "update", "value": "update" } ] }, "enum": [ "add", "remove", "update" ], "type": "string" }, "type": { "$ref": "#/definitions/GraphType" } }, "required": [ "op", "type", "id" ], "title": "GraphManagementReq", "type": "object" }, "GraphObject": { "properties": { "attributes": { "description": "The graph object's attributes.", "type": "object" }, "id": { "description": "The ObjectID of the graph object.", "type": "string" }, "type": { "description": "The type of graph object.", "type": "string" } }, "required": [ "type", "id" ], "title": "GraphObject", "type": "object" }, "GraphObjectWithPaths": { "properties": { "compiledAttributes": { "description": "The compiled graph attributes of the target object.", "type": "object" }, "id": { "description": "Object ID of this graph object.", "type": "string" }, "paths": { "description": "A path through the graph between two graph objects.", "items": { "items": { "$ref": "#/definitions/GraphConnection" }, "type": "array" }, "type": "array" }, "type": { "$ref": "#/definitions/GraphType" } }, "required": [ "type", "id", "paths" ], "title": "GraphObjectWithPaths", "type": "object" }, "GraphType": { "description": "The graph type.", "x-ms-enum": { "name": "GraphType", "modelAsString": true, "values": [ { "name": "active_directory", "value": "active_directory" }, { "name": "application", "value": "application" }, { "name": "command", "value": "command" }, { "name": "g_suite", "value": "g_suite" }, { "name": "ldap_server", "value": "ldap_server" }, { "name": "office_365", "value": "office_365" }, { "name": "policy", "value": "policy" }, { "name": "radius_server", "value": "radius_server" }, { "name": "systems", "value": "system" }, { "name": "systems_group", "value": "system_group" }, { "name": "user", "value": "user" }, { "name": "user_group", "value": "user_group" } ] }, "enum": [ "active_directory", "application", "command", "g_suite", "ldap_server", "office_365", "policy", "radius_server", "system", "system_group", "user", "user_group" ], "title": "GraphType", "type": "string" }, "Group": { "properties": { "attributes": { "description": "The group object's attributes.", "type": "object" }, "description": { "description": "Description of a Group", "type": "string" }, "email": { "description": "E-mail address associated with a Group", "type": "string" }, "id": { "description": "ObjectId uniquely identifying a Group.", "type": "string" }, "name": { "description": "Display name of a Group.", "type": "string" }, "type": { "$ref": "#/definitions/GroupType" } }, "title": "Group", "type": "object" }, "GroupType": { "description": "The group type.", "x-ms-enum": { "name": "GroupType", "modelAsString": true, "values": [ { "name": "systems_group", "value": "system_group" }, { "name": "user_group", "value": "user_group" } ] }, "enum": [ "system_group", "user_group" ], "title": "GroupType", "type": "string" }, "GSuiteBuiltinTranslation": { "description": "Built-in translations for G Suite export:\n* `user_home_addresses` - Translate all JumpCloud user addresses of type `home` to G Suite Directory user addresses of type `home`\n* `user_work_addresses` - Translate all JumpCloud user addresses of type `work` to G Suite Directory user addresses of type `work`\n* `user_other_addresses` - Translate all JumpCloud user addresses of type `other` to G Suite Directory user addresses of type `other`\n* `user_home_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `home` to G Suite Directory user phones of type `home`\n* `user_mobile_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `mobile` to G Suite Directory user phones of type `mobile`\n* `user_other_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `other` to G Suite Directory user phones of type `other`\n* `user_work_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `work` to G Suite Directory user phones of type `work`\n* `user_work_fax_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `work_fax` to G Suite Directory user phones of type `work_fax`\n* `user_work_mobile_phone_numbers` - Translate all JumpCloud user phoneNumbers of type `work_mobile` to G Suite Directory user phones of type `work_mobile`\n* `user_primary_organization_cost_center` - Translate JumpCloud user `costCenter` to G Suite Directory user `costCenter` for `primary` organization\n* `user_primary_organization_department` - Translate JumpCloud user `department` to G Suite Directory user `department` for `primary` organization\n* `user_primary_organization_description` - Translate JumpCloud user `employeeType` to G Suite Directory user `description` for `primary` organization\n* `user_primary_organization_employee_id` - Translate JumpCloud user `employeeIdentifier` to G Suite Directory user `externalIds` element of type `organization`\n* `user_primary_organization_title` - Translate JumpCloud user `jobTitle` to G Suite Directory user `title` for `primary` organization\n", "x-ms-enum": { "name": "GSuiteBuiltinTranslation", "modelAsString": true, "values": [ { "name": "user_home_addresses", "value": "user_home_addresses" }, { "name": "user_work_addresses", "value": "user_work_addresses" }, { "name": "user_other_addresses", "value": "user_other_addresses" }, { "name": "user_home_phone_numbers", "value": "user_home_phone_numbers" }, { "name": "user_mobile_phone_numbers", "value": "user_mobile_phone_numbers" }, { "name": "user_other_phone_numbers", "value": "user_other_phone_numbers" }, { "name": "user_work_phone_numbers", "value": "user_work_phone_numbers" }, { "name": "user_work_fax_phone_numbers", "value": "user_work_fax_phone_numbers" }, { "name": "user_work_mobile_phone_numbers", "value": "user_work_mobile_phone_numbers" }, { "name": "user_primary_organization_cost_center", "value": "user_primary_organization_cost_center" }, { "name": "user_primary_organization_department", "value": "user_primary_organization_department" }, { "name": "user_primary_organization_description", "value": "user_primary_organization_description" }, { "name": "user_primary_organization_employee_id", "value": "user_primary_organization_employee_id" }, { "name": "user_primary_organization_title", "value": "user_primary_organization_title" } ] }, "enum": [ "user_home_addresses", "user_work_addresses", "user_other_addresses", "user_home_phone_numbers", "user_mobile_phone_numbers", "user_other_phone_numbers", "user_work_phone_numbers", "user_work_fax_phone_numbers", "user_work_mobile_phone_numbers", "user_primary_organization_cost_center", "user_primary_organization_department", "user_primary_organization_description", "user_primary_organization_employee_id", "user_primary_organization_title" ], "title": "G Suite BuiltIn Translation", "type": "string" }, "gsuite-output": { "allOf": [ { "properties": { "groupsEnabled": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "userLockoutAction": { "x-ms-enum": { "name": "userLockoutAction", "modelAsString": true, "values": [ { "name": "suspend", "value": "suspend" }, { "name": "maintain", "value": "maintain" } ] }, "enum": [ "suspend", "maintain" ], "type": "string" }, "userPasswordExpirationAction": { "x-ms-enum": { "name": "userPasswordExpirationAction", "modelAsString": true, "values": [ { "name": "suspend", "value": "suspend" }, { "name": "maintain", "value": "maintain" }, { "name": "remove_access", "value": "remove_access" } ] }, "enum": [ "suspend", "maintain", "remove_access" ], "type": "string" } } } ], "title": "GSuite Output", "type": "object" }, "gsuite-patch-input": { "properties": { "groupsEnabled": { "type": "boolean" }, "name": { "type": "string" }, "userLockoutAction": { "x-ms-enum": { "name": "userLockoutAction", "modelAsString": true, "values": [ { "name": "suspend", "value": "suspend" }, { "name": "maintain", "value": "maintain" } ] }, "enum": [ "suspend", "maintain" ], "type": "string" }, "userPasswordExpirationAction": { "x-ms-enum": { "name": "userPasswordExpirationAction", "modelAsString": true, "values": [ { "name": "suspend", "value": "suspend" }, { "name": "maintain", "value": "maintain" }, { "name": "remove_access", "value": "remove_access" } ] }, "enum": [ "suspend", "maintain", "remove_access" ], "type": "string" } }, "title": "GSuite Patch Input", "type": "object" }, "GSuiteTranslationRule": { "properties": { "builtIn": { "$ref": "#/definitions/GSuiteBuiltinTranslation" }, "id": { "description": "ObjectId uniquely identifying a Translation Rule.", "type": "string" } }, "title": "G Suite Translation Rule", "type": "object" }, "GSuiteTranslationRuleRequest": { "example": { "builtIn": "user_home_addresses" }, "properties": { "builtIn": { "$ref": "#/definitions/GSuiteBuiltinTranslation" } }, "title": "G Suite Translation Rule Request", "type": "object" }, "JcSoftware-app-settings": { "properties": { "packageId": { "type": "string" } }, "title": "Software Application Package Setting Object" }, "job-details": { "properties": { "adminId": { "type": "string" }, "createdAt": { "type": "string" }, "id": { "type": "string" }, "meta": { "type": "object" }, "name": { "type": "string" }, "persistedFields": { "items": { "type": "string" }, "type": "array" }, "status": { "type": "string" }, "updatedAt": { "type": "string" }, "workUnitsCount": { "type": "integer" } }, "title": "Job Details", "type": "object" }, "job-id": { "properties": { "id": { "type": "string" } }, "title": "Job ID", "type": "object" }, "job-workresult": { "properties": { "createdAt": { "type": "string" }, "id": { "type": "string" }, "meta": { "type": "object" }, "persistedFields": { "type": "object" }, "status": { "type": "string" }, "statusMsg": { "type": "string" }, "updatedAt": { "type": "string" } }, "title": "Job WorkResult", "type": "object" }, "LdapServerAction": { "x-ms-enum": { "name": "LdapServerAction", "modelAsString": true, "values": [ { "name": "disable", "value": "disable" }, { "name": "remove", "value": "remove" } ] }, "enum": [ "disable", "remove" ], "title": "LDAP Server Action", "type": "string" }, "ldap-server-input": { "properties": { "name": { "description": "The name of this LDAP server", "type": "string" }, "userLockoutAction": { "description": "action to take; one of 'remove' or 'disable'", "x-ms-enum": { "name": "userLockoutAction1", "modelAsString": true, "values": [ { "name": "disable", "value": "disable" }, { "name": "remove", "value": "remove" } ] }, "enum": [ "disable", "remove" ], "type": "string" }, "userPasswordExpirationAction": { "description": "action to take; one of 'remove' or 'disable'", "x-ms-enum": { "name": "userPasswordExpirationAction1", "modelAsString": true, "values": [ { "name": "disable", "value": "disable" }, { "name": "remove", "value": "remove" } ] }, "enum": [ "disable", "remove" ], "type": "string" } }, "title": "LDAP Server Input", "type": "object" }, "ldap-server-output": { "allOf": [ { "properties": { "id": { "description": "Unique identifier of this LDAP server", "type": "string" } }, "required": [ "id" ], "type": "object" }, { "$ref": "#/definitions/ldap-server-input" } ], "title": "LDAP Server Output" }, "mobileconfig": { "title": "mobileconfig", "type": "string" }, "Office365BuiltinTranslation": { "description": "Built-in translations for Office 365 (Microsoft Graph) export:\n* `user_street_address` - Translate `streetAddress` field of JumpCloud user address of type `work` to `city` 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_state` - Translate `region` field of JumpCloud user address of type `work` to `state` 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_postal_code` - Translate `postalCode` field of JumpCloud user address of type `work` to `postalCode` 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_mobile_phone` - Translate `number` field of first JumpCloud user `phoneNumber` of type `mobile` to `mobilePhone` 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_office_location` - Translate `location` field of JumpCloud user to `officeLocation` field of Microsoft Graph `user` ", "x-ms-enum": { "name": "Office365BuiltinTranslation", "modelAsString": true, "values": [ { "name": "user_street_address", "value": "user_street_address" }, { "name": "user_city", "value": "user_city" }, { "name": "user_state", "value": "user_state" }, { "name": "user_country", "value": "user_country" }, { "name": "user_postal_code", "value": "user_postal_code" }, { "name": "user_business_phones", "value": "user_business_phones" }, { "name": "user_mobile_phone", "value": "user_mobile_phone" }, { "name": "user_department", "value": "user_department" }, { "name": "user_job_title", "value": "user_job_title" }, { "name": "user_office_location", "value": "user_office_location" } ] }, "enum": [ "user_street_address", "user_city", "user_state", "user_country", "user_postal_code", "user_business_phones", "user_mobile_phone", "user_department", "user_job_title", "user_office_location" ], "title": "Office 365 BuiltIn Translation", "type": "string" }, "office365-output": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "userLockoutAction": { "x-ms-enum": { "name": "userLockoutAction", "modelAsString": true, "values": [ { "name": "suspend", "value": "suspend" }, { "name": "maintain", "value": "maintain" } ] }, "enum": [ "suspend", "maintain" ], "type": "string" }, "userPasswordExpirationAction": { "x-ms-enum": { "name": "userPasswordExpirationAction2", "modelAsString": true, "values": [ { "name": "suspend", "value": "suspend" }, { "name": "maintain", "value": "maintain" } ] }, "enum": [ "suspend", "maintain" ], "type": "string" } }, "required": [ "id", "userLockoutAction", "userPasswordExpirationAction" ], "title": "Office 365 Output", "type": "object" }, "office365-patch-input": { "properties": { "name": { "type": "string" }, "userLockoutAction": { "x-ms-enum": { "name": "userLockoutAction", "modelAsString": true, "values": [ { "name": "suspend", "value": "suspend" }, { "name": "maintain", "value": "maintain" } ] }, "enum": [ "suspend", "maintain" ], "type": "string" }, "userPasswordExpirationAction": { "x-ms-enum": { "name": "userPasswordExpirationAction2", "modelAsString": true, "values": [ { "name": "suspend", "value": "suspend" }, { "name": "maintain", "value": "maintain" } ] }, "enum": [ "suspend", "maintain" ], "type": "string" } }, "title": "Office 365 Patch Input", "type": "object" }, "Office365TranslationRule": { "properties": { "builtIn": { "$ref": "#/definitions/Office365BuiltinTranslation" }, "id": { "description": "ObjectId uniquely identifying a Translation Rule.", "type": "string" } }, "title": "Office 365 Translation Rule", "type": "object" }, "Office365TranslationRuleRequest": { "example": { "builtIn": "user_department" }, "properties": { "builtIn": { "$ref": "#/definitions/Office365BuiltinTranslation" } }, "title": "Office 365 Translation Rule Request", "type": "object" }, "org-crypto-settings": { "properties": { "sshKeys": { "properties": { "keySize": { "type": "integer" }, "validate": { "type": "boolean" }, "validateKeySize": { "type": "boolean" } }, "type": "object" } }, "title": "Org Crypto Settings", "type": "object" }, "PaymentDetails": { "example": { "billing": { "address1": "Example address 1", "address2": "Example address 2", "city": "Example city", "companyName": "Example company name", "contactName": "Example contact name", "country": "Example country", "email": "test@example.com", "postalCode": "Example postal code", "region": "Example region" }, "transactionId": "tok_example" }, "properties": { "billing": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "companyName": { "type": "string" }, "contactName": { "type": "string" }, "country": { "type": "string" }, "email": { "type": "string" }, "postalCode": { "type": "string" }, "region": { "type": "string" } }, "type": "object" }, "transactionId": { "type": "string" } }, "title": "PaymentDetails", "type": "object" }, "PaymentDetailsReq": { "example": { "billing": { "address1": "Example address 1", "address2": "Example address 2", "city": "Example city", "companyName": "Example company name", "contactName": "Example contact name", "country": "Example country", "email": "test@example.com", "postalCode": "Example postal code", "region": "Example region" }, "transactionId": "tok_example" }, "properties": { "billing": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "companyName": { "type": "string" }, "contactName": { "type": "string" }, "country": { "type": "string" }, "email": { "type": "string" }, "postalCode": { "type": "string" }, "region": { "type": "string" } }, "required": [ "address1", "city", "contactName", "country", "email", "postalCode", "region" ], "type": "object" }, "transactionId": { "type": "string" } }, "required": [ "billing" ], "title": "PaymentDetailsReq", "type": "object" }, "Policy": { "description": "An instance of a policy template.", "properties": { "id": { "description": "ObjectId uniquely identifying a Policy.", "type": "string" }, "name": { "description": "The description for this specific Policy.", "type": "string" }, "template": { "$ref": "#/definitions/PolicyTemplate" } }, "title": "Policy", "type": "object" }, "PolicyRequest": { "description": "An instance of a policy template.", "properties": { "name": { "description": "The description for this specific Policy.", "type": "string" }, "template": { "properties": { "id": { "description": "ObjectId uniquely identifying a Policy instance; only allowed on POST requests.", "type": "string" } }, "type": "object" }, "values": { "items": { "$ref": "#/definitions/PolicyValue" }, "type": "array" } }, "required": [ "name" ], "title": "PolicyRequest", "type": "object" }, "PolicyResult": { "properties": { "detail": { "description": "Details pertaining to the policy result.", "type": "string" }, "endedAt": { "description": "The end of the policy application.", "format": "date-time", "type": "string" }, "exitStatus": { "description": "The 32-bit unsigned exit status from the applying the policy.", "type": "integer" }, "id": { "description": "ObjectId uniquely identifying a Policy Result.", "type": "string" }, "policyID": { "description": "ObjectId uniquely identifying the parent Policy.", "type": "string" }, "startedAt": { "description": "The start of the policy application.", "format": "date-time", "type": "string" }, "state": { "description": "Enumeration describing the state of the policy. Success, failed, or pending.", "type": "string" }, "stdErr": { "description": "The STDERR output from applying the policy.", "type": "string" }, "stdOut": { "description": "The STDOUT output from applying the policy.", "type": "string" }, "success": { "description": "True if the policy was successfully applied; false otherwise.", "type": "boolean" }, "systemID": { "description": "ObjectId uniquely identifying the parent System.", "type": "string" } }, "title": "PolicyResult", "type": "object" }, "PolicyTemplate": { "description": "The shallow information about a Policy Template.", "properties": { "activation": { "description": "Requirements before the policy can be activated.", "type": "string" }, "alert": { "description": "Text to describe any risk associated with this policy.", "type": "string" }, "behavior": { "description": "Specifics about the behavior of the policy.", "type": "string" }, "deliveryTypes": { "description": "The supported delivery mechanisms for this policy template.", "items": { "default": "agent", "x-ms-enum": { "name": "items", "modelAsString": true, "values": [ { "name": "agent", "value": "agent" }, { "name": "mdm", "value": "mdm" } ] }, "enum": [ "agent", "mdm" ], "type": "string" }, "type": "array" }, "description": { "description": "The default description for the Policy.", "type": "string" }, "displayName": { "description": "The default display name for the Policy.", "type": "string" }, "id": { "description": "ObjectId uniquely identifying a Policy Template.", "type": "string" }, "name": { "description": "The unique name for the Policy Template.", "type": "string" }, "osMetaFamily": { "x-ms-enum": { "name": "osMetaFamily", "modelAsString": true, "values": [ { "name": "linux", "value": "linux" }, { "name": "darwin", "value": "darwin" }, { "name": "windows", "value": "windows" } ] }, "enum": [ "linux", "darwin", "windows" ], "type": "string" }, "reference": { "description": "URL to visit for further information.", "type": "string" }, "state": { "default": "", "description": "String describing the release status of the policy template.", "type": "string" } }, "title": "PolicyTemplate", "type": "object" }, "PolicyTemplateConfigField": { "properties": { "defaultValue": { "description": "The default value for this field.", "type": "string" }, "displayOptions": { "description": "The options that correspond to the display_type.", "type": "object" }, "displayType": { "description": "The default rendering for this field.", "x-ms-enum": { "name": "displayType", "modelAsString": true, "values": [ { "name": "checkbox", "value": "checkbox" }, { "name": "date", "value": "date" }, { "name": "email", "value": "email" }, { "name": "file", "value": "file" }, { "name": "number", "value": "number" }, { "name": "select", "value": "select" }, { "name": "text", "value": "text" }, { "name": "textarea", "value": "textarea" }, { "name": "singlelistbox", "value": "singlelistbox" }, { "name": "doublelistbox", "value": "doublelistbox" }, { "name": "table", "value": "table" } ] }, "enum": [ "checkbox", "date", "email", "file", "number", "select", "text", "textarea", "singlelistbox", "doublelistbox", "table" ], "type": "string" }, "id": { "description": "ObjectId uniquely identifying a Policy Template Configuration Field", "type": "string" }, "label": { "description": "The default label for this field.", "type": "string" }, "name": { "description": "A unique name identifying this config field.", "type": "string" }, "position": { "description": "The default position to render this field.", "type": "number" }, "readOnly": { "description": "If an admin is allowed to modify this field.", "type": "boolean" }, "required": { "description": "If this field is required for this field.", "type": "boolean" }, "tooltip": { "properties": { "template": { "type": "string" }, "variables": { "properties": { "icon": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } }, "type": "object" } }, "required": [ "id", "name" ], "title": "PolicyTemplateConfigField", "type": "object" }, "PolicyTemplateWithDetails": { "description": "The shallow information about a Policy Template.", "properties": { "activation": { "description": "Requirements before the policy can be activated.", "type": "string" }, "behavior": { "description": "Specifics about the behavior of the policy.", "type": "string" }, "configFields": { "description": "An unordered list of all the fields that can be configured for this Policy Template.", "items": { "$ref": "#/definitions/PolicyTemplateConfigField" }, "type": "array" }, "description": { "description": "The default description for the Policy.", "type": "string" }, "displayName": { "description": "The default display name for the Policy.", "type": "string" }, "id": { "description": "ObjectId uniquely identifying a Policy Template.", "type": "string" }, "name": { "description": "The unique name for the Policy Template.", "type": "string" }, "osMetaFamily": { "x-ms-enum": { "name": "osMetaFamily", "modelAsString": true, "values": [ { "name": "linux", "value": "linux" }, { "name": "darwin", "value": "darwin" }, { "name": "windows", "value": "windows" } ] }, "enum": [ "linux", "darwin", "windows" ], "type": "string" } }, "title": "PolicyTemplateWithDetails", "type": "object" }, "PolicyValue": { "properties": { "configFieldID": { "description": "The ObjectId of the corresponding Policy Template configuration field.", "type": "string" }, "value": { "description": "The value for the configuration field for this Policy instance.", "type": "string" } }, "title": "PolicyValue", "type": "object" }, "PolicyWithDetails": { "description": "An instance of a policy template.", "properties": { "configFields": { "items": { "$ref": "#/definitions/PolicyTemplateConfigField" }, "type": "array" }, "id": { "description": "ObjectId uniquely identifying a Policy.", "type": "string" }, "name": { "description": "The description for this specific Policy.", "type": "string" }, "template": { "$ref": "#/definitions/PolicyTemplate" }, "values": { "items": { "$ref": "#/definitions/PolicyValue" }, "type": "array" } }, "title": "PolicyWithDetails", "type": "object" }, "ProviderAdminReq": { "properties": { "email": { "type": "string" }, "enableMultiFactor": { "type": "boolean" }, "firstname": { "type": "string" }, "lastname": { "type": "string" } }, "required": [ "email" ], "title": "ProviderAdminReq", "type": "object" }, "ProvisionCallbackReq": { "description": "Request to insert provision in SCIM service.", "properties": { "api_key": { "type": "string" }, "state": { "type": "string" }, "vanity_url": { "type": "string" } }, "required": [ "api_key", "state" ], "title": "ProvisionCallbackReq", "type": "object" }, "salesforce-knowledge-list-output": { "items": { "properties": { "body": { "type": "string" }, "id": { "type": "string" }, "isWhatsNew": { "type": "boolean" }, "language": { "type": "string" }, "publishedDate": { "type": "string" }, "publishStatus": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "whatsNewBlurb": { "type": "string" } }, "type": "object" }, "title": "Salesforce Knowledge List Output", "type": "array" }, "samba-domain-input": { "properties": { "name": { "description": "Name of this domain's WorkGroup", "type": "string" }, "sid": { "description": "Security identifier of this domain", "type": "string" } }, "required": [ "name", "sid" ], "title": "Samba Domain Input", "type": "object" }, "samba-domain-output": { "allOf": [ { "properties": { "id": { "description": "Unique identifier of this domain", "type": "string" } }, "required": [ "id" ], "type": "object" }, { "$ref": "#/definitions/samba-domain-input" } ], "title": "Samba Domain Output" }, "SetupAssistantOption": { "description": "Options to skip screens during MacOS setup:\n* `accessibility` - Skips the Accessibility pane, only if the Mac is connected to Ethernet and the cloud config is downloaded.\n* `appearance` - Skips the Choose Your Look screen.\n* `appleID` - Skips Apple ID setup.\n* `biometric` - Skips biometric setup.\n* `diagnostics` - Skips the App Analytics pane.\n* `displayTone` - Skips display tone setup.\n* `fileVault` - Skips FileVault setup assistant screen.\n* `icloudDiagnostics` - Skips iCloud analytics screen.\n* `icloudStorage` - Skips iCloud documents and desktop screen.\n* `location` - Skips location services setup.\n* `payment` - Skips Apple Pay setup.\n* `privacy` - Skips the Privacy setup.\n* `restore` - Skips restoring from backup.\n* `screenTime` - Skips screen time setup.\n* `siri` - Skips Siri setup.\n* `tos` - Skips terms and conditions.\n", "x-ms-enum": { "name": "SetupAssistantOption", "modelAsString": true, "values": [ { "name": "accessibility", "value": "accessibility" }, { "name": "appearance", "value": "appearance" }, { "name": "appleID", "value": "appleID" }, { "name": "biometric", "value": "biometric" }, { "name": "diagnostics", "value": "diagnostics" }, { "name": "displayTone", "value": "displayTone" }, { "name": "fileVault", "value": "fileVault" }, { "name": "icloudDiagnostics", "value": "icloudDiagnostics" }, { "name": "icloudStorage", "value": "icloudStorage" }, { "name": "location", "value": "location" }, { "name": "payment", "value": "payment" }, { "name": "privacy", "value": "privacy" }, { "name": "restore", "value": "restore" }, { "name": "screenTime", "value": "screenTime" }, { "name": "siri", "value": "siri" }, { "name": "tos", "value": "tos" } ] }, "enum": [ "accessibility", "appearance", "appleID", "biometric", "diagnostics", "displayTone", "fileVault", "icloudDiagnostics", "icloudStorage", "location", "payment", "privacy", "restore", "screenTime", "siri", "tos" ], "title": "Setup Assistant Option", "type": "string" }, "software-app": { "properties": { "displayName": { "type": "string" }, "id": { "type": "string" }, "settings": { "items": { "$ref": "#/definitions/JcSoftware-app-settings" }, "type": "array" } }, "title": "Software Application Package Object" }, "software-app-status": { "properties": { "code": { "type": "integer" }, "details": { "type": "string" }, "id": { "type": "string" }, "softwareAppId": { "type": "string" }, "state": { "type": "string" }, "systemId": { "type": "string" }, "timestamp": { "type": "string" }, "version": { "type": "string" } }, "title": "Software Application Status Object" }, "SSOPostReq": { "description": "Request to insert SSO configuration for application.", "properties": { "config": { "properties": { "acsUrl": { "properties": { "label": { "type": "string" }, "options": { "type": "string" }, "position": { "type": "integer" }, "readOnly": { "type": "boolean" }, "required": { "type": "boolean" }, "toggle": { "type": "string" }, "tooltip": { "properties": { "template": { "type": "string" }, "variables": { "properties": { "icon": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } }, "type": "object" }, "type": { "type": "string" }, "value": { "type": "string" }, "visible": { "type": "boolean" } }, "type": "object" }, "constantAttributes": { "properties": { "label": { "type": "string" }, "mutable": { "type": "boolean" }, "options": { "type": "string" }, "position": { "type": "integer" }, "readOnly": { "type": "boolean" }, "required": { "type": "boolean" }, "toggle": { "type": "string" }, "tooltip": { "properties": { "template": { "type": "string" }, "variables": { "properties": { "icon": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } }, "type": "object" }, "type": { "type": "string" }, "value": { "items": { "properties": { "name": { "type": "string" }, "readOnly": { "type": "boolean" }, "required": { "type": "boolean" }, "value": { "type": "string" }, "visible": { "type": "boolean" } }, "type": "object" }, "type": "array" }, "visible": { "type": "boolean" } }, "type": "object" }, "databaseAttributes": { "properties": { "position": { "type": "integer" } }, "type": "object" }, "idpCertificate": { "properties": { "label": { "type": "string" }, "options": { "type": "string" }, "position": { "type": "integer" }, "readOnly": { "type": "boolean" }, "required": { "type": "boolean" }, "toggle": { "type": "string" }, "tooltip": { "properties": { "template": { "type": "string" }, "variables": { "properties": { "icon": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } }, "type": "object" }, "type": { "type": "string" }, "value": { "type": "string" }, "visible": { "type": "boolean" } }, "type": "object" }, "idpEntityId": { "properties": { "label": { "type": "string" }, "options": { "type": "string" }, "position": { "type": "integer" }, "readOnly": { "type": "boolean" }, "required": { "type": "boolean" }, "toggle": { "type": "string" }, "tooltip": { "properties": { "template": { "type": "string" }, "variables": { "properties": { "icon": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } }, "type": "object" }, "type": { "type": "string" }, "value": { "type": "string" }, "visible": { "type": "boolean" } }, "type": "object" }, "idpPrivateKey": { "properties": { "label": { "type": "string" }, "options": { "type": "string" }, "position": { "type": "integer" }, "readOnly": { "type": "boolean" }, "required": { "type": "boolean" }, "toggle": { "type": "string" }, "tooltip": { "properties": { "template": { "type": "string" }, "variables": { "properties": { "icon": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } }, "type": "object" }, "type": { "type": "string" }, "value": { "type": "string" }, "visible": { "type": "boolean" } }, "type": "object" }, "spEntityId": { "properties": { "label": { "type": "string" }, "options": { "type": "string" }, "position": { "type": "integer" }, "readOnly": { "type": "boolean" }, "required": { "type": "boolean" }, "toggle": { "type": "string" }, "tooltip": { "properties": { "template": { "type": "string" }, "variables": { "properties": { "icon": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } }, "type": "object" }, "type": { "type": "string" }, "value": { "type": "string" }, "visible": { "type": "boolean" } }, "type": "object" } }, "type": "object" }, "databaseAttributes": { "items": { "type": "object" }, "type": "array" }, "name": { "type": "string" }, "ssoUrl": { "type": "string" } }, "title": "SSOPostReq", "type": "object" }, "systemfdekey": { "properties": { "key": { "type": "string" } }, "required": [ "key" ], "title": "SystemFDEKey", "type": "object" }, "SystemGraphManagementReq": { "properties": { "attributes": { "description": "The graph connection's attributes", "properties": { "sudo": { "properties": { "enabled": { "type": "boolean" }, "withoutPassword": { "type": "boolean" } }, "type": "object" } }, "type": "object" }, "id": { "description": "The ObjectID of graph object being added or removed as an association.", "type": "string" }, "op": { "description": "How to modify the graph connection.", "x-ms-enum": { "name": "op", "modelAsString": true, "values": [ { "name": "add", "value": "add" }, { "name": "remove", "value": "remove" }, { "name": "update", "value": "update" } ] }, "enum": [ "add", "remove", "update" ], "type": "string" }, "type": { "x-ms-enum": { "name": "type1", "modelAsString": true, "values": [ { "name": "active_directory", "value": "active_directory" }, { "name": "application", "value": "application" }, { "name": "command", "value": "command" }, { "name": "g_suite", "value": "g_suite" }, { "name": "ldap_server", "value": "ldap_server" }, { "name": "office_365", "value": "office_365" }, { "name": "policy", "value": "policy" }, { "name": "radius_server", "value": "radius_server" }, { "name": "user", "value": "user" }, { "name": "user_group", "value": "user_group" } ] }, "enum": [ "active_directory", "application", "command", "g_suite", "ldap_server", "office_365", "policy", "radius_server", "user", "user_group" ], "type": "string" } }, "required": [ "op", "type", "id" ], "title": "SystemGraphManagementReq", "type": "object" }, "SystemGroup": { "properties": { "attributes": { "description": "The group object's attributes.", "type": "object" }, "description": { "description": "Description of a System Group", "type": "string" }, "email": { "description": "E-mail address associated with a System Group", "type": "string" }, "id": { "description": "ObjectId uniquely identifying a System Group.", "type": "string" }, "name": { "description": "Display name of a System Group.", "type": "string" }, "type": { "description": "The type of the group; always 'system' for a System Group.", "x-ms-enum": { "name": "type2", "modelAsString": true, "values": [ { "name": "systems_group", "value": "system_group" } ] }, "enum": [ "system_group" ], "type": "string" } }, "title": "SystemGroup", "type": "object" }, "SystemGroupData": { "properties": { "name": { "description": "Display name of a System Group.", "type": "string" } }, "required": [ "name" ], "title": "SystemGroupData", "type": "object" }, "SystemGroupGraphManagementReq": { "properties": { "attributes": { "description": "The graph connection's attributes.", "type": "object" }, "id": { "description": "The ObjectID of graph object being added or removed as an association.", "type": "string" }, "op": { "description": "How to modify the graph connection.", "x-ms-enum": { "name": "op", "modelAsString": true, "values": [ { "name": "add", "value": "add" }, { "name": "remove", "value": "remove" }, { "name": "update", "value": "update" } ] }, "enum": [ "add", "remove", "update" ], "type": "string" }, "type": { "x-ms-enum": { "name": "type1", "modelAsString": true, "values": [ { "name": "active_directory", "value": "active_directory" }, { "name": "application", "value": "application" }, { "name": "command", "value": "command" }, { "name": "g_suite", "value": "g_suite" }, { "name": "ldap_server", "value": "ldap_server" }, { "name": "office_365", "value": "office_365" }, { "name": "policy", "value": "policy" }, { "name": "radius_server", "value": "radius_server" }, { "name": "user", "value": "user" }, { "name": "user_group", "value": "user_group" } ] }, "enum": [ "active_directory", "application", "command", "g_suite", "ldap_server", "office_365", "policy", "radius_server", "user", "user_group" ], "type": "string" } }, "required": [ "op", "type", "id" ], "title": "SystemGroupGraphManagementReq", "type": "object" }, "SystemGroupMembersReq": { "properties": { "id": { "description": "The ObjectID of member being added or removed.", "type": "string" }, "op": { "description": "How to modify the membership connection.", "x-ms-enum": { "name": "op1", "modelAsString": true, "values": [ { "name": "add", "value": "add" }, { "name": "remove", "value": "remove" } ] }, "enum": [ "add", "remove" ], "type": "string" }, "type": { "description": "The member type.", "x-ms-enum": { "name": "type3", "modelAsString": true, "values": [ { "name": "systems", "value": "system" } ] }, "enum": [ "system" ], "type": "string" } }, "required": [ "op", "type", "id" ], "title": "SystemGroupMembersReq", "type": "object" }, "system-insights-alf": { "properties": { "allow_signed_enabled\t": { "type": "integer" }, "collection_time": { "type": "string" }, "firewall_unload": { "type": "integer" }, "global_state": { "type": "integer" }, "logging_enabled": { "type": "integer" }, "logging_option": { "type": "integer" }, "stealth_enabled": { "type": "integer" }, "system_id": { "type": "string" }, "version": { "type": "string" } }, "title": "System Insights ALF", "type": "object" }, "system-insights-alf-exceptions": { "properties": { "collection_time": { "type": "string" }, "path": { "type": "string" }, "state": { "type": "number" }, "system_id": { "type": "string" } }, "title": "System Insights ALF Exceptions", "type": "object" }, "system-insights-alf-explicit-auths": { "properties": { "collection_time": { "type": "string" }, "process": { "type": "string" }, "system_id": { "type": "string" } }, "title": "System Insights ALF Explicit Authorizations", "type": "object" }, "system-insights-appcompat-shims": { "properties": { "collection_time": { "type": "string" }, "description": { "type": "string" }, "executable": { "type": "string" }, "install_time": { "type": "number" }, "path": { "type": "string" }, "sdb_id": { "type": "string" }, "system_id": { "type": "string" }, "type": { "type": "string" } }, "title": "System Insights Application Compatibility Shims", "type": "object" }, "system-insights-apps": { "example": { "copyright": "", "element": "", "environment": "", "info_string": "", "applescript_enabled": "1", "bundle_executable": "App Store", "bundle_identifier": "com.apple.appstore", "bundle_name": "App Store", "bundle_package_type": "APPL", "bundle_short_version": "2.4", "bundle_version": "658.1", "category": "public.app-category.utilities", "collection_time": "2019-06-03T19:41:30.658+00:00", "compiler": "com.apple.compilers.llvm.clang.1_0", "development_region": "English", "display_name": "App Store", "last_opened_time": 1556688963, "minimum_system_version": "10.13", "name": "App Store.app", "path": "/Applications/App Store.app", "system_id": "5c9e51a13c5146f89bae12d9" }, "properties": { "applescript_enabled": { "type": "string" }, "bundle_executable": { "type": "string" }, "bundle_identifier": { "type": "string" }, "bundle_name": { "type": "string" }, "bundle_package_type": { "type": "string" }, "bundle_short_version": { "type": "string" }, "bundle_version": { "type": "string" }, "category": { "type": "string" }, "collection_time": { "type": "string" }, "compiler": { "type": "string" }, "copyright": { "type": "string" }, "development_region": { "type": "string" }, "display_name": { "type": "string" }, "element": { "type": "string" }, "environment": { "type": "string" }, "info_string": { "type": "string" }, "last_opened_time": { "type": "number" }, "minimum_system_version": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "system_id": { "type": "string" } }, "title": "System Insights Apps", "type": "object" }, "system-insights-authorized-keys": { "properties": { "algorithm": { "type": "string" }, "collection_time": { "type": "string" }, "key": { "type": "string" }, "key_file": { "type": "string" }, "system_id": { "type": "string" }, "uid": { "type": "string" } }, "title": "System Insights Authorized Keys", "type": "object" }, "system-insights-battery": { "example": { "amperage": 93836453, "charged": 63086136, "charging": 6577424, "collection_time": "anim in dolor", "condition": "magna Ut dolor laborum", "current_capacity": 95829126, "cycle_count": -58203101, "designed_capacity": 51607498, "health": "ipsum Duis amet magna sint", "manufacture_date": 66625366, "manufacturer": "laboris", "max_capacity": 407375, "minutes_to_full_charge": -43087634, "minutes_until_empty": 56660087, "model": "cupidatat quis esse tempor nostr", "percent_remaining": -77798506, "serial_number": "est do nisi anim eu", "state": "Duis qui eu labore", "system_id": "elit nulla cillum et", "voltage": -79728034 }, "properties": { "amperage": { "type": "integer" }, "charged": { "type": "integer" }, "charging": { "type": "integer" }, "collection_time": { "type": "string" }, "condition": { "type": "string" }, "current_capacity": { "type": "integer" }, "cycle_count": { "type": "integer" }, "designed_capacity": { "type": "integer" }, "health": { "type": "string" }, "manufacture_date": { "type": "integer" }, "manufacturer": { "type": "string" }, "max_capacity": { "type": "integer" }, "minutes_to_full_charge": { "type": "integer" }, "minutes_until_empty": { "type": "integer" }, "model": { "type": "string" }, "percent_remaining": { "type": "integer" }, "serial_number": { "type": "string" }, "state": { "type": "string" }, "system_id": { "type": "string" }, "voltage": { "type": "integer" } }, "title": "System Insights Battery", "type": "object" }, "system-insights-bitlocker-info": { "example": { "conversion_status": 0, "persistent_volume_id": "", "protection_status": 0, "collection_time": "2019-06-03T19:41:30.658+00:00", "devide_id": "\\\\\\\\?\\\\Volume{3ba5cc52-e0fd-45fa-b8b8-5c88f44f8b17}\\", "drive_letter": "C:", "encryption_method": "None", "system_id": "5c9e51a13c5146f89bae12d9" }, "properties": { "collection_time": { "type": "string" }, "conversion_status": { "type": "integer" }, "device_id": { "type": "string" }, "drive_letter": { "type": "string" }, "encryption_method": { "type": "string" }, "persistent_volume_id": { "type": "string" }, "protection_status": { "type": "integer" }, "system_id": { "type": "string" } }, "title": "System Insights Bitlocker Info", "type": "object" }, "system-insights-browser-plugins": { "example": { "disabled": 0, "native": 0, "collection_time": "2019-06-03T19:41:30.858+00:00", "description": "LastPass Plugin", "development_region": "en-US", "identifier": "com.lastpass.nplastpass", "name": "LastPass", "path": "/Library/Internet Plug-Ins/nplastpass.plugin/", "sdk": "7D175", "system_id": "5c9e51a13c5146f89bae12d9", "uid": "0", "version": "4.1.7" }, "properties": { "collection_time": { "type": "string" }, "description": { "type": "string" }, "development_region": { "type": "string" }, "disabled": { "type": "integer" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "native": { "type": "integer" }, "path": { "type": "string" }, "sdk": { "type": "string" }, "system_id": { "type": "string" }, "uid": { "type": "string" }, "version": { "type": "string" } }, "title": "System Insights Browser Plugins", "type": "object" }, "system-insights-certificates": { "properties": { "authority_key_id": { "type": "string" }, "ca": { "type": "integer" }, "common_name": { "type": "string" }, "issuer": { "type": "string" }, "key_algorithm": { "type": "string" }, "key_strength": { "type": "string" }, "key_usage": { "type": "string" }, "not_valid_after": { "type": "string" }, "not_valid_before": { "type": "string" }, "path": { "type": "string" }, "self_signed": { "type": "integer" }, "serial": { "type": "string" }, "sha1": { "type": "string" }, "sid": { "type": "string" }, "signing_algorithm": { "type": "string" }, "store": { "type": "string" }, "store_id": { "type": "string" }, "store_location": { "type": "string" }, "subject": { "type": "string" }, "subject_key_id": { "type": "string" }, "system_id": { "type": "string" }, "username": { "type": "string" } }, "title": "System Insights Certificates" }, "system-insights-chrome-extensions": { "example": { "author": "", "persistent": 0, "collection_time": "2019-06-03T19:41:31.125+00:00", "description": "provider for discovery and services for mirroring of chrome media router", "identifier": "pkedcjkdefgpdelpbcmbmeomcjbeemfm", "locale": "en", "name": "chrome media router", "path": "/users/thomas/library/application support/google/chrome/default/extensions/pkedcjkdefgpdelpbcmbmeomcjbeemfm/7419.311.0.1_0/", "permissions": "alarms, cast, cast.streaming, declarativewebrequest, desktopcapture, gcm, http://*/*, identity, identity.email, management, mdns, mediarouterprivate, metricsprivate, networkingprivate, processes, storage, system.cpu, settingsprivate, tabcapture, tabs, webview, https://hangouts.google.com/*, https://*.google.com/cast/chromecast/home/gsse", "system_id": "5c9e51a13c5146f89bae12d9", "uid": "501", "update_url": "https://clients2.google.com/service/update2/crx", "version": "7419.311.0.1" }, "properties": { "author": { "type": "string" }, "collection_time": { "type": "string" }, "description": { "type": "string" }, "identifier": { "type": "string" }, "locale": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "permissions": { "type": "string" }, "persistent": { "type": "integer" }, "system_id": { "type": "string" }, "uid": { "type": "string" }, "update_url": { "type": "string" }, "version": { "type": "string" } }, "title": "System Insights Chrome Extensions", "type": "object" }, "system-insights-connectivity": { "properties": { "collection_time": { "type": "string" }, "disconnected": { "type": "integer" }, "ipv4_internet": { "type": "integer" }, "ipv4_local_network": { "type": "integer" }, "ipv4_no_traffic": { "type": "integer" }, "ipv4_subnet": { "type": "integer" }, "ipv6_internet": { "type": "integer" }, "ipv6_local_network": { "type": "integer" }, "ipv6_no_traffic": { "type": "integer" }, "ipv6_subnet": { "type": "integer" }, "system_id": { "type": "string" } }, "title": "system insights connectivity", "type": "object" }, "system-insights-crashes": { "properties": { "collection_time": { "type": "string" }, "crash_path": { "type": "string" }, "crashed_thread": { "type": "string" }, "datetime": { "type": "string" }, "exception_codes": { "type": "string" }, "exception_notes": { "type": "string" }, "exception_type": { "type": "string" }, "identifier": { "type": "string" }, "parent": { "type": "string" }, "path": { "type": "string" }, "pid": { "type": "string" }, "registers": { "type": "string" }, "responsible": { "type": "string" }, "stack_trace": { "type": "string" }, "system_id": { "type": "string" }, "type": { "type": "string" }, "uid": { "type": "integer" }, "version": { "type": "string" } }, "title": "System Insights Crashes", "type": "object" }, "system-insights-cups-destinations": { "properties": { "name": { "type": "string" }, "option_name": { "type": "string" }, "option_value": { "type": "string" }, "system_id": { "type": "string" } }, "title": "System Insights CUPS Destinations" }, "system-insights-disk-encryption": { "example": { "encrypted": 0, "type": "", "uid": "", "user_uuid": "", "uuid": "", "collection_time": "2019-06-03T19:41:31.557+00:00", "encryption_status": "undefined", "name": "/dev/disk8", "system_id": "5c9e51a13c5146f89bae12d9" }, "properties": { "collection_time": { "type": "string" }, "encrypted": { "type": "integer" }, "encryption_status": { "type": "string" }, "name": { "type": "string" }, "system_id": { "type": "string" }, "type": { "type": "string" }, "uid": { "type": "string" }, "user_uuid": { "type": "string" }, "uuid": { "type": "string" } }, "title": "System Insights Disk Encryption", "type": "object" }, "system-insights-disk-info": { "example": { "disk_index": 0, "serial": "", "collection_time": "2019-06-03T19:41:30.658+00:00", "description": "Disk drive", "disk_size": "64420392960", "hardware_model": "VMware, VMware Virtual S SCSI Disk Device", "id": "\\\\.\\PHYSICALDRIVE0", "manufacturer": "(Standard disk drives)", "name": "\\\\.\\PHYSICALDRIVE0", "partitions": 3, "pnp_device_id": "SCSI\\DISK&VEN_VMWARE_&PROD_VMWARE_VIRTUAL_S\\5&1EC51BF7&0&000000", "system_id": "5c9e51a13c5146f89bae12d9", "type": "SCSI" }, "properties": { "collection_time": { "type": "string" }, "description": { "type": "string" }, "disk_index": { "type": "integer" }, "disk_size": { "type": "string" }, "hardware_model": { "type": "string" }, "id": { "type": "string" }, "manufacturer": { "type": "string" }, "name": { "type": "string" }, "partitions": { "type": "integer" }, "pnp_device_id": { "type": "string" }, "serial": { "type": "string" }, "system_id": { "type": "string" }, "type": { "type": "string" } }, "title": "System Insights Disk Info", "type": "object" }, "system-insights-dns-resolvers": { "properties": { "address": { "type": "string" }, "collection_time": { "type": "string" }, "id": { "type": "number" }, "netmask": { "type": "string" }, "options": { "type": "string" }, "system_id": { "type": "string" }, "type": { "type": "string" } }, "title": "System Insights DNS Resolvers", "type": "object" }, "system-insights-etc-hosts": { "example": { "address": "192.168.2.21", "collection_time": "2019-06-03T19:41:30.658+00:00", "hostnames": "hosty hosty.local", "system_id": "5c9e51a13c5146f89bae12d9" }, "properties": { "address": { "type": "string" }, "collection_time": { "type": "string" }, "hostnames": { "type": "string" }, "system_id": { "type": "string" } }, "title": "System Insights Etc Hosts", "type": "object" }, "system-insights-firefox-addons": { "example": { "description": "", "disabled": 0, "path": "", "active": 1, "autoupdate": 1, "collection_time": "2019-06-03T19:41:31.204+00:00", "creator": "null", "identifier": "fxmonitor@mozilla.org", "location": "app-system-addons", "name": "Firefox Monitor", "source_url": "file:///var/folders/dn/zjm_0lzn4lv6bgnt5b3nkgxh0000gn/T/tmpaddon-9fb449", "system_id": "5c9e51a13c5146f89bae12d9", "type": "extension", "uid": "501", "version": "2.8", "visible": 1 }, "properties": { "active": { "type": "integer" }, "autoupdate": { "type": "integer" }, "collection_time": { "type": "string" }, "creator": { "type": "string" }, "description": { "type": "string" }, "disabled": { "type": "integer" }, "identifier": { "type": "string" }, "location": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "source_url": { "type": "string" }, "system_id": { "type": "string" }, "type": { "type": "string" }, "uid": { "type": "string" }, "version": { "type": "string" }, "visible": { "type": "integer" } }, "title": "System Insights Firefox Addons", "type": "object" }, "system-insights-groups": { "example": { "comment": "", "group_sid": "", "collection_time": "2019-06-03T19:41:31.673+00:00", "gid": "701", "gid_signed": "701", "groupname": "1", "system_id": "5c9e51a13c5146f89bae12d9" }, "properties": { "collection_time": { "type": "string" }, "comment": { "type": "string" }, "gid": { "type": "string" }, "gid_signed": { "type": "string" }, "group_sid": { "type": "string" }, "groupname": { "type": "string" }, "system_id": { "type": "string" } }, "title": "System Insights Groups", "type": "object" }, "system-insights-ie-extensions": { "properties": { "collection_time": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "registry_path": { "type": "string" }, "system_id": { "type": "string" }, "version": { "type": "string" } }, "title": "System Insights IE Extensions", "type": "object" }, "system-insights-interface-addresses": { "example": { "broadcast": "", "friendly_name": "", "address": "::1", "collection_time": "2019-06-03T19:41:31.008+00:00", "interface": "lo0", "mask": "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff", "point_to_point": "::1", "system_id": "5c9e51a13c5146f89bae12d9", "type": "unknown" }, "properties": { "address": { "type": "string" }, "broadcast": { "type": "string" }, "collection_time": { "type": "string" }, "friendly_name": { "type": "string" }, "interface": { "type": "string" }, "mask": { "type": "string" }, "point_to_point": { "type": "string" }, "system_id": { "type": "string" }, "type": { "type": "string" } }, "title": "System Insights Interface Addresses", "type": "object" }, "system-insights-interface-details": { "properties": { "collisions": { "type": "string" }, "connection_id": { "type": "string" }, "connection_status": { "type": "string" }, "description": { "type": "string" }, "dhcp_enabled": { "type": "integer" }, "dhcp_lease_expires": { "type": "string" }, "dhcp_lease_obtained": { "type": "string" }, "dhcp_server": { "type": "string" }, "dns_domain": { "type": "string" }, "dns_domain_suffix_search_order": { "type": "string" }, "dns_host_name": { "type": "string" }, "dns_server_search_order": { "type": "string" }, "enabled": { "type": "integer" }, "flags": { "type": "integer" }, "friendly_name": { "type": "string" }, "ibytes": { "type": "string" }, "idrops": { "type": "string" }, "ierrors": { "type": "string" }, "interface": { "type": "string" }, "ipackets": { "type": "string" }, "last_change": { "type": "string" }, "link_speed": { "type": "string" }, "mac": { "type": "string" }, "manufacturer": { "type": "string" }, "metric": { "type": "integer" }, "mtu": { "type": "integer" }, "obytes": { "type": "string" }, "odrops": { "type": "string" }, "oerrors": { "type": "string" }, "opackets": { "type": "string" }, "pci_slot": { "type": "string" }, "physical_adapter": { "type": "integer" }, "service": { "type": "string" }, "speed": { "type": "integer" }, "system_id": { "type": "string" }, "type": { "type": "integer" } }, "title": "System Insights Interface Details", "type": "object" }, "system-insights-kernel-info": { "properties": { "arguments": { "type": "string" }, "collection_time": { "type": "string" }, "device": { "type": "string" }, "path": { "type": "string" }, "system_id": { "type": "string" }, "version": { "type": "string" } }, "title": "System Insights Kernel Info", "type": "object" }, "system-insights-launchd": { "properties": { "collection_time": { "type": "string" }, "disabled": { "type": "string" }, "groupname": { "type": "string" }, "inetd_compatibility": { "type": "string" }, "keep_alive": { "type": "string" }, "label": { "type": "string" }, "name": { "type": "string" }, "on_demand": { "type": "string" }, "path": { "type": "string" }, "process_type": { "type": "string" }, "program": { "type": "string" }, "program_arguments": { "type": "string" }, "queue_directories": { "type": "string" }, "root_directory": { "type": "string" }, "run_at_load": { "type": "string" }, "start_interval": { "type": "string" }, "start_on_mount": { "type": "string" }, "stderr_path": { "type": "string" }, "stdout_path": { "type": "string" }, "system_id": { "type": "string" }, "username": { "type": "string" }, "watch_paths": { "type": "string" }, "working_directory": { "type": "string" } }, "title": "System Insights LaunchD", "type": "object" }, "system-insights-logged-in-users": { "properties": { "collection_time": { "type": "string" }, "host": { "type": "string" }, "pid": { "type": "integer" }, "system_id": { "type": "string" }, "time": { "type": "integer" }, "tty": { "type": "string" }, "type": { "type": "string" }, "user": { "type": "string" } }, "title": "System Insights Logged-In Users", "type": "object" }, "system-insights-logical-drives": { "example": { "boot_partition": 0, "collection_time": "2019-06-03T19:41:30.658+00:00", "device_id": "C:", "file_system": "NTFS", "free_space": "43194331136", "size": "63778582528", "system_id": "5c9e51a13c5146f89bae12d9", "type": "Unknown" }, "properties": { "boot_partition": { "type": "integer" }, "collection_time": { "type": "string" }, "device_id": { "type": "string" }, "file_system": { "type": "string" }, "free_space": { "type": "string" }, "size": { "type": "string" }, "system_id": { "type": "string" }, "type": { "type": "string" } }, "title": "System Insights Logical Drives", "type": "object" }, "system-insights-managed-policies": { "properties": { "collection_time": { "type": "string" }, "domain": { "type": "string" }, "manual": { "type": "integer" }, "name": { "type": "string" }, "system_id": { "type": "string" }, "username": { "type": "string" }, "uuid": { "type": "string" }, "value": { "type": "string" } }, "title": "System Insights Managed Policies", "type": "object" }, "system-insights-mounts": { "example": { "blocks": "388086", "blocks_available": "95135", "blocks_free": "95135", "blocks_size": "4096", "collection_time": "2019-06-03T19:41:31.746+00:00", "device": "/dev/disk5s1", "device_alias": "/dev/disk5s1", "flags": "70292505", "inodes": "4294967279", "inodes_free": "4294966853", "path": "/private/var/folders/zz/zyxvpxvq6csfxvn_n0000000000000/T/.vbfolder_1dQavK", "system_id": "5c9e51a13c5146f89bae12d9", "type": "hfs" }, "properties": { "blocks": { "type": "string" }, "blocks_available": { "type": "string" }, "blocks_free": { "type": "string" }, "blocks_size": { "type": "string" }, "collection_time": { "type": "string" }, "device": { "type": "string" }, "device_alias": { "type": "string" }, "flags": { "type": "string" }, "inodes": { "type": "string" }, "inodes_free": { "type": "string" }, "path": { "type": "string" }, "system_id": { "type": "string" }, "type": { "type": "string" } }, "title": "System Insights Mounts", "type": "object" }, "system-insights-os-version": { "example": { "codename": "", "install_date": "", "build": "17G65", "collection_time": "2019-06-03T19:41:30.933+00:00", "major": 10, "minor": 13, "name": "Mac OS X", "patch": 6, "platform": "darwin", "platform_like": "darwin", "system_id": "5c9e51a13c5146f89bae12d9", "version": "10.13.6" }, "properties": { "build": { "type": "string" }, "codename": { "type": "string" }, "collection_time": { "type": "string" }, "install_date": { "type": "string" }, "major": { "type": "integer" }, "minor": { "type": "integer" }, "name": { "type": "string" }, "patch": { "type": "integer" }, "platform": { "type": "string" }, "platform_like": { "type": "string" }, "system_id": { "type": "string" }, "version": { "type": "string" } }, "title": "System Insights OS Version", "type": "object" }, "system-insights-patches": { "example": { "fix_comments": "", "install_date": "", "caption": "http://support.microsoft.com/?kbid=4503308", "collection_time": "2019-06-03T19:41:31.673+00:00", "csname": "DESKTOP-B17DUKP", "description": "Security Update", "hotfix_id": "KB4503308", "installed_by": "NT AUTHORITY\\SYSTEM", "installed_on": "7/30/2019", "system_id": "5c9e51a13c5146f89bae12d9" }, "properties": { "caption": { "type": "string" }, "collection_time": { "type": "string" }, "csname": { "type": "string" }, "description": { "type": "string" }, "fix_comments": { "type": "string" }, "hotfix_id": { "type": "string" }, "install_date": { "type": "string" }, "installed_by": { "type": "string" }, "installed_on": { "type": "string" }, "system_id": { "type": "string" } }, "title": "System Insights Patches", "type": "object" }, "system-insights-programs": { "example": { "install_location": "", "collection_time": "2019-06-03T19:41:31.673+00:00", "identifying_number": "{2E8B8BDD-03DF-4C1C-8C99-E6A4BCBF43CE}", "install_date": "20190724", "install_source": "C:\\Windows\\SoftwareDistribution\\Download\\b78f29c88063bd09e7afd48e257d0126\\img\\", "language": "0", "name": "Update for Windows 10 for x64-based Systems (KB4480730)", "publisher": "Microsoft Corporation", "system_id": "5c9e51a13c5146f89bae12d9", "uninstall_string": "MsiExec.exe /X{2E8B8BDD-03DF-4C1C-8C99-E6A4BCBF43CE}", "version": "2.51.0.0" }, "properties": { "collection_time": { "type": "string" }, "identifying_number": { "type": "string" }, "install_date": { "type": "string" }, "install_location": { "type": "string" }, "install_source": { "type": "string" }, "language": { "type": "string" }, "name": { "type": "string" }, "publisher": { "type": "string" }, "system_id": { "type": "string" }, "uninstall_string": { "type": "string" }, "version": { "type": "string" } }, "title": "System Insights Programs", "type": "object" }, "system-insights-python-packages": { "properties": { "auther": { "type": "string" }, "directory": { "type": "string" }, "license": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "summary": { "type": "string" }, "system_id": { "type": "string" }, "version": { "type": "string" } }, "title": "System Insights Python packages" }, "system-insights-safari-extensions": { "example": { "author": "Eyeo GmbH", "collection_time": "2019-05-16T18:58:15.673+00:00", "description": "Used by over 50 million people, a free ad blocker that blocks ALL annoying ads, malware and tracking.", "developer_id": "GRYYZR985A", "identifier": "org.adblockplus.adblockplussafari", "name": "Adblock Plus", "path": "/Users/samuelharvanek/Library/Safari/Extensions/Adblock Plus.safariextz", "sdk": "6.0", "system_id": "5cdb13e85a0e0719283583c0", "uid": "501", "update_url": "https://update.adblockplus.org/adblockplussafari/updates.plist", "version": "1.12.5" }, "properties": { "author": { "type": "string" }, "collection_time": { "type": "string" }, "description": { "type": "string" }, "developer_id": { "type": "string" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "sdk": { "type": "string" }, "system_id": { "type": "string" }, "uid": { "type": "string" }, "update_url": { "type": "string" }, "version": { "type": "string" } }, "title": "System Insights Safari Extensions", "type": "object" }, "system-insights-scheduled-tasks": { "properties": { "action": { "type": "string" }, "enabled": { "type": "integer" }, "hidden": { "type": "integer" }, "last_run_code": { "type": "string" }, "last_run_message": { "type": "string" }, "last_run_time": { "type": "integer" }, "name": { "type": "string" }, "next_run_time": { "type": "integer" }, "path": { "type": "string" }, "state": { "type": "string" }, "system_id": { "type": "string" } }, "title": "System Insights Scheduled tasks", "type": "object" }, "system-insights-services": { "properties": { "description": { "type": "string" }, "display_name": { "type": "string" }, "module_path": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "pid": { "type": "integer" }, "service_exit_code": { "type": "integer" }, "service_type": { "type": "string" }, "start_type": { "type": "string" }, "status": { "type": "string" }, "system_id": { "type": "string" }, "user_account": { "type": "string" }, "win32_exit_code": { "type": "integer" } }, "title": "System Insights Services", "type": "object" }, "system-insights-shadow": { "properties": { "collection_time": { "type": "string" }, "expire": { "type": "string" }, "flag": { "type": "string" }, "hash_alg": { "type": "string" }, "inactive": { "type": "string" }, "last_change": { "type": "string" }, "max": { "type": "string" }, "min": { "type": "string" }, "password_status": { "type": "string" }, "system_id": { "type": "string" }, "username": { "type": "string" }, "warning": { "type": "string" } }, "title": "System Insights Shadow", "type": "object" }, "system-insights-shared-folders": { "properties": { "collection_time": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "system_id": { "type": "string" } }, "title": "System Insights Shared Folders", "type": "object" }, "system-insights-shared-resources": { "properties": { "allow_maximum": { "type": "integer" }, "collection_time": { "type": "string" }, "description": { "type": "string" }, "install_date": { "type": "string" }, "maximum_allowed": { "type": "integer" }, "name": { "type": "string" }, "path": { "type": "string" }, "status": { "type": "string" }, "system_id": { "type": "string" }, "type": { "type": "integer" } }, "title": "System Insights Shared Resources", "type": "object" }, "system-insights-sharing-preferences": { "properties": { "bluetooth_sharing": { "type": "integer" }, "collection_time": { "type": "string" }, "content_caching": { "type": "integer" }, "disc_sharing": { "type": "integer" }, "file_sharing": { "type": "integer" }, "internet_sharing": { "type": "integer" }, "printer_sharing": { "type": "integer" }, "remote_apple_events": { "type": "integer" }, "remote_login": { "type": "integer" }, "remote_management": { "type": "integer" }, "screen_sharing": { "type": "integer" }, "system_id": { "type": "string" } }, "title": "System Insights Sharing Preferences", "type": "object" }, "system-insights-sip-config": { "properties": { "collection_time": { "type": "string" }, "config_flag": { "type": "string" }, "enabled": { "type": "integer" }, "enabled_nvram": { "type": "integer" }, "system_id": { "type": "string" } }, "title": "System Insights SIP Config", "type": "object" }, "system-insights-startup-items": { "properties": { "args": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "source": { "type": "string" }, "status": { "type": "string" }, "system_id": { "type": "string" }, "type": { "type": "string" }, "username": { "type": "string" } }, "title": "System Insights Startup items" }, "system-insights-system-controls": { "properties": { "collection_time": { "type": "string" }, "config_value": { "type": "string" }, "current_value": { "type": "string" }, "field_name": { "type": "string" }, "name": { "type": "string" }, "oid": { "type": "string" }, "subsystem": { "type": "string" }, "system_id": { "type": "string" }, "type": { "type": "string" } }, "title": "System Insights System Controls", "type": "object" }, "system-insights-system-info": { "example": { "cpu_microcode": "", "collection_time": "2019-06-03T19:41:30.771+00:00", "computer_name": "Johnny’s MacBook Pro (2)", "cpu_brand": "Intel(R) Core(TM) i7-7820HQ CPU @ 2.90GHz", "cpu_logical_cores": 8, "cpu_physical_cores": 4, "cpu_subtype": "Intel x86-64h Haswell", "cpu_type": "x86_64h", "hardware_model": "MacBookPro14,3 ", "hardware_serial": "111111FFFFFF", "hardware_vendor": "Apple Inc. ", "hardware_version": "1.0 ", "hostname": "johnnys-macbook-pro-2.local", "local_hostname": "Jonnys-MacBook-Pro-2", "physical_memory": "17179869184", "system_id": "5c9e51a13c5146f89bae12d9", "uuid": "11111111-FFFF-1111-FFFF-111111111111" }, "properties": { "collection_time": { "type": "string" }, "computer_name": { "type": "string" }, "cpu_brand": { "type": "string" }, "cpu_logical_cores": { "type": "integer" }, "cpu_microcode": { "type": "string" }, "cpu_physical_cores": { "type": "integer" }, "cpu_subtype": { "type": "string" }, "cpu_type": { "type": "string" }, "hardware_model": { "type": "string" }, "hardware_serial": { "type": "string" }, "hardware_vendor": { "type": "string" }, "hardware_version": { "type": "string" }, "hostname": { "type": "string" }, "local_hostname": { "type": "string" }, "physical_memory": { "type": "string" }, "system_id": { "type": "string" }, "uuid": { "type": "string" } }, "title": "System Insights System Info", "type": "object" }, "system-insights-uptime": { "properties": { "collection_time": { "type": "string" }, "days": { "type": "integer" }, "hours": { "type": "integer" }, "minutes": { "type": "integer" }, "seconds": { "type": "integer" }, "system_id": { "type": "string" }, "total_seconds": { "type": "string" } }, "title": "System Insights Uptime", "type": "object" }, "system-insights-usb-devices": { "properties": { "class": { "type": "string" }, "collection_time": { "type": "string" }, "model": { "type": "string" }, "model_id": { "type": "string" }, "protocol": { "type": "string" }, "removable": { "type": "integer" }, "serial": { "type": "string" }, "subclass": { "type": "string" }, "system_id": { "type": "string" }, "usb_address": { "type": "integer" }, "usb_port": { "type": "integer" }, "vendor": { "type": "string" }, "vendor_id": { "type": "string" }, "version": { "type": "string" } }, "title": "System Insights USB Devices", "type": "object" }, "system-insights-user-groups": { "properties": { "collection_time": { "type": "string" }, "gid": { "type": "string" }, "system_id": { "type": "string" }, "uid": { "type": "string" } }, "title": "System Insights User Groups", "type": "object" }, "system-insights-users": { "example": { "type": "", "collection_time": "2019-06-03T19:41:29.71+00:00", "description": "AppleEvents Daemon", "directory": "/var/empty", "gid": "55", "gid_signed": "55", "shell": "/usr/bin/false", "system_id": "5c9e51a13c5146f89bae12d9", "uid": "55", "uid_signed": "55", "username": "_appleevents", "uuid": "FFFFEEEE-DDDD-CCCC-BBBB-AAAA00000037" }, "properties": { "collection_time": { "type": "string" }, "description": { "type": "string" }, "directory": { "type": "string" }, "gid": { "type": "string" }, "gid_signed": { "type": "string" }, "shell": { "type": "string" }, "system_id": { "type": "string" }, "type": { "type": "string" }, "uid": { "type": "string" }, "uid_signed": { "type": "string" }, "username": { "type": "string" }, "uuid": { "type": "string" } }, "title": "System Insights Users", "type": "object" }, "system-insights-user-ssh-keys": { "properties": { "collection_time": { "type": "string" }, "encrypted": { "type": "integer" }, "path": { "type": "string" }, "system_id": { "type": "string" }, "uid": { "type": "string" } }, "title": "System Insights User SSH Keys", "type": "object" }, "system-insights-wifi-networks": { "properties": { "auto_login": { "type": "number" }, "captive_portal": { "type": "number" }, "collection_time": { "type": "string" }, "disabled": { "type": "number" }, "last_connected": { "type": "number" }, "network_name": { "type": "string" }, "passpoint": { "type": "number" }, "possibly_hidden": { "type": "number" }, "roaming": { "type": "number" }, "roaming_profile": { "type": "string" }, "security_type": { "type": "string" }, "ssid": { "type": "string" }, "system_id": { "type": "string" }, "temporarily_disabled": { "type": "number" } }, "title": "System Insights WiFi Networks", "type": "object" }, "system-insights-wifi-status": { "properties": { "bssid": { "type": "string" }, "channel": { "type": "number" }, "channel_band": { "type": "number" }, "channel_width": { "type": "number" }, "collection_time": { "type": "string" }, "country_code": { "type": "string" }, "interface": { "type": "string" }, "mode": { "type": "string" }, "network_name": { "type": "string" }, "noise": { "type": "number" }, "rssi": { "type": "number" }, "security_type": { "type": "string" }, "ssid": { "type": "string" }, "system_id": { "type": "string" }, "transmit_rate": { "type": "string" } }, "title": "System Insights WiFi Status", "type": "object" }, "system-insights-windows-security-products": { "properties": { "collection_time": { "type": "string" }, "name": { "type": "string" }, "remediation_path": { "type": "string" }, "signatures_up_to_date": { "type": "number" }, "state": { "type": "string" }, "state_timestamp": { "type": "string" }, "system_id": { "type": "string" }, "type": { "type": "string" } }, "title": "System Insights Windows Security Products", "type": "object" }, "UserGraphManagementReq": { "properties": { "attributes": { "description": "The graph connection's attributes", "properties": { "sudo": { "properties": { "enabled": { "type": "boolean" }, "withoutPassword": { "type": "boolean" } }, "type": "object" } }, "type": "object" }, "id": { "description": "The ObjectID of graph object being added or removed as an association.", "type": "string" }, "op": { "description": "How to modify the graph connection.", "x-ms-enum": { "name": "op", "modelAsString": true, "values": [ { "name": "add", "value": "add" }, { "name": "remove", "value": "remove" }, { "name": "update", "value": "update" } ] }, "enum": [ "add", "remove", "update" ], "type": "string" }, "type": { "x-ms-enum": { "name": "type4", "modelAsString": true, "values": [ { "name": "active_directory", "value": "active_directory" }, { "name": "application", "value": "application" }, { "name": "command", "value": "command" }, { "name": "g_suite", "value": "g_suite" }, { "name": "ldap_server", "value": "ldap_server" }, { "name": "office_365", "value": "office_365" }, { "name": "policy", "value": "policy" }, { "name": "radius_server", "value": "radius_server" }, { "name": "systems", "value": "system" }, { "name": "systems_group", "value": "system_group" } ] }, "enum": [ "active_directory", "application", "command", "g_suite", "ldap_server", "office_365", "policy", "radius_server", "system", "system_group" ], "type": "string" } }, "required": [ "op", "type", "id" ], "title": "UserGraphManagementReq", "type": "object" }, "UserGroup": { "properties": { "attributes": { "$ref": "#/definitions/UserGroupAttributes" }, "description": { "description": "Description of a User Group", "type": "string" }, "email": { "description": "Email address of a User Group", "type": "string" }, "id": { "description": "ObjectId uniquely identifying a User Group.", "type": "string" }, "name": { "description": "Display name of a User Group.", "type": "string" }, "type": { "description": "The type of the group.", "x-ms-enum": { "name": "type5", "modelAsString": true, "values": [ { "name": "user_group", "value": "user_group" } ] }, "enum": [ "user_group" ], "type": "string" } }, "title": "UserGroup", "type": "object" }, "UserGroupAttributes": { "properties": { "posixGroups": { "items": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "sambaEnabled": { "type": "boolean" } }, "title": "UserGroupAttributes", "type": "object" }, "UserGroupGraphManagementReq": { "properties": { "attributes": { "description": "The graph connection's attributes.", "type": "object" }, "id": { "description": "The ObjectID of graph object being added or removed as an association.", "type": "string" }, "op": { "description": "How to modify the graph connection.", "x-ms-enum": { "name": "op", "modelAsString": true, "values": [ { "name": "add", "value": "add" }, { "name": "remove", "value": "remove" }, { "name": "update", "value": "update" } ] }, "enum": [ "add", "remove", "update" ], "type": "string" }, "type": { "description": "The graph type", "x-ms-enum": { "name": "type4", "modelAsString": true, "values": [ { "name": "active_directory", "value": "active_directory" }, { "name": "application", "value": "application" }, { "name": "command", "value": "command" }, { "name": "g_suite", "value": "g_suite" }, { "name": "ldap_server", "value": "ldap_server" }, { "name": "office_365", "value": "office_365" }, { "name": "policy", "value": "policy" }, { "name": "radius_server", "value": "radius_server" }, { "name": "systems", "value": "system" }, { "name": "systems_group", "value": "system_group" } ] }, "enum": [ "active_directory", "application", "command", "g_suite", "ldap_server", "office_365", "policy", "radius_server", "system", "system_group" ], "type": "string" } }, "required": [ "op", "type", "id" ], "title": "UserGroupGraphManagementReq", "type": "object" }, "UserGroupMembersReq": { "properties": { "id": { "description": "The ObjectID of member being added or removed.", "type": "string" }, "op": { "description": "How to modify the membership connection.", "x-ms-enum": { "name": "op1", "modelAsString": true, "values": [ { "name": "add", "value": "add" }, { "name": "remove", "value": "remove" } ] }, "enum": [ "add", "remove" ], "type": "string" }, "type": { "description": "The member type.", "x-ms-enum": { "name": "type6", "modelAsString": true, "values": [ { "name": "user", "value": "user" } ] }, "enum": [ "user" ], "type": "string" } }, "required": [ "op", "type", "id" ], "title": "UserGroupMembersReq", "type": "object" }, "UserGroupPost": { "properties": { "attributes": { "$ref": "#/definitions/UserGroupAttributes" }, "description": { "description": "Description of a User Group", "type": "string" }, "email": { "description": "Email address of a User Group", "type": "string" }, "name": { "description": "Display name of a User Group.", "type": "string" } }, "required": [ "name" ], "title": "UserGroupPost", "type": "object" }, "UserGroupPut": { "properties": { "attributes": { "$ref": "#/definitions/UserGroupAttributes" }, "description": { "description": "Description of a User Group", "type": "string" }, "email": { "description": "Email address of a User Group", "type": "string" }, "name": { "description": "Display name of a User Group.", "type": "string" } }, "required": [ "name" ], "title": "UserGroupPut", "type": "object" }, "workday-fields": { "properties": { "name": { "type": "string" }, "reportUrl": { "type": "string" } }, "title": "Workday Fields", "type": "object" }, "workday-input": { "example": { "auth": { "basic": { "password": "in tempor ipsum quis", "username": "mollit ex" }, "oauth": { "code": "non laborum dolore" } }, "name": "dolore tempor", "reportUrl": "est sit laboris" }, "properties": { "auth": { "$ref": "#/definitions/auth-input" }, "name": { "type": "string" }, "reportUrl": { "type": "string" } }, "title": "Workday Input", "type": "object" }, "workday-output": { "properties": { "auth": { "properties": { "basic": { "$ref": "#/definitions/auth-info" }, "oauth": { "$ref": "#/definitions/auth-info" } }, "type": "object" }, "id": { "type": "string" }, "lastImport": { "type": "string" }, "name": { "type": "string" }, "reportUrl": { "type": "string" } }, "title": "Workday Output", "type": "object" }, "workday-worker": { "properties": { "attributes": { "type": "object" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "username": { "type": "string" } }, "title": "Workday Worker", "type": "object" } }, "host": "console.jumpcloud.com", "info": { "description": "JumpCloud's V2 API. This set of endpoints allows JumpCloud customers to manage objects, groupings and mappings and interact with the JumpCloud Graph.", "title": "JumpCloud APIs", "version": "2.0" }, "parameters": { "trait:aggregate:aggregate": { "required": false, "default": [], "in": "query", "items": { "type": "string" }, "name": "aggregate", "type": "array" }, "trait:fields:fields": { "required": false, "default": [], "description": "The comma separated fields included in the returned records.\nIf omitted, the default list of fields will be returned.\n", "in": "query", "items": { "type": "string" }, "name": "fields", "type": "array" }, "trait:filter:filter": { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, "trait:graphSystemGroupTargets:targets": { "description": "", "in": "query", "items": { "x-ms-enum": { "name": "items1", "modelAsString": true, "values": [ { "name": "active_directory", "value": "active_directory" }, { "name": "application", "value": "application" }, { "name": "command", "value": "command" }, { "name": "g_suite", "value": "g_suite" }, { "name": "ldap_server", "value": "ldap_server" }, { "name": "office_365", "value": "office_365" }, { "name": "policy", "value": "policy" }, { "name": "radius_server", "value": "radius_server" }, { "name": "user", "value": "user" }, { "name": "user_group", "value": "user_group" } ] }, "enum": [ "active_directory", "application", "command", "g_suite", "ldap_server", "office_365", "policy", "radius_server", "user", "user_group" ], "type": "string" }, "name": "targets", "required": true, "type": "array" }, "trait:graphSystemTargets:targets": { "description": "", "in": "query", "items": { "x-ms-enum": { "name": "items1", "modelAsString": true, "values": [ { "name": "active_directory", "value": "active_directory" }, { "name": "application", "value": "application" }, { "name": "command", "value": "command" }, { "name": "g_suite", "value": "g_suite" }, { "name": "ldap_server", "value": "ldap_server" }, { "name": "office_365", "value": "office_365" }, { "name": "policy", "value": "policy" }, { "name": "radius_server", "value": "radius_server" }, { "name": "user", "value": "user" }, { "name": "user_group", "value": "user_group" } ] }, "enum": [ "active_directory", "application", "command", "g_suite", "ldap_server", "office_365", "policy", "radius_server", "user", "user_group" ], "type": "string" }, "name": "targets", "required": true, "type": "array" }, "trait:graphTargets:targets": { "description": "", "in": "query", "items": { "x-ms-enum": { "name": "items2", "modelAsString": true, "values": [ { "name": "active_directory", "value": "active_directory" }, { "name": "application", "value": "application" }, { "name": "command", "value": "command" }, { "name": "g_suite", "value": "g_suite" }, { "name": "ldap_server", "value": "ldap_server" }, { "name": "office_365", "value": "office_365" }, { "name": "policy", "value": "policy" }, { "name": "radius_server", "value": "radius_server" }, { "name": "systems", "value": "system" }, { "name": "systems_group", "value": "system_group" }, { "name": "user", "value": "user" }, { "name": "user_group", "value": "user_group" } ] }, "enum": [ "active_directory", "application", "command", "g_suite", "ldap_server", "office_365", "policy", "radius_server", "system", "system_group", "user", "user_group" ], "type": "string" }, "name": "targets", "required": true, "type": "array" }, "trait:graphUserGroupTargets:targets": { "description": "", "in": "query", "items": { "x-ms-enum": { "name": "items3", "modelAsString": true, "values": [ { "name": "active_directory", "value": "active_directory" }, { "name": "application", "value": "application" }, { "name": "command", "value": "command" }, { "name": "g_suite", "value": "g_suite" }, { "name": "ldap_server", "value": "ldap_server" }, { "name": "office_365", "value": "office_365" }, { "name": "policy", "value": "policy" }, { "name": "radius_server", "value": "radius_server" }, { "name": "systems", "value": "system" }, { "name": "systems_group", "value": "system_group" } ] }, "enum": [ "active_directory", "application", "command", "g_suite", "ldap_server", "office_365", "policy", "radius_server", "system", "system_group" ], "type": "string" }, "name": "targets", "required": true, "type": "array" }, "trait:graphUserTargets:targets": { "description": "", "in": "query", "items": { "x-ms-enum": { "name": "items3", "modelAsString": true, "values": [ { "name": "active_directory", "value": "active_directory" }, { "name": "application", "value": "application" }, { "name": "command", "value": "command" }, { "name": "g_suite", "value": "g_suite" }, { "name": "ldap_server", "value": "ldap_server" }, { "name": "office_365", "value": "office_365" }, { "name": "policy", "value": "policy" }, { "name": "radius_server", "value": "radius_server" }, { "name": "systems", "value": "system" }, { "name": "systems_group", "value": "system_group" } ] }, "enum": [ "active_directory", "application", "command", "g_suite", "ldap_server", "office_365", "policy", "radius_server", "system", "system_group" ], "type": "string" }, "name": "targets", "required": true, "type": "array" }, "trait:limit:limit": { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, "trait:limitMax100:limit": { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 100, "name": "limit", "type": "integer" }, "trait:listCount:x-total-count": { "required": false, "in": "header", "name": "x-total-count", "type": "integer" }, "trait:listCount:x-unfiltered-total-count": { "required": false, "description": "If provided in the request with any non-empty value, this header will be returned on the response populated with the total count of objects without filters taken into account", "in": "header", "name": "x-unfiltered-total-count", "type": "integer" }, "trait:multiTenantRequestHeaders:x-org-id": { "description": "", "required": false, "default": "", "in": "header", "name": "x-org-id", "type": "string" }, "trait:requestHeaders:Accept": { "default": "application/x-pem-file", "in": "header", "name": "Accept", "required": true, "type": "string" }, "trait:requestHeaders:Content-Type": { "default": "application/json", "in": "header", "name": "Content-Type", "required": true, "type": "string" }, "trait:skip:skip": { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, "trait:sort:sort": { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, "trait:systemContextAuth:Authorization": { "required": false, "description": "Authorization header for the System Context API", "in": "header", "name": "Authorization", "type": "string" }, "trait:systemContextAuth:Date": { "required": false, "description": "Current date header for the System Context API", "in": "header", "name": "Date", "type": "string" }, "trait:systemInsightsFilter:filter": { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, "trait:systemInsightsLimit:limit": { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } }, "paths": { "/activedirectories": { "get": { "description": "This endpoint allows you to list all your Active Directory Instances.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/activedirectories/ \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n ```", "operationId": "List-ActiveDirectory", "parameters": [ { "required": false, "default": [], "description": "The comma separated fields included in the returned records.\nIf omitted, the default list of fields will be returned.\n", "in": "query", "items": { "type": "string" }, "name": "fields", "type": "array" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/active-directory-output" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List Active Directories" } }, "/activedirectories/{activedirectory_id}/associations": { "get": { "description": "This endpoint returns the direct associations of this Active Directory instance.\n\nA direct association can be a non-homogeneous relationship between 2 different objects, for example Active Directory and Users.\n\n\n#### Sample Request\n```\ncurl -X GET 'https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/associations?targets=user \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-ActiveDirectoryAssociation", "parameters": [ { "description": "", "x-ms-enum": { "name": "targets", "modelAsString": true, "values": [ { "name": "active_directory", "value": "active_directory" }, { "name": "application", "value": "application" }, { "name": "command", "value": "command" }, { "name": "g_suite", "value": "g_suite" }, { "name": "ldap_server", "value": "ldap_server" }, { "name": "office_365", "value": "office_365" }, { "name": "policy", "value": "policy" }, { "name": "radius_server", "value": "radius_server" }, { "name": "systems", "value": "system" }, { "name": "systems_group", "value": "system_group" }, { "name": "user", "value": "user" }, { "name": "user_group", "value": "user_group" } ] }, "enum": [ "active_directory", "application", "command", "g_suite", "ldap_server", "office_365", "policy", "radius_server", "system", "system_group", "user", "user_group" ], "in": "query", "name": "targets", "required": true, "type": "string" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/GraphConnection" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the associations of an Active Directory instance" }, "parameters": [ { "in": "path", "name": "activedirectory_id", "required": true, "type": "string" } ] }, "/activedirectories/{activedirectory_id}/usergroups": { "get": { "description": "This endpoint will return all Users Groups bound to an Active Directory instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the group's type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this Active Directory instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Active Directory instance.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID}/usergroups \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-ActiveDirectoryTraverseUserGroup", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the User Groups bound to an Active Directory instance" }, "parameters": [ { "description": "ObjectID of the Active Directory instance.", "in": "path", "name": "activedirectory_id", "required": true, "type": "string" } ] }, "/activedirectories/{id}": { "get": { "parameters": [], "description": "This endpoint returns a specific Active Directory.\n\n#### Sample Request\n\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/activedirectories/{ActiveDirectory_ID} \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n ```", "operationId": "Get-ActiveDirectory", "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/active-directory-output" } } }, "security": [ { "x-api-key": [] } ], "summary": "Get an Active Directory" }, "parameters": [ { "description": "ObjectID of this Active Directory instance.", "in": "path", "name": "id", "required": true, "type": "string" } ] }, "/applemdms": { "get": { "parameters": [], "description": "Get a list of all Apple MDM configurations. An empty topic indicates that a signed certificate from Apple has not been provided to the PUT endpoint yet.\n\nNote: currently only one MDM configuration per organization is supported.\n\n#### Sample Request\n```\ncurl https://console.jumpcloud.com/api/v2/applemdms \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "List-AppleMDM", "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/AppleMDM" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List Apple MDMs" } }, "/applemdms/{apple_mdm_id}/csr": { "get": { "parameters": [], "description": "Retrieves an Apple MDM signed CSR Plist for an organization. The user must supply the returned plist to Apple for signing, and then provide the certificate provided by Apple back into the PUT API.\n\n#### Sample Request\n```\n curl -X GET https://console.jumpcloud.com/api/v2/applemdms/{APPLE_MDM_ID}/csr \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-AppleMDMCsr", "produces": [ "application/octet-stream" ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/apple-mdm-signed-csr-plist" } }, "400": { "$ref": "#/responses/trait:standardErrors:400" }, "401": { "$ref": "#/responses/trait:standardErrors:401" }, "403": { "$ref": "#/responses/trait:standardErrors:403" }, "404": { "$ref": "#/responses/trait:standardErrors:404" }, "409": { "$ref": "#/responses/trait:standardErrors:409" }, "500": { "$ref": "#/responses/trait:standardErrors:500" } }, "security": [ { "x-api-key": [] } ], "summary": "Get Apple MDM CSR Plist" }, "parameters": [ { "in": "path", "name": "apple_mdm_id", "required": true, "type": "string" } ] }, "/applemdms/{apple_mdm_id}/depkey": { "get": { "parameters": [], "description": "Retrieves an Apple MDM DEP Public Key.", "operationId": "Get-AppleMDMDepKey", "produces": [ "application/x-pem-file" ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/apple-mdm-public-key-cert" } }, "400": { "$ref": "#/responses/trait:standardErrors:400" }, "401": { "$ref": "#/responses/trait:standardErrors:401" }, "403": { "$ref": "#/responses/trait:standardErrors:403" }, "404": { "$ref": "#/responses/trait:standardErrors:404" }, "409": { "$ref": "#/responses/trait:standardErrors:409" }, "500": { "$ref": "#/responses/trait:standardErrors:500" } }, "security": [ { "x-api-key": [] } ], "summary": "Get Apple MDM DEP Public Key" }, "parameters": [ { "in": "path", "name": "apple_mdm_id", "required": true, "type": "string" } ] }, "/applemdms/{apple_mdm_id}/devices": { "get": { "description": "Lists all Apple MDM devices.\n\nThe filter and sort queries will allow the following fields:\n`createdAt`\n`depRegistered`\n`enrolled`\n`id`\n`osVersion`\n`serialNumber`\n`udid`\n\n#### Sample Request\n```\n curl -X GET https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices \\\n -H 'accept: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{}'\n```", "operationId": "List-AppleMDMDevice", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "$ref": "#/parameters/trait:listCount:x-total-count" }, { "$ref": "#/parameters/trait:listCount:x-unfiltered-total-count" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/apple-mdm-device" }, "type": "array" } }, "400": { "$ref": "#/responses/trait:standardErrors:400" }, "401": { "$ref": "#/responses/trait:standardErrors:401" }, "403": { "$ref": "#/responses/trait:standardErrors:403" }, "404": { "$ref": "#/responses/trait:standardErrors:404" }, "409": { "$ref": "#/responses/trait:standardErrors:409" }, "500": { "$ref": "#/responses/trait:standardErrors:500" } }, "security": [ { "x-api-key": [] } ], "summary": "List AppleMDM Devices" }, "parameters": [ { "in": "path", "name": "apple_mdm_id", "required": true, "type": "string" } ] }, "/applemdms/{apple_mdm_id}/devices/{device_id}/erase": { "parameters": [ { "in": "path", "name": "apple_mdm_id", "required": true, "type": "string" }, { "in": "path", "name": "device_id", "required": true, "type": "string" } ], "post": { "description": "Erases a DEP-enrolled device.\n\n#### Sample Request\n```\n curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/erase \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{}'\n```", "operationId": "Clear-AppleMDMDevice", "parameters": [ { "in": "body", "name": "body", "schema": { "properties": { "pin": { "description": "6-digit PIN required to erase the device", "example": "123456", "pattern": "^[0-9]{6}$", "type": "string" } }, "required": [ "pin" ], "type": "object" } } ], "responses": { "204": { "description": "" }, "400": { "description": "", "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } }, "401": { "$ref": "#/responses/trait:standardErrors:401" }, "403": { "$ref": "#/responses/trait:standardErrors:403" }, "404": { "$ref": "#/responses/trait:standardErrors:404" }, "409": { "$ref": "#/responses/trait:standardErrors:409" }, "500": { "description": "", "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } } }, "security": [ { "x-api-key": [] } ], "summary": "Erase Device" } }, "/applemdms/{apple_mdm_id}/devices/{device_id}/lock": { "parameters": [ { "in": "path", "name": "apple_mdm_id", "required": true, "type": "string" }, { "in": "path", "name": "device_id", "required": true, "type": "string" } ], "post": { "description": "Locks a DEP-enrolled device.\n\n#### Sample Request\n```\n curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/lock \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{}'\n```", "operationId": "Lock-AppleMDMDevice", "parameters": [ { "in": "body", "name": "body", "schema": { "properties": { "pin": { "description": "6-digit PIN required to erase the device", "example": "123456", "pattern": "^[0-9]{6}$", "type": "string" } }, "required": [ "pin" ], "type": "object" } } ], "responses": { "204": { "description": "" }, "400": { "description": "", "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } }, "401": { "$ref": "#/responses/trait:standardErrors:401" }, "403": { "$ref": "#/responses/trait:standardErrors:403" }, "404": { "$ref": "#/responses/trait:standardErrors:404" }, "409": { "$ref": "#/responses/trait:standardErrors:409" }, "500": { "description": "", "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } } }, "security": [ { "x-api-key": [] } ], "summary": "Lock Device" } }, "/applemdms/{apple_mdm_id}/devices/{device_id}/restart": { "parameters": [ { "in": "path", "name": "apple_mdm_id", "required": true, "type": "string" }, { "in": "path", "name": "device_id", "required": true, "type": "string" } ], "post": { "parameters": [], "description": "Restarts a DEP-enrolled device.\n\n#### Sample Request\n```\n curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/restart \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{}'\n```", "operationId": "Restart-AppleMDMDevice", "responses": { "204": { "description": "" }, "400": { "description": "", "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } }, "401": { "$ref": "#/responses/trait:standardErrors:401" }, "403": { "$ref": "#/responses/trait:standardErrors:403" }, "404": { "$ref": "#/responses/trait:standardErrors:404" }, "409": { "$ref": "#/responses/trait:standardErrors:409" }, "500": { "description": "", "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } } }, "security": [ { "x-api-key": [] } ], "summary": "Restart Device" } }, "/applemdms/{apple_mdm_id}/devices/{device_id}/shutdown": { "parameters": [ { "in": "path", "name": "apple_mdm_id", "required": true, "type": "string" }, { "in": "path", "name": "device_id", "required": true, "type": "string" } ], "post": { "parameters": [], "description": "Shuts down a DEP-enrolled device.\n\n#### Sample Request\n```\n curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/devices/{device_id}/shutdown \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{}'\n```", "operationId": "Stop-AppleMDMDevice", "responses": { "204": { "description": "" }, "400": { "description": "", "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } }, "401": { "$ref": "#/responses/trait:standardErrors:401" }, "403": { "$ref": "#/responses/trait:standardErrors:403" }, "404": { "$ref": "#/responses/trait:standardErrors:404" }, "409": { "$ref": "#/responses/trait:standardErrors:409" }, "500": { "description": "", "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } } }, "security": [ { "x-api-key": [] } ], "summary": "Shut Down Device" } }, "/applemdms/{apple_mdm_id}/enrollmentprofiles": { "get": { "parameters": [], "description": "Get a list of enrollment profiles for an apple mdm.\n\nNote: currently only one enrollment profile is supported.\n\n#### Sample Request\n```\n curl https://console.jumpcloud.com/api/v2/applemdms/{APPLE_MDM_ID}/enrollmentprofiles \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "List-AppleMDMEnrollmentProfile", "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/AppleMDM" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List Apple MDM Enrollment Profiles" }, "parameters": [ { "in": "path", "name": "apple_mdm_id", "required": true, "type": "string" } ] }, "/applemdms/{apple_mdm_id}/enrollmentprofiles/{id}": { "get": { "parameters": [], "description": "Get an enrollment profile\n\nCurrently only requesting the mobileconfig is supported.\n\n#### Sample Request\n\n```\ncurl https://console.jumpcloud.com/api/v2/applemdms/{APPLE_MDM_ID}/enrollmentprofiles/{ID} \\\n -H 'accept: application/x-apple-aspen-config' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-AppleMDMEnrollmentProfile", "produces": [ "application/x-apple-aspen-config" ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/mobileconfig" } } }, "security": [ { "x-api-key": [] } ], "summary": "Get an Apple MDM Enrollment Profile" }, "parameters": [ { "in": "path", "name": "apple_mdm_id", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ] }, "/applemdms/{apple_mdm_id}/refreshdepdevices": { "parameters": [ { "in": "path", "name": "apple_mdm_id", "required": true, "type": "string" } ], "post": { "parameters": [], "description": "Refreshes the list of devices that a JumpCloud admin has added to their virtual MDM in Apple Business Manager - ABM so that they can be DEP enrolled with JumpCloud.\n\n#### Sample Request\n```\n curl -X POST https://console.jumpcloud.com/api/v2/applemdms/{apple_mdm_id}/refreshdepdevices \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{}'\n```", "operationId": "Sync-AppleMDMDevice", "responses": { "204": { "description": "" }, "400": { "description": "", "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } }, "401": { "$ref": "#/responses/trait:standardErrors:401" }, "403": { "$ref": "#/responses/trait:standardErrors:403" }, "404": { "$ref": "#/responses/trait:standardErrors:404" }, "409": { "$ref": "#/responses/trait:standardErrors:409" }, "500": { "description": "", "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } } }, "security": [ { "x-api-key": [] } ], "summary": "Refresh DEP Devices" } }, "/applemdms/{id}": { "delete": { "parameters": [], "description": "Removes an Apple MDM configuration.\n\nWarning: This is a destructive operation and will remove your Apple Push Certificates. We will no longer be able to manage your devices and the only recovery option is to re-register all devices into MDM.\n\n#### Sample Request\n```\ncurl -X DELETE https://console.jumpcloud.com/api/v2/applemdms/{id} \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Delete-AppleMDM", "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AppleMDM" } }, "400": { "$ref": "#/responses/trait:standardErrors:400" }, "401": { "$ref": "#/responses/trait:standardErrors:401" }, "403": { "$ref": "#/responses/trait:standardErrors:403" }, "404": { "$ref": "#/responses/trait:standardErrors:404" }, "409": { "$ref": "#/responses/trait:standardErrors:409" }, "500": { "$ref": "#/responses/trait:standardErrors:500" } }, "security": [ { "x-api-key": [] } ], "summary": "Delete an Apple MDM" }, "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" } ], "put": { "description": "Updates an Apple MDM configuration. This endpoint is used to supply JumpCloud with a signed certificate from Apple in order to finalize the setup and allow JumpCloud to manage your devices. It may also be used to update the DEP Settings.\n\n#### Sample Request\n```\n curl -X PUT https://console.jumpcloud.com/api/v2/applemdms/{ID} \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"name\": \"MDM name\",\n \"appleSignedCert\": \"{CERTIFICATE}\",\n \"encryptedDepServerToken\": \"{SERVER_TOKEN}\",\n \"dep\": {\n \"welcomeScreen\": {\n \"title\": \"Welcome\",\n \"paragraph\": \"In just a few steps, you will be working securely from your Mac.\",\n \"button\": \"continue\",\n },\n },\n }'\n```", "operationId": "Update-AppleMDM", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/apple-mdm-patch-input" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AppleMDM" } }, "400": { "$ref": "#/responses/trait:standardErrors:400" }, "401": { "$ref": "#/responses/trait:standardErrors:401" }, "403": { "$ref": "#/responses/trait:standardErrors:403" }, "404": { "$ref": "#/responses/trait:standardErrors:404" }, "409": { "$ref": "#/responses/trait:standardErrors:409" }, "500": { "$ref": "#/responses/trait:standardErrors:500" } }, "security": [ { "x-api-key": [] } ], "summary": "Update an Apple MDM" } }, "/applications/{application_id}/associations": { "get": { "description": "This endpoint will return the _direct_ associations of an Application. A direct association can be a non-homogeneous relationship between 2 different objects, for example Applications and User Groups.\n\n\n#### Sample Request\n```\ncurl -X GET 'https://console.jumpcloud.com/api/v2/applications/{Application_ID}/associations?targets=user_group \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-ApplicationAssociation", "parameters": [ { "description": "", "x-ms-enum": { "name": "targets", "modelAsString": true, "values": [ { "name": "active_directory", "value": "active_directory" }, { "name": "application", "value": "application" }, { "name": "command", "value": "command" }, { "name": "g_suite", "value": "g_suite" }, { "name": "ldap_server", "value": "ldap_server" }, { "name": "office_365", "value": "office_365" }, { "name": "policy", "value": "policy" }, { "name": "radius_server", "value": "radius_server" }, { "name": "systems", "value": "system" }, { "name": "systems_group", "value": "system_group" }, { "name": "user", "value": "user" }, { "name": "user_group", "value": "user_group" } ] }, "enum": [ "active_directory", "application", "command", "g_suite", "ldap_server", "office_365", "policy", "radius_server", "system", "system_group", "user", "user_group" ], "in": "query", "name": "targets", "required": true, "type": "string" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphConnection" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the associations of an Application" }, "parameters": [ { "description": "ObjectID of the Application.", "in": "path", "name": "application_id", "required": true, "type": "string" } ], "post": { "description": "This endpoint allows you to manage the _direct_ associations of an Application. A direct association can be a non-homogeneous relationship between 2 different objects, for example Application and User Groups.\n\n#### Sample Request\n```\ncurl -X POST 'https://console.jumpcloud.com/api/v2/applications/{Application_ID}/associations' \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"op\": \"add\",\n \"type\": \"user_group\",\n \"id\": \"{Group_ID}\"\n}'\n```", "operationId": "Set-ApplicationAssociation", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/GraphManagementReq" } } ], "responses": { "204": { "description": "OK" } }, "security": [ { "x-api-key": [] } ], "summary": "Manage the associations of an Application" } }, "/applications/{application_id}/usergroups": { "get": { "description": "This endpoint will return all Users Groups bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the group's type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this Application to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Application.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/usergroups \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-ApplicationTraverseUserGroup", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the User Groups bound to an Application" }, "parameters": [ { "description": "ObjectID of the Application.", "in": "path", "name": "application_id", "required": true, "type": "string" } ] }, "/applications/{application_id}/users": { "get": { "description": "This endpoint will return all Users bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-ApplicationTraverseUser", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the Users bound to an Application" }, "parameters": [ { "description": "ObjectID of the Application.", "in": "path", "name": "application_id", "required": true, "type": "string" } ] }, "/bulk/users": { "patch": { "description": "The endpoint allows you to create a bulk job to asynchronously update users. See [Update a System User](https://docs.jumpcloud.com/1.0/systemusers/update-a-system-user) for full list of attributes.\n\n#### Sample Request \n```\ncurl -X PATCH https://console.jumpcloud.com/api/v2/bulk/users \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '[\n\t{\n\t \"id\":\"5be9fb4ddb01290001e85109\",\n\t\t\"firstname\":\"{UPDATED_FIRSTNAME}\",\n\t\t\"department\":\"{UPDATED_DEPARTMENT}\",\n\t\t\"attributes\":[\n\t\t\t{\"name\":\"Custom\",\"value\":\"{ATTRIBUTE_VALUE}\"}\n\t\t]\n\t},\n\t{\n\t \"id\":\"5be9fb4ddb01290001e85109\",\n\t\t\"firstname\":\"{UPDATED_FIRSTNAME}\",\n\t\t\"costCenter\":\"{UPDATED_COST_CENTER}\",\n\t\t\"phoneNumbers\":[\n\t\t\t{\"type\":\"home\",\"number\":\"{HOME_PHONE_NUMBER}\"},\n\t\t\t{\"type\":\"work\",\"number\":\"{WORK_PHONE_NUMBER}\"}\n\t\t]\n\t}\n]\n```", "operationId": "Patch-BulkUsers", "parameters": [ { "in": "body", "name": "body", "schema": { "items": { "$ref": "#/definitions/bulk-user-update" }, "type": "array" } } ], "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/job-id" } } }, "security": [ { "x-api-key": [] } ], "summary": "Bulk Users Update" }, "post": { "description": "The endpoint allows you to create a bulk job to asynchronously create users. See [Create a System User](https://docs.jumpcloud.com/1.0/systemusers/create-a-system-user) for full list of attributes.\n\n#### Sample Request \n```\ncurl -X POST https://console.jumpcloud.com/api/v2/bulk/users \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '[\n\t{\n\t\t\"email\":\"{email}\",\n\t\t\"firstname\":\"{firstname}\",\n\t\t\"lastname\":\"{firstname}\",\n\t\t\"username\":\"{username}\",\n\t\t\"attributes\":[\n\t\t\t{\"name\":\"EmployeeID\",\"value\":\"0000\"},\n\t\t\t{\"name\":\"Custom\",\"value\":\"attribute\"}\n\t\t]\n\t}\n]\n```", "operationId": "Create-BulkUsers", "parameters": [ { "in": "body", "name": "body", "schema": { "items": { "$ref": "#/definitions/bulk-user-create" }, "type": "array" } } ], "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/job-id" } } }, "security": [ { "x-api-key": [] } ], "summary": "Bulk Users Create" } }, "/bulk/users/{job_id}/results": { "get": { "description": "This endpoint will return the results of particular user import or update job request.\n\n#### Sample Request\n```\ncurl -X GET \\\n https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n ```", "operationId": "Get-BulkUsersResult", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/job-workresult" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List Bulk Users Results" }, "parameters": [ { "in": "path", "name": "job_id", "required": true, "type": "string" } ] }, "/commands/{command_id}/associations": { "get": { "description": "This endpoint will return the _direct_ associations of this Command.\n\nA direct association can be a non-homogeneous relationship between 2 different objects, for example Commands and User Groups.\n\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/associations?targets=system_group \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-CommandAssociation", "parameters": [ { "description": "", "x-ms-enum": { "name": "targets", "modelAsString": true, "values": [ { "name": "active_directory", "value": "active_directory" }, { "name": "application", "value": "application" }, { "name": "command", "value": "command" }, { "name": "g_suite", "value": "g_suite" }, { "name": "ldap_server", "value": "ldap_server" }, { "name": "office_365", "value": "office_365" }, { "name": "policy", "value": "policy" }, { "name": "radius_server", "value": "radius_server" }, { "name": "systems", "value": "system" }, { "name": "systems_group", "value": "system_group" }, { "name": "user", "value": "user" }, { "name": "user_group", "value": "user_group" } ] }, "enum": [ "active_directory", "application", "command", "g_suite", "ldap_server", "office_365", "policy", "radius_server", "system", "system_group", "user", "user_group" ], "in": "query", "name": "targets", "required": true, "type": "string" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphConnection" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the associations of a Command" }, "parameters": [ { "description": "ObjectID of the Command.", "in": "path", "name": "command_id", "required": true, "type": "string" } ], "post": { "description": "This endpoint will allow you to manage the _direct_ associations of this Command.\n\nA direct association can be a non-homogeneous relationship between 2 different objects, for example Commands and User Groups.\n\n\n#### Sample Request\n```\n curl -X POST https://console.jumpcloud.com/api/v2/commands/{Command_ID}/associations \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"op\": \"add\",\n \"type\": \"system_group\",\n \"id\": \"Group_ID\"\n}'\n```", "operationId": "Set-CommandAssociation", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/GraphManagementReq" } } ], "responses": { "204": { "description": "OK" } }, "security": [ { "x-api-key": [] } ], "summary": "Manage the associations of a Command" } }, "/commands/{command_id}/systemgroups": { "get": { "description": "This endpoint will return all System Groups bound to a Command, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the group's type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this Command to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Command.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/systemgroups \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-CommandTraverseSystemGroup", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the System Groups bound to a Command" }, "parameters": [ { "description": "ObjectID of the Command.", "in": "path", "name": "command_id", "required": true, "type": "string" } ] }, "/commands/{command_id}/systems": { "get": { "description": "This endpoint will return all Systems bound to a Command, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this Command to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Command.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/commands/{Command_ID}/systems \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-CommandTraverseSystem", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the Systems bound to a Command" }, "parameters": [ { "description": "ObjectID of the Command.", "in": "path", "name": "command_id", "required": true, "type": "string" } ] }, "/directories": { "get": { "description": "This endpoint returns all active directories (LDAP, O365 Suite, G-Suite).\n\n#### Sample Request\n```\n curl -X GET https://console.jumpcloud.com/api/v2/directories \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "List-Directory", "parameters": [ { "required": false, "default": [], "description": "The comma separated fields included in the returned records.\nIf omitted, the default list of fields will be returned.\n", "in": "query", "items": { "type": "string" }, "name": "fields", "type": "array" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/Directory" }, "type": "array" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "x-api-key": [] } ], "summary": "List All Directories" } }, "/duo/accounts": { "get": { "parameters": [], "description": "This endpoint returns all the Duo accounts for your organization. Note: There can currently only be one Duo account for your organization.\n\n#### Sample Request\n```\ncurl https://console.jumpcloud.com/api/v2/duo/accounts \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "List-DuoAccount", "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/DuoAccount" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List Duo Accounts" }, "post": { "parameters": [], "description": "Registers a Duo account for an organization. Only one Duo account will be allowed,\nin case an organization has a Duo account already a 409 (Conflict) code will be returned.\n\n#### Sample Request\n```\n curl -X POST https://console.jumpcloud.com/api/v2/duo/accounts \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{}'\n```", "operationId": "Create-DuoAccount", "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/DuoAccount" } }, "400": { "$ref": "#/responses/trait:standardErrors:400" }, "401": { "$ref": "#/responses/trait:standardErrors:401" }, "403": { "$ref": "#/responses/trait:standardErrors:403" }, "404": { "$ref": "#/responses/trait:standardErrors:404" }, "409": { "$ref": "#/responses/trait:standardErrors:409" }, "500": { "$ref": "#/responses/trait:standardErrors:500" } }, "security": [ { "x-api-key": [] } ], "summary": "Create Duo Account" } }, "/duo/accounts/{account_id}/applications": { "get": { "parameters": [], "description": "This endpoint returns all the Duo applications for the specified Duo account. Note: There can currently only be one Duo application for your organization.\n\n#### Sample Request\n```\n curl https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "List-DuoApplication", "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/DuoApplication" }, "type": "array" } }, "400": { "$ref": "#/responses/trait:standardErrors:400" }, "401": { "$ref": "#/responses/trait:standardErrors:401" }, "403": { "$ref": "#/responses/trait:standardErrors:403" }, "404": { "$ref": "#/responses/trait:standardErrors:404" }, "409": { "$ref": "#/responses/trait:standardErrors:409" }, "500": { "$ref": "#/responses/trait:standardErrors:500" } }, "security": [ { "x-api-key": [] } ], "summary": "List Duo Applications" }, "parameters": [ { "in": "path", "name": "account_id", "required": true, "type": "string" } ], "post": { "description": "Creates a Duo application for your organization and the specified account.\n\n#### Sample Request\n```\n curl -X POST https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"name\": \"Application Name\",\n \"apiHost\": \"api-1234.duosecurity.com\",\n \"integrationKey\": \"1234\",\n \"secretKey\": \"5678\"\n }'\n```", "operationId": "Create-DuoApplication", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/DuoApplicationReq" } } ], "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/DuoApplication" } }, "400": { "$ref": "#/responses/trait:standardErrors:400" }, "401": { "$ref": "#/responses/trait:standardErrors:401" }, "403": { "$ref": "#/responses/trait:standardErrors:403" }, "404": { "$ref": "#/responses/trait:standardErrors:404" }, "409": { "$ref": "#/responses/trait:standardErrors:409" }, "500": { "$ref": "#/responses/trait:standardErrors:500" } }, "security": [ { "x-api-key": [] } ], "summary": "Create Duo Application" } }, "/duo/accounts/{account_id}/applications/{application_id}": { "delete": { "parameters": [], "description": "Deletes the specified Duo application, an error will be returned if the application is used in a protected resource.\n\n#### Sample Request\n```\n curl -X DELETE https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}''\n```", "operationId": "Delete-DuoApplication", "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/DuoApplication" } }, "400": { "$ref": "#/responses/trait:standardErrors:400" }, "401": { "$ref": "#/responses/trait:standardErrors:401" }, "403": { "$ref": "#/responses/trait:standardErrors:403" }, "404": { "$ref": "#/responses/trait:standardErrors:404" }, "409": { "$ref": "#/responses/trait:standardErrors:409" }, "500": { "$ref": "#/responses/trait:standardErrors:500" } }, "security": [ { "x-api-key": [] } ], "summary": "Delete a Duo Application" }, "get": { "parameters": [], "description": "This endpoint returns a specific Duo application that is associated with the specified Duo account.\n\n#### Sample Request\n```\n curl https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-DuoApplication", "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/DuoApplication" } }, "400": { "$ref": "#/responses/trait:standardErrors:400" }, "401": { "$ref": "#/responses/trait:standardErrors:401" }, "403": { "$ref": "#/responses/trait:standardErrors:403" }, "404": { "$ref": "#/responses/trait:standardErrors:404" }, "409": { "$ref": "#/responses/trait:standardErrors:409" }, "500": { "$ref": "#/responses/trait:standardErrors:500" } }, "security": [ { "x-api-key": [] } ], "summary": "Get a Duo application" }, "parameters": [ { "in": "path", "name": "account_id", "required": true, "type": "string" }, { "in": "path", "name": "application_id", "required": true, "type": "string" } ], "put": { "description": "Updates the specified Duo application.\n\n#### Sample Request\n```\n curl -X PUT https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"name\": \"Application Name\",\n \"apiHost\": \"api-1234.duosecurity.com\",\n \"integrationKey\": \"1234\",\n \"secretKey\": \"5678\"\n }'\n```", "operationId": "Put-DuoApplication", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/DuoApplicationUpdateReq" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/DuoApplication" } }, "400": { "$ref": "#/responses/trait:standardErrors:400" }, "401": { "$ref": "#/responses/trait:standardErrors:401" }, "403": { "$ref": "#/responses/trait:standardErrors:403" }, "404": { "$ref": "#/responses/trait:standardErrors:404" }, "409": { "$ref": "#/responses/trait:standardErrors:409" }, "500": { "$ref": "#/responses/trait:standardErrors:500" } }, "security": [ { "x-api-key": [] } ], "summary": "Update Duo Application" } }, "/duo/accounts/{id}": { "delete": { "parameters": [], "description": "Removes the specified Duo account, an error will be returned if the account has some Duo application used in a protected resource.\n\n#### Sample Request\n```\ncurl -X DELETE https://console.jumpcloud.com/api/v2/duo/accounts/{id} \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Delete-DuoAccount", "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/DuoAccount" } }, "400": { "$ref": "#/responses/trait:standardErrors:400" }, "401": { "$ref": "#/responses/trait:standardErrors:401" }, "403": { "$ref": "#/responses/trait:standardErrors:403" }, "404": { "$ref": "#/responses/trait:standardErrors:404" }, "409": { "$ref": "#/responses/trait:standardErrors:409" }, "500": { "$ref": "#/responses/trait:standardErrors:500" } }, "security": [ { "x-api-key": [] } ], "summary": "Delete a Duo Account" }, "get": { "parameters": [], "description": "This endpoint returns a specific Duo account.\n\n#### Sample Request\n```\ncurl https://console.jumpcloud.com/api/v2/duo/accounts/{id} \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-DuoAccount", "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/DuoAccount" } } }, "security": [ { "x-api-key": [] } ], "summary": "Get a Duo Acount" }, "parameters": [ { "description": "ObjectID of the Duo Account", "in": "path", "name": "id", "required": true, "type": "string" } ] }, "/groups": { "get": { "description": "This endpoint returns all Groups that exist in your organization.\n\n#### Available filter fields:\n - `name`\n - `disabled`\n - `type`\n\n#### Sample Request\n\n```\n curl -X GET \\\n https://console.jumpcloud.com/api/v2/groups \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "List-Group", "parameters": [ { "required": false, "default": [], "description": "The comma separated fields included in the returned records.\nIf omitted, the default list of fields will be returned.\n", "in": "query", "items": { "type": "string" }, "name": "fields", "type": "array" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "$ref": "#/parameters/trait:listCount:x-total-count" }, { "$ref": "#/parameters/trait:listCount:x-unfiltered-total-count" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/Group" }, "type": "array" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "x-api-key": [] } ], "summary": "List All Groups" } }, "/gsuites/{gsuite_id}/associations": { "get": { "description": "This endpoint returns the _direct_ associations of this G Suite instance.\n\nA direct association can be a non-homogeneous relationship between 2 different objects, for example G Suite and Users.\n\n\n#### Sample Request\n```\ncurl -X GET 'https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/associations?targets=user_group \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-GSuiteAssociation", "parameters": [ { "description": "", "x-ms-enum": { "name": "targets", "modelAsString": true, "values": [ { "name": "active_directory", "value": "active_directory" }, { "name": "application", "value": "application" }, { "name": "command", "value": "command" }, { "name": "g_suite", "value": "g_suite" }, { "name": "ldap_server", "value": "ldap_server" }, { "name": "office_365", "value": "office_365" }, { "name": "policy", "value": "policy" }, { "name": "radius_server", "value": "radius_server" }, { "name": "systems", "value": "system" }, { "name": "systems_group", "value": "system_group" }, { "name": "user", "value": "user" }, { "name": "user_group", "value": "user_group" } ] }, "enum": [ "active_directory", "application", "command", "g_suite", "ldap_server", "office_365", "policy", "radius_server", "system", "system_group", "user", "user_group" ], "in": "query", "name": "targets", "required": true, "type": "string" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphConnection" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the associations of a G Suite instance" }, "parameters": [ { "description": "ObjectID of the G Suite instance.", "in": "path", "name": "gsuite_id", "required": true, "type": "string" } ], "post": { "description": "This endpoint returns the _direct_ associations of this G Suite instance.\n\nA direct association can be a non-homogeneous relationship between 2 different objects, for example G Suite and Users.\n\n\n#### Sample Request\n```\ncurl -X POST https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/associations \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"op\": \"add\",\n \"type\": \"user_group\",\n \"id\": \"{Group_ID}\"\n}'\n```", "operationId": "Set-GSuiteAssociation", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/GraphManagementReq" } } ], "responses": { "204": { "description": "OK" } }, "security": [ { "x-api-key": [] } ], "summary": "Manage the associations of a G Suite instance" } }, "/gsuites/{gsuite_id}/import/users": { "get": { "description": "Lists G Suite users available for import.", "operationId": "List-GSuiteUsersToImport", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "description": "Maximum number of results per page.", "in": "query", "name": "maxResults", "type": "integer" }, { "required": false, "description": "Token used to access next page of results.", "in": "query", "name": "pageToken", "type": "string" }, { "required": false, "description": "Google Directory API search parameter. See https://developers.google.com/admin-sdk/directory/v1/guides/search-users.", "in": "query", "name": "query", "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "properties": { "nextPageToken": { "type": "string" }, "users": { "items": { "properties": { "familyName": { "type": "string" }, "givenName": { "type": "string" }, "id": { "type": "string" }, "primaryEmail": { "type": "string" }, "thumbnailPhotoUrl": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "security": [ { "x-api-key": [] } ], "summary": "Get a list of users to import" }, "parameters": [ { "in": "path", "name": "gsuite_id", "required": true, "type": "string" } ] }, "/gsuites/{gsuite_id}/translationrules": { "get": { "description": "This endpoint returns all graph translation rules for a specific G Suite instance. These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes.\n\n##### Sample Request\n\n```\n curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n ```", "operationId": "List-GSuiteTranslationRule", "parameters": [ { "required": false, "default": [], "description": "The comma separated fields included in the returned records.\nIf omitted, the default list of fields will be returned.\n", "in": "query", "items": { "type": "string" }, "name": "fields", "type": "array" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" } ], "responses": { "200": { "description": "", "examples": { "application/json": [ { "field": "g_suite_work_addresses", "id": "object_id_1", "source_type": "user" } ] }, "schema": { "items": { "$ref": "#/definitions/GSuiteTranslationRule" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List all the G Suite Translation Rules" }, "parameters": [ { "in": "path", "name": "gsuite_id", "required": true, "type": "string" } ], "post": { "description": "This endpoint allows you to create a translation rule for a specific G Suite instance. These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes.\n\n##### Sample Request\n```\ncurl -X POST https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n {Translation Rule Parameters}\n}'\n\n```", "operationId": "Create-GSuiteTranslationRule", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/GSuiteTranslationRuleRequest" } } ], "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/GSuiteTranslationRule" } } }, "security": [ { "x-api-key": [] } ], "summary": "Create a new G Suite Translation Rule" } }, "/gsuites/{gsuite_id}/translationrules/{id}": { "delete": { "parameters": [], "description": "This endpoint allows you to delete a translation rule for a specific G Suite instance. These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes.\n\n#### Sample Request\n\n```\ncurl -X DELETE https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n ```", "operationId": "Delete-GSuiteTranslationRule", "responses": { "204": { "description": "" } }, "security": [ { "x-api-key": [] } ], "summary": "Deletes a G Suite translation rule" }, "get": { "parameters": [], "description": "This endpoint returns a specific translation rule for a specific G Suite instance. These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes.\n\n###### Sample Request\n\n```\n curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n ```", "operationId": "Get-GSuiteTranslationRule", "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/GSuiteTranslationRule" } } }, "security": [ { "x-api-key": [] } ], "summary": "Gets a specific G Suite translation rule" }, "parameters": [ { "in": "path", "name": "gsuite_id", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ] }, "/gsuites/{gsuite_id}/usergroups": { "get": { "description": "This endpoint will return all User Groups bound to an G Suite instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the group's type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this G Suite instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this G Suite instance.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\n curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{GSuite_ID}/usergroups \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-GSuiteTraverseUserGroup", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the User Groups bound to a G Suite instance" }, "parameters": [ { "description": "ObjectID of the G Suite instance.", "in": "path", "name": "gsuite_id", "required": true, "type": "string" } ] }, "/gsuites/{gsuite_id}/users": { "get": { "description": "This endpoint will return all Users bound to a G Suite instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this G Suite instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this G Suite instance.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\n curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{Gsuite_ID}/users \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-GSuiteTraverseUser", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the Users bound to a G Suite instance" }, "parameters": [ { "description": "ObjectID of the G Suite instance.", "in": "path", "name": "gsuite_id", "required": true, "type": "string" } ] }, "/gsuites/{id}": { "get": { "parameters": [], "description": "This endpoint returns a specific G Suite.\n\n##### Sample Request\n\n```\n curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-GSuite", "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/gsuite-output" } } }, "security": [ { "x-api-key": [] } ], "summary": "Get G Suite" }, "parameters": [ { "description": "Unique identifier of the GSuite.", "in": "path", "name": "id", "required": true, "type": "string" } ], "patch": { "description": "This endpoint allows updating some attributes of a G Suite.\n\n##### Sample Request\n\n```\ncurl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"userLockoutAction\": \"suspend\",\n \"userPasswordExpirationAction\": \"maintain\"\n }'\n```", "operationId": "Patch-GSuite", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/gsuite-patch-input" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/gsuite-output" } } }, "summary": "Update existing G Suite" } }, "/ldapservers": { "get": { "description": "This endpoint returns the object IDs of your LDAP servers.\n\n\n##### Sample Request\n\n```\n curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/ \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'", "operationId": "List-LdapServer", "parameters": [ { "required": false, "default": [], "description": "The comma separated fields included in the returned records.\nIf omitted, the default list of fields will be returned.\n", "in": "query", "items": { "type": "string" }, "name": "fields", "type": "array" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/ldap-server-output" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List LDAP Servers" } }, "/ldapservers/{id}": { "get": { "parameters": [], "description": "This endpoint returns a specific LDAP server.\n\n##### Sample Request\n\n```\n curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID} \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-LdapServer", "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ldap-server-output" } } }, "security": [ { "x-api-key": [] } ], "summary": "Get LDAP Server" }, "parameters": [ { "description": "Unique identifier of the LDAP server.", "in": "path", "name": "id", "required": true, "type": "string" } ], "patch": { "description": "This endpoint allows updating some attributes of an LDAP server.\n\nSample Request\n\n```\ncurl -X PATCH https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID} \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"userLockoutAction\": \"remove\",\n \"userPasswordExpirationAction\": \"disable\"\n }'\n```", "operationId": "Patch-LdapServer", "parameters": [ { "in": "body", "name": "body", "schema": { "properties": { "id": { "type": "string" }, "userLockoutAction": { "$ref": "#/definitions/LdapServerAction" }, "userPasswordExpirationAction": { "$ref": "#/definitions/LdapServerAction" } }, "type": "object" } } ], "responses": { "200": { "description": "", "schema": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "userLockoutAction": { "$ref": "#/definitions/LdapServerAction" }, "userPasswordExpirationAction": { "$ref": "#/definitions/LdapServerAction" } }, "type": "object" } }, "400": { "description": "", "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } } }, "security": [ { "x-api-key": [] } ], "summary": "Update existing LDAP server" } }, "/ldapservers/{ldapserver_id}/associations": { "get": { "description": "This endpoint returns the _direct_ associations of this LDAP Server.\n\nA direct association can be a non-homogeneous relationship between 2 different objects, for example LDAP and Users.\n\n#### Sample Request\n\n```\n curl -X GET 'https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/associations?targets=user_group \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-LdapServerAssociation", "parameters": [ { "description": "", "x-ms-enum": { "name": "targets", "modelAsString": true, "values": [ { "name": "active_directory", "value": "active_directory" }, { "name": "application", "value": "application" }, { "name": "command", "value": "command" }, { "name": "g_suite", "value": "g_suite" }, { "name": "ldap_server", "value": "ldap_server" }, { "name": "office_365", "value": "office_365" }, { "name": "policy", "value": "policy" }, { "name": "radius_server", "value": "radius_server" }, { "name": "systems", "value": "system" }, { "name": "systems_group", "value": "system_group" }, { "name": "user", "value": "user" }, { "name": "user_group", "value": "user_group" } ] }, "enum": [ "active_directory", "application", "command", "g_suite", "ldap_server", "office_365", "policy", "radius_server", "system", "system_group", "user", "user_group" ], "in": "query", "name": "targets", "required": true, "type": "string" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphConnection" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the associations of a LDAP Server" }, "parameters": [ { "description": "ObjectID of the LDAP Server.", "in": "path", "name": "ldapserver_id", "required": true, "type": "string" } ], "post": { "description": "This endpoint allows you to manage the _direct_ associations of a LDAP Server.\n\nA direct association can be a non-homogeneous relationship between 2 different objects, for example LDAP and Users.\n\n#### Sample Request\n```\ncurl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/associations \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"op\": \"add\",\n \"type\": \"user\",\n \"id\": \"{User_ID}\"\n}'\n```", "operationId": "Set-LdapServerAssociation", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/GraphManagementReq" } } ], "responses": { "204": { "description": "OK" } }, "security": [ { "x-api-key": [] } ], "summary": "Manage the associations of a LDAP Server" } }, "/ldapservers/{ldapserver_id}/sambadomains": { "get": { "description": "This endpoint returns all samba domains for an LDAP server.\n\n##### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n ```", "operationId": "List-LdapServerSambaDomain", "parameters": [ { "required": false, "default": [], "description": "The comma separated fields included in the returned records.\nIf omitted, the default list of fields will be returned.\n", "in": "query", "items": { "type": "string" }, "name": "fields", "type": "array" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/samba-domain-output" }, "type": "array" } }, "default": { "description": "", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "x-api-key": [] } ], "summary": "List Samba Domains" }, "parameters": [ { "description": "Unique identifier of the LDAP server.", "in": "path", "name": "ldapserver_id", "required": true, "type": "string" } ], "post": { "description": "This endpoint allows you to create a samba domain for an LDAP server.\n\n##### Sample Request\n```\ncurl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n\"sid\":\"{SID_ID}\",\n\"name\":\"{WORKGROUP_NAME}\"\n}'\n```", "operationId": "Create-LdapServerSambaDomain", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/samba-domain-input" } } ], "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/samba-domain-output" } } }, "security": [ { "x-api-key": [] } ], "summary": "Create Samba Domain" } }, "/ldapservers/{ldapserver_id}/sambadomains/{id}": { "delete": { "parameters": [], "description": "This endpoint allows you to delete a samba domain from an LDAP server.\n\n##### Sample Request\n```\ncurl -X DELETE https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Delete-LdapServerSambaDomain", "responses": { "200": { "description": "", "schema": { "type": "string" } }, "204": { "description": "" } }, "security": [ { "x-api-key": [] } ], "summary": "Delete Samba Domain" }, "get": { "parameters": [], "description": "This endpoint returns a specific samba domain for an LDAP server.\n\n##### Sample Request\n```\ncurl -X GET \\\n https://console.jumpcloud.com/api/v2/ldapservers/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n ```", "operationId": "Get-LdapServerSambaDomain", "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/samba-domain-output" } } }, "security": [ { "x-api-key": [] } ], "summary": "Get Samba Domain" }, "parameters": [ { "description": "Unique identifier of the LDAP server.", "in": "path", "name": "ldapserver_id", "required": true, "type": "string" }, { "description": "Unique identifier of the samba domain.", "in": "path", "name": "id", "required": true, "type": "string" } ], "put": { "description": "This endpoint allows you to update the samba domain information for an LDAP server.\n\n##### Sample Request\n```\ncurl -X PUT https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n\"sid\":\"{SID_ID}\",\n\"name\":\"{WORKGROUP_NAME}\"\n}'\n\n```", "operationId": "Put-LdapServerSambaDomain", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/samba-domain-input" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/samba-domain-output" } } }, "security": [ { "x-api-key": [] } ], "summary": "Update Samba Domain" } }, "/ldapservers/{ldapserver_id}/usergroups": { "get": { "description": "This endpoint will return all Users Groups bound to a LDAP Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the group's type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this LDAP server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this LDAP server instance.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/usergroups \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-LdapServerTraverseUserGroup", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the User Groups bound to a LDAP Server" }, "parameters": [ { "description": "ObjectID of the LDAP Server.", "in": "path", "name": "ldapserver_id", "required": true, "type": "string" } ] }, "/ldapservers/{ldapserver_id}/users": { "get": { "description": "This endpoint will return all Users bound to an LDAP Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this LDAP server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this LDAP server instance.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-LdapServerTraverseUser", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the Users bound to a LDAP Server" }, "parameters": [ { "description": "ObjectID of the LDAP Server.", "in": "path", "name": "ldapserver_id", "required": true, "type": "string" } ] }, "/office365s/{office365_id}": { "get": { "parameters": [], "description": "This endpoint returns a specific Office 365 instance.\n\n#####\n\nSample Request\n\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n\n```", "operationId": "Get-Office365", "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/office365-output" } } }, "security": [ { "x-api-key": [] } ], "summary": "Get Office 365 instance" }, "parameters": [ { "description": "ObjectID of the Office 365 instance.", "in": "path", "name": "office365_id", "required": true, "type": "string" } ], "patch": { "description": "This endpoint allows updating some attributes of an Office 365 instance.\n\n#####\n\nSample Request\n\n```\ncurl -X PATCH https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID} \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"userLockoutAction\": \"maintain\",\n \"userPasswordExpirationAction\": \"suspend\"\n }'\n\n```", "operationId": "Patch-Office365", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/office365-patch-input" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/office365-output" } } }, "security": [ { "x-api-key": [] } ], "summary": "Update existing Office 365 instance." } }, "/office365s/{office365_id}/associations": { "get": { "description": "This endpoint returns _direct_ associations of an Office 365 instance.\n\n\nA direct association can be a non-homogeneous relationship between 2 different objects, for example Office 365 and Users.\n\n#### Sample Request\n```\ncurl -X GET 'https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/associations?targets=user_group' \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n\n```", "operationId": "Get-Office365Association", "parameters": [ { "description": "", "x-ms-enum": { "name": "targets", "modelAsString": true, "values": [ { "name": "active_directory", "value": "active_directory" }, { "name": "application", "value": "application" }, { "name": "command", "value": "command" }, { "name": "g_suite", "value": "g_suite" }, { "name": "ldap_server", "value": "ldap_server" }, { "name": "office_365", "value": "office_365" }, { "name": "policy", "value": "policy" }, { "name": "radius_server", "value": "radius_server" }, { "name": "systems", "value": "system" }, { "name": "systems_group", "value": "system_group" }, { "name": "user", "value": "user" }, { "name": "user_group", "value": "user_group" } ] }, "enum": [ "active_directory", "application", "command", "g_suite", "ldap_server", "office_365", "policy", "radius_server", "system", "system_group", "user", "user_group" ], "in": "query", "name": "targets", "required": true, "type": "string" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphConnection" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the associations of an Office 365 instance" }, "parameters": [ { "description": "ObjectID of the Office 365 instance.", "in": "path", "name": "office365_id", "required": true, "type": "string" } ], "post": { "description": "This endpoint allows you to manage the _direct_ associations of a Office 365 instance.\n\nA direct association can be a non-homogeneous relationship between 2 different objects, for example Office 365 and Users.\n\n#### Sample Request\n```\ncurl -X POST https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/associations \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"op\": \"add\",\n \"type\": \"user_group\",\n \"id\": \"{Group_ID}\"\n}'\n```", "operationId": "Set-Office365Association", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/GraphManagementReq" } } ], "responses": { "204": { "description": "OK" } }, "security": [ { "x-api-key": [] } ], "summary": "Manage the associations of an Office 365 instance" } }, "/office365s/{office365_id}/translationrules": { "get": { "description": "This endpoint returns all translation rules for a specific Office 365 instance. These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes.\n\n##### Sample Request\n\n```\n curl -X GET https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n ```", "operationId": "List-Office365TranslationRule", "parameters": [ { "required": false, "default": [], "description": "The comma separated fields included in the returned records.\nIf omitted, the default list of fields will be returned.\n", "in": "query", "items": { "type": "string" }, "name": "fields", "type": "array" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" } ], "responses": { "200": { "description": "", "examples": { "application/json": [ { "field": "office_365_state", "id": "object_id_1", "source_type": "user" } ] }, "schema": { "items": { "$ref": "#/definitions/Office365TranslationRule" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List all the Office 365 Translation Rules" }, "parameters": [ { "in": "path", "name": "office365_id", "required": true, "type": "string" } ], "post": { "description": "This endpoint allows you to create a translation rule for a specific Office 365 instance. These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes.\n\n##### Sample Request\n```\ncurl -X POST https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n {Translation Rule Parameters}\n}'\n\n```", "operationId": "Create-Office365TranslationRule", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/Office365TranslationRuleRequest" } } ], "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/Office365TranslationRule" } } }, "security": [ { "x-api-key": [] } ], "summary": "Create a new Office 365 Translation Rule" } }, "/office365s/{office365_id}/translationrules/{id}": { "delete": { "parameters": [], "description": "This endpoint allows you to delete a translation rule for a specific Office 365 instance. These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes.\n\n#### Sample Request\n\n```\ncurl -X DELETE https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n ```", "operationId": "Delete-Office365TranslationRule", "responses": { "204": { "description": "" } }, "security": [ { "x-api-key": [] } ], "summary": "Deletes a Office 365 translation rule" }, "get": { "parameters": [], "description": "This endpoint returns a specific translation rule for a specific Office 365 instance. These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes.\n\n###### Sample Request\n\n```\n curl -X GET https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n ```", "operationId": "Get-Office365TranslationRule", "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Office365TranslationRule" } } }, "security": [ { "x-api-key": [] } ], "summary": "Gets a specific Office 365 translation rule" }, "parameters": [ { "in": "path", "name": "office365_id", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ] }, "/office365s/{office365_id}/usergroups": { "get": { "description": "This endpoint will return all Users Groups bound to an Office 365 instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the group's type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this Office 365 instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this Office 365 instance.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\n curl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID/usergroups \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-Office365TraverseUserGroup", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the User Groups bound to an Office 365 instance" }, "parameters": [ { "description": "ObjectID of the Office 365 suite.", "in": "path", "name": "office365_id", "required": true, "type": "string" } ] }, "/office365s/{office365_id}/users": { "get": { "description": "This endpoint will return all Users bound to an Office 365 instance, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this Office 365 instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Office 365 instance.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/office365s/{OFFICE365_ID}/users \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-Office365TraverseUser", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the Users bound to an Office 365 instance" }, "parameters": [ { "description": "ObjectID of the Office 365 suite.", "in": "path", "name": "office365_id", "required": true, "type": "string" } ] }, "/policies": { "get": { "description": "This endpoint returns all policies.\n\n##### Sample Request\n\n```\n curl -X GET https://console.jumpcloud.com/api/v2/policies \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n ```", "operationId": "List-Policy", "parameters": [ { "required": false, "default": [], "description": "The comma separated fields included in the returned records.\nIf omitted, the default list of fields will be returned.\n", "in": "query", "items": { "type": "string" }, "name": "fields", "type": "array" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/Policy" }, "type": "array" } }, "500": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "x-api-key": [] } ], "summary": "Lists all the Policies" }, "post": { "description": "This endpoint allows you to create a policy. Given the amount of configurable parameters required to create a Policy, we suggest you use the JumpCloud Admin Console to create new policies.\n\n##### Sample Request\n```\ncurl -X POST https://console.jumpcloud.com/api/v2/policies \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n {Policy_Parameters}\n}'\n\n```", "operationId": "Create-Policy", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/PolicyRequest" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/PolicyWithDetails" } } }, "security": [ { "x-api-key": [] } ], "summary": "Create a new Policy" } }, "/policies/{id}": { "delete": { "parameters": [], "description": "This endpoint allows you to delete a policy.\n\n#### Sample Request\n\n```\ncurl -X DELETE https://console.jumpcloud.com/api/v2/policies/5a837ecd232e110d4291e6b9 \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n ```", "operationId": "Delete-Policy", "responses": { "204": { "description": "No Content" } }, "security": [ { "x-api-key": [] } ], "summary": "Deletes a Policy" }, "get": { "parameters": [], "description": "This endpoint returns a specific policy.\n\n###### Sample Request\n\n```\n curl -X GET https://console.jumpcloud.com/api/v2/policies/{PolicyID} \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n ```", "operationId": "Get-Policy", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PolicyWithDetails" } } }, "security": [ { "x-api-key": [] } ], "summary": "Gets a specific Policy." }, "parameters": [ { "description": "ObjectID of the Policy object.", "in": "path", "name": "id", "required": true, "type": "string" } ], "put": { "description": "This endpoint allows you to update a policy. Given the amount of configurable parameters required to update a Policy, we suggest you use the JumpCloud Admin Console to create new policies.\n\n\n##### Sample Request\n```\ncurl -X PUT https://console.jumpcloud.com/api/v2/policies/59fced45c9118022172547ff \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY' \\\n -d '{\n {Policy_Parameters}\n}'\n```", "operationId": "Put-Policy", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/PolicyRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Policy" } } }, "security": [ { "x-api-key": [] } ], "summary": "Update an existing Policy" } }, "/policies/{policy_id}/associations": { "get": { "description": "This endpoint returns the _direct_ associations of a Policy.\n\nA direct association can be a non-homogeneous relationship between 2 different objects, for example Policies and Systems.\n\n#### Sample Request\n```\ncurl -X GET 'https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/associations?targets=system_group \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-PolicyAssociation", "parameters": [ { "description": "", "x-ms-enum": { "name": "targets", "modelAsString": true, "values": [ { "name": "active_directory", "value": "active_directory" }, { "name": "application", "value": "application" }, { "name": "command", "value": "command" }, { "name": "g_suite", "value": "g_suite" }, { "name": "ldap_server", "value": "ldap_server" }, { "name": "office_365", "value": "office_365" }, { "name": "policy", "value": "policy" }, { "name": "radius_server", "value": "radius_server" }, { "name": "systems", "value": "system" }, { "name": "systems_group", "value": "system_group" }, { "name": "user", "value": "user" }, { "name": "user_group", "value": "user_group" } ] }, "enum": [ "active_directory", "application", "command", "g_suite", "ldap_server", "office_365", "policy", "radius_server", "system", "system_group", "user", "user_group" ], "in": "query", "name": "targets", "required": true, "type": "string" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphConnection" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the associations of a Policy" }, "parameters": [ { "description": "ObjectID of the Policy.", "in": "path", "name": "policy_id", "required": true, "type": "string" } ], "post": { "description": "This endpoint allows you to manage the _direct_ associations of a Policy.\n\nA direct association can be a non-homogeneous relationship between 2 different objects, for example Policies and Systems.\n\n#### Sample Request\n```\ncurl -X POST https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/associations/ \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"op\": \"add\",\n \"type\": \"system_group\",\n \"id\": \"{Group_ID}\"\n}'\n```", "operationId": "Set-PolicyAssociation", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/GraphManagementReq" } } ], "responses": { "204": { "description": "" } }, "security": [ { "x-api-key": [] } ], "summary": "Manage the associations of a Policy" } }, "/policies/{policy_id}/policyresults": { "get": { "description": "This endpoint returns all policies results for a specific policy.\n\n##### Sample Request\n\n```\n curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policyresults \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n ```", "operationId": "List-PolicyResult", "parameters": [ { "required": false, "default": [], "description": "The comma separated fields included in the returned records.\nIf omitted, the default list of fields will be returned.\n", "in": "query", "items": { "type": "string" }, "name": "fields", "type": "array" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/PolicyResult" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "Lists all the policy results of a policy." }, "parameters": [ { "in": "path", "name": "policy_id", "required": true, "type": "string" } ] }, "/policies/{policy_id}/policystatuses": { "get": { "description": "This endpoint returns the latest policies results for a specific policy.\n\n##### Sample Request\n\n```\n curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policystatuses \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n ```", "operationId": "List-PolicyStatus", "parameters": [ { "required": false, "default": [], "description": "The comma separated fields included in the returned records.\nIf omitted, the default list of fields will be returned.\n", "in": "query", "items": { "type": "string" }, "name": "fields", "type": "array" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/PolicyResult" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "Lists the latest policy results of a policy." }, "parameters": [ { "in": "path", "name": "policy_id", "required": true, "type": "string" } ] }, "/policies/{policy_id}/systemgroups": { "get": { "description": "This endpoint will return all Systems Groups bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the group's type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this Policy to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Policy.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systemgroups \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-PolicyTraverseSystemGroup", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the System Groups bound to a Policy" }, "parameters": [ { "description": "ObjectID of the Command.", "in": "path", "name": "policy_id", "required": true, "type": "string" } ] }, "/policies/{policy_id}/systems": { "get": { "description": "This endpoint will return all Systems bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this Policy to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systems \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-PolicyTraverseSystem", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the Systems bound to a Policy" }, "parameters": [ { "description": "ObjectID of the Command.", "in": "path", "name": "policy_id", "required": true, "type": "string" } ] }, "/policyresults": { "get": { "description": "This endpoint returns all policies results for an organization.\n\n##### Sample Request\n\n```\n curl -X GET https://console.jumpcloud.com/api/v2/policyresults \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n ```", "operationId": "List-PolicyResult", "parameters": [ { "required": false, "default": [], "description": "The comma separated fields included in the returned records.\nIf omitted, the default list of fields will be returned.\n", "in": "query", "items": { "type": "string" }, "name": "fields", "type": "array" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/PolicyResult" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "Lists all the policy results for an organization." } }, "/policyresults/{id}": { "get": { "parameters": [], "description": "This endpoint will return the policy results for a specific policy.\n\n##### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/policyresults/{Policy_ID} \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n ```", "operationId": "Get-PolicyResult", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PolicyResult" } } }, "security": [ { "x-api-key": [] } ], "summary": "Get a specific Policy Result." }, "parameters": [ { "description": "ObjectID of the Policy Result.", "in": "path", "name": "id", "required": true, "type": "string" } ] }, "/policytemplates": { "get": { "description": "This endpoint returns all policy templates.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/policytemplates \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n ```", "operationId": "List-PolicyTemplate", "parameters": [ { "required": false, "default": [], "description": "The comma separated fields included in the returned records.\nIf omitted, the default list of fields will be returned.\n", "in": "query", "items": { "type": "string" }, "name": "fields", "type": "array" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/PolicyTemplate" }, "type": "array" } }, "500": { "description": "Unexpected error.", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "x-api-key": [] } ], "summary": "Lists all of the Policy Templates" } }, "/policytemplates/{id}": { "get": { "parameters": [], "description": "This endpoint returns a specific policy template.\n\n#### Sample Request\n```\n curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}\\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-PolicyTemplate", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PolicyTemplateWithDetails" } } }, "security": [ { "x-api-key": [] } ], "summary": "Get a specific Policy Template" }, "parameters": [ { "description": "ObjectID of the Policy Template.", "in": "path", "name": "id", "required": true, "type": "string" } ] }, "/providers/{provider_id}/administrators": { "get": { "description": "This endpoint returns a list of the Administrators associated with the Provider. You must be associated with the provider to use this route.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/providers/{ProviderID}/administrators \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "List-ProviderAdministrator", "parameters": [ { "required": false, "default": [], "description": "The comma separated fields included in the returned records.\nIf omitted, the default list of fields will be returned.\n", "in": "query", "items": { "type": "string" }, "name": "fields", "type": "array" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" } ], "responses": { "200": { "description": "", "examples": { "application/json": { "results": [ { "enableMultiFactor": false, "firstname": "", "lastname": "", "_id": "5c3536e9e0a6840001872782", "email": "joe@example.com", "registered": true }, { "enableMultiFactor": false, "firstname": "", "lastname": "", "_id": "5c35370ae0a6840001872784", "email": "mildred@example.com", "registered": true } ], "totalCount": 2 } }, "schema": { "properties": { "results": { "items": { "$ref": "#/definitions/Administrator" }, "type": "array" }, "totalCount": { "type": "integer" } }, "type": "object" } }, "401": { "description": "", "examples": { "application/json": { "message": "Unauthorized" } }, "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } } }, "security": [ { "x-api-key": [] } ], "summary": "List Provider Administrators" }, "parameters": [ { "in": "path", "name": "provider_id", "required": true, "type": "string" } ], "post": { "description": "This endpoint allows you to create a provider administrator. You must be associated with the provider to use this route.\n\n#### Sample Request\n```\ncurl -X POST https://console.jumpcloud.com/api/v2/providers/{ProviderID}/administrators \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"email\":\"{ADMIN_EMAIL}\"\n }'\n```", "operationId": "Create-ProviderAdmin", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ProviderAdminReq" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Administrator" } }, "401": { "description": "", "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } } }, "security": [ { "x-api-key": [] } ], "summary": "Create a new Provider Administrator" } }, "/radiusservers/{radiusserver_id}/associations": { "get": { "description": "This endpoint returns the _direct_ associations of a Radius Server.\n\nA direct association can be a non-homogeneous relationship between 2 different objects, for example Radius Servers and Users.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/associations?targets=user_group \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-RadiusServerAssociation", "parameters": [ { "description": "", "x-ms-enum": { "name": "targets", "modelAsString": true, "values": [ { "name": "active_directory", "value": "active_directory" }, { "name": "application", "value": "application" }, { "name": "command", "value": "command" }, { "name": "g_suite", "value": "g_suite" }, { "name": "ldap_server", "value": "ldap_server" }, { "name": "office_365", "value": "office_365" }, { "name": "policy", "value": "policy" }, { "name": "radius_server", "value": "radius_server" }, { "name": "systems", "value": "system" }, { "name": "systems_group", "value": "system_group" }, { "name": "user", "value": "user" }, { "name": "user_group", "value": "user_group" } ] }, "enum": [ "active_directory", "application", "command", "g_suite", "ldap_server", "office_365", "policy", "radius_server", "system", "system_group", "user", "user_group" ], "in": "query", "name": "targets", "required": true, "type": "string" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphConnection" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the associations of a RADIUS Server" }, "parameters": [ { "description": "ObjectID of the Radius Server.", "in": "path", "name": "radiusserver_id", "required": true, "type": "string" } ], "post": { "description": "This endpoint allows you to manage the _direct_ associations of a Radius Server.\n\nA direct association can be a non-homogeneous relationship between 2 different objects, for example Radius Servers and Users.\n\n#### Sample Request\n```\ncurl -X POST https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/associations \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n\t\n\"type\":\"user\", \n\"id\":\"{USER_ID}\", \n\"op\":\"add\"\n\t\n}'\n```", "operationId": "Set-RadiusServerAssociation", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/GraphManagementReq" } } ], "responses": { "204": { "description": "OK" } }, "security": [ { "x-api-key": [] } ], "summary": "Manage the associations of a RADIUS Server" } }, "/radiusservers/{radiusserver_id}/usergroups": { "get": { "description": "This endpoint will return all Users Groups bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the group's type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this RADIUS server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this RADIUS server instance.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/usergroups \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-RadiusServerTraverseUserGroup", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the User Groups bound to a RADIUS Server" }, "parameters": [ { "description": "ObjectID of the Radius Server.", "in": "path", "name": "radiusserver_id", "required": true, "type": "string" } ] }, "/radiusservers/{radiusserver_id}/users": { "get": { "description": "This endpoint will return all Users bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this RADIUS server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this RADIUS server instance.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n ```", "operationId": "Get-RadiusServerTraverseUser", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the Users bound to a RADIUS Server" }, "parameters": [ { "description": "ObjectID of the Radius Server.", "in": "path", "name": "radiusserver_id", "required": true, "type": "string" } ] }, "/softwareapps": { "get": { "description": "This endpoint allows you to get all configured Software Applications that will be managed by JumpCloud on associated JumpCloud systems.\n\n#### Sample Request\n```\n$ curl -X GET https://console.jumpcloud.com/api/v2/softwareapps \\\n-H 'Accept: application/json' \\\n-H 'Content-Type: application/json' \\\n-H 'x-api-key: {API_KEY}' \\\n```", "operationId": "List-SoftwareApp", "parameters": [ { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/software-app" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ] }, "post": { "description": "This endpoint allows you to create a Software Application that will be managed by JumpCloud on associated JumpCloud systems.\n\n#### Sample Request\n```\n$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps \\\n-H 'Accept: application/json' \\\n-H 'Content-Type: application/json' \\\n-H 'x-api-key: {API_KEY}' \\\n-d '{\n\"displayName\": \"Adobe Reader\", \n\"settings\": [{\"packageId\": \"adobereader\"}]\n}' \n```", "operationId": "Create-SoftwareApp", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/software-app" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/software-app" } } }, "security": [ { "x-api-key": [] } ] } }, "/softwareapps/{id}": { "delete": { "parameters": [], "description": "Removes a Software Application configuration.\n\nWarning: This is a destructive operation and will unmanage the application on all affected systems.\n\n#### Sample Request\n```\ncurl -X DELETE https://console.jumpcloud.com/api/v2/softwareapps/{id} \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Delete-SoftwareApp", "responses": { "204": { "description": "" }, "400": { "$ref": "#/responses/trait:standardErrors:400" }, "401": { "$ref": "#/responses/trait:standardErrors:401" }, "403": { "$ref": "#/responses/trait:standardErrors:403" }, "404": { "$ref": "#/responses/trait:standardErrors:404" }, "409": { "$ref": "#/responses/trait:standardErrors:409" }, "500": { "$ref": "#/responses/trait:standardErrors:500" } }, "security": [ { "x-api-key": [] } ], "summary": "Delete a configured Software Application" }, "get": { "parameters": [], "description": "Retrieves a Software Application.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{id} \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-SoftwareApp", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/software-app" } }, "400": { "$ref": "#/responses/trait:standardErrors:400" }, "401": { "$ref": "#/responses/trait:standardErrors:401" }, "403": { "$ref": "#/responses/trait:standardErrors:403" }, "404": { "$ref": "#/responses/trait:standardErrors:404" }, "409": { "$ref": "#/responses/trait:standardErrors:409" }, "500": { "$ref": "#/responses/trait:standardErrors:500" } }, "security": [ { "x-api-key": [] } ], "summary": "Retrieve a configured Software Application" }, "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" } ], "put": { "description": "This endpoint updates a specific Software Application configuration for the organization. Only displayName can be changed.\n\n#### Sample Request\n```\n curl -X PUT https://console.jumpcloud.com/api/v2/softwareapps/{id} \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n\"displayName\": \"Adobe Reader\"\n}'\n```", "operationId": "Update-SoftwareApp", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/software-app" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/software-app" } }, "400": { "$ref": "#/responses/trait:standardErrors:400" }, "401": { "$ref": "#/responses/trait:standardErrors:401" }, "403": { "$ref": "#/responses/trait:standardErrors:403" }, "404": { "$ref": "#/responses/trait:standardErrors:404" }, "409": { "$ref": "#/responses/trait:standardErrors:409" }, "500": { "$ref": "#/responses/trait:standardErrors:500" } }, "security": [ { "x-api-key": [] } ], "summary": "Update a Software Application Configuration" } }, "/softwareapps/{software_app_id}/associations": { "get": { "description": "This endpoint will return the _direct_ associations of a Software Application. A direct association can be a non-homogeneous relationship between 2 different objects, for example Software Application and System Groups.\n\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/associations?targets=system_group \\\n -H 'accept: application/json' \\\n -H 'content-type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-SoftwareAppAssociation", "parameters": [ { "description": "", "x-ms-enum": { "name": "targets", "modelAsString": true, "values": [ { "name": "active_directory", "value": "active_directory" }, { "name": "application", "value": "application" }, { "name": "command", "value": "command" }, { "name": "g_suite", "value": "g_suite" }, { "name": "ldap_server", "value": "ldap_server" }, { "name": "office_365", "value": "office_365" }, { "name": "policy", "value": "policy" }, { "name": "radius_server", "value": "radius_server" }, { "name": "systems", "value": "system" }, { "name": "systems_group", "value": "system_group" }, { "name": "user", "value": "user" }, { "name": "user_group", "value": "user_group" } ] }, "enum": [ "active_directory", "application", "command", "g_suite", "ldap_server", "office_365", "policy", "radius_server", "system", "system_group", "user", "user_group" ], "in": "query", "name": "targets", "required": true, "type": "string" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphConnection" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the associations of a Software Application" }, "parameters": [ { "description": "ObjectID of the Software App.", "in": "path", "name": "software_app_id", "required": true, "type": "string" } ], "post": { "description": "This endpoint allows you to associate or disassociate a software application to a system or system group.\n\n#### Sample Request\n```\n$ curl -X POST https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/associations \\\n-H 'Accept: application/json' \\\n-H 'Content-Type: application/json' \\\n-H 'x-api-key: {API_KEY}' \\\n-d '{\n \"id\": \"<object_id>\",\n \"op\": \"add\",\n \"type\": \"system\"\n }'\n```", "operationId": "Set-SoftwareAppAssociation", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/GraphManagementReq" } } ], "responses": { "204": { "description": "" } }, "security": [ { "x-api-key": [] } ], "summary": "Manage the associations of a software application." } }, "/softwareapps/{software_app_id}/statuses": { "get": { "description": "This endpoint allows you to get the status of the provided Software Application on associated JumpCloud systems.\n\n#### Sample Request\n```\n$ curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/statuses \\\n-H 'Accept: application/json' \\\n-H 'Content-Type: application/json' \\\n-H 'x-api-key: {API_KEY}' \\\n```", "operationId": "Get-SoftwareAppStatus", "parameters": [ { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/software-app-status" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ] }, "parameters": [ { "description": "ObjectID of the Software App.", "in": "path", "name": "software_app_id", "required": true, "type": "string" } ] }, "/softwareapps/{software_app_id}/systemgroups": { "get": { "description": "This endpoint will return all Systems Groups bound to a Software App, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the group's type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this Software App to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this Software App.\n\nSee `/associations` endpoint to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/systemgroups \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-SoftwareAppTraverseSystemGroup", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the System Groups bound to a Software App." }, "parameters": [ { "description": "ObjectID of the Software App.", "in": "path", "name": "software_app_id", "required": true, "type": "string" } ] }, "/softwareapps/{software_app_id}/systems": { "get": { "description": "This endpoint will return all Systems bound to a Software App, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this Software App to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Software App.\n\nSee `/associations` endpoint to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{software_app_id}/systems \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-SoftwareAppTraverseSystem", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the Systems bound to a Software App." }, "parameters": [ { "description": "ObjectID of the Software App.", "in": "path", "name": "software_app_id", "required": true, "type": "string" } ] }, "/systemgroups": { "get": { "description": "This endpoint returns all System Groups.\n\nAvailable filter fields:\n - `name`\n - `disabled`\n - `type`\n\n#### Sample Request\n\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/systemgroups \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "List-SystemGroup", "parameters": [ { "required": false, "default": [], "description": "The comma separated fields included in the returned records.\nIf omitted, the default list of fields will be returned.\n", "in": "query", "items": { "type": "string" }, "name": "fields", "type": "array" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" } ], "responses": { "200": { "description": "OK", "examples": { "application/json": [ { "id": "000000" }, { "type": "system_group" }, { "id": "000000", "name": "group1" } ] }, "schema": { "items": { "$ref": "#/definitions/SystemGroup" }, "type": "array" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "x-api-key": [] } ], "summary": "List all System Groups" }, "post": { "description": "This endpoint allows you to create a new System Group.\n\n#### Sample Request\n\n```\ncurl -X POST https://console.jumpcloud.com/api/v2/systemgroups \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"name\": \"{Group_Name}\"\n}'\n\n```", "operationId": "Create-SystemGroup", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/SystemGroupData" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/SystemGroup" } } }, "security": [ { "x-api-key": [] } ], "summary": "Create a new System Group" } }, "/systemgroups/{group_id}/associations": { "get": { "description": "This endpoint returns the _direct_ associations of a System Group.\n\nA direct association can be a non-homogeneous relationship between 2 different objects, for example System Groups and Users.\n\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/associations?targets=user \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-SystemGroupAssociation", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "description": "", "x-ms-enum": { "name": "targets1", "modelAsString": true, "values": [ { "name": "active_directory", "value": "active_directory" }, { "name": "application", "value": "application" }, { "name": "command", "value": "command" }, { "name": "g_suite", "value": "g_suite" }, { "name": "ldap_server", "value": "ldap_server" }, { "name": "office_365", "value": "office_365" }, { "name": "policy", "value": "policy" }, { "name": "radius_server", "value": "radius_server" }, { "name": "user", "value": "user" }, { "name": "user_group", "value": "user_group" } ] }, "enum": [ "active_directory", "application", "command", "g_suite", "ldap_server", "office_365", "policy", "radius_server", "user", "user_group" ], "in": "query", "name": "targets", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphConnection" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the associations of a System Group" }, "parameters": [ { "description": "ObjectID of the System Group.", "in": "path", "name": "group_id", "required": true, "type": "string" } ], "post": { "description": "This endpoint allows you to manage the _direct_ associations of a System Group.\n\nA direct association can be a non-homogeneous relationship between 2 different objects, for example System Groups and Users.\n\n\n#### Sample Request\n```\ncurl -X POST https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/associations \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"op\": \"add\",\n \"type\": \"user\",\n \"id\": \"{UserID}\"\n}'\n\n```", "operationId": "Set-SystemGroupAssociation", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/SystemGroupGraphManagementReq" } } ], "responses": { "204": { "description": "OK" } }, "security": [ { "x-api-key": [] } ], "summary": "Manage the associations of a System Group" } }, "/systemgroups/{group_id}/commands": { "get": { "description": "This endpoint will return all Commands bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the group's type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this System Group to the corresponding Command; this array represents all grouping and/or associations that would have to be removed to deprovision the Command from this System Group.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/commands \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-SystemGroupTraverseCommand", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the Commands bound to a System Group" }, "parameters": [ { "description": "ObjectID of the System Group.", "in": "path", "name": "group_id", "required": true, "type": "string" } ] }, "/systemgroups/{group_id}/members": { "get": { "description": "This endpoint returns the system members of a System Group.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID}/members \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n\n```", "operationId": "Get-SystemGroupMembers", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphConnection" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the members of a System Group" }, "parameters": [ { "description": "ObjectID of the System Group.", "in": "path", "name": "group_id", "required": true, "type": "string" } ], "post": { "description": "This endpoint allows you to manage the system members of a System Group.\n\n#### Sample Request\n```\ncurl -X POST https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID}/members \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"op\": \"add\",\n \"type\": \"system\",\n \"id\": \"{System_ID}\"\n}'\n```", "operationId": "Set-SystemGroupMembers", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/SystemGroupMembersReq" } }, { "$ref": "#/parameters/trait:systemContextAuth:Authorization" }, { "$ref": "#/parameters/trait:systemContextAuth:Date" } ], "responses": { "204": { "description": "OK" } }, "security": [ { "x-api-key": [] } ], "summary": "Manage the members of a System Group" } }, "/systemgroups/{group_id}/membership": { "get": { "description": "This endpoint returns all Systems that are a member of this System Group.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID/membership \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n\n```", "operationId": "Get-SystemGroupMembership", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the System Group's membership" }, "parameters": [ { "description": "ObjectID of the System Group.", "in": "path", "name": "group_id", "required": true, "type": "string" } ] }, "/systemgroups/{group_id}/policies": { "get": { "description": "This endpoint will return all Policies bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this System Group to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System Group.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\nThis endpoint is not public yet as we haven't finished the code.\n\n##### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/policies \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-SystemGroupTraversePolicy", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the Policies bound to a System Group" }, "parameters": [ { "description": "ObjectID of the System Group.", "in": "path", "name": "group_id", "required": true, "type": "string" } ] }, "/systemgroups/{group_id}/usergroups": { "get": { "description": "This endpoint will return all User Groups bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this System Group to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System Group.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/usergroups \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n\n```", "operationId": "Get-SystemGroupTraverseUserGroup", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the User Groups bound to a System Group" }, "parameters": [ { "description": "ObjectID of the System Group.", "in": "path", "name": "group_id", "required": true, "type": "string" } ] }, "/systemgroups/{group_id}/users": { "get": { "description": "This endpoint will return all Users bound to a System Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this System Group to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System Group.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{GroupID}/users \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-SystemGroupTraverseUser", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the Users bound to a System Group" }, "parameters": [ { "description": "ObjectID of the System Group.", "in": "path", "name": "group_id", "required": true, "type": "string" } ] }, "/systemgroups/{id}": { "delete": { "parameters": [], "description": "This endpoint allows you to delete a System Group.\n\n#### Sample Request\n```\ncurl -X DELETE https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n\n```", "operationId": "Delete-SystemGroup", "responses": { "204": { "description": "No Content" } }, "security": [ { "x-api-key": [] } ], "summary": "Delete a System Group" }, "get": { "parameters": [], "description": "This endpoint returns the details of a System Group.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-SystemGroup", "responses": { "200": { "description": "OK", "examples": { "application/json": { "id": "000000", "name": "group1", "type": "system_group" } }, "schema": { "$ref": "#/definitions/SystemGroup" } } }, "security": [ { "x-api-key": [] } ], "summary": "View an individual System Group details" }, "parameters": [ { "description": "ObjectID of the System Group.", "in": "path", "name": "id", "required": true, "type": "string" } ], "put": { "description": "This endpoint allows you to do a full update of the System Group.\n\n#### Sample Request\n```\ncurl -X PUT https://console.jumpcloud.com/api/v2/systemgroups/{Group_ID} \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"name\": \"Name_Update\"\n}'\n```", "operationId": "Put-SystemGroup", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/SystemGroupData" } } ], "responses": { "200": { "description": "OK", "examples": { "application/json": { "id": "00000", "name": "group1", "type": "system_group" } }, "schema": { "$ref": "#/definitions/SystemGroup" } } }, "security": [ { "x-api-key": [] } ], "summary": "Update a System Group" } }, "/systeminsights/alf": { "get": { "description": "Valid filter fields are `system_id` and `global_state`.", "operationId": "List-SystemInsightsAlf", "parameters": [ { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-alf" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights ALF" } }, "/systeminsights/alf_exceptions": { "get": { "description": "Valid filter fields are `system_id` and `state`.", "operationId": "List-SystemInsightsAlfException", "parameters": [ { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-alf-exceptions" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights ALF Exceptions" } }, "/systeminsights/alf_explicit_auths": { "get": { "description": "Valid filter fields are `system_id` and `process`.", "operationId": "List-SystemInsightsAlfExplicitAuth", "parameters": [ { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-alf-explicit-auths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights ALF Explicit Authentications" } }, "/systeminsights/appcompat_shims": { "get": { "description": "Valid filter fields are `system_id` and `enabled`.", "operationId": "List-SystemInsightsAppCompatShim", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-appcompat-shims" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Application Compatibility Shims" } }, "/systeminsights/apps": { "get": { "description": "Valid filter fields are `system_id` and `bundle_name`.", "operationId": "List-SystemInsightsApps", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-apps" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Apps" } }, "/systeminsights/authorized_keys": { "get": { "description": "Valid filter fields are `system_id` and `uid`.", "operationId": "List-SystemInsightsAuthorizedKey", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-authorized-keys" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Authorized Keys" } }, "/systeminsights/battery": { "get": { "description": "Valid filter fields are `system_id` and `health`.", "operationId": "List-SystemInsightsBattery", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-battery" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Battery" } }, "/systeminsights/bitlocker_info": { "get": { "description": "Valid filter fields are `system_id` and `protection_status`.", "operationId": "List-SystemInsightsBitlockerInfo", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-bitlocker-info" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Bitlocker Info" } }, "/systeminsights/browser_plugins": { "get": { "description": "Valid filter fields are `system_id` and `name`.", "operationId": "List-SystemInsightsBrowserPlugins", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-browser-plugins" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Browser Plugins" } }, "/systeminsights/certificates": { "get": { "description": "Valid filter fields are `system_id` and `common_name`.", "operationId": "List-SystemInsightsCertificates", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-certificates" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Certificates" } }, "/systeminsights/chrome_extensions": { "get": { "description": "Valid filter fields are `system_id` and `name`.", "operationId": "List-SystemInsightsChromeExtensions", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-chrome-extensions" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Chrome Extensions" } }, "/systeminsights/connectivity": { "get": { "description": "The only valid filter field is `system_id`.", "operationId": "List-SystemInsightsConnectivity", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-connectivity" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Connectivity" } }, "/systeminsights/crashes": { "get": { "description": "Valid filter fields are `system_id` and `identifier`.", "operationId": "List-SystemInsightsCrashes", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-crashes" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Crashes" } }, "/systeminsights/cups_destinations": { "get": { "description": "Valid filter fields are `system_id` and `name`.", "operationId": "List-SystemInsightsCupsDestinations", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-cups-destinations" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights CUPS Destinations" } }, "/systeminsights/disk_encryption": { "get": { "description": "Valid filter fields are `system_id` and `encryption_status`.", "operationId": "List-SystemInsightsDiskEncryption", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-disk-encryption" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Disk Encryption" } }, "/systeminsights/disk_info": { "get": { "description": "Valid filter fields are `system_id` and `disk_index`.", "operationId": "List-SystemInsightsDiskInfo", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-disk-info" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Disk Info" } }, "/systeminsights/dns_resolvers": { "get": { "description": "Valid filter fields are `system_id` and `type`.", "operationId": "List-SystemInsightsDnsResolver", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-dns-resolvers" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights DNS Resolvers" } }, "/systeminsights/etc_hosts": { "get": { "description": "Valid filter fields are `system_id` and `address`.", "operationId": "List-SystemInsightsEtcHosts", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-etc-hosts" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Etc Hosts" } }, "/systeminsights/firefox_addons": { "get": { "description": "Valid filter fields are `system_id` and `name`.", "operationId": "List-SystemInsightsFirefoxAddons", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-firefox-addons" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Firefox Addons" } }, "/systeminsights/groups": { "get": { "description": "Valid filter fields are `system_id` and `groupname`.", "operationId": "List-SystemInsightsGroups", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-groups" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Groups" } }, "/systeminsights/ie_extensions": { "get": { "description": "Valid filter fields are `system_id` and `name`.", "operationId": "List-SystemInsightsIEExtensions", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-ie-extensions" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights IE Extensions" } }, "/systeminsights/interface_addresses": { "get": { "description": "Valid filter fields are `system_id` and `address`.", "operationId": "List-SystemInsightsInterfaceAddresses", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-interface-addresses" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Interface Addresses" } }, "/systeminsights/interface_details": { "get": { "description": "Valid filter fields are `system_id` and `interface`.", "operationId": "List-SystemInsightsInterfaceDetails", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-interface-details" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Interface Details" } }, "/systeminsights/kernel_info": { "get": { "description": "Valid filter fields are `system_id` and `version`.", "operationId": "List-SystemInsightsKernelInfo", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-kernel-info" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Kernel Info" } }, "/systeminsights/launchd": { "get": { "description": "Valid filter fields are `system_id` and `name`.", "operationId": "List-SystemInsightsLaunchd", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-launchd" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Launchd" } }, "/systeminsights/logged_in_users": { "get": { "description": "Valid filter fields are `system_id` and `user`.", "operationId": "List-SystemInsightsLoggedinUsers", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-logged-in-users" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Logged-In Users" } }, "/systeminsights/logical_drives": { "get": { "description": "Valid filter fields are `system_id` and `device_id`.", "operationId": "List-SystemInsightsLogicalDrives", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-logical-drives" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Logical Drives" } }, "/systeminsights/managed_policies": { "get": { "description": "Valid filter fields are `system_id` and `domain`.", "operationId": "List-SystemInsightsManagedPolicies", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-managed-policies" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Managed Policies" } }, "/systeminsights/mounts": { "get": { "description": "Valid filter fields are `system_id` and `path`.", "operationId": "List-SystemInsightsMounts", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-mounts" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Mounts" } }, "/systeminsights/os_version": { "get": { "description": "Valid filter fields are `system_id` and `version`.", "operationId": "List-SystemInsightsOsVersion", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-os-version" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights OS Version" } }, "/systeminsights/patches": { "get": { "description": "Valid filter fields are `system_id` and `hotfix_id`.", "operationId": "List-SystemInsightsPatches", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-patches" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Patches" } }, "/systeminsights/programs": { "get": { "description": "Valid filter fields are `system_id` and `name`.", "operationId": "List-SystemInsightsPrograms", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-programs" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Programs" } }, "/systeminsights/python_packages": { "get": { "description": "Valid filter fields are `system_id` and `name`.", "operationId": "List-SystemInsightsPythonPackages", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-python-packages" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Python Packages" } }, "/systeminsights/safari_extensions": { "get": { "description": "Valid filter fields are `system_id` and `name`.", "operationId": "List-SystemInsightsSafariExtensions", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-safari-extensions" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Safari Extensions" } }, "/systeminsights/scheduled_tasks": { "get": { "description": "Valid filter fields are `system_id` and `enabled`.", "operationId": "List-SystemInsightsScheduledTasks", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-scheduled-tasks" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Scheduled Tasks" } }, "/systeminsights/services": { "get": { "description": "Valid filter fields are `system_id` and `name`.", "operationId": "List-SystemInsightsServices", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-services" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Services" } }, "/systeminsights/shadow": { "get": { "description": "Valid filter fields are `system_id` and `username`.", "operationId": "List-SystemInsightsShadow", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-shadow" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "LIst System Insights Shadow" } }, "/systeminsights/shared_folders": { "get": { "description": "Valid filter fields are `system_id` and `name`.", "operationId": "List-SystemInsightsSharedFolders", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-shared-folders" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Shared Folders" } }, "/systeminsights/shared_resources": { "get": { "description": "Valid filter fields are `system_id` and `type`.", "operationId": "List-SystemInsightsSharedResources", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-shared-resources" }, "type": "array" } } }, "summary": "List System Insights Shared Resources" } }, "/systeminsights/sharing_preferences": { "get": { "description": "Only valid filed field is `system_id`.", "operationId": "List-SystemInsightsSharingPreferences", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-sharing-preferences" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Sharing Preferences" } }, "/systeminsights/sip_config": { "get": { "description": "Valid filter fields are `system_id` and `enabled`.", "operationId": "List-SystemInsightsSipConfig", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-sip-config" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights SIP Config" } }, "/systeminsights/startup_items": { "get": { "description": "Valid filter fields are `system_id` and `name`.", "operationId": "List-SystemInsightsStartupItems", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-startup-items" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Startup Items" } }, "/systeminsights/system_controls": { "get": { "description": "Valid filter fields are `system_id` and `name`.", "operationId": "List-SystemInsightsSystemControls", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-system-controls" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights System Control" } }, "/systeminsights/system_info": { "get": { "description": "Valid filter fields are `system_id` and `cpu_subtype`.", "operationId": "List-SystemInsightsSystemInfo", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-system-info" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights System Info" } }, "/systeminsights/uptime": { "get": { "description": "Valid filter fields are `system_id` and `days`.", "operationId": "List-SystemInsightsUptime", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-uptime" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Uptime" } }, "/systeminsights/usb_devices": { "get": { "description": "Valid filter fields are `system_id` and `model`.", "operationId": "List-SystemInsightsUSBDevices", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-usb-devices" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights USB Devices" } }, "/systeminsights/user_groups": { "get": { "description": "Only valid filter field is `system_id`.", "operationId": "List-SystemInsightsUserGroups", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-user-groups" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights User Groups" } }, "/systeminsights/user_ssh_keys": { "get": { "description": "Valid filter fields are `system_id` and `uid`.", "operationId": "List-SystemInsightsUserSSHKeys", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-user-ssh-keys" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights User SSH Keys" } }, "/systeminsights/users": { "get": { "description": "Valid filter fields are `system_id` and `username`.", "operationId": "List-SystemInsightsUsers", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-users" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Users" } }, "/systeminsights/wifi_networks": { "get": { "description": "Valid filter fields are `system_id` and `security_type`.", "operationId": "List-SystemInsightsWifiNetwork", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-wifi-networks" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights WiFi Networks" } }, "/systeminsights/wifi_status": { "get": { "description": "Valid filter fields are `system_id` and `security_type`.", "operationId": "List-SystemInsightsWifiStatus", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-wifi-status" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights WiFi Status" } }, "/systeminsights/windows_security_products": { "get": { "description": "Valid filter fields are `system_id` and `state`.", "operationId": "List-SystemInsightsWindowsSecurityProduct", "parameters": [ { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "Supported operators are: eq", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "minimum": 0, "default": 10, "in": "query", "maximum": 1000, "name": "limit", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/system-insights-windows-security-products" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List System Insights Windows Security Products" } }, "/systems/{system_id}/associations": { "get": { "description": "This endpoint returns the _direct_ associations of a System.\n\nA direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users.\n\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations?targets=user \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n\n```", "operationId": "Get-SystemAssociation", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "description": "", "x-ms-enum": { "name": "targets1", "modelAsString": true, "values": [ { "name": "active_directory", "value": "active_directory" }, { "name": "application", "value": "application" }, { "name": "command", "value": "command" }, { "name": "g_suite", "value": "g_suite" }, { "name": "ldap_server", "value": "ldap_server" }, { "name": "office_365", "value": "office_365" }, { "name": "policy", "value": "policy" }, { "name": "radius_server", "value": "radius_server" }, { "name": "user", "value": "user" }, { "name": "user_group", "value": "user_group" } ] }, "enum": [ "active_directory", "application", "command", "g_suite", "ldap_server", "office_365", "policy", "radius_server", "user", "user_group" ], "in": "query", "name": "targets", "required": true, "type": "string" }, { "$ref": "#/parameters/trait:systemContextAuth:Authorization" }, { "$ref": "#/parameters/trait:systemContextAuth:Date" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphConnection" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the associations of a System" }, "parameters": [ { "description": "ObjectID of the System.", "in": "path", "name": "system_id", "required": true, "type": "string" } ], "post": { "description": "This endpoint allows you to manage the _direct_ associations of a System.\n\nA direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users.\n\n\n#### Sample Request\n```\ncurl -X POST https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"attributes\": {\n \"sudo\": {\n \"enabled\": true,\n \"withoutPassword\": false\n }\n },\n \"op\": \"add\",\n \"type\": \"user\",\n \"id\": \"UserID\"\n}'\n\n```", "operationId": "Set-SystemAssociation", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/SystemGraphManagementReq" } }, { "$ref": "#/parameters/trait:systemContextAuth:Authorization" }, { "$ref": "#/parameters/trait:systemContextAuth:Date" } ], "responses": { "204": { "description": "OK" } }, "security": [ { "x-api-key": [] } ], "summary": "Manage associations of a System" } }, "/systems/{system_id}/commands": { "get": { "description": "This endpoint will return all Commands bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this System to the corresponding Command; this array represents all grouping and/or associations that would have to be removed to deprovision the Command from this System.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/commands \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n\n```", "operationId": "Get-SystemTraverseCommand", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the Commands bound to a System" }, "parameters": [ { "description": "ObjectID of the System.", "in": "path", "name": "system_id", "required": true, "type": "string" } ] }, "/systems/{system_id}/fdekey": { "get": { "parameters": [], "description": "This endpoint will return the current (latest) fde key saved for a system.", "operationId": "Get-SystemFDEKey", "responses": { "200": { "description": "", "examples": { "application/json": { "key": "cupidatat consequat occaecat proident" } }, "schema": { "$ref": "#/definitions/systemfdekey" } }, "400": { "$ref": "#/responses/trait:standardErrors:400" }, "401": { "$ref": "#/responses/trait:standardErrors:401" }, "403": { "$ref": "#/responses/trait:standardErrors:403" }, "404": { "$ref": "#/responses/trait:standardErrors:404" }, "409": { "$ref": "#/responses/trait:standardErrors:409" }, "500": { "$ref": "#/responses/trait:standardErrors:500" } }, "security": [ { "x-api-key": [] } ], "summary": "Get System FDE Key" }, "parameters": [ { "in": "path", "name": "system_id", "required": true, "type": "string" } ] }, "/systems/{system_id}/memberof": { "get": { "description": "This endpoint returns all the System Groups a System is a member of.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/memberof \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n\n```", "operationId": "Get-SystemMember", "parameters": [ { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "$ref": "#/parameters/trait:systemContextAuth:Authorization" }, { "$ref": "#/parameters/trait:systemContextAuth:Date" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the parent Groups of a System" }, "parameters": [ { "description": "ObjectID of the System.", "in": "path", "name": "system_id", "required": true, "type": "string" } ] }, "/systems/{system_id}/policies": { "get": { "description": "This endpoint will return all Policies bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this System to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\nThis endpoint is not yet public as we have finish the code.\n\n##### Sample Request\n\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/{System_ID}/policies \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n\n```", "operationId": "Get-SystemTraversePolicy", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the Policies bound to a System" }, "parameters": [ { "description": "ObjectID of the System.", "in": "path", "name": "system_id", "required": true, "type": "string" } ] }, "/systems/{system_id}/policystatuses": { "get": { "description": "This endpoint returns the policy results for a particular system.\n\n##### Sample Request\n\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policystatuses \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n\n```", "operationId": "List-PolicyStatus", "parameters": [ { "required": false, "default": [], "description": "The comma separated fields included in the returned records.\nIf omitted, the default list of fields will be returned.\n", "in": "query", "items": { "type": "string" }, "name": "fields", "type": "array" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/PolicyResult" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the policy statuses for a system" }, "parameters": [ { "description": "ObjectID of the System.", "in": "path", "name": "system_id", "required": true, "type": "string" } ] }, "/systems/{system_id}/usergroups": { "get": { "description": "This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n\n```", "operationId": "Get-SystemTraverseUserGroup", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "$ref": "#/parameters/trait:systemContextAuth:Authorization" }, { "$ref": "#/parameters/trait:systemContextAuth:Date" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the User Groups bound to a System" }, "parameters": [ { "description": "ObjectID of the System.", "in": "path", "name": "system_id", "required": true, "type": "string" } ] }, "/systems/{system_id}/users": { "get": { "description": "This endpoint will return all Users bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this System to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/users \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n\n```", "operationId": "Get-SystemTraverseUser", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "$ref": "#/parameters/trait:systemContextAuth:Authorization" }, { "$ref": "#/parameters/trait:systemContextAuth:Date" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the Users bound to a System" }, "parameters": [ { "description": "ObjectID of the System.", "in": "path", "name": "system_id", "required": true, "type": "string" } ] }, "/usergroups": { "get": { "description": "This endpoint returns all User Groups.\n\nAvailable filter fields:\n - `name`\n - `disabled`\n - `type`\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/usergroups \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "List-UserGroup", "parameters": [ { "required": false, "default": [], "description": "The comma separated fields included in the returned records.\nIf omitted, the default list of fields will be returned.\n", "in": "query", "items": { "type": "string" }, "name": "fields", "type": "array" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/UserGroup" }, "type": "array" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } }, "security": [ { "x-api-key": [] } ], "summary": "List all User Groups" }, "post": { "description": "This endpoint allows you to create a new User Group.\n\n#### Sample Request\n```\ncurl -X POST https://console.jumpcloud.com/api/v2/usergroups \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"name\": \"{Group_Name}\"\n}'\n\n```", "operationId": "Create-UserGroup", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/UserGroupPost" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/UserGroup" } } }, "security": [ { "x-api-key": [] } ], "summary": "Create a new User Group" } }, "/usergroups/{group_id}/applications": { "get": { "description": "This endpoint will return all Applications bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this User Group to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User Group.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/applications \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-UserGroupTraverseApplication", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the Applications bound to a User Group" }, "parameters": [ { "description": "ObjectID of the User Group.", "in": "path", "name": "group_id", "required": true, "type": "string" } ] }, "/usergroups/{group_id}/associations": { "get": { "description": "This endpoint returns the _direct_ associations of this User Group.\n\nA direct association can be a non-homogeneous relationship between 2 different objects, for example User Groups and Users.\n\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/associations?targets=system \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-UserGroupAssociation", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "description": "", "x-ms-enum": { "name": "targets2", "modelAsString": true, "values": [ { "name": "active_directory", "value": "active_directory" }, { "name": "application", "value": "application" }, { "name": "command", "value": "command" }, { "name": "g_suite", "value": "g_suite" }, { "name": "ldap_server", "value": "ldap_server" }, { "name": "office_365", "value": "office_365" }, { "name": "policy", "value": "policy" }, { "name": "radius_server", "value": "radius_server" }, { "name": "systems", "value": "system" }, { "name": "systems_group", "value": "system_group" } ] }, "enum": [ "active_directory", "application", "command", "g_suite", "ldap_server", "office_365", "policy", "radius_server", "system", "system_group" ], "in": "query", "name": "targets", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphConnection" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the associations of a User Group." }, "parameters": [ { "description": "ObjectID of the User Group.", "in": "path", "name": "group_id", "required": true, "type": "string" } ], "post": { "description": "This endpoint manages the _direct_ associations of this User Group.\n\nA direct association can be a non-homogeneous relationship between 2 different objects, for example User Groups and Users.\n\n\n#### Sample Request\n```\ncurl -X POST https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/associations \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"op\": \"add\",\n \"type\": \"system\",\n \"id\": \"{SystemID}\"\n}'\n\n```", "operationId": "Set-UserGroupAssociation", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/UserGroupGraphManagementReq" } } ], "responses": { "204": { "description": "OK" } }, "security": [ { "x-api-key": [] } ], "summary": "Manage the associations of a User Group" } }, "/usergroups/{group_id}/directories": { "get": { "description": "This endpoint will return all Directories bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this User Group to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directories from this User Group.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/directories \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n\n```", "operationId": "Get-UserGroupTraverseDirectory", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the Directories bound to a User Group" }, "parameters": [ { "description": "ObjectID of the User Group.", "in": "path", "name": "group_id", "required": true, "type": "string" } ] }, "/usergroups/{group_id}/gsuites": { "get": { "description": "This endpoint will return all G Suite Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this User Group to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User Group.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID/gsuites \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n\n```", "operationId": "Get-UserGroupTraverseGSuite", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the G Suite instances bound to a User Group" }, "parameters": [ { "description": "ObjectID of the User Group.", "in": "path", "name": "group_id", "required": true, "type": "string" } ] }, "/usergroups/{group_id}/ldapservers": { "get": { "description": "This endpoint will return all LDAP Servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this User Group to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User Group.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/ldapservers \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-UserGroupTraverseLdapServer", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the LDAP Servers bound to a User Group" }, "parameters": [ { "description": "ObjectID of the User Group.", "in": "path", "name": "group_id", "required": true, "type": "string" } ] }, "/usergroups/{group_id}/members": { "get": { "description": "This endpoint returns the user members of a User Group.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/members \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-UserGroupMembers", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphConnection" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the members of a User Group" }, "parameters": [ { "description": "ObjectID of the User Group.", "in": "path", "name": "group_id", "required": true, "type": "string" } ], "post": { "description": "This endpoint allows you to manage the user members of a User Group.\n\n#### Sample Request\n```\ncurl -X POST https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/members \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"op\": \"add\",\n \"type\": \"user\",\n \"id\": \"{User_ID}\"\n}'\n```", "operationId": "Set-UserGroupMembers", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/UserGroupMembersReq" } } ], "responses": { "204": { "description": "OK" } }, "security": [ { "x-api-key": [] } ], "summary": "Manage the members of a User Group" } }, "/usergroups/{group_id}/membership": { "get": { "description": "This endpoint returns all users members that are a member of this User Group.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/membership \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-UserGroupMembership", "parameters": [ { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the User Group's membership" }, "parameters": [ { "description": "ObjectID of the User Group.", "in": "path", "name": "group_id", "required": true, "type": "string" } ] }, "/usergroups/{group_id}/office365s": { "get": { "description": "This endpoint will return all Office 365 instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this User Group to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User Group.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/office365s \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-UserGroupTraverseOffice365", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the Office 365 instances bound to a User Group" }, "parameters": [ { "description": "ObjectID of the User Group.", "in": "path", "name": "group_id", "required": true, "type": "string" } ] }, "/usergroups/{group_id}/radiusservers": { "get": { "description": "This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n\n```", "operationId": "Get-UserGroupTraverseRadiusServer", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the RADIUS Servers bound to a User Group" }, "parameters": [ { "description": "ObjectID of the User Group.", "in": "path", "name": "group_id", "required": true, "type": "string" } ] }, "/usergroups/{group_id}/systemgroups": { "get": { "description": "This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-UserGroupTraverseSystemGroup", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the System Groups bound to User Groups" }, "parameters": [ { "description": "ObjectID of the User Group.", "in": "path", "name": "group_id", "required": true, "type": "string" } ] }, "/usergroups/{group_id}/systems": { "get": { "description": "This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-UserGroupTraverseSystem", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the Systems bound to a User Group" }, "parameters": [ { "description": "ObjectID of the User Group.", "in": "path", "name": "group_id", "required": true, "type": "string" } ] }, "/usergroups/{id}": { "delete": { "parameters": [], "description": "This endpoint allows you to delete a User Group.\n\n#### Sample Request\n```\ncurl -X DELETE https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n\n```", "operationId": "Delete-UserGroup", "responses": { "204": { "description": "No Content" } }, "security": [ { "x-api-key": [] } ], "summary": "Delete a User Group" }, "get": { "parameters": [], "description": "This endpoint returns the details of a User Group.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-UserGroup", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserGroup" } } }, "security": [ { "x-api-key": [] } ], "summary": "View an individual User Group details" }, "parameters": [ { "description": "ObjectID of the User Group.", "in": "path", "name": "id", "required": true, "type": "string" } ], "put": { "description": "This endpoint allows you to do a full update of the User Group.\n\n#### Sample Request\n```\ncurl -X PUT https://console.jumpcloud.com/api/v2/usergroups/{Group_ID} \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY' \\\n -d '{\n \"name\": \"group_update\"\n}'\n\n```", "operationId": "Put-UserGroup", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/UserGroupPut" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserGroup" } } }, "security": [ { "x-api-key": [] } ], "summary": "Update a User Group" } }, "/users/{user_id}/applications": { "get": { "description": "This endpoint will return all Applications bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this User to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/applications \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-UserTraverseApplication", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the Applications bound to a User" }, "parameters": [ { "description": "ObjectID of the User.", "in": "path", "name": "user_id", "required": true, "type": "string" } ] }, "/users/{user_id}/associations": { "get": { "description": "This endpoint returns the _direct_ associations of a User.\n\nA direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems.\n\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/associations?targets=system_group \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n\n```", "operationId": "Get-UserAssociation", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "description": "", "x-ms-enum": { "name": "targets2", "modelAsString": true, "values": [ { "name": "active_directory", "value": "active_directory" }, { "name": "application", "value": "application" }, { "name": "command", "value": "command" }, { "name": "g_suite", "value": "g_suite" }, { "name": "ldap_server", "value": "ldap_server" }, { "name": "office_365", "value": "office_365" }, { "name": "policy", "value": "policy" }, { "name": "radius_server", "value": "radius_server" }, { "name": "systems", "value": "system" }, { "name": "systems_group", "value": "system_group" } ] }, "enum": [ "active_directory", "application", "command", "g_suite", "ldap_server", "office_365", "policy", "radius_server", "system", "system_group" ], "in": "query", "name": "targets", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphConnection" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the associations of a User" }, "parameters": [ { "description": "ObjectID of the User.", "in": "path", "name": "user_id", "required": true, "type": "string" } ], "post": { "description": "This endpoint allows you to manage the _direct_ associations of a User.\n\nA direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems.\n\n\n#### Sample Request\n```\ncurl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"attributes\": {\n \"sudo\": {\n \"enabled\": true,\n \"withoutPassword\": false\n }\n },\n \"op\": \"add\",\n \"type\": \"system_group\",\n \"id\": \"{GroupID}\"\n}'", "operationId": "Set-UserAssociation", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/UserGraphManagementReq" } } ], "responses": { "204": { "description": "OK" } }, "security": [ { "x-api-key": [] } ], "summary": "Manage the associations of a User" } }, "/users/{user_id}/directories": { "get": { "description": "This endpoint will return all Directories bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this User to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/directories \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-UserTraverseDirectory", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the Directories bound to a User" }, "parameters": [ { "description": "ObjectID of the User.", "in": "path", "name": "user_id", "required": true, "type": "string" } ] }, "/users/{user_id}/gsuites": { "get": { "description": "This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-UserTraverseGSuite", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the G Suite instances bound to a User" }, "parameters": [ { "description": "ObjectID of the User.", "in": "path", "name": "user_id", "required": true, "type": "string" } ] }, "/users/{user_id}/ldapservers": { "get": { "description": "This endpoint will return all LDAP Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this User to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/ldapservers \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-UserTraverseLdapServer", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the LDAP servers bound to a User" }, "parameters": [ { "description": "ObjectID of the User.", "in": "path", "name": "user_id", "required": true, "type": "string" } ] }, "/users/{user_id}/memberof": { "get": { "description": "This endpoint returns all the User Groups a User is a member of.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/memberof \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-UserMember", "parameters": [ { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the parent Groups of a User" }, "parameters": [ { "description": "ObjectID of the User.", "in": "path", "name": "user_id", "required": true, "type": "string" } ] }, "/users/{user_id}/office365s": { "get": { "description": "This endpoint will return all Office 365 Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this User to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/office365s \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-UserTraverseOffice365", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the Office 365 instances bound to a User" }, "parameters": [ { "description": "ObjectID of the User.", "in": "path", "name": "user_id", "required": true, "type": "string" } ] }, "/users/{user_id}/radiusservers": { "get": { "description": "This endpoint will return all RADIUS Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this User to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/radiusservers \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-UserTraverseRadiusServer", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the RADIUS Servers bound to a User" }, "parameters": [ { "description": "ObjectID of the User.", "in": "path", "name": "user_id", "required": true, "type": "string" } ] }, "/users/{user_id}/systemgroups": { "get": { "description": "This endpoint will return all System Groups bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this User to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systemgroups\\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-UserTraverseSystemGroup", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the System Groups bound to a User" }, "parameters": [ { "description": "ObjectID of the User.", "in": "path", "name": "user_id", "required": true, "type": "string" } ] }, "/users/{user_id}/systems": { "get": { "description": "This endpoint will return all Systems bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.\n\nEach element will contain the type, id, attributes and paths.\n\nThe `attributes` object is a key/value hash of compiled graph attributes for all paths followed.\n\nThe `paths` array enumerates each path from this User to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User.\n\nSee `/members` and `/associations` endpoints to manage those collections.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systems\\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Get-UserTraverseSystem", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GraphObjectWithPaths" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List the Systems bound to a User" }, "parameters": [ { "description": "ObjectID of the User.", "in": "path", "name": "user_id", "required": true, "type": "string" } ] }, "/workdays": { "get": { "description": "This endpoint will return all the available information about all your instances of Workday.\n\n##### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/workdays/ \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n ```", "operationId": "List-Workday", "parameters": [ { "required": false, "default": [], "description": "The comma separated fields included in the returned records.\nIf omitted, the default list of fields will be returned.\n", "in": "query", "items": { "type": "string" }, "name": "fields", "type": "array" }, { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" }, { "required": false, "default": [], "description": "A filter to apply to the query. **Filter structure**: `<field>:<operator>:<value>`. **field** = Populate with a valid field from an endpoint response. **operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. **value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards. **EX:** `GET /users?username=eq:testuser`", "in": "query", "items": { "type": "string" }, "name": "filter", "type": "array" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/workday-output" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List Workdays" }, "post": { "description": "This endpoint allows you to create a new workday instance.\n\nYou must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. Failure to provide these credentials will result in the request being rejected.\n\nCurrently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future.\n\nCurrently, only one instance is allowed and it must be `Workday Import`.\n\n#### Sample Request\n```\ncurl -X POST https://console.jumpcloud.com/api/v2/workdays/ \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n \"name\": \"Workday2\",\n \"reportUrl\":\"https://workday.com/ccx/service/customreport2/gms/user/reportname?format=json\",\n \"auth\": {\n \"basic\": {\n \"username\": \"someDeveloper\",\n \"password\": \"notTheRealPassword\"\n }\n }\n}'\n```", "operationId": "Create-Workday", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/workday-input" } } ], "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/workday-output" } } }, "security": [ { "x-api-key": [] } ], "summary": "Create new Workday" } }, "/workdays/{id}": { "get": { "parameters": [], "description": "This endpoint will return all the available information about an instance of Workday.\n\n#### Sample Request\n\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/workdays/ \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n ```", "operationId": "Get-Workday", "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/workday-output" } } }, "security": [ { "x-api-key": [] } ], "summary": "Get Workday" }, "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" } ], "put": { "description": "This endpoint allows you to update the name and Custom Report URL for a Workday Instance.\n\nCurrently, the name can not be changed from the default of `Workday Import`.\n\n##### Sample Request\n```\ncurl -X PUT https://console.jumpcloud.com/api/v2/workdays/{WorkdayID} \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n\t\"reportUrl\":\"{Report_URL}\",\n\t\"name\":\"{Name}\"\n}\t'\n```", "operationId": "Put-Workday", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/workday-fields" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/workday-output" } } }, "security": [ { "x-api-key": [] } ], "summary": "Update Workday" } }, "/workdays/{id}/import/{job_id}/results": { "get": { "description": "This endpoint provides a list of job results from the workday import and will contain all imported data from Workday.\n\n#### Sample Request\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkdayID}/import/{ImportJobID}/results \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Import-WorkdayResult", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "items": { "$ref": "#/definitions/job-workresult" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List Import Results" }, "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "path", "name": "job_id", "required": true, "type": "string" } ] }, "/workdays/{workday_id}/auth": { "delete": { "parameters": [], "description": "Removes any and all authorization methods from the workday instance\n\n##### Sample Request\n```\ncurl -X DELETE https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/auth \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n```", "operationId": "Delete-WorkdayAuthorization", "responses": { "204": { "description": "" } }, "security": [ { "x-api-key": [] } ], "summary": "Deauthorize Workday" }, "parameters": [ { "in": "path", "name": "workday_id", "required": true, "type": "string" } ], "post": { "description": "This endpoint adds an authorization method to a workday instance.\n\nYou must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. Failure to provide these credentials will result in the request being rejected.\n\nCurrently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future.\n\n#### Sample Request\n\n```\ncurl -X POST https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/auth \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '{\n\t\"auth\":{\n\t \"basic\": {\n\t\t\"username\": \"someDeveloper\",\t \n\t\t\"password\": \"notTheRealPassword\"\n\n\t }\n\t}\n}'\n\n```", "operationId": "Authorize-Workday", "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/auth-input-object" } } ], "responses": { "204": { "description": "" } }, "security": [ { "x-api-key": [] } ], "summary": "Authorize Workday" } }, "/workdays/{workday_id}/import": { "parameters": [ { "in": "path", "name": "workday_id", "required": true, "type": "string" } ], "post": { "description": "The endpoint allows you to create a Workday Import request.\n\n#### Sample Request \n```\ncurl -X POST https://console.jumpcloud.com/api/v2/workdays/{WorkdayID}/import \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}' \\\n -d '[\n\t{\n\t\t\"email\":\"{email}\",\n\t\t\"firstname\":\"{firstname}\",\n\t\t\"lastname\":\"{firstname}\",\n\t\t\"username\":\"{username}\",\n\t\t\"attributes\":[\n\t\t\t{\"name\":\"EmployeeID\",\"value\":\"0000\"},\n\t\t\t{\"name\":\"WorkdayID\",\"value\":\"name.name\"}\n\t\t\t]\n\t\t\n\t}\n]\n```", "operationId": "Import-Workday", "parameters": [ { "in": "body", "name": "body", "schema": { "items": { "$ref": "#/definitions/bulk-user-create" }, "type": "array" } } ], "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/job-id" } } }, "security": [ { "x-api-key": [] } ], "summary": "Workday Import" } }, "/workdays/{workday_id}/workers": { "get": { "description": "This endpoint will return all of the data in your WorkDay Custom Report that has been associated with your WorkDay Instance in JumpCloud.\n\n##### Sample Request\n\n```\ncurl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/workers \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n -H 'x-api-key: {API_KEY}'\n\n\n```", "operationId": "List-WorkdayWorker", "parameters": [ { "required": false, "default": 10, "description": "The number of records to return at once. Limited to 100.", "in": "query", "name": "limit", "type": "integer" }, { "required": false, "default": 0, "minimum": 0, "description": "The offset into the records to return.", "in": "query", "name": "skip", "type": "integer" }, { "required": false, "default": [], "description": "The comma separated fields used to sort the collection.\nDefault sort is ascending, prefix with `-` to sort descending.\n", "in": "query", "items": { "type": "string" }, "name": "sort", "type": "array" } ], "responses": { "200": { "description": "", "examples": { "application/json": [ { "lastName": "sint dolore Excepteur ad" }, { "attributes": {}, "email": "nostrud tempor anim ips", "firstName": "et ad", "username": "Excepteur culpa nulla aliqua" }, { "attributes": {}, "email": "veniam ullamco" }, {}, { "lastName": "do" } ] }, "schema": { "items": { "$ref": "#/definitions/workday-worker" }, "type": "array" } } }, "security": [ { "x-api-key": [] } ], "summary": "List Workday Workers" }, "parameters": [ { "in": "path", "name": "workday_id", "required": true, "type": "string" } ] } }, "produces": [ "application/json" ], "responses": { "trait:standardErrors:400": { "description": "", "schema": { "$ref": "#/definitions/errorresponse" } }, "trait:standardErrors:401": { "description": "", "schema": { "$ref": "#/definitions/errorresponse" } }, "trait:standardErrors:403": { "description": "", "schema": { "$ref": "#/definitions/errorresponse" } }, "trait:standardErrors:404": { "description": "", "schema": { "$ref": "#/definitions/errorresponse" } }, "trait:standardErrors:409": { "description": "", "schema": { "$ref": "#/definitions/errorresponse" } }, "trait:standardErrors:500": { "description": "", "schema": { "$ref": "#/definitions/errorresponse" } } }, "schemes": [ "https" ], "securityDefinitions": { "x-api-key": { "in": "header", "name": "x-api-key", "type": "apiKey" } }, "swagger": "2.0" } |