Skip to main content

​
Sample Request​

curl -X GET https://console.jumpcloud.com/api/systemusers \  -H 'Accept: application/json' \  -H 'Content-Type: application/json' \  -H 'x-api-key: {API_KEY}'

​
Basic Parameters​

ParameterDescription
FieldsThe space separated fields included in the returned records.If omitted the default list of fields will be returned.
FilterA filter to apply to the query. See the supported operators below. For more complex searches,see the related /search/<domain> endpoints,e.g. /search/systems.Filter structure: <field>:<operator>:<value>.field = Populate with a valid field from an endpoint response.operator = Supported operators are:- $eq (equals)
  • $ne (does not equal)
  • $gt (is greater than)
  • $gte (is greater than or equal to)
  • $lt (is less than)
  • $lte (is less than or equal to)*Note: v1 operators differ from v2 operators.**Note: For v1 operators, excluding the $ will result in undefined behavior.*value = Populate with the value you want to search for. Is case sensitive.Examples- GET /users?filter=username:$eq:testuser
  • GET /systemusers?filter=password_expiration_date:$lte:2021-10-24
  • GET /systemusers?filter=department:$ne:Accounting
  • GET /systems?filter[0]=firstname:$eq:foo&filter[1]=lastname:$eq:bar - this willAND the filters together.
  • GET /systems?filter[or][0]=lastname:$eq:foo&filter[or][1]=lastname:$eq:bar - this willOR the filters together. | | Search | A nested object containing a searchTerm string or array of strings and a list of fields to search on. | | Sort | The space separated fields used to sort the collection.Default sort is ascending, prefix with - to sort descending. |

​
Advanced Parameters​

ParameterDescription
LimitThe number of records to return at once.
Organization IDOrganization identifier that can be obtained from console settings.
SkipThe offset into the records to return.

​
Example Output​

{    "results": [        {            "_id": "string",            "account_locked": true,            "account_locked_date": "string",            "activated": true,            "addresses": [                {                    "country": "string",                    "extendedAddress": "string",                    "id": "string",                    "locality": "string",                    "poBox": "string",                    "postalCode": "string",                    "region": "string",                    "streetAddress": "string",                    "type": "string"                }            ],            "allow_public_key": true,            "alternateEmail": "string",            "attributes": [                {                    "name": "string",                    "value": "string"                }            ],            "badLoginAttempts": 0,            "company": "string",            "costCenter": "string",            "created": "string",            "creationSource": "string",            "department": "string",            "description": "string",            "disableDeviceMaxLoginAttempts": true,            "displayname": "string",            "email": "string",            "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": "string",            "jobTitle": "string",            "lastname": "string",            "ldap_binding_user": true,            "location": "string",            "managedAppleId": "string",            "manager": "string",            "mfa": {                "configured": true,                "exclusion": true,                "exclusionDays": 1,                "exclusionUntil": "2019-08-24T14:15:22Z"            },            "mfaEnrollment": {                "overallStatus": "NOT_ENROLLED",                "pushStatus": "NOT_ENROLLED",                "totpStatus": "NOT_ENROLLED",                "webAuthnStatus": "NOT_ENROLLED"            },            "middlename": "string",            "organization": "string",            "password_expiration_date": "string",            "password_expired": true,            "password_never_expires": true,            "passwordless_sudo": true,            "phoneNumbers": [                {                    "id": "string",                    "number": "string",                    "type": "string"                }            ],            "public_key": "string",            "recoveryEmail": {                "address": "string",                "verified": true,                "verifiedAt": "string"            },            "relationships": [                {                    "type": "string",                    "value": "string"                }            ],            "samba_service_user": true,            "ssh_keys": [                {                    "_id": "string",                    "create_date": "string",                    "name": "string",                    "public_key": "string"                }            ],            "state": "STAGED",            "sudo": true,            "suspended": true,            "tags": [                "string"            ],            "totp_enabled": true,            "unix_guid": 1,            "unix_uid": 1,            "username": "string"        }    ],    "totalCount": 0}

​
Workflow Library Example​

List System Users with Jumpcloud and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop