JumpCloud

the jumpcloud connector allows for streamlined user and system management through automated tasks, enhancing security and operational efficiency jumpcloud is a comprehensive cloud directory platform that centralizes and simplifies identity, device, and access management this connector enables swimlane turbine users to automate critical user and system management tasks within jumpcloud, such as user creation, password expiration, system locking, and group associations by integrating with jumpcloud, security teams can streamline their identity management processes, enforce security policies, and rapidly respond to security events across their digital environment jumpcloud's open directory platform makes it possible to unify your technology stack across identity, access, and device management, in a cost effective manner that doesn't sacrifice security or functionality limitations none to date supported versions jumpcloud currently utilizes two versions of apis depending on the type of integration, it may be required to use both v1 and v2 apis additional docs api documentations https //docs jumpcloud com/api/1 0/index html https //docs jumpcloud com/api/2 0/index html configuration prerequisites to effectively utilize the jumpcloud connector within the swimlane turbine platform, ensure you have the following prerequisites api key authentication url the endpoint url for the jumpcloud api api key your unique api key provided by jumpcloud for authentication authentication methods api key authentication setup instructions log into the https //console jumpcloud com/ go to the username drop down located in the top right of the console retrieve your api key from api settings setup document reference https //docs jumpcloud com/api/1 0/index html#section/overview/api best practices troubleshooting tips in order to revoke access with the current api key, simply reset your api key this will render all calls using the previous api key inaccessible document reference for https //docs jumpcloud com/api/1 0/index html#section/api key/recycling or resetting your api key capabilities jumpcloud connector provides the following capabilities add or remove system to user add or remove user group to system group add or remove user to ldap add or remove user to user group create user delete a system user expire a system user's password get user details get users list all systems list all system groups list all system users list all user groups list ldap servers list system insights apps and so on add or remove system to user this endpoint allows you to manage the direct associations of a user the scope is only to "users" a direct association can be a non homogeneous relationship between 2 different objects, for example users and systems more details https //docs jumpcloud com/api/2 0/index html#tag/graph/operation/graph userassociationspost add or remove user group to system group this endpoint allows you to manage the direct associations of a system group a direct association can be a non homogeneous relationship between 2 different objects, for example system groups and users the scopes are "groups","groups self" more details https //docs jumpcloud com/api/2 0/index html#tag/graph/operation/graph systemgroupassociationspost add or remove user to ldap this endpoint allows you to manage the direct associations of a ldap server a direct association can be a non homogeneous relationship between 2 different objects, for example ldap and users the scope is only to "directories" more details https //docs jumpcloud com/api/2 0/index html#tag/graph/operation/graph ldapserverassociationspost add or remove user to user group this endpoint allows you to manage the user members of a user group the scope is only to "groups" more details https //docs jumpcloud com/api/2 0/index html#tag/graph/operation/graph usergroupmemberspost create user this endpoint allows you to create a new system user the scope is only to "users" default user state the state of the user can be explicitly passed in or omitted if state is omitted from the request, then the user will get created using the value returned from the get an organization endpoint the default user state for manually created users is stored in settings newsystemuserstatedefaults manualentry these default state values can be changed in the admin portal settings or by using the update an organization endpoint for more details https //docs jumpcloud com/api/1 0/index html#tag/systemusers/operation/systemusers post delete a system user this endpoint allows you to delete a particular system user the scope is only to "users" more details https //docs jumpcloud com/api/1 0/index html#tag/systemusers/operation/systemusers delete expire a system user's password this endpoint allows you to expire a user's password the scope is only to "users" more details https //docs jumpcloud com/api/1 0/index html#tag/systemusers/operation/systemusers expire get user details get user details by id scopes are "passwordmanager","passwordmanager readonly" more details https //docs jumpcloud com/api/2 0/index html#tag/password manager/operation/userservice getuserdetailsbyid get users get user details scopes are "passwordmanager","passwordmanager readonly" more details https //docs jumpcloud com/api/2 0/index html#tag/password manager/operation/userservice getallusers list all systems this endpoint returns all systems scopes are "systems","systems readonly" more details https //docs jumpcloud com/api/1 0/index html#tag/systems/operation/systems list list all system groups this endpoint returns all system groups scopes are "groups","groups readonly" kindly check the parameters format https //docs jumpcloud com/api/2 0/index html#tag/system groups/operation/groups system list list all system users list all system users scopes are "commandrunner legacy","users","users readonly" kindly check the parameters format https //docs jumpcloud com/api/1 0/index html#tag/systemusers/operation/systemusers list list all user groups this endpoint returns all systems scopes are "groups","groups readonly" kindly check the parameters format https //docs jumpcloud com/api/2 0/index html#tag/user groups/operation/groups user list list ldap servers this endpoint returns the object ids of your ldap servers scopes are "directories","directories readonly" kindly check the parameters format https //docs jumpcloud com/api/2 0/index html#tag/ldap servers/operation/ldapservers list list system insights apps lists all apps for macos devices for windows devices, use list system insights programs scopes are "systeminsights readonly" more details https //docs jumpcloud com/api/2 0/index html#tag/system insights/operation/systeminsights list apps lock a system this endpoint allows you to run the lock command on the specified device if a device is offline, the command will be run when the device becomes available only supported on linux and windows devices use apple mdm security commands for macos devices scopes are "systems" more details https //docs jumpcloud com/api/1 0/index html#tag/systems/operation/systems commandbuiltinlock unlock a system user this endpoint allows you to unlock a user's account scopes are "users" more details https //docs jumpcloud com/api/1 0/index html#tag/systemusers/operation/systemusers unlock configurations jumpcloud api key authentication authenticates using an api key configuration parameters parameter description type required url a url to the target host string required x api key api key string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions add or remove system to user adds or removes systems to a user's profile in jumpcloud, requiring user id and system attributes such as id, op, and type endpoint url /api/v2/users/{{user id}}/associations method post input argument name type required description path parameters user id string required the objectid of the user for whom the association is being managed headers object optional http headers for the request headers x org id string optional organization id for the request id string optional the objectid of the graph object being added or removed as an association op string optional this parameter specifies the operation to be performed on the graph connection type string optional this parameter defines the type of target to which a user can be associated attributes object optional the graph attributes that provide additional details about the association attributes sudo object required attributes related to sudo permissions for the user attributes sudo enabled boolean required a boolean value indicating whether sudo is enabled for the user if true, the user has sudo privileges attributes sudo withoutpassword boolean required a boolean value indicating whether the user can use sudo without a password if true, the user can execute sudo commands without entering a password input example {"path parameters" {"user id" "string"},"headers" {"x org id" "string"},"id" "12345678 1234 1234 1234 123456789abc","op" "string","type" "string","attributes" {"sudo" {"enabled"\ true,"withoutpassword"\ true}}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 204,"response headers" {"content length" "140","content type" "application/json","date" "mon, 28 oct 2024 20 37 23 gmt"},"reason" "ok","json body" {}} add or remove user group to system group add or remove a user group to/from a system group in jumpcloud by specifying the group id, operation (op), and object id (id) endpoint url /api/v2/systemgroups/{{group id}}/associations method post input argument name type required description path parameters group id string required the objectid of the system group this is a unique identifier for the system group you are targeting for association management headers object optional http headers for the request headers x org id string optional organization id for the request op string optional this parameter specifies the operation to be performed on the association type string optional this parameter defines the type of object that is being associated with the system group id string optional the objectid of the graph object being added or removed as an association this is a unique identifier for the object that is being associated with the system group it is necessary to specify which object is being targeted for the association operation attributes object optional additional attributes for the association input example {"path parameters" {"group id" "string"},"headers" {"x org id" "string"},"op" "string","type" "string","id" "12345678 1234 1234 1234 123456789abc","attributes" {}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 204,"response headers" {"content length" "140","content type" "application/json","date" "mon, 28 oct 2024 20 37 23 gmt"},"reason" "ok","json body" {}} add or remove user to ldap associates or dissociates a user with an ldap server in jumpcloud using the server id, operation type, and user id endpoint url /api/v2/ldapservers/{{ldapserver id}}/associations method post input argument name type required description path parameters ldapserver id string required the objectid of the ldap server which is required to identify the specific ldap server for which the associations are being managed this identifier can be obtained from the console settings and is crucial for directing the request to the correct server headers object optional the headers for the request headers x org id string optional organization id for the request op string optional this parameter specifies the operation to be performed on the graph connection type string optional this parameter defines the target type that the ldap server can be associated with id string optional the objectid of the graph object being added or removed as an association this id is necessary to identify the specific user or user group that is being associated with or disassociated from the ldap server attributes object optional this object contains additional graph attributes that may be required for the association it allows for the inclusion of any extra properties that might be necessary for the operation input example {"path parameters" {"ldapserver id" "string"},"headers" {"x org id" "string"},"op" "string","type" "string","id" "12345678 1234 1234 1234 123456789abc","attributes" {}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 204,"response headers" {"content length" "140","content type" "application/json","date" "mon, 28 oct 2024 20 37 23 gmt"},"reason" "ok","json body" {}} add or remove user to user group add or remove a user to/from a jumpcloud user group using the group id, operation (op), type, and user id endpoint url /api/v2/usergroups/{{group id}}/members method post input argument name type required description path parameters group id string required the unique identifier of the user group headers object optional http headers for the request headers x org id string optional the unique identifier of the organization in jumpcloud op string optional this parameter specifies the operation to be performed on the user group's members operation is used to modify existing user details within the group type string optional this parameter indicates the type of member being managed within the user group this is a required field and helps the api understand the context of the operation id string optional the objectid of the user being added to or removed from the user group the id is necessary for the api to accurately perform the specified operation on the correct user input example {"path parameters" {"group id" "string"},"headers" {"x org id" "string"},"op" "string","type" "string","id" "12345678 1234 1234 1234 123456789abc"} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 204,"response headers" {"content length" "140","content type" "application/json","date" "mon, 28 oct 2024 20 37 23 gmt"},"reason" "ok","json body" {}} create user creates a new user in jumpcloud using the provided username and email, and returns the user's details endpoint url /api/systemusers method post input argument name type required description headers object optional http headers for the request headers x org id string optional the organization id parameters fullvalidationdetails string optional pass this query parameter when a client wants all validation errors to be returned with a detailed error response for the form field specified the current form fields are allowed password password validation flag use the password validation flag to receive details on a possible bad request response "?fullvalidationdetails=password" without the flag, default behavior will be a normal 400 with only a single validation string error expected behavior is clients can expect a list of validation error mappings for the validation query field in the details provided on the response account locked boolean optional account locked status activated boolean optional account activated status addresses array optional address details for the user addresses country string optional country addresses extendedaddress string optional extended address addresses locality string optional locality addresses pobox string optional post office box addresses postalcode string optional postal code addresses region string optional region addresses streetaddress string optional street address addresses type string optional address type allow public key boolean optional allow public key alternateemail string optional alternate email attributes array optional attributes attributes name string optional attribute name attributes value string optional value string should <= 1024 characters company string optional company costcenter string optional cost center department string optional department description string optional description string value should <= 1024 characters disabledevicemaxloginattempts boolean optional parameter for create user displayname string optional displayname string value should <= 1024 characters input example {"headers" {"x org id" "string"},"parameters" {"fullvalidationdetails" "string"},"account locked"\ true,"activated"\ true,"addresses" \[{"country" "string","extendedaddress" "string","locality" "string","pobox" "string","postalcode" "string","region" "string","streetaddress" "string","type" "string"}],"allow public key"\ true,"alternateemail" "string","attributes" \[{"name" "example name","value" "string"}],"company" "string","costcenter" "string","department" "string","description" "string","disabledevicemaxloginattempts"\ true,"displayname" "example name","email" "user\@example com","employeeidentifier" "string","employeetype" "string","enable managed uid"\ true,"enable user portal multifactor"\ true,"external dn" "string","external password expiration date" "string","external source type" "string","externally managed"\ true,"firstname" "example name","jobtitle" "string","lastname" "example name","ldap binding user"\ true,"location" "string","managedappleid" "string","manager" "string","mfa" {"configured"\ true,"exclusion"\ true,"exclusiondays" 123,"exclusionuntil" "string"},"middlename" "example name","password" "string","password never expires"\ true,"passwordless sudo"\ true,"phonenumbers" \[{"number" "string","type" "string"}],"public key" "string","recoveryemail" {"address" "string"},"relationships" \[{"type" "string","value" "string"}],"restrictedfields" \[{"field" "string","id" "12345678 1234 1234 1234 123456789abc","type" "string"}],"samba service user"\ true,"state" "string","sudo"\ true,"suspended"\ true,"tags" \["string"],"unix guid" 123,"unix uid" 123,"username" "example name"} output parameter type description status code number http status code of the response reason string response reason phrase id string unique identifier account locked boolean output field account locked account locked date string date value activated boolean output field activated addresses array output field addresses addresses country string output field addresses country addresses extendedaddress string output field addresses extendedaddress addresses id string unique identifier addresses locality string output field addresses locality addresses pobox string output field addresses pobox addresses postalcode string output field addresses postalcode addresses region string output field addresses region addresses streetaddress string output field addresses streetaddress addresses type string type of the resource admin object output field admin admin id string unique identifier allow public key boolean output field allow public key alternateemail string output field alternateemail attributes array output field attributes attributes name string name of the resource attributes value string value for the parameter badloginattempts number output field badloginattempts company string output field company output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 28 oct 2024 20 37 23 gmt"},"reason" "ok","json body" {" id" "string","account locked"\ true,"account locked date" "string","activated"\ true,"addresses" \[{}],"admin" {"id" "string"},"allow public key"\ true,"alternateemail" "string","attributes" \[{}],"badloginattempts" 0,"company" "string","costcenter" "string","created" "string","creationsource" "string","department" "string"}} delete a system user removes a specified system user from jumpcloud using the user's unique id provided in the path parameters endpoint url /api/systemusers/{{id}} method delete input argument name type required description path parameters id string required unique identifier for the system user parameters cascade manager string optional this is an optional flag that can be enabled on the delete call, delete /systemusers/{id}?cascade manager=null this parameter will clear the manager attribute on all direct reports and then delete the account headers object optional the headers to be included in the request headers x org id string optional organization id for the request input example {"path parameters" {"id" "12345678 1234 1234 1234 123456789abc"},"parameters" {"cascade manager" "string"},"headers" {"x org id" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase id string unique identifier account locked boolean output field account locked account locked date string date value activated boolean output field activated addresses array output field addresses addresses country string output field addresses country addresses extendedaddress string output field addresses extendedaddress addresses id string unique identifier addresses locality string output field addresses locality addresses pobox string output field addresses pobox addresses postalcode string output field addresses postalcode addresses region string output field addresses region addresses streetaddress string output field addresses streetaddress addresses type string type of the resource admin object output field admin admin id string unique identifier allow public key boolean output field allow public key alternateemail string output field alternateemail attributes array output field attributes attributes name string name of the resource attributes value string value for the parameter badloginattempts number output field badloginattempts company string output field company output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 21 oct 2024 20 37 23 gmt"},"reason" "ok","json body" {" id" "string","account locked"\ true,"account locked date" "string","activated"\ true,"addresses" \[{}],"admin" {"id" "string"},"allow public key"\ true,"alternateemail" "string","attributes" \[{}],"badloginattempts" 0,"company" "string","costcenter" "string","created" "string","creationsource" "string","department" "string"}} expire a system users password initiates a password expiration for a specified system user in jumpcloud using the user's unique id endpoint url /api/systemusers/{{id}}/expire method post input argument name type required description path parameters id string required unique identifier of the user headers object optional the headers of the request headers x org id string optional organization id for the request input example {"path parameters" {"id" "12345678 1234 1234 1234 123456789abc"},"headers" {"x org id" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 21 oct 2024 20 37 23 gmt"},"reason" "ok","json body" {}} get user details retrieve detailed information for a specified user in jumpcloud by utilizing the unique userid endpoint url /api/v2/passwordmanager/users/{{userid}} method get input argument name type required description path parameters userid string required user id/employee id input example {"path parameters" {"userid" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase apps array output field apps apps appversion string output field apps appversion apps osid number unique identifier cloudbackuprestores object output field cloudbackuprestores cloudbackuprestores approved number output field cloudbackuprestores approved cloudbackuprestores requested number output field cloudbackuprestores requested compromisedpasswords number output field compromisedpasswords createdat string output field createdat email string output field email employeeuuid string unique identifier externalid string unique identifier groups array output field groups groups createdat string output field groups createdat groups displayname string name of the resource groups externalid string unique identifier groups id string unique identifier groups name string name of the resource groups updatedat string output field groups updatedat groups uuid string unique identifier id string unique identifier itemscount number count value name string name of the resource oldpasswords number output field oldpasswords output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "wed, 6 nov 2024 20 37 23 gmt"},"reason" "ok","json body" {"apps" \[{}],"cloudbackuprestores" {"approved" 0,"requested" 0},"compromisedpasswords" 0,"createdat" "string","email" "string","employeeuuid" "string","externalid" "string","groups" \[{}],"id" "string","itemscount" 0,"name" "string","oldpasswords" 0,"passwordscount" 0,"passwordsscore" 0,"reusedpasswords" 0}} get users retrieves a comprehensive list of user accounts from jumpcloud, detailing each user's information endpoint url /api/v2/passwordmanager/users method get input argument name type required description parameters search string optional search term for filtering users parameters skip number optional number of records to skip parameters limit number optional maximum number of records to return parameters sort string optional sort order of the results parameters filter array optional filter conditions for the query input example {"parameters" {"search" "string","skip" 123,"limit" 123,"sort" "string","filter" \["string"]}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results apps array result of the operation results apps appversion string result of the operation results apps osid number unique identifier results cloudbackuprestores object result of the operation results cloudbackuprestores approved number result of the operation results cloudbackuprestores requested number result of the operation results email string result of the operation results employeeuuid string unique identifier results externalid string unique identifier results groups array result of the operation results groups createdat string result of the operation results groups displayname string name of the resource results groups externalid string unique identifier results groups id string unique identifier results groups name string name of the resource results groups updatedat string result of the operation results groups uuid string unique identifier results id string unique identifier results itemscount number result of the operation results name string name of the resource results oldpasswords number result of the operation results passwordscount number result of the operation output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 21 oct 2024 20 37 23 gmt"},"reason" "ok","json body" {"results" \[{}],"totalcount" 0}} list all system groups retrieve all system groups from jumpcloud to provide a comprehensive overview of group configurations endpoint url /api/v2/systemgroups method get input argument name type required description parameters filter array optional filter to apply to the query filter structure field = populate with a valid field from an endpoint response operator = supported operators are eq, ne, gt, ge, lt, le, between, search, in note v1 operators differ from v2 operators value = populate with the value you want to search for is case sensitive supports wild cards parameters limit number optional the number of records to return at once limited to 100 parameters skip number optional offset into the records to return parameters sort array optional the comma separated fields used to sort the collection default sort is ascending, prefix with to sort descending parameters fields array optional the comma separated fields included in the returned records if omitted, the default list of fields will be returned headers object optional the headers to be included in the request headers x org id string optional organization id for the request input example {"parameters" {"filter" "name\ eq\ test+group"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 21 oct 2024 20 37 23 gmt"},"reason" "ok","json body" \[{"id" "000000"},{"type" "system group"},{"id" "000000","name" "group1"}]} list all system users retrieve a complete list of all system users from jumpcloud, including their details and attributes endpoint url /api/systemusers method get input argument name type required description parameters limit number optional the number of records to return at once parameters skip number optional the offset into the records to return parameters sort string optional the space separated fields used to sort the collection default sort is ascending, prefix with to sort descending parameters fields string optional the space separated fields included in the returned records if omitted the default list of fields will be returned parameters filter string optional a filter to apply to the query see the supported operators below for more complex searches, see the related /search/ endpoints, e g /search/systems filter structure (e g department $eq \ finance ) parameters search string optional a nested object containing a searchterm string or array of strings and a list of fields to search on headers object optional http headers for the request headers x org id string optional the id of the organization that owns the records being queried input example {"parameters" {"limit" 10,"skip" 0,"sort" " ","fields" " ","filter" "department $eq\ finance","search" " "},"headers" {"x org id" " "}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results id string unique identifier results account locked boolean result of the operation results account locked date string result of the operation results activated boolean result of the operation results addresses array result of the operation results addresses country string result of the operation results addresses extendedaddress string result of the operation results addresses id string unique identifier results addresses locality string result of the operation results addresses pobox string result of the operation results addresses postalcode string result of the operation results addresses region string result of the operation results addresses streetaddress string result of the operation results addresses type string type of the resource results admin object result of the operation results admin id string unique identifier results allow public key boolean result of the operation results alternateemail string result of the operation results attributes array result of the operation results attributes name string name of the resource results attributes value string value for the parameter results badloginattempts number result of the operation output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 21 oct 2024 20 37 23 gmt"},"reason" "ok","json body" {"results" \[{}],"totalcount" 0}} list all systems retrieve a comprehensive overview of all devices registered with jumpcloud, including details and status endpoint url /api/systems method get input argument name type required description parameters fields string optional use a space seperated string of field parameters to include the data in the response if omitted, the default list of fields will be returned parameters limit number optional number of records to return at once limited to 100 parameters search string optional a nested object containing a searchterm string or array of strings and a list of fields to search on parameters skip number optional offset into the records to return parameters sort string optional use space separated sort parameters to sort the collection default sort is ascending prefix with to sort descending parameters filter string optional filter to apply to the query filter structure field = populate with a valid field from an endpoint response operator = supported operators are $eq, $in, $ne, $nin, $gt, $gte, $lt, $lte, $sw note v1 operators differ from v2 operators for v1 operators, excluding the $ will result in undefined behavior and is not recommended value = populate with the value you want to search for case sensitive check document in readme for more examples headers object optional the headers to be included in the request headers x org id string optional organization id for the request input example {"parameters" {"filter" "department $eq\ finance"}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results id string unique identifier results active boolean result of the operation results agentversion string result of the operation results allowmultifactorauthentication boolean result of the operation results allowpublickeyauthentication boolean result of the operation results allowsshpasswordauthentication boolean result of the operation results allowsshrootlogin boolean result of the operation results amazoninstanceid string unique identifier results arch string result of the operation results archfamily string result of the operation results azureadjoined boolean result of the operation results builtincommands array result of the operation results builtincommands name string name of the resource results builtincommands type string type of the resource results connectionhistory array result of the operation results created string result of the operation results description string result of the operation results desktopcapable boolean result of the operation results displaymanager string result of the operation results displayname string name of the resource results domaininfo object result of the operation results domaininfo domainname string name of the resource output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 21 oct 2024 20 37 23 gmt"},"reason" "ok","json body" {"results" \[{}],"totalcount" 0}} list all user groups retrieve all user groups and memberships from jumpcloud, providing a complete overview of group associations endpoint url /api/v2/usergroups method get input argument name type required description parameters fields array optional the comma separated fields included in the returned records if omitted, the default list of fields will be returned parameters filter array optional filter to apply to the query filter structure field = populate with a valid field from an endpoint response operator = supported operators are eq, ne, gt, ge, lt, le, between, search, in note v1 operators differ from v2 operators value = populate with the value you want to search for is case sensitive supports wild cards parameters limit number optional the number of records to return at once limited to 100 parameters skip number optional offset into the records to return parameters sort array optional fields used to sort the collection default sort is ascending, prefix with to sort descending headers object optional the headers to be included in the request headers x org id string optional organization id for the request input example {"parameters" {"filter" "name\ eq\ test+group"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 21 oct 2024 20 37 23 gmt"},"reason" "ok","json body" {}} list ldap servers retrieve an overview of available ldap server object ids from jumpcloud endpoint url /api/v2/ldapservers method get input argument name type required description parameters fields array optional the comma separated fields included in the returned records if omitted, the default list of fields will be returned parameters filter array optional filter to apply to the query filter structure field = populate with a valid field from an endpoint response operator = supported operators are eq, ne, gt, ge, lt, le, between, search, in note v1 operators differ from v2 operators value = populate with the value you want to search for is case sensitive supports wild cards parameters limit number optional number of records to return at once limited to 100 parameters skip number optional offset into the records to return parameters sort array optional the comma separated fields used to sort the collection default sort is ascending, prefix with to sort descending headers object optional the headers to be included in the request headers x org id string optional organization id for the request input example {"parameters" {"filter" "name\ eq\ test+ldap"}} output parameter type description status code number http status code of the response reason string response reason phrase id string unique identifier name string name of the resource userlockoutaction string output field userlockoutaction userpasswordexpirationaction string output field userpasswordexpirationaction output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 21 oct 2024 20 37 23 gmt"},"reason" "ok","json body" {"id" "string","name" "string","userlockoutaction" "disable","userpasswordexpirationaction" "disable"}} list system insights apps retrieve a list of applications installed on macos devices via the jumpcloud api endpoint url /api/v2/systeminsights/apps method get input argument name type required description parameters skip number optional offset into the records to return parameters sort array optional the comma separated fields used to sort the collection default sort is ascending, prefix with to sort descending e g, sort by single field sort=field sort descending by single field sort= field sort by multiple fields sort=field1, field2,field3 parameters filter array optional supported operators are eq, in e g, filter for single value filter=field\ eq \ value filter for any value in a list (note "pipe" character separating values) filter=field\ in \ value1 value2 value3 parameters limit number optional number of records to return headers object optional the headers of the request headers x org id string optional organization identifier that can be obtained from console settings input example {"parameters" {"filter" "field\ eq\ value"}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results applescript enabled string result of the operation results bundle executable string result of the operation results bundle identifier string unique identifier results bundle name string name of the resource results bundle package type string type of the resource results bundle short version string result of the operation results bundle version string result of the operation results category string result of the operation results collection time string result of the operation results compiler string result of the operation results copyright string result of the operation results development region string result of the operation results display name string name of the resource results element string result of the operation results environment string result of the operation results info string string result of the operation results last opened time number result of the operation results minimum system version string result of the operation results name string name of the resource results path string result of the operation results system id string unique identifier output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 21 oct 2024 20 37 23 gmt"},"reason" "ok","json body" {"results" \[{}]}} lock a system executes an immediate or queued command to lock a specified device in jumpcloud using the system id endpoint url /api/systems/{{system id}}/command/builtin/lock method post input argument name type required description path parameters system id string required unique identifier for the system headers object optional the headers of the request headers x org id string optional organization id for the request input example {"path parameters" {"system id" "string"},"headers" {"x org id" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 201,"response headers" {"content length" "140","content type" "application/json","date" "mon, 21 oct 2024 20 37 23 gmt"},"reason" "ok","json body" {}} unlock a system user unlocks a jumpcloud user account specified by the unique identifier (id) provided in the path parameters endpoint url /api/users/{{id}}/unlock method post input argument name type required description path parameters id string required unique identifier of the user headers object optional the headers to be included in the request headers x org id string optional organization id for the request input example {"path parameters" {"id" "12345678 1234 1234 1234 123456789abc"},"headers" {"x org id" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 21 oct 2024 20 37 23 gmt"},"reason" "ok","json body" {}} response headers header description example content length the length of the response body in bytes 140 content type the media type of the resource application/json date the date and time at which the message was originated wed, 6 nov 2024 20 37 23 gmt