Download OpenAPI specification:Download
JumpCloud's V1 API. This set of endpoints allows JumpCloud customers to manage commands, systems, and system users.
Read the linked Help Article below for guidance on retrying failed requests to JumpCloud's REST API, as well as best practices for structuring subsequent retry requests. Customizing retry mechanisms based on these recommendations will increase the reliability and dependability of your API calls.
Covered topics include:
To locate your API Key:
This API key is associated to the currently logged in administrator. Other admins will have different API keys.
WARNING Please keep this API key secret, as it grants full access to any data accessible via your JumpCloud console account.
You can also reset your API key in the same location in the JumpCloud Admin Console.
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.
Your API key will be passed in as a header with the header name "x-api-key".
curl -H "x-api-key: [YOUR_API_KEY_HERE]" "https://console.jumpcloud.com/api/systemusers"
JumpCloud System Context Authorization is an alternative way to authenticate with a subset of JumpCloud's REST APIs. Using this method, a system can manage its information and resource associations, allowing modern auto provisioning environments to scale as needed.
Notes:
JumpCloud System Context Authorization can be used in conjunction with Systems endpoints found in the V1 API and certain System Group endpoints found in the v2 API.
/api/systems/{system_id}
| DELETE
/api/v2/systems/{system_id}/associations
| POST
/api/v2/systemgroups/{group_id}/members
| POST
If endpoints other than those described above are called using the System Context API, the server will return a 401
response.
To allow for secure access to our APIs, you must authenticate each API request.
JumpCloud System Context Authorization uses HTTP Signatures to authenticate API requests.
The HTTP Signatures sent with each request are similar to the signatures used by the Amazon Web Services REST API.
To help with the request-signing process, we have provided an example bash script. This example API request simply requests the entire system record. You must be root, or have permissions to access the contents of the /opt/jc
directory to generate a signature.
Here is a breakdown of the example script with explanations.
First, the script extracts the systemKey from the JSON formatted /opt/jc/jcagent.conf
file.
#!/bin/bash
conf="`cat /opt/jc/jcagent.conf`"
regex="systemKey\":\"(\w+)\""
if [[ $conf =~ $regex ]] ; then
systemKey="${BASH_REMATCH[1]}"
fi
Then, the script retrieves the current date in the correct format.
now=`date -u "+%a, %d %h %Y %H:%M:%S GMT"`;
Next, we build a signing string to demonstrate the expected signature format. The signed string must consist of the request-line and the date header, separated by a newline character.
signstr="GET /api/systems/${systemKey} HTTP/1.1\ndate: ${now}"
The next step is to calculate and apply the signature. This is a two-step process:
printf "$signstr" | openssl dgst -sha256 -sign /opt/jc/client.key
| openssl enc -e -a | tr -d '\n'
The combined steps above result in:
signature=`printf "$signstr" | openssl dgst -sha256 -sign /opt/jc/client.key | openssl enc -e -a | tr -d '\n'` ;
Finally, we make sure the API call sending the signature has the same Authorization and Date header values, HTTP method, and URL that were used in the signing string.
curl -iq \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Date: ${now}" \
-H "Authorization: Signature keyId=\"system/${systemKey}\",headers=\"request-line date\",algorithm=\"rsa-sha256\",signature=\"${signature}\"" \
--url https://console.jumpcloud.com/api/systems/${systemKey}
All PUT and POST methods should use the HTTP Content-Type header with a value of 'application/json'. PUT methods are used for updating a record. POST methods are used to create a record.
The following example demonstrates how to update the displayName
of the system.
signstr="PUT /api/systems/${systemKey} HTTP/1.1\ndate: ${now}"
signature=`printf "$signstr" | openssl dgst -sha256 -sign /opt/jc/client.key | openssl enc -e -a | tr -d '\n'` ;
curl -iq \
-d "{\"displayName\" : \"updated-system-name-1\"}" \
-X "PUT" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Date: ${now}" \
-H "Authorization: Signature keyId=\"system/${systemKey}\",headers=\"request-line date\",algorithm=\"rsa-sha256\",signature=\"${signature}\"" \
--url https://console.jumpcloud.com/api/systems/${systemKey}
All results will be formatted as JSON.
Here is an abbreviated example of response output:
{
"_id": "625ee96f52e144993e000015",
"agentServer": "lappy386",
"agentVersion": "0.9.42",
"arch": "x86_64",
"displayName": "ubuntu-1204",
"firstContact": "2013-10-16T19:30:55.611Z",
"hostname": "ubuntu-1204"
...
This example demonstrates how to make an authenticated request to fetch the JumpCloud record for this system.
This example demonstrates how to make an authenticated request on system shutdown. Using an init.d script registered at run level 0, you can call the System Context API as the system is shutting down.
Instance-shutdown-initd is an example of an init.d script that only runs at system shutdown.
After customizing the instance-shutdown-initd script, you should install it on the system(s) running the JumpCloud agent.
/etc/init.d/instance-shutdown
.update-rc.d instance-shutdown defaults
. On RedHat/CentOS systems, run chkconfig --add instance-shutdown
.Multi-Tenant Organization API Headers are available for JumpCloud Admins to use when making API requests from Organizations that have multiple managed organizations.
The x-org-id
is a required header for all multi-tenant admins when making API requests to JumpCloud. This header will define to which organization you would like to make the request.
NOTE Single Tenant Admins do not need to provide this header when making an API request.
400
Malformed ID.400
x-org-id and Organization path ID do not match.401
ID not included for multi-tenant admin403
ID included on unsupported route.404
Organization ID Not Found.curl -X GET https://console.jumpcloud.com/api/v2/directories \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-org-id: {ORG_ID}'
As a prerequisite, your Primary Organization will need to be setup for Multi-Tenancy. This provides access to the Multi-Tenant Organization Admin Portal.
https://console.jumpcloud.com/api/organizations/
This will return all your managed organizations.curl -X GET \
https://console.jumpcloud.com/api/organizations/ \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}'
The endpoint returns all the SSO / SAML Application Templates.
curl -X GET https://console.jumpcloud.com/api/application-templates \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}'
fields | string The space separated fields included in the returned records. If omitted the default list of fields will be returned. |
limit | integer The number of records to return at once. |
skip | integer The offset into the records to return. |
sort | string The space separated fields used to sort the collection. Default sort is ascending, prefix with - to sort descending. |
filter | string A filter to apply to the query. See the supported operators below. For more complex searches,
see the related Filter structure: field = Populate with a valid field from an endpoint response. operator = Supported operators are:
Note: v1 operators differ from v2 operators. Note: For v1 operators, excluding the value = Populate with the value you want to search for. Case sensitive. Examples
|
x-org-id | string Default: |
curl --request GET \ --url 'https://console.jumpcloud.com/api/application-templates?fields=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&skip=SOME_INTEGER_VALUE&sort=SOME_STRING_VALUE&filter=SOME_STRING_VALUE' \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "results": [
- {
- "_id": "string",
- "active": true,
- "beta": true,
- "color": "",
- "config": {
- "acsUrl": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "constantAttributes": {
- "label": "string",
- "mutable": true,
- "options": null,
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": null,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": [
- {
- "name": "string",
- "readOnly": true,
- "required": true,
- "value": "string",
- "visible": true
}
], - "visible": true
}, - "databaseAttributes": {
- "position": 0
}, - "idpCertificate": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "idpEntityId": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "idpPrivateKey": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "signAssertion": {
- "label": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": true,
- "visible": true
}, - "signResponse": {
- "label": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": true,
- "visible": true
}, - "spEntityId": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "spErrorFlow": {
- "label": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": true,
- "visible": true
}
}, - "displayLabel": "string",
- "displayName": "string",
- "isConfigured": true,
- "jit": {
- "attributes": { },
- "createOnly": true
}, - "keywords": [
- "string"
], - "learnMore": "string",
- "logo": {
- "url": "string"
}, - "name": "string",
- "oidc": {
- "grantTypes": [
- "authorization_code"
], - "redirectUris": [
- "string"
], - "ssoUrl": "string",
- "tokenEndpointAuthMethod": "client_secret_basic"
}, - "provision": {
- "beta": true,
- "groups_supported": true,
- "type": "string"
}, - "sso": {
- "beta": true,
- "hidden": true,
- "idpCertExpirationAt": "2019-08-24T14:15:22Z",
- "idpCertificateUpdatedAt": "2019-08-24T14:15:22Z",
- "idpPrivateKeyUpdatedAt": "2019-08-24T14:15:22Z",
- "jit": true,
- "spCertificateUpdatedAt": "2019-08-24T14:15:22Z",
- "type": "string"
}, - "ssoUrl": "string",
- "status": "",
- "test": "string"
}
], - "totalCount": 0
}
The endpoint returns a specific SSO / SAML Application Template.
curl -X GET https://console.jumpcloud.com/api/application-templates/{id} \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}'
id required | string |
fields | string The space separated fields included in the returned records. If omitted the default list of fields will be returned. |
limit | integer The number of records to return at once. |
skip | integer The offset into the records to return. |
sort | string The space separated fields used to sort the collection. Default sort is ascending, prefix with - to sort descending. |
filter | string A filter to apply to the query. See the supported operators below. For more complex searches,
see the related Filter structure: field = Populate with a valid field from an endpoint response. operator = Supported operators are:
Note: v1 operators differ from v2 operators. Note: For v1 operators, excluding the value = Populate with the value you want to search for. Case sensitive. Examples
|
x-org-id | string Default: |
curl --request GET \ --url 'https://console.jumpcloud.com/api/application-templates/{id}?fields=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&skip=SOME_INTEGER_VALUE&sort=SOME_STRING_VALUE&filter=SOME_STRING_VALUE' \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "_id": "string",
- "active": true,
- "beta": true,
- "color": "",
- "config": {
- "acsUrl": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "constantAttributes": {
- "label": "string",
- "mutable": true,
- "options": null,
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": null,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": [
- {
- "name": "string",
- "readOnly": true,
- "required": true,
- "value": "string",
- "visible": true
}
], - "visible": true
}, - "databaseAttributes": {
- "position": 0
}, - "idpCertificate": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "idpEntityId": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "idpPrivateKey": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "signAssertion": {
- "label": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": true,
- "visible": true
}, - "signResponse": {
- "label": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": true,
- "visible": true
}, - "spEntityId": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "spErrorFlow": {
- "label": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": true,
- "visible": true
}
}, - "displayLabel": "string",
- "displayName": "string",
- "isConfigured": true,
- "jit": {
- "attributes": { },
- "createOnly": true
}, - "keywords": [
- "string"
], - "learnMore": "string",
- "logo": {
- "url": "string"
}, - "name": "string",
- "oidc": {
- "grantTypes": [
- "authorization_code"
], - "redirectUris": [
- "string"
], - "ssoUrl": "string",
- "tokenEndpointAuthMethod": "client_secret_basic"
}, - "provision": {
- "beta": true,
- "groups_supported": true,
- "type": "string"
}, - "sso": {
- "beta": true,
- "hidden": true,
- "idpCertExpirationAt": "2019-08-24T14:15:22Z",
- "idpCertificateUpdatedAt": "2019-08-24T14:15:22Z",
- "idpPrivateKeyUpdatedAt": "2019-08-24T14:15:22Z",
- "jit": true,
- "spCertificateUpdatedAt": "2019-08-24T14:15:22Z",
- "type": "string"
}, - "ssoUrl": "string",
- "status": "",
- "test": "string"
}
The endpoint returns all your SSO / SAML Applications.
curl -X GET https://console.jumpcloud.com/api/applications \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}'
fields | string The space separated fields included in the returned records. If omitted the default list of fields will be returned. |
limit | integer The number of records to return at once. |
skip | integer The offset into the records to return. |
sort | string Default: "name" The space separated fields used to sort the collection. Default sort is ascending, prefix with - to sort descending. |
filter | string A filter to apply to the query. See the supported operators below. For more complex searches,
see the related Filter structure: field = Populate with a valid field from an endpoint response. operator = Supported operators are:
Note: v1 operators differ from v2 operators. Note: For v1 operators, excluding the value = Populate with the value you want to search for. Case sensitive. Examples
|
x-org-id | string Default: |
curl --request GET \ --url 'https://console.jumpcloud.com/api/applications?fields=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&skip=SOME_INTEGER_VALUE&sort=name&filter=SOME_STRING_VALUE' \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "name": "string",
- "results": [
- {
- "_id": "string",
- "active": true,
- "beta": true,
- "color": "",
- "config": {
- "acsUrl": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "constantAttributes": {
- "label": "string",
- "mutable": true,
- "options": null,
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": null,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": [
- {
- "name": "string",
- "readOnly": true,
- "required": true,
- "value": "string",
- "visible": true
}
], - "visible": true
}, - "databaseAttributes": {
- "position": 0
}, - "idpCertificate": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "idpEntityId": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "idpPrivateKey": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "signAssertion": {
- "label": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": true,
- "visible": true
}, - "signResponse": {
- "label": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": true,
- "visible": true
}, - "spEntityId": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "spErrorFlow": {
- "label": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": true,
- "visible": true
}
}, - "created": "string",
- "databaseAttributes": [
- { }
], - "description": "string",
- "displayLabel": "string",
- "displayName": "string",
- "learnMore": "string",
- "logo": {
- "color": "",
- "url": "string"
}, - "name": "string",
- "organization": "string",
- "sso": {
- "beta": true,
- "hidden": true,
- "idpCertExpirationAt": "2019-08-24T14:15:22Z",
- "idpCertificateUpdatedAt": "2019-08-24T14:15:22Z",
- "idpPrivateKeyUpdatedAt": "2019-08-24T14:15:22Z",
- "jit": true,
- "spCertificateUpdatedAt": "2019-08-24T14:15:22Z",
- "type": "string"
}, - "ssoUrl": "string"
}
], - "totalCount": 0
}
The endpoint adds a new SSO / SAML Applications.
x-org-id | string Default: |
_id | string |
active | boolean |
beta | boolean |
color | string Enum: "" "#202D38" "#005466" "#3E8696" "#006CAC" "#0617AC" "#7C6ADA" "#D5779D" "#9E2F00" "#FFB000" "#58C469" "#57C49F" "#FF6C03" |
required | object |
created | string |
databaseAttributes | Array of objects |
description | string <= 256 characters |
displayLabel | string |
displayName | string |
learnMore | string |
object | |
name required | string |
organization | string |
object (sso) | |
ssoUrl required | string |
{- "_id": "string",
- "active": true,
- "beta": true,
- "color": "",
- "config": {
- "acsUrl": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "constantAttributes": {
- "label": "string",
- "mutable": true,
- "options": null,
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": null,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": [
- {
- "name": "string",
- "readOnly": true,
- "required": true,
- "value": "string",
- "visible": true
}
], - "visible": true
}, - "databaseAttributes": {
- "position": 0
}, - "idpCertificate": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "idpEntityId": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "idpPrivateKey": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "signAssertion": {
- "label": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": true,
- "visible": true
}, - "signResponse": {
- "label": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": true,
- "visible": true
}, - "spEntityId": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "spErrorFlow": {
- "label": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": true,
- "visible": true
}
}, - "created": "string",
- "databaseAttributes": [
- { }
], - "description": "string",
- "displayLabel": "string",
- "displayName": "string",
- "learnMore": "string",
- "logo": {
- "color": "",
- "url": "string"
}, - "name": "string",
- "organization": "string",
- "sso": {
- "beta": true,
- "hidden": true,
- "idpCertExpirationAt": "2019-08-24T14:15:22Z",
- "jit": true,
- "type": "string"
}, - "ssoUrl": "string"
}
{- "_id": "string",
- "active": true,
- "beta": true,
- "color": "",
- "config": {
- "acsUrl": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "constantAttributes": {
- "label": "string",
- "mutable": true,
- "options": null,
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": null,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": [
- {
- "name": "string",
- "readOnly": true,
- "required": true,
- "value": "string",
- "visible": true
}
], - "visible": true
}, - "databaseAttributes": {
- "position": 0
}, - "idpCertificate": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "idpEntityId": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "idpPrivateKey": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "signAssertion": {
- "label": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": true,
- "visible": true
}, - "signResponse": {
- "label": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": true,
- "visible": true
}, - "spEntityId": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "spErrorFlow": {
- "label": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": true,
- "visible": true
}
}, - "created": "string",
- "databaseAttributes": [
- { }
], - "description": "string",
- "displayLabel": "string",
- "displayName": "string",
- "learnMore": "string",
- "logo": {
- "color": "",
- "url": "string"
}, - "name": "string",
- "organization": "string",
- "sso": {
- "beta": true,
- "hidden": true,
- "idpCertExpirationAt": "2019-08-24T14:15:22Z",
- "idpCertificateUpdatedAt": "2019-08-24T14:15:22Z",
- "idpPrivateKeyUpdatedAt": "2019-08-24T14:15:22Z",
- "jit": true,
- "spCertificateUpdatedAt": "2019-08-24T14:15:22Z",
- "type": "string"
}, - "ssoUrl": "string"
}
The endpoint deletes an SSO / SAML Application.
id required | string |
x-org-id | string Default: |
curl --request DELETE \ --url https://console.jumpcloud.com/api/applications/{id} \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "_id": "string",
- "active": true,
- "beta": true,
- "color": "",
- "config": {
- "acsUrl": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "constantAttributes": {
- "label": "string",
- "mutable": true,
- "options": null,
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": null,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": [
- {
- "name": "string",
- "readOnly": true,
- "required": true,
- "value": "string",
- "visible": true
}
], - "visible": true
}, - "databaseAttributes": {
- "position": 0
}, - "idpCertificate": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "idpEntityId": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "idpPrivateKey": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "signAssertion": {
- "label": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": true,
- "visible": true
}, - "signResponse": {
- "label": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": true,
- "visible": true
}, - "spEntityId": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "spErrorFlow": {
- "label": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": true,
- "visible": true
}
}, - "created": "string",
- "databaseAttributes": [
- { }
], - "description": "string",
- "displayLabel": "string",
- "displayName": "string",
- "learnMore": "string",
- "logo": {
- "color": "",
- "url": "string"
}, - "name": "string",
- "organization": "string",
- "sso": {
- "beta": true,
- "hidden": true,
- "idpCertExpirationAt": "2019-08-24T14:15:22Z",
- "idpCertificateUpdatedAt": "2019-08-24T14:15:22Z",
- "idpPrivateKeyUpdatedAt": "2019-08-24T14:15:22Z",
- "jit": true,
- "spCertificateUpdatedAt": "2019-08-24T14:15:22Z",
- "type": "string"
}, - "ssoUrl": "string"
}
The endpoint retrieves an SSO / SAML Application.
id required | string |
x-org-id | string Default: |
curl --request GET \ --url https://console.jumpcloud.com/api/applications/{id} \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "_id": "string",
- "active": true,
- "beta": true,
- "color": "",
- "config": {
- "acsUrl": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "constantAttributes": {
- "label": "string",
- "mutable": true,
- "options": null,
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": null,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": [
- {
- "name": "string",
- "readOnly": true,
- "required": true,
- "value": "string",
- "visible": true
}
], - "visible": true
}, - "databaseAttributes": {
- "position": 0
}, - "idpCertificate": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "idpEntityId": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "idpPrivateKey": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "signAssertion": {
- "label": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": true,
- "visible": true
}, - "signResponse": {
- "label": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": true,
- "visible": true
}, - "spEntityId": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "spErrorFlow": {
- "label": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": true,
- "visible": true
}
}, - "created": "string",
- "databaseAttributes": [
- { }
], - "description": "string",
- "displayLabel": "string",
- "displayName": "string",
- "learnMore": "string",
- "logo": {
- "color": "",
- "url": "string"
}, - "name": "string",
- "organization": "string",
- "sso": {
- "beta": true,
- "hidden": true,
- "idpCertExpirationAt": "2019-08-24T14:15:22Z",
- "idpCertificateUpdatedAt": "2019-08-24T14:15:22Z",
- "idpPrivateKeyUpdatedAt": "2019-08-24T14:15:22Z",
- "jit": true,
- "spCertificateUpdatedAt": "2019-08-24T14:15:22Z",
- "type": "string"
}, - "ssoUrl": "string"
}
The endpoint updates a SSO / SAML Application. Any fields not provided will be reset or created with default values.
id required | string |
x-org-id | string Default: |
_id | string |
active | boolean |
beta | boolean |
color | string Enum: "" "#202D38" "#005466" "#3E8696" "#006CAC" "#0617AC" "#7C6ADA" "#D5779D" "#9E2F00" "#FFB000" "#58C469" "#57C49F" "#FF6C03" |
required | object |
created | string |
databaseAttributes | Array of objects |
description | string <= 256 characters |
displayLabel | string |
displayName | string |
learnMore | string |
object | |
name required | string |
organization | string |
object (sso) | |
ssoUrl required | string |
{- "_id": "string",
- "active": true,
- "beta": true,
- "color": "",
- "config": {
- "acsUrl": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "constantAttributes": {
- "label": "string",
- "mutable": true,
- "options": null,
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": null,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": [
- {
- "name": "string",
- "readOnly": true,
- "required": true,
- "value": "string",
- "visible": true
}
], - "visible": true
}, - "databaseAttributes": {
- "position": 0
}, - "idpCertificate": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "idpEntityId": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "idpPrivateKey": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "signAssertion": {
- "label": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": true,
- "visible": true
}, - "signResponse": {
- "label": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": true,
- "visible": true
}, - "spEntityId": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "spErrorFlow": {
- "label": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": true,
- "visible": true
}
}, - "created": "string",
- "databaseAttributes": [
- { }
], - "description": "string",
- "displayLabel": "string",
- "displayName": "string",
- "learnMore": "string",
- "logo": {
- "color": "",
- "url": "string"
}, - "name": "string",
- "organization": "string",
- "sso": {
- "beta": true,
- "hidden": true,
- "idpCertExpirationAt": "2019-08-24T14:15:22Z",
- "jit": true,
- "type": "string"
}, - "ssoUrl": "string"
}
{- "_id": "string",
- "active": true,
- "beta": true,
- "color": "",
- "config": {
- "acsUrl": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "constantAttributes": {
- "label": "string",
- "mutable": true,
- "options": null,
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": null,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": [
- {
- "name": "string",
- "readOnly": true,
- "required": true,
- "value": "string",
- "visible": true
}
], - "visible": true
}, - "databaseAttributes": {
- "position": 0
}, - "idpCertificate": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "idpEntityId": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "idpPrivateKey": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "signAssertion": {
- "label": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": true,
- "visible": true
}, - "signResponse": {
- "label": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": true,
- "visible": true
}, - "spEntityId": {
- "label": "string",
- "options": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "toggle": "string",
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": "string",
- "visible": true
}, - "spErrorFlow": {
- "label": "string",
- "position": 0,
- "readOnly": true,
- "required": true,
- "tooltip": {
- "template": "string",
- "variables": {
- "icon": "string",
- "message": "string"
}
}, - "type": "string",
- "value": true,
- "visible": true
}
}, - "created": "string",
- "databaseAttributes": [
- { }
], - "description": "string",
- "displayLabel": "string",
- "displayName": "string",
- "learnMore": "string",
- "logo": {
- "color": "",
- "url": "string"
}, - "name": "string",
- "organization": "string",
- "sso": {
- "beta": true,
- "hidden": true,
- "idpCertExpirationAt": "2019-08-24T14:15:22Z",
- "idpCertificateUpdatedAt": "2019-08-24T14:15:22Z",
- "idpPrivateKeyUpdatedAt": "2019-08-24T14:15:22Z",
- "jit": true,
- "spCertificateUpdatedAt": "2019-08-24T14:15:22Z",
- "type": "string"
}, - "ssoUrl": "string"
}
This endpoint returns all command results.
curl -X GET https://console.jumpcloud.com/api/commandresults \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key:{API_KEY}'
To filter command results use the Search API
fields | string Default: "" 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. |
limit | integer Default: 10 The number of records to return at once. Limited to 100. |
skip | integer >= 0 Default: 0 The offset into the records to return. |
sort | string Default: "" Use space separated sort parameters to sort the collection.
Default sort is ascending. Prefix with |
x-org-id | string Default: |
curl --request GET \ --url 'https://console.jumpcloud.com/api/commandresults?fields=&limit=10&skip=0&sort=' \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "results": [
- {
- "_id": "string",
- "command": "string",
- "exitCode": 0,
- "name": "string",
- "requestTime": "2019-08-24T14:15:22Z",
- "responseTime": "2019-08-24T14:15:22Z",
- "sudo": true,
- "system": "string",
- "systemId": "string",
- "user": "string",
- "workflowId": "string"
}
], - "totalCount": 0
}
This endpoint deletes a specific command result.
curl -X DELETE https://console.jumpcloud.com/api/commandresults/{CommandID} \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}'
id required | string |
x-org-id | string Default: |
curl --request DELETE \ --url https://console.jumpcloud.com/api/commandresults/{id} \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "_id": "string",
- "command": "string",
- "files": [
- "string"
], - "name": "string",
- "organization": "string",
- "requestTime": "2019-08-24T14:15:22Z",
- "response": {
- "data": {
- "exitCode": 0,
- "output": "string"
}, - "error": "string",
- "id": "string"
}, - "responseTime": "2019-08-24T14:15:22Z",
- "sudo": true,
- "system": "string",
- "systemId": "string",
- "user": "string",
- "workflowId": "string",
- "workflowInstanceId": "string"
}
This endpoint returns a specific command result.
curl -X GET https://console.jumpcloud.com/api/commandresults/{CommandResultID} \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}'
id required | string |
fields | string Default: "" 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. |
filter | string A filter to apply to the query. See the supported operators below. For more complex searches,
see the related Filter structure: field = Populate with a valid field from an endpoint response. operator = Supported operators are:
Note: v1 operators differ from v2 operators. Note: For v1 operators, excluding the value = Populate with the value you want to search for. Case sensitive. Examples
|
x-org-id | string Default: |
curl --request GET \ --url 'https://console.jumpcloud.com/api/commandresults/{id}?fields=&filter=SOME_STRING_VALUE' \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "_id": "string",
- "command": "string",
- "files": [
- "string"
], - "name": "string",
- "organization": "string",
- "requestTime": "2019-08-24T14:15:22Z",
- "response": {
- "data": {
- "exitCode": 0,
- "output": "string"
}, - "error": "string",
- "id": "string"
}, - "responseTime": "2019-08-24T14:15:22Z",
- "sudo": true,
- "system": "string",
- "systemId": "string",
- "user": "string",
- "workflowId": "string",
- "workflowInstanceId": "string"
}
This endpoint allows you to launch a command based on a defined trigger.
Launch a Command via a Trigger
curl --silent \
-X 'POST' \
-H "x-api-key: {API_KEY}" \
"https://console.jumpcloud.com/api/command/trigger/{TriggerName}"
Launch a Command via a Trigger passing a JSON object to the command
curl --silent \
-X 'POST' \
-H "x-api-key: {API_KEY}" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{ "srcip":"192.168.2.32", "attack":"Cross Site Scripting Attempt" }' \
"https://console.jumpcloud.com/api/command/trigger/{TriggerName}"
triggername required | string |
x-org-id | string Default: |
property name* additional property | any |
{ }
{- "triggered": [
- "string"
]
}
This endpoint returns all commands.
curl -X GET https://console.jumpcloud.com/api/commands/ \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}'
fields | string Default: "" 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. |
filter | string A filter to apply to the query. See the supported operators below. For more complex searches,
see the related Filter structure: field = Populate with a valid field from an endpoint response. operator = Supported operators are:
Note: v1 operators differ from v2 operators. Note: For v1 operators, excluding the value = Populate with the value you want to search for. Case sensitive. Examples
|
limit | integer Default: 10 The number of records to return at once. Limited to 100. |
skip | integer >= 0 Default: 0 The offset into the records to return. |
sort | string Default: "" Use space separated sort parameters to sort the collection.
Default sort is ascending. Prefix with |
x-org-id | string Default: |
curl --request GET \ --url 'https://console.jumpcloud.com/api/commands?fields=&filter=SOME_STRING_VALUE&limit=10&skip=0&sort=' \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "results": [
- {
- "_id": "string",
- "command": "string",
- "commandType": "string",
- "launchType": "string",
- "listensTo": "string",
- "name": "string",
- "organization": "string",
- "schedule": "string",
- "scheduleRepeatType": "string",
- "trigger": "string"
}
], - "totalCount": 0
}
This endpoint allows you to create a new command.
NOTE: the system property in the command is not used. Use a POST to /api/v2/commands/{id}/associations to bind a command to a system.
curl -X POST https://console.jumpcloud.com/api/commands/ \
-H 'Accept: application/json' \
-H 'Content-Type: application/json'
-H 'x-api-key: {API_KEY}'
-d '{"name":"Test API Command", "command":"String", "user":"{UserID}", "schedule":"", "timeout":"100"}'
x-org-id | string Default: |
command required | string The command to execute on the server. |
commandRunners | Array of strings An array of IDs of the Command Runner Users that can execute this command. |
commandType required | string Default: "linux" The Command OS |
files | Array of strings An array of file IDs to include with the command. |
launchType | string How the command will execute. |
listensTo | string |
name required | string |
organization | string The ID of the organization. |
schedule | string A crontab that consists of: [ (seconds) (minutes) (hours) (days of month) (months) (weekdays) ] or [ immediate ]. If you send this as an empty string, it will run immediately. |
scheduleRepeatType | string When the command will repeat. |
scheduleYear | integer The year that a scheduled command will launch in. |
shell | string The shell used to run the command. |
sudo | boolean |
systems | Array of strings Not used. Use /api/v2/commands/{id}/associations to bind commands to systems. |
template | string The template this command was created from |
timeToLiveSeconds | integer Time in seconds a command can wait in the queue to be run before timing out |
timeout | string The time in seconds to allow the command to run for. The maximum value is 86400 seconds (1 day). |
trigger | string The name of the command trigger. |
user | string The ID of the system user to run the command as. This field is required when creating a command with a commandType of "mac" or "linux". |
{- "command": "string",
- "commandRunners": [
- "string"
], - "commandType": "linux",
- "files": [
- "string"
], - "launchType": "string",
- "listensTo": "string",
- "name": "string",
- "organization": "string",
- "schedule": "string",
- "scheduleRepeatType": "string",
- "scheduleYear": 0,
- "shell": "string",
- "sudo": true,
- "systems": [
- "string"
], - "template": "string",
- "timeToLiveSeconds": 0,
- "timeout": "string",
- "trigger": "string",
- "user": "string"
}
{- "command": "string",
- "commandRunners": [
- "string"
], - "commandType": "linux",
- "files": [
- "string"
], - "launchType": "string",
- "listensTo": "string",
- "name": "string",
- "organization": "string",
- "schedule": "string",
- "scheduleRepeatType": "string",
- "scheduleYear": 0,
- "shell": "string",
- "sudo": true,
- "systems": [
- "string"
], - "template": "string",
- "timeToLiveSeconds": 0,
- "timeout": "string",
- "trigger": "string",
- "user": "string"
}
This endpoint deletes a specific command based on the Command ID.
curl -X DELETE https://console.jumpcloud.com/api/commands/{CommandID} \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}'
id required | string |
x-org-id | string Default: |
curl --request DELETE \ --url https://console.jumpcloud.com/api/commands/{id} \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "command": "string",
- "commandRunners": [
- "string"
], - "commandType": "linux",
- "files": [
- "string"
], - "launchType": "string",
- "listensTo": "string",
- "name": "string",
- "organization": "string",
- "schedule": "string",
- "scheduleRepeatType": "string",
- "scheduleYear": 0,
- "shell": "string",
- "sudo": true,
- "systems": [
- "string"
], - "template": "string",
- "timeToLiveSeconds": 0,
- "timeout": "string",
- "trigger": "string",
- "user": "string"
}
This endpoint returns a specific command based on the command ID.
curl -X GET https://console.jumpcloud.com/api/commands/{CommandID} \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}'
id required | string |
fields | string Default: "" 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. |
x-org-id | string Default: |
curl --request GET \ --url 'https://console.jumpcloud.com/api/commands/{id}?fields=' \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "command": "string",
- "commandRunners": [
- "string"
], - "commandType": "linux",
- "files": [
- "string"
], - "launchType": "string",
- "listensTo": "string",
- "name": "string",
- "organization": "string",
- "schedule": "string",
- "scheduleRepeatType": "string",
- "scheduleYear": 0,
- "shell": "string",
- "sudo": true,
- "systems": [
- "string"
], - "template": "string",
- "timeToLiveSeconds": 0,
- "timeout": "string",
- "trigger": "string",
- "user": "string"
}
This endpoint Updates a command based on the command ID and returns the modified command record.
curl -X PUT https://console.jumpcloud.com/api/commands/{CommandID} \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d '{
"name":"Test API Command",
"command":"String",
"user":"{UserID}",
"schedule":"",
"timeout":"100"
}'
id required | string |
x-org-id | string Default: |
command required | string The command to execute on the server. |
commandRunners | Array of strings An array of IDs of the Command Runner Users that can execute this command. |
commandType required | string Default: "linux" The Command OS |
files | Array of strings An array of file IDs to include with the command. |
launchType | string How the command will execute. |
listensTo | string |
name required | string |
organization | string The ID of the organization. |
schedule | string A crontab that consists of: [ (seconds) (minutes) (hours) (days of month) (months) (weekdays) ] or [ immediate ]. If you send this as an empty string, it will run immediately. |
scheduleRepeatType | string When the command will repeat. |
scheduleYear | integer The year that a scheduled command will launch in. |
shell | string The shell used to run the command. |
sudo | boolean |
systems | Array of strings Not used. Use /api/v2/commands/{id}/associations to bind commands to systems. |
template | string The template this command was created from |
timeToLiveSeconds | integer Time in seconds a command can wait in the queue to be run before timing out |
timeout | string The time in seconds to allow the command to run for. The maximum value is 86400 seconds (1 day). |
trigger | string The name of the command trigger. |
user | string The ID of the system user to run the command as. This field is required when creating a command with a commandType of "mac" or "linux". |
{- "command": "string",
- "commandRunners": [
- "string"
], - "commandType": "linux",
- "files": [
- "string"
], - "launchType": "string",
- "listensTo": "string",
- "name": "string",
- "organization": "string",
- "schedule": "string",
- "scheduleRepeatType": "string",
- "scheduleYear": 0,
- "shell": "string",
- "sudo": true,
- "systems": [
- "string"
], - "template": "string",
- "timeToLiveSeconds": 0,
- "timeout": "string",
- "trigger": "string",
- "user": "string"
}
{- "command": "string",
- "commandRunners": [
- "string"
], - "commandType": "linux",
- "files": [
- "string"
], - "launchType": "string",
- "listensTo": "string",
- "name": "string",
- "organization": "string",
- "schedule": "string",
- "scheduleRepeatType": "string",
- "scheduleYear": 0,
- "shell": "string",
- "sudo": true,
- "systems": [
- "string"
], - "template": "string",
- "timeToLiveSeconds": 0,
- "timeout": "string",
- "trigger": "string",
- "user": "string"
}
This endpoint returns results for a specific command.
curl -X GET https://console.jumpcloud.com/api/commands/{id}/results \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}'
id required | string |
limit | integer Default: 10 The number of records to return at once. Limited to 100. |
skip | integer >= 0 Default: 0 The offset into the records to return. |
curl --request GET \ --url 'https://console.jumpcloud.com/api/commands/{id}/results?limit=10&skip=0' \ --header 'x-api-key: REPLACE_KEY_VALUE'
[- {
- "_id": "string",
- "command": "string",
- "files": [
- "string"
], - "name": "string",
- "organization": "string",
- "requestTime": "2019-08-24T14:15:22Z",
- "response": {
- "data": {
- "exitCode": 0,
- "output": "string"
}, - "error": "string",
- "id": "string"
}, - "responseTime": "2019-08-24T14:15:22Z",
- "sudo": true,
- "system": "string",
- "systemId": "string",
- "user": "string",
- "workflowId": "string",
- "workflowInstanceId": "string"
}
]
This endpoint returns the uploaded file(s) associated with a specific command.
curl -X GET https://console.jumpcloud.com/api/files/command/{commandID} \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}'
id required | string |
fields | string Default: "" 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. |
limit | integer Default: 10 The number of records to return at once. Limited to 100. |
skip | integer >= 0 Default: 0 The offset into the records to return. |
x-org-id | string Default: |
curl --request GET \ --url 'https://console.jumpcloud.com/api/files/command/{id}?fields=&limit=10&skip=0' \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "results": [
- {
- "_id": "string",
- "destination": "string",
- "name": "string"
}
], - "totalCount": 0
}
This endpoint allows you to run a command.
curl -X POST https://console.jumpcloud.com/api/runCommand \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}'
-d '{"_id":"{commandID}", "systemIds":["systemId"]}'
_id | string The ID of the command. |
systemIds | Array of strings An optional list of device IDs to run the command on. If omitted, the command will run on devices bound to the command. |
{- "_id": "string",
- "systemIds": [
- "string"
]
}
{- "queueIds": [
- "string"
], - "workflowInstanceId": "string"
}
This endpoint returns Organization Details.
curl -X GET \
https://console.jumpcloud.com/api/organizations \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}'
fields | string Default: "" 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. |
filter | string A filter to apply to the query. See the supported operators below. For more complex searches,
see the related Filter structure: field = Populate with a valid field from an endpoint response. operator = Supported operators are:
Note: v1 operators differ from v2 operators. Note: For v1 operators, excluding the value = Populate with the value you want to search for. Case sensitive. Examples
|
limit | integer Default: 10 The number of records to return at once. Limited to 100. |
search | string A nested object containing a |
skip | integer >= 0 Default: 0 The offset into the records to return. |
sort | string Default: "" Use space separated sort parameters to sort the collection.
Default sort is ascending. Prefix with |
sortIgnoreCase | string Default: "" Use space separated sort parameters to sort the collection, ignoring case.
Default sort is ascending. Prefix with |
curl --request GET \ --url 'https://console.jumpcloud.com/api/organizations?fields=&filter=SOME_STRING_VALUE&limit=10&search=SOME_STRING_VALUE&skip=0&sort=&sortIgnoreCase=' \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "results": [
- {
- "_id": "string",
- "displayName": "string",
- "logoUrl": "string"
}
], - "totalCount": 0
}
This endpoint triggers the sending of a reactivation e-mail to an administrator.
id required | string |
curl --request GET \ --url https://console.jumpcloud.com/api/users/reactivate/{id} \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "code": 0,
- "message": "string",
- "status": "string"
}
This endpoint initiates a TOTP reset for an admin. This request does not accept a body.
id required | string |
curl --request POST \ --url https://console.jumpcloud.com/api/users/resettotp/{id} \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "code": 0,
- "message": "string",
- "status": "string"
}
This endpoint allows you to update a user.
id required | string |
x-org-id | string Default: |
apiKeyAllowed | boolean |
string <email> <= 1024 characters | |
enableMultiFactor | boolean |
firstname | string |
growthData | object |
lastWhatsNewChecked | string <date> |
lastname | string |
roleName | string |
{- "apiKeyAllowed": true,
- "email": "user@example.com",
- "enableMultiFactor": true,
- "firstname": "string",
- "growthData": { },
- "lastWhatsNewChecked": "2019-08-24",
- "lastname": "string",
- "roleName": "string"
}
{- "_id": "string",
- "apiKeyAllowed": true,
- "apiKeyHash": {
- "createdAt": "2019-08-24T14:15:22Z",
- "expireAt": "2019-08-24T14:15:22Z",
- "prefix": "string"
}, - "apiKeySet": true,
- "apiKeyUpdatedAt": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "disableIntroduction": true,
- "email": "string",
- "enableMultiFactor": true,
- "firstname": "string",
- "growthData": {
- "experimentStates": { },
- "onboardingState": { }
}, - "lastWhatsNewChecked": "2019-08-24T14:15:22Z",
- "lastname": "string",
- "organization": "string",
- "passwordUpdatedAt": "2019-08-24T14:15:22Z",
- "provider": "string",
- "role": "string",
- "roleName": "string",
- "sessionCount": 0,
- "suspended": true,
- "totpEnrolled": true,
- "totpUpdatedAt": "2019-08-24T14:15:22Z",
- "usersTimeZone": "string"
}
This endpoint returns Organization Details.
curl -X GET \
https://console.jumpcloud.com/api/organizations \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}'
fields | string Default: "" 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. |
filter | string A filter to apply to the query. See the supported operators below. For more complex searches,
see the related Filter structure: field = Populate with a valid field from an endpoint response. operator = Supported operators are:
Note: v1 operators differ from v2 operators. Note: For v1 operators, excluding the value = Populate with the value you want to search for. Case sensitive. Examples
|
limit | integer Default: 10 The number of records to return at once. Limited to 100. |
search | string A nested object containing a |
skip | integer >= 0 Default: 0 The offset into the records to return. |
sort | string Default: "" Use space separated sort parameters to sort the collection.
Default sort is ascending. Prefix with |
sortIgnoreCase | string Default: "" Use space separated sort parameters to sort the collection, ignoring case.
Default sort is ascending. Prefix with |
curl --request GET \ --url 'https://console.jumpcloud.com/api/organizations?fields=&filter=SOME_STRING_VALUE&limit=10&search=SOME_STRING_VALUE&skip=0&sort=&sortIgnoreCase=' \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "results": [
- {
- "_id": "string",
- "displayName": "string",
- "logoUrl": "string"
}
], - "totalCount": 0
}
This endpoint returns a particular Organization.
curl -X GET https://console.jumpcloud.com/api/organizations/{OrganizationID} \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}'
id required | string |
fields | string Default: "" 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. |
filter | string A filter to apply to the query. See the supported operators below. For more complex searches,
see the related Filter structure: field = Populate with a valid field from an endpoint response. operator = Supported operators are:
Note: v1 operators differ from v2 operators. Note: For v1 operators, excluding the value = Populate with the value you want to search for. Case sensitive. Examples
|
curl --request GET \ --url 'https://console.jumpcloud.com/api/organizations/{id}?fields=&filter=SOME_STRING_VALUE' \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "_id": "string",
- "accessRestriction": "string",
- "accountsReceivable": "string",
- "created": "string",
- "customEmailSettings": {
- "enabled": true
}, - "displayName": "string",
- "entitlement": {
- "billingModel": "string",
- "capUserQuantity": true,
- "entitlementProducts": [
- {
- "committedUsers": 0,
- "contractType": "string",
- "maxUserCount": 0,
- "name": "string",
- "pricePerUser": 0,
- "productCategory": "string",
- "productCode": "string",
- "uncommittedUsers": 0
}
], - "isManuallyBilled": true,
- "maxUserQuantity": 0,
- "pricePerUserSum": 0,
- "purchaseChannel": "string"
}, - "hasCreditCard": true,
- "hasStripeCustomerId": true,
- "lastEstimateCalculationTimeStamp": "string",
- "lastSfdcSyncStatus": { },
- "logoUrl": "string",
- "provider": "string",
- "settings": {
- "agentVersion": "string",
- "betaFeatures": { },
- "contactEmail": "string",
- "contactName": "string",
- "deviceIdentificationEnabled": true,
- "disableCommandRunner": true,
- "disableGoogleLogin": true,
- "disableLdap": true,
- "disableUM": true,
- "duplicateLDAPGroups": true,
- "emailDisclaimer": "string",
- "enableGoogleApps": true,
- "enableManagedUID": true,
- "enableO365": true,
- "enableUserPortalAgentInstall": true,
- "features": {
- "directoryInsights": {
- "enabled": true
}, - "directoryInsightsPremium": {
- "createdAt": "string",
- "enabled": true,
- "updatedAt": "string"
}, - "systemInsights": {
- "createdAt": "string",
- "enableNewDarwin": true,
- "enableNewLinux": true,
- "enableNewWindows": true,
- "enabled": true,
- "updatedAt": "string"
}
}, - "growthData": { },
- "logo": "string",
- "maxSystemUsers": 0,
- "name": "string",
- "newSystemUserStateDefaults": {
- "applicationImport": "ACTIVATED",
- "csvImport": "ACTIVATED",
- "manualEntry": "ACTIVATED"
}, - "passwordCompliance": "custom",
- "passwordPolicy": {
- "allowUnenrolledMFAPasswordReset": true,
- "allowUsernameSubstring": true,
- "daysAfterExpirationToSelfRecover": 0,
- "daysBeforeExpirationToForceReset": 1,
- "disallowCommonlyUsedPasswords": true,
- "disallowSequentialOrRepetitiveChars": true,
- "effectiveDate": "string",
- "enableDaysAfterExpirationToSelfRecover": true,
- "enableDaysBeforeExpirationToForceReset": true,
- "enableLockoutTimeInSeconds": true,
- "enableMaxHistory": true,
- "enableMaxLoginAttempts": true,
- "enableMinChangePeriodInDays": true,
- "enableMinLength": true,
- "enablePasswordExpirationInDays": true,
- "enableRecoveryEmail": true,
- "enableResetLockoutCounter": true,
- "gracePeriodDate": "string",
- "lockoutTimeInSeconds": 300,
- "maxHistory": 1,
- "maxLoginAttempts": 1,
- "minChangePeriodInDays": 0,
- "minLength": 0,
- "needsLowercase": true,
- "needsNumeric": true,
- "needsSymbolic": true,
- "needsUppercase": true,
- "passwordExpirationInDays": 1,
- "resetLockoutCounterMinutes": 1
}, - "pendingDelete": true,
- "requireAdminMFA": true,
- "showIntro": true,
- "systemUserDefaults": {
- "restrictedFields": [
- {
- "field": "addresses",
- "id": "string",
- "type": "active_directory"
}
]
}, - "systemUserPasswordExpirationInDays": 0,
- "systemUsersCanEdit": true,
- "trustedAppConfig": {
- "checksum": "thisIsAnExampleChecksum1234",
- "trustedApps": [
- {
- "name": "Application 1",
- "path": "/someuser/Applications/application1.app",
- "teamid": "FakeTeamID"
}
]
}, - "userPortal": {
- "cookieExpirationType": "session",
- "idleSessionDurationMinutes": 1
}, - "windowsMDM": {
- "autoEnroll": true,
- "enabled": true
}
}, - "totalBillingEstimate": 0
}
This endpoint allows you to update an Organization.
Note: passwordPolicy
settings are only used when passwordCompliance
is set to "custom". We discourage the use of non-custom passwordCompliance values.
emailDisclaimer
can only be modified by paying customers.
hasStripeCustomerId
is deprecated and will be removed.
curl -X PUT https://console.jumpcloud.com/api/organizations/{OrganizationID} \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d '{
"settings": {
"contactName": "Admin Name",
"contactEmail": "admin@company.com",
"systemUsersCanEdit":true,
"passwordPolicy": {
"enableMaxHistory": true,
"maxHistory": 3
}
}
}'
id required | string |
object (OrganizationSettingsPut) |
{- "settings": {
- "contactEmail": "string",
- "contactName": "string",
- "deviceIdentificationEnabled": true,
- "disableGoogleLogin": true,
- "disableLdap": true,
- "disableUM": true,
- "duplicateLDAPGroups": true,
- "emailDisclaimer": "string",
- "enableManagedUID": true,
- "features": {
- "directoryInsights": {
- "enabled": true
}, - "directoryInsightsPremium": {
- "createdAt": "string",
- "enabled": true,
- "updatedAt": "string"
}, - "systemInsights": {
- "createdAt": "string",
- "enableNewDarwin": true,
- "enableNewLinux": true,
- "enableNewWindows": true,
- "enabled": true,
- "updatedAt": "string"
}
}, - "growthData": { },
- "logo": "string",
- "maxSystemUsers": 0,
- "name": "string",
- "newSystemUserStateDefaults": {
- "applicationImport": "ACTIVATED",
- "csvImport": "ACTIVATED",
- "manualEntry": "ACTIVATED"
}, - "passwordCompliance": "custom",
- "passwordPolicy": {
- "allowUnenrolledMFAPasswordReset": true,
- "allowUsernameSubstring": true,
- "daysAfterExpirationToSelfRecover": 0,
- "daysBeforeExpirationToForceReset": 1,
- "disallowCommonlyUsedPasswords": true,
- "disallowSequentialOrRepetitiveChars": true,
- "effectiveDate": "string",
- "enableDaysAfterExpirationToSelfRecover": true,
- "enableDaysBeforeExpirationToForceReset": true,
- "enableLockoutTimeInSeconds": true,
- "enableMaxHistory": true,
- "enableMaxLoginAttempts": true,
- "enableMinChangePeriodInDays": true,
- "enableMinLength": true,
- "enablePasswordExpirationInDays": true,
- "gracePeriodDate": "string",
- "lockoutTimeInSeconds": 0,
- "maxHistory": 1,
- "maxLoginAttempts": 1,
- "minChangePeriodInDays": 0,
- "minLength": 0,
- "needsLowercase": true,
- "needsNumeric": true,
- "needsSymbolic": true,
- "needsUppercase": true,
- "passwordExpirationInDays": 1
}, - "showIntro": true,
- "systemUserDefaults": {
- "restrictedFields": [
- {
- "field": "addresses",
- "id": "string",
- "type": "active_directory"
}
]
}, - "systemUserPasswordExpirationInDays": 0,
- "systemUsersCanEdit": true,
- "trustedAppConfig": {
- "trustedApps": [
- {
- "name": "Application 1",
- "path": "/someuser/Applications/application1.app",
- "teamid": "FakeTeamID"
}
]
}, - "userPortal": {
- "cookieExpirationType": "session",
- "idleSessionDurationMinutes": 1
}
}
}
{- "_id": "string",
- "accessRestriction": "string",
- "accountsReceivable": "string",
- "created": "string",
- "customEmailSettings": {
- "enabled": true
}, - "displayName": "string",
- "entitlement": {
- "billingModel": "string",
- "capUserQuantity": true,
- "entitlementProducts": [
- {
- "committedUsers": 0,
- "contractType": "string",
- "maxUserCount": 0,
- "name": "string",
- "pricePerUser": 0,
- "productCategory": "string",
- "productCode": "string",
- "uncommittedUsers": 0
}
], - "isManuallyBilled": true,
- "maxUserQuantity": 0,
- "pricePerUserSum": 0,
- "purchaseChannel": "string"
}, - "hasCreditCard": true,
- "hasStripeCustomerId": true,
- "lastEstimateCalculationTimeStamp": "string",
- "lastSfdcSyncStatus": { },
- "logoUrl": "string",
- "provider": "string",
- "settings": {
- "agentVersion": "string",
- "betaFeatures": { },
- "contactEmail": "string",
- "contactName": "string",
- "deviceIdentificationEnabled": true,
- "disableCommandRunner": true,
- "disableGoogleLogin": true,
- "disableLdap": true,
- "disableUM": true,
- "duplicateLDAPGroups": true,
- "emailDisclaimer": "string",
- "enableGoogleApps": true,
- "enableManagedUID": true,
- "enableO365": true,
- "enableUserPortalAgentInstall": true,
- "features": {
- "directoryInsights": {
- "enabled": true
}, - "directoryInsightsPremium": {
- "createdAt": "string",
- "enabled": true,
- "updatedAt": "string"
}, - "systemInsights": {
- "createdAt": "string",
- "enableNewDarwin": true,
- "enableNewLinux": true,
- "enableNewWindows": true,
- "enabled": true,
- "updatedAt": "string"
}
}, - "growthData": { },
- "logo": "string",
- "maxSystemUsers": 0,
- "name": "string",
- "newSystemUserStateDefaults": {
- "applicationImport": "ACTIVATED",
- "csvImport": "ACTIVATED",
- "manualEntry": "ACTIVATED"
}, - "passwordCompliance": "custom",
- "passwordPolicy": {
- "allowUnenrolledMFAPasswordReset": true,
- "allowUsernameSubstring": true,
- "daysAfterExpirationToSelfRecover": 0,
- "daysBeforeExpirationToForceReset": 1,
- "disallowCommonlyUsedPasswords": true,
- "disallowSequentialOrRepetitiveChars": true,
- "effectiveDate": "string",
- "enableDaysAfterExpirationToSelfRecover": true,
- "enableDaysBeforeExpirationToForceReset": true,
- "enableLockoutTimeInSeconds": true,
- "enableMaxHistory": true,
- "enableMaxLoginAttempts": true,
- "enableMinChangePeriodInDays": true,
- "enableMinLength": true,
- "enablePasswordExpirationInDays": true,
- "enableRecoveryEmail": true,
- "enableResetLockoutCounter": true,
- "gracePeriodDate": "string",
- "lockoutTimeInSeconds": 300,
- "maxHistory": 1,
- "maxLoginAttempts": 1,
- "minChangePeriodInDays": 0,
- "minLength": 0,
- "needsLowercase": true,
- "needsNumeric": true,
- "needsSymbolic": true,
- "needsUppercase": true,
- "passwordExpirationInDays": 1,
- "resetLockoutCounterMinutes": 1
}, - "pendingDelete": true,
- "requireAdminMFA": true,
- "showIntro": true,
- "systemUserDefaults": {
- "restrictedFields": [
- {
- "field": "addresses",
- "id": "string",
- "type": "active_directory"
}
]
}, - "systemUserPasswordExpirationInDays": 0,
- "systemUsersCanEdit": true,
- "trustedAppConfig": {
- "checksum": "thisIsAnExampleChecksum1234",
- "trustedApps": [
- {
- "name": "Application 1",
- "path": "/someuser/Applications/application1.app",
- "teamid": "FakeTeamID"
}
]
}, - "userPortal": {
- "cookieExpirationType": "session",
- "idleSessionDurationMinutes": 1
}, - "windowsMDM": {
- "autoEnroll": true,
- "enabled": true
}
}, - "totalBillingEstimate": 0
}
This endpoint allows you to get a list of all RADIUS servers in your organization.
curl -X GET https://console.jumpcloud.com/api/radiusservers/ \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
fields | string Default: "" 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. |
filter | string A filter to apply to the query. See the supported operators below. For more complex searches,
see the related Filter structure: field = Populate with a valid field from an endpoint response. operator = Supported operators are:
Note: v1 operators differ from v2 operators. Note: For v1 operators, excluding the value = Populate with the value you want to search for. Case sensitive. Examples
|
limit | integer Default: 10 The number of records to return at once. Limited to 100. |
skip | integer >= 0 Default: 0 The offset into the records to return. |
sort | string Default: "" Use space separated sort parameters to sort the collection.
Default sort is ascending. Prefix with |
x-org-id | string Default: |
curl --request GET \ --url 'https://console.jumpcloud.com/api/radiusservers?fields=&filter=SOME_STRING_VALUE&limit=10&skip=0&sort=' \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "results": [
- {
- "_id": "string",
- "authIdp": "JUMPCLOUD",
- "caCert": "string",
- "deviceCertEnabled": true,
- "mfa": "DISABLED",
- "name": "string",
- "networkSourceIp": "string",
- "organization": "string",
- "requireTlsAuth": true,
- "sharedSecret": "string",
- "tagNames": [
- "string"
], - "tags": [
- "string"
], - "userCertEnabled": true,
- "userLockoutAction": "string",
- "userPasswordEnabled": true,
- "userPasswordExpirationAction": "string"
}
], - "totalCount": 0
}
This endpoint allows you to create RADIUS servers in your organization.
curl -X POST https://console.jumpcloud.com/api/radiusservers/ \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d '{
"name": "{test_radius}",
"networkSourceIp": "{0.0.0.0}",
"sharedSecret":"{secretpassword}",
"userLockoutAction": "REMOVE",
"userPasswordExpirationAction": "MAINTAIN"
}'
x-org-id | string Default: |
authIdp | string Enum: "JUMPCLOUD" "AZURE" |
caCert | string |
deviceCertEnabled | boolean |
mfa | string Enum: "DISABLED" "ENABLED" "REQUIRED" "ALWAYS" |
name required | string |
networkSourceIp required | string |
requireTlsAuth | boolean |
sharedSecret required | string RADIUS shared secret between the server and client. |
tagNames | Array of strings |
userCertEnabled | boolean |
userLockoutAction | string |
userPasswordEnabled | boolean |
userPasswordExpirationAction | string |
{- "authIdp": "JUMPCLOUD",
- "caCert": "string",
- "deviceCertEnabled": true,
- "mfa": "DISABLED",
- "name": "string",
- "networkSourceIp": "string",
- "requireTlsAuth": true,
- "sharedSecret": "string",
- "tagNames": [
- "string"
], - "userCertEnabled": true,
- "userLockoutAction": "string",
- "userPasswordEnabled": true,
- "userPasswordExpirationAction": "string"
}
{- "_id": "string",
- "authIdp": "JUMPCLOUD",
- "caCert": "string",
- "deviceCertEnabled": true,
- "mfa": "DISABLED",
- "name": "string",
- "networkSourceIp": "string",
- "organization": "string",
- "requireTlsAuth": true,
- "sharedSecret": "string",
- "tagNames": [
- "string"
], - "tags": [
- "string"
], - "userCertEnabled": true,
- "userLockoutAction": "string",
- "userPasswordEnabled": true,
- "userPasswordExpirationAction": "string"
}
This endpoint allows you to delete RADIUS servers in your organization.
curl -X DELETE https://console.jumpcloud.com/api/radiusservers/{ServerID} \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
id required | string |
x-org-id | string Default: |
curl --request DELETE \ --url https://console.jumpcloud.com/api/radiusservers/{id} \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "_id": "string",
- "authIdp": "JUMPCLOUD",
- "caCert": "string",
- "deviceCertEnabled": true,
- "mfa": "DISABLED",
- "name": "string",
- "networkSourceIp": "string",
- "requireTlsAuth": true,
- "tagNames": [
- "string"
], - "userCertEnabled": true,
- "userLockoutAction": "string",
- "userPasswordEnabled": true,
- "userPasswordExpirationAction": "string"
}
This endpoint allows you to get a RADIUS server in your organization.
curl -X PUT https://console.jumpcloud.com/api/radiusservers/{ServerID} \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
id required | string |
x-org-id | string Default: |
curl --request GET \ --url https://console.jumpcloud.com/api/radiusservers/{id} \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "_id": "string",
- "authIdp": "JUMPCLOUD",
- "caCert": "string",
- "deviceCertEnabled": true,
- "mfa": "DISABLED",
- "name": "string",
- "networkSourceIp": "string",
- "organization": "string",
- "requireTlsAuth": true,
- "sharedSecret": "string",
- "tagNames": [
- "string"
], - "tags": [
- "string"
], - "userCertEnabled": true,
- "userLockoutAction": "string",
- "userPasswordEnabled": true,
- "userPasswordExpirationAction": "string"
}
This endpoint allows you to update RADIUS servers in your organization.
curl -X PUT https://console.jumpcloud.com/api/radiusservers/{ServerID} \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d '{
"name": "{name_update}",
"networkSourceIp": "{0.0.0.0}",
"sharedSecret": "{secret_password}",
"userLockoutAction": "REMOVE",
"userPasswordExpirationAction": "MAINTAIN"
}'
id required | string |
x-org-id | string Default: |
caCert | string |
deviceCertEnabled | boolean |
mfa | string Enum: "DISABLED" "ENABLED" "REQUIRED" "ALWAYS" |
name required | string |
networkSourceIp required | string |
requireTlsAuth | boolean |
sharedSecret required | string |
tags | Array of strings |
userCertEnabled | boolean |
userLockoutAction | string |
userPasswordEnabled | boolean |
userPasswordExpirationAction | string |
{- "name": "test radius",
- "networkSourceIp": "0.0.0.0",
- "sharedSecret": "secretradiuspassword",
- "tagsNames": [
- "tag1"
]
}
{- "_id": "string",
- "authIdp": "JUMPCLOUD",
- "caCert": "string",
- "deviceCertEnabled": true,
- "mfa": "DISABLED",
- "name": "string",
- "networkSourceIp": "string",
- "requireTlsAuth": true,
- "tagNames": [
- "string"
], - "userCertEnabled": true,
- "userLockoutAction": "string",
- "userPasswordEnabled": true,
- "userPasswordExpirationAction": "string"
}
Return Command Results in multi-record format allowing for the passing of the filter
parameter.
To support advanced filtering you can use the filter
and searchFilter
parameters that can only be passed in the body of POST /api/search/commandresults route. The filter
parameter must be passed as Content-Type application/json.
The filter
parameter is an object with a single property, either and
or or
with the value of the property being an array of query expressions.
This allows you to filter records using the logic of matching ALL or ANY records in the array of query expressions. If the and
or or
are not included the default behavior is to match ALL query expressions.
Exact search for a specific command result
curl -X POST https://console.jumpcloud.com/api/search/commandresults \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d '{
"filter" : "workflowInstanceId:$eq:62f3c599ec4e928499069c7f",
"fields" : "name workflowId sudo"
}'
fields | string Default: "" 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. |
filter | string A filter to apply to the query. See the supported operators below. For more complex searches,
see the related Filter structure: field = Populate with a valid field from an endpoint response. operator = Supported operators are:
Note: v1 operators differ from v2 operators. Note: For v1 operators, excluding the value = Populate with the value you want to search for. Case sensitive. Examples
|
limit | integer Default: 10 The number of records to return at once. Limited to 100. |
skip | integer >= 0 Default: 0 The offset into the records to return. |
x-org-id | string Default: |
fields | string |
filter | object |
searchFilter | object |
{- "fields": "string",
- "filter": { },
- "searchFilter": { }
}
{- "results": [
- {
- "_id": "string",
- "command": "string",
- "exitCode": 0,
- "name": "string",
- "requestTime": "2019-08-24T14:15:22Z",
- "responseTime": "2019-08-24T14:15:22Z",
- "sudo": true,
- "system": "string",
- "systemId": "string",
- "user": "string",
- "workflowId": "string"
}
], - "totalCount": 0
}
Return Commands in multi-record format allowing for the passing of the filter
and searchFilter
parameters. This WILL NOT allow you to add a new command.
To support advanced filtering you can use the filter
and searchFilter
parameters that can only be passed in the body of POST /api/search/* routes. The filter
and searchFilter
parameters must be passed as Content-Type application/json.
The filter
parameter is an object with a single property, either and
or or
with the value of the property being an array of query expressions.
This allows you to filter records using the logic of matching ALL or ANY records in the array of query expressions. If the and
or or
are not included the default behavior is to match ALL query expressions.
The searchFilter
parameter allows text searching on supported fields by specifying a searchTerm
and a list of fields
to query on. If any field
has a partial text match on the searchTerm
the record will be returned.
Exact search for a list of commands in a launchType
curl -X POST https://console.jumpcloud.com/api/search/commands \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d '{
"filter" : [{"launchType" : "repeated"}],
"fields" : "name launchType sudo"
}'
Text search for commands with name
curl -X POST https://console.jumpcloud.com/api/search/commands \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d '{
"searchFilter" : {
"searchTerm": "List",
"fields": ["name"]
},
"fields" : "name launchType sudo"
}'
Text search for multiple commands
curl -X POST https://console.jumpcloud.com/api/search/commands \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d '{
"searchFilter" : {
"searchTerm": ["List", "Log"],
"fields": ["name"]
},
"fields" : "name launchType sudo"
}'
Combining filter
and searchFilter
to text search for commands with name who are in a list of launchType
curl -X POST https://console.jumpcloud.com/api/search/commands \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d '{
"searchFilter": {
"searchTerm": "List",
"fields": ["name"]
},
"filter": {
"or": [
{"launchType" : "repeated"},
{"launchType" : "one-time"}
]
},
"fields" : "name launchType sudo"
}'
fields | string Default: "" 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. |
filter | string A filter to apply to the query. See the supported operators below. For more complex searches,
see the related Filter structure: field = Populate with a valid field from an endpoint response. operator = Supported operators are:
Note: v1 operators differ from v2 operators. Note: For v1 operators, excluding the value = Populate with the value you want to search for. Case sensitive. Examples
|
limit | integer Default: 10 The number of records to return at once. Limited to 100. |
skip | integer >= 0 Default: 0 The offset into the records to return. |
x-org-id | string Default: |
fields | string |
filter | object |
searchFilter | object |
{- "fields": "string",
- "filter": { },
- "searchFilter": { }
}
{- "results": [
- {
- "_id": "string",
- "command": "string",
- "commandType": "string",
- "launchType": "string",
- "listensTo": "string",
- "name": "string",
- "organization": "string",
- "schedule": "string",
- "scheduleRepeatType": "string",
- "trigger": "string"
}
], - "totalCount": 0
}
This endpoint will return Organization data based on your search parameters. This endpoint WILL NOT allow you to add a new Organization.
You can use the supported parameters and pass those in the body of request.
The parameters must be passed as Content-Type application/json.
curl -X POST https://console.jumpcloud.com/api/search/organizations \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d '{
"search":{
"fields" : ["settings.name"],
"searchTerm": "Second"
},
"fields": ["_id", "displayName", "logoUrl"],
"limit" : 0,
"skip" : 0
}'
fields | string Default: "" 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. |
filter | string A filter to apply to the query. See the supported operators below. For more complex searches,
see the related Filter structure: field = Populate with a valid field from an endpoint response. operator = Supported operators are:
Note: v1 operators differ from v2 operators. Note: For v1 operators, excluding the value = Populate with the value you want to search for. Case sensitive. Examples
|
limit | integer Default: 10 The number of records to return at once. Limited to 100. |
skip | integer >= 0 Default: 0 The offset into the records to return. |
fields | string |
filter | object |
searchFilter | object |
{- "fields": "string",
- "filter": { },
- "searchFilter": { }
}
{- "results": [
- {
- "_id": "string",
- "displayName": "string",
- "logoUrl": "string"
}
], - "totalCount": 0
}
Return Systems in multi-record format allowing for the passing of the filter
and searchFilter
parameters. This WILL NOT allow you to add a new system.
To support advanced filtering you can use the filter
and searchFilter
parameters that can only be passed in the body of POST /api/search/* routes. The filter
and searchFilter
parameters must be passed as Content-Type application/json.
The filter
parameter is an object with a single property, either and
or or
with the value of the property being an array of query expressions.
This allows you to filter records using the logic of matching ALL or ANY records in the array of query expressions. If the and
or or
are not included the default behavior is to match ALL query expressions.
The searchFilter
parameter allows text searching on supported fields by specifying a searchTerm
and a list of fields
to query on. If any field
has a partial text match on the searchTerm
the record will be returned.
Exact search for a list of hostnames
curl -X POST https://console.jumpcloud.com/api/search/systems \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d '{
"filter": {
"or": [
{"hostname" : "my-hostname"},
{"hostname" : "other-hostname"}
]
},
"fields" : "os hostname displayName"
}'
Text search for a hostname or display name
curl -X POST https://console.jumpcloud.com/api/search/systems \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d '{
"searchFilter": {
"searchTerm": "my-host",
"fields": ["hostname", "displayName"]
},
"fields": "os hostname displayName"
}'
Text search for a multiple hostnames.
curl -X POST https://console.jumpcloud.com/api/search/systems \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d '{
"searchFilter": {
"searchTerm": ["my-host", "my-other-host"],
"fields": ["hostname"]
},
"fields": "os hostname displayName"
}'
Combining filter
and searchFilter
to search for names that match a given OS
curl -X POST https://console.jumpcloud.com/api/search/systems \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d '{
"searchFilter": {
"searchTerm": "my-host",
"fields": ["hostname", "displayName"]
},
"filter": {
"or": [
{"os" : "Ubuntu"},
{"os" : "Mac OS X"}
]
},
"fields": "os hostname displayName"
}'
fields | string Default: "" 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. |
limit | integer Default: 10 The number of records to return at once. Limited to 100. |
skip | integer >= 0 Default: 0 The offset into the records to return. |
filter | string A filter to apply to the query. See the supported operators below. For more complex searches,
see the related Filter structure: field = Populate with a valid field from an endpoint response. operator = Supported operators are:
Note: v1 operators differ from v2 operators. Note: For v1 operators, excluding the value = Populate with the value you want to search for. Case sensitive. Examples
|
x-org-id | string Default: |
x-eventually-consistent | boolean Default: false EXPERIMENTAL! Use to acknowledge eventually consistent data in response. |
fields | string |
filter | object |
searchFilter | object |
{- "fields": "string",
- "filter": { },
- "searchFilter": { }
}
{- "results": [
- {
- "_id": "string",
- "active": true,
- "agentVersion": "string",
- "allowMultiFactorAuthentication": true,
- "allowPublicKeyAuthentication": true,
- "allowSshPasswordAuthentication": true,
- "allowSshRootLogin": true,
- "amazonInstanceID": "string",
- "arch": "string",
- "archFamily": "string",
- "azureAdJoined": true,
- "builtInCommands": [
- {
- "name": "erase",
- "type": "security"
}
], - "connectionHistory": [
- { }
], - "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "desktopCapable": true,
- "displayManager": "string",
- "displayName": "string",
- "domainInfo": {
- "domainName": "string",
- "partOfDomain": true
}, - "fde": {
- "active": true,
- "keyPresent": true
}, - "fileSystem": "string",
- "hasServiceAccount": true,
- "hostname": "string",
- "hwVendor": "string",
- "isPolicyBound": true,
- "lastContact": "2019-08-24T14:15:22Z",
- "mdm": {
- "dep": true,
- "enrollmentType": "unknown",
- "internal": {
- "deviceId": "string",
- "windowsDeviceId": "string"
}, - "lostModeStatus": "string",
- "profileIdentifier": "string",
- "providerId": "string",
- "userApproved": true,
- "vendor": "unknown",
- "windows": {
- "upn": "string"
}
}, - "modifySSHDConfig": true,
- "networkInterfaces": [
- {
- "address": "string",
- "family": "IPv4",
- "internal": true,
- "name": "string"
}
], - "organization": "string",
- "os": "string",
- "osFamily": "string",
- "osVersionDetail": {
- "distributionName": "string",
- "major": "string",
- "majorNumber": 0,
- "minor": "string",
- "minorNumber": 0,
- "osName": "string",
- "patch": "string",
- "patchNumber": 0,
- "releaseName": "string",
- "revision": "string",
- "version": "string"
}, - "policyStats": {
- "duplicate": 0,
- "failed": 0,
- "pending": 0,
- "success": 0,
- "total": 0,
- "unsupportedOs": 0
}, - "primarySystemUser": {
- "id": "string"
}, - "provisionMetadata": {
- "provisioner": {
- "provisionerId": "string",
- "type": "administrator"
}
}, - "remoteAssistAgentVersion": "string",
- "remoteIP": "string",
- "secureLogin": {
- "enabled": true,
- "supported": true
}, - "serialNumber": "string",
- "serviceAccountState": {
- "hasSecureToken": true,
- "passwordAPFSValid": true,
- "passwordODValid": true
}, - "sshRootEnabled": true,
- "sshdParams": [
- {
- "name": "string",
- "value": "string"
}
], - "systemInsights": {
- "state": "enabled"
}, - "systemTimezone": 0,
- "tags": [
- "string"
], - "templateName": "string",
- "userMetrics": [
- {
- "admin": true,
- "managed": true,
- "secureTokenEnabled": true,
- "suspended": true,
- "userName": "string"
}
], - "version": "string"
}
], - "totalCount": 0
}
Return System Users in multi-record format allowing for the passing of the filter
and searchFilter
parameters. This WILL NOT allow you to add a new system user.
To support advanced filtering you can use the filter
and searchFilter
parameters that can only be passed in the body of POST /api/search/* routes. The filter
and searchFilter
parameters must be passed as Content-Type application/json.
The filter
parameter is an object with a single property, either and
or or
with the value of the property being an array of query expressions.
This allows you to filter records using the logic of matching ALL or ANY records in the array of query expressions. If the and
or or
are not included the default behavior is to match ALL query expressions.
The searchFilter
parameter allows text searching on supported fields by specifying a searchTerm
and a list of fields
to query on. If any field
has a partial text match on the searchTerm
the record will be returned.
Exact search for a list of system users in a department
curl -X POST https://console.jumpcloud.com/api/search/systemusers \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d '{
"filter" : [{"department" : "IT"}],
"fields" : "email username sudo"
}'
Text search for system users with and email on a domain
curl -X POST https://console.jumpcloud.com/api/search/systemusers \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d '{
"searchFilter" : {
"searchTerm": "@jumpcloud.com",
"fields": ["email"]
},
"fields" : "email username sudo"
}'
Text search for multiple system users
curl -X POST https://console.jumpcloud.com/api/search/systemusers \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d '{
"searchFilter" : {
"searchTerm": ["john", "sarah"],
"fields": ["username"]
},
"fields" : "email username sudo"
}'
Combining filter
and searchFilter
to text search for system users with and email on a domain who are in a list of departments
curl -X POST https://console.jumpcloud.com/api/search/systemusers \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d '{
"searchFilter": {
"searchTerm": "@jumpcloud.com",
"fields": ["email"]
},
"filter": {
"or": [
{"department" : "IT"},
{"department" : "Sales"}
]
},
"fields" : "email username sudo"
}'
fields | string Default: "" 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. |
filter | string A filter to apply to the query. See the supported operators below. For more complex searches,
see the related Filter structure: field = Populate with a valid field from an endpoint response. operator = Supported operators are:
Note: v1 operators differ from v2 operators. Note: For v1 operators, excluding the value = Populate with the value you want to search for. Case sensitive. Examples
|
limit | integer Default: 10 The number of records to return at once. Limited to 100. |
skip | integer >= 0 Default: 0 The offset into the records to return. |
x-org-id | string Default: |
x-eventually-consistent | boolean Default: false EXPERIMENTAL! Use to acknowledge eventually consistent data in response. |
fields | string |
filter | object |
searchFilter | object |
{- "fields": "string",
- "filter": { },
- "searchFilter": { }
}
{- "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"
}
], - "admin": {
- "id": "string",
- "roleName": "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_date": "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"
}
], - "restrictedFields": [
- {
- "field": "addresses",
- "id": "string",
- "type": "active_directory"
}
], - "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
}
This endpoint returns all Systems.
curl -X GET https://console.jumpcloud.com/api/systems \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}'
fields | string Default: "" 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. |
limit | integer Default: 10 The number of records to return at once. Limited to 100. |
search | string A nested object containing a |
skip | integer >= 0 Default: 0 The offset into the records to return. |
sort | string Default: "" Use space separated sort parameters to sort the collection.
Default sort is ascending. Prefix with |
filter | string A filter to apply to the query. See the supported operators below. For more complex searches,
see the related Filter structure: field = Populate with a valid field from an endpoint response. operator = Supported operators are:
Note: v1 operators differ from v2 operators. Note: For v1 operators, excluding the value = Populate with the value you want to search for. Case sensitive. Examples
|
x-org-id | string Default: |
curl --request GET \ --url 'https://console.jumpcloud.com/api/systems?fields=&limit=10&search=SOME_STRING_VALUE&skip=0&sort=&filter=SOME_STRING_VALUE' \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "results": [
- {
- "_id": "string",
- "active": true,
- "agentVersion": "string",
- "allowMultiFactorAuthentication": true,
- "allowPublicKeyAuthentication": true,
- "allowSshPasswordAuthentication": true,
- "allowSshRootLogin": true,
- "amazonInstanceID": "string",
- "arch": "string",
- "archFamily": "string",
- "azureAdJoined": true,
- "builtInCommands": [
- {
- "name": "erase",
- "type": "security"
}
], - "connectionHistory": [
- { }
], - "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "desktopCapable": true,
- "displayManager": "string",
- "displayName": "string",
- "domainInfo": {
- "domainName": "string",
- "partOfDomain": true
}, - "fde": {
- "active": true,
- "keyPresent": true
}, - "fileSystem": "string",
- "hasServiceAccount": true,
- "hostname": "string",
- "hwVendor": "string",
- "isPolicyBound": true,
- "lastContact": "2019-08-24T14:15:22Z",
- "mdm": {
- "dep": true,
- "enrollmentType": "unknown",
- "internal": {
- "deviceId": "string",
- "windowsDeviceId": "string"
}, - "lostModeStatus": "string",
- "profileIdentifier": "string",
- "providerId": "string",
- "userApproved": true,
- "vendor": "unknown",
- "windows": {
- "upn": "string"
}
}, - "modifySSHDConfig": true,
- "networkInterfaces": [
- {
- "address": "string",
- "family": "IPv4",
- "internal": true,
- "name": "string"
}
], - "organization": "string",
- "os": "string",
- "osFamily": "string",
- "osVersionDetail": {
- "distributionName": "string",
- "major": "string",
- "majorNumber": 0,
- "minor": "string",
- "minorNumber": 0,
- "osName": "string",
- "patch": "string",
- "patchNumber": 0,
- "releaseName": "string",
- "revision": "string",
- "version": "string"
}, - "policyStats": {
- "duplicate": 0,
- "failed": 0,
- "pending": 0,
- "success": 0,
- "total": 0,
- "unsupportedOs": 0
}, - "primarySystemUser": {
- "id": "string"
}, - "provisionMetadata": {
- "provisioner": {
- "provisionerId": "string",
- "type": "administrator"
}
}, - "remoteAssistAgentVersion": "string",
- "remoteIP": "string",
- "secureLogin": {
- "enabled": true,
- "supported": true
}, - "serialNumber": "string",
- "serviceAccountState": {
- "hasSecureToken": true,
- "passwordAPFSValid": true,
- "passwordODValid": true
}, - "sshRootEnabled": true,
- "sshdParams": [
- {
- "name": "string",
- "value": "string"
}
], - "systemInsights": {
- "state": "enabled"
}, - "systemTimezone": 0,
- "tags": [
- "string"
], - "templateName": "string",
- "userMetrics": [
- {
- "admin": true,
- "managed": true,
- "secureTokenEnabled": true,
- "suspended": true,
- "userName": "string"
}
], - "version": "string"
}
], - "totalCount": 0
}
This endpoint allows you to delete a system. This command will cause the system to uninstall the JumpCloud agent from its self which can can take about a minute. If the system is not connected to JumpCloud the system record will simply be removed.
curl -X DELETE https://console.jumpcloud.com/api/systems/{SystemID} \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}'
id required | string |
Date | string Current date header for the System Context API |
Authorization | string Authorization header for the System Context API |
x-org-id | string Default: |
curl --request DELETE \ --url https://console.jumpcloud.com/api/systems/{id} \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "_id": "string",
- "active": true,
- "agentVersion": "string",
- "allowMultiFactorAuthentication": true,
- "allowPublicKeyAuthentication": true,
- "allowSshPasswordAuthentication": true,
- "allowSshRootLogin": true,
- "amazonInstanceID": "string",
- "arch": "string",
- "archFamily": "string",
- "azureAdJoined": true,
- "builtInCommands": [
- {
- "name": "erase",
- "type": "security"
}
], - "connectionHistory": [
- { }
], - "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "desktopCapable": true,
- "displayManager": "string",
- "displayName": "string",
- "domainInfo": {
- "domainName": "string",
- "partOfDomain": true
}, - "fde": {
- "active": true,
- "keyPresent": true
}, - "fileSystem": "string",
- "hasServiceAccount": true,
- "hostname": "string",
- "hwVendor": "string",
- "isPolicyBound": true,
- "lastContact": "2019-08-24T14:15:22Z",
- "mdm": {
- "dep": true,
- "enrollmentType": "unknown",
- "internal": {
- "deviceId": "string",
- "windowsDeviceId": "string"
}, - "lostModeStatus": "string",
- "profileIdentifier": "string",
- "providerId": "string",
- "userApproved": true,
- "vendor": "unknown",
- "windows": {
- "upn": "string"
}
}, - "modifySSHDConfig": true,
- "networkInterfaces": [
- {
- "address": "string",
- "family": "IPv4",
- "internal": true,
- "name": "string"
}
], - "organization": "string",
- "os": "string",
- "osFamily": "string",
- "osVersionDetail": {
- "distributionName": "string",
- "major": "string",
- "majorNumber": 0,
- "minor": "string",
- "minorNumber": 0,
- "osName": "string",
- "patch": "string",
- "patchNumber": 0,
- "releaseName": "string",
- "revision": "string",
- "version": "string"
}, - "policyStats": {
- "duplicate": 0,
- "failed": 0,
- "pending": 0,
- "success": 0,
- "total": 0,
- "unsupportedOs": 0
}, - "primarySystemUser": {
- "id": "string"
}, - "provisionMetadata": {
- "provisioner": {
- "provisionerId": "string",
- "type": "administrator"
}
}, - "remoteAssistAgentVersion": "string",
- "remoteIP": "string",
- "secureLogin": {
- "enabled": true,
- "supported": true
}, - "serialNumber": "string",
- "serviceAccountState": {
- "hasSecureToken": true,
- "passwordAPFSValid": true,
- "passwordODValid": true
}, - "sshRootEnabled": true,
- "sshdParams": [
- {
- "name": "string",
- "value": "string"
}
], - "systemInsights": {
- "state": "enabled"
}, - "systemTimezone": 0,
- "tags": [
- "string"
], - "templateName": "string",
- "userMetrics": [
- {
- "admin": true,
- "managed": true,
- "secureTokenEnabled": true,
- "suspended": true,
- "userName": "string"
}
], - "version": "string"
}
This endpoint returns an individual system.
curl -X GET https://console.jumpcloud.com/api/systems/{SystemID} \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}'
id required | string |
fields | string Default: "" 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. |
filter | string A filter to apply to the query. See the supported operators below. For more complex searches,
see the related Filter structure: field = Populate with a valid field from an endpoint response. operator = Supported operators are:
Note: v1 operators differ from v2 operators. Note: For v1 operators, excluding the value = Populate with the value you want to search for. Case sensitive. Examples
|
Date | string Current date header for the System Context API |
Authorization | string Authorization header for the System Context API |
x-org-id | string Default: |
curl --request GET \ --url 'https://console.jumpcloud.com/api/systems/{id}?fields=&filter=SOME_STRING_VALUE' \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "_id": "string",
- "active": true,
- "agentVersion": "string",
- "allowMultiFactorAuthentication": true,
- "allowPublicKeyAuthentication": true,
- "allowSshPasswordAuthentication": true,
- "allowSshRootLogin": true,
- "amazonInstanceID": "string",
- "arch": "string",
- "archFamily": "string",
- "azureAdJoined": true,
- "builtInCommands": [
- {
- "name": "erase",
- "type": "security"
}
], - "connectionHistory": [
- { }
], - "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "desktopCapable": true,
- "displayManager": "string",
- "displayName": "string",
- "domainInfo": {
- "domainName": "string",
- "partOfDomain": true
}, - "fde": {
- "active": true,
- "keyPresent": true
}, - "fileSystem": "string",
- "hasServiceAccount": true,
- "hostname": "string",
- "hwVendor": "string",
- "isPolicyBound": true,
- "lastContact": "2019-08-24T14:15:22Z",
- "mdm": {
- "dep": true,
- "enrollmentType": "unknown",
- "internal": {
- "deviceId": "string",
- "windowsDeviceId": "string"
}, - "lostModeStatus": "string",
- "profileIdentifier": "string",
- "providerId": "string",
- "userApproved": true,
- "vendor": "unknown",
- "windows": {
- "upn": "string"
}
}, - "modifySSHDConfig": true,
- "networkInterfaces": [
- {
- "address": "string",
- "family": "IPv4",
- "internal": true,
- "name": "string"
}
], - "organization": "string",
- "os": "string",
- "osFamily": "string",
- "osVersionDetail": {
- "distributionName": "string",
- "major": "string",
- "majorNumber": 0,
- "minor": "string",
- "minorNumber": 0,
- "osName": "string",
- "patch": "string",
- "patchNumber": 0,
- "releaseName": "string",
- "revision": "string",
- "version": "string"
}, - "policyStats": {
- "duplicate": 0,
- "failed": 0,
- "pending": 0,
- "success": 0,
- "total": 0,
- "unsupportedOs": 0
}, - "primarySystemUser": {
- "id": "string"
}, - "provisionMetadata": {
- "provisioner": {
- "provisionerId": "string",
- "type": "administrator"
}
}, - "remoteAssistAgentVersion": "string",
- "remoteIP": "string",
- "secureLogin": {
- "enabled": true,
- "supported": true
}, - "serialNumber": "string",
- "serviceAccountState": {
- "hasSecureToken": true,
- "passwordAPFSValid": true,
- "passwordODValid": true
}, - "sshRootEnabled": true,
- "sshdParams": [
- {
- "name": "string",
- "value": "string"
}
], - "systemInsights": {
- "state": "enabled"
}, - "systemTimezone": 0,
- "tags": [
- "string"
], - "templateName": "string",
- "userMetrics": [
- {
- "admin": true,
- "managed": true,
- "secureTokenEnabled": true,
- "suspended": true,
- "userName": "string"
}
], - "version": "string"
}
This endpoint allows you to update a system.
curl -X PUT https://console.jumpcloud.com/api/systems/{SystemID} \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d '{
"displayName":"Name_Update",
"allowSshPasswordAuthentication":"true",
"allowSshRootLogin":"true",
"allowMultiFactorAuthentication":"true",
"allowPublicKeyAuthentication":"false"
}'
id required | string |
Date | string Current date header for the System Context API |
Authorization | string Authorization header for the System Context API |
x-org-id | string Default: |
Array of objects | |
allowMultiFactorAuthentication | boolean |
allowPublicKeyAuthentication | boolean |
allowSshPasswordAuthentication | boolean |
allowSshRootLogin | boolean |
displayName | string |
tags | Array of strings |
{- "agentBoundMessages": [
- {
- "cmd": "string"
}
], - "allowMultiFactorAuthentication": true,
- "allowPublicKeyAuthentication": true,
- "allowSshPasswordAuthentication": true,
- "allowSshRootLogin": true,
- "displayName": "string",
- "tags": [
- "string"
]
}
{- "_id": "string",
- "active": true,
- "agentVersion": "string",
- "allowMultiFactorAuthentication": true,
- "allowPublicKeyAuthentication": true,
- "allowSshPasswordAuthentication": true,
- "allowSshRootLogin": true,
- "amazonInstanceID": "string",
- "arch": "string",
- "archFamily": "string",
- "azureAdJoined": true,
- "builtInCommands": [
- {
- "name": "erase",
- "type": "security"
}
], - "connectionHistory": [
- { }
], - "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "desktopCapable": true,
- "displayManager": "string",
- "displayName": "string",
- "domainInfo": {
- "domainName": "string",
- "partOfDomain": true
}, - "fde": {
- "active": true,
- "keyPresent": true
}, - "fileSystem": "string",
- "hasServiceAccount": true,
- "hostname": "string",
- "hwVendor": "string",
- "isPolicyBound": true,
- "lastContact": "2019-08-24T14:15:22Z",
- "mdm": {
- "dep": true,
- "enrollmentType": "unknown",
- "internal": {
- "deviceId": "string",
- "windowsDeviceId": "string"
}, - "lostModeStatus": "string",
- "profileIdentifier": "string",
- "providerId": "string",
- "userApproved": true,
- "vendor": "unknown",
- "windows": {
- "upn": "string"
}
}, - "modifySSHDConfig": true,
- "networkInterfaces": [
- {
- "address": "string",
- "family": "IPv4",
- "internal": true,
- "name": "string"
}
], - "organization": "string",
- "os": "string",
- "osFamily": "string",
- "osVersionDetail": {
- "distributionName": "string",
- "major": "string",
- "majorNumber": 0,
- "minor": "string",
- "minorNumber": 0,
- "osName": "string",
- "patch": "string",
- "patchNumber": 0,
- "releaseName": "string",
- "revision": "string",
- "version": "string"
}, - "policyStats": {
- "duplicate": 0,
- "failed": 0,
- "pending": 0,
- "success": 0,
- "total": 0,
- "unsupportedOs": 0
}, - "primarySystemUser": {
- "id": "string"
}, - "provisionMetadata": {
- "provisioner": {
- "provisionerId": "string",
- "type": "administrator"
}
}, - "remoteAssistAgentVersion": "string",
- "remoteIP": "string",
- "secureLogin": {
- "enabled": true,
- "supported": true
}, - "serialNumber": "string",
- "serviceAccountState": {
- "hasSecureToken": true,
- "passwordAPFSValid": true,
- "passwordODValid": true
}, - "sshRootEnabled": true,
- "sshdParams": [
- {
- "name": "string",
- "value": "string"
}
], - "systemInsights": {
- "state": "enabled"
}, - "systemTimezone": 0,
- "tags": [
- "string"
], - "templateName": "string",
- "userMetrics": [
- {
- "admin": true,
- "managed": true,
- "secureTokenEnabled": true,
- "suspended": true,
- "userName": "string"
}
], - "version": "string"
}
This endpoint allows you to run the erase 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.
curl -X POST \
https://console.jumpcloud.com/api/systems/{system_id}/command/builtin/erase \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d {}
system_id required | string |
x-org-id | string Default: |
curl --request POST \ --url https://console.jumpcloud.com/api/systems/{system_id}/command/builtin/erase \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "code": 0,
- "message": "string",
- "status": "string"
}
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.
curl -X POST \
https://console.jumpcloud.com/api/systems/{system_id}/command/builtin/lock \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d {}
system_id required | string |
x-org-id | string Default: |
curl --request POST \ --url https://console.jumpcloud.com/api/systems/{system_id}/command/builtin/lock \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "code": 0,
- "message": "string",
- "status": "string"
}
This endpoint allows you to run the restart 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.
curl -X POST \
https://console.jumpcloud.com/api/systems/{system_id}/command/builtin/restart \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d {}
system_id required | string |
x-org-id | string Default: |
curl --request POST \ --url https://console.jumpcloud.com/api/systems/{system_id}/command/builtin/restart \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "code": 0,
- "message": "string",
- "status": "string"
}
This endpoint allows you to run the shutdown 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.
curl -X POST \
https://console.jumpcloud.com/api/systems/{system_id}/command/builtin/shutdown \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d {}
system_id required | string |
x-org-id | string Default: |
curl --request POST \ --url https://console.jumpcloud.com/api/systems/{system_id}/command/builtin/shutdown \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "code": 0,
- "message": "string",
- "status": "string"
}
This endpoint returns all systemusers.
curl -X GET https://console.jumpcloud.com/api/systemusers \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}'
limit | integer Default: 10 The number of records to return at once. |
skip | integer Default: 0 The offset into the records to return. |
sort | string Default: "" The space separated fields used to sort the collection.
Default sort is ascending, prefix with |
fields | string Default: "" The space separated fields included in the returned records. If omitted the default list of fields will be returned. |
filter | string A filter to apply to the query. See the supported operators below. For more complex searches,
see the related Filter structure: field = Populate with a valid field from an endpoint response. operator = Supported operators are:
Note: v1 operators differ from v2 operators. Note: For v1 operators, excluding the value = Populate with the value you want to search for. Case sensitive. Examples
|
search | string A nested object containing a |
x-org-id | string Default: |
curl --request GET \ --url 'https://console.jumpcloud.com/api/systemusers?limit=10&skip=0&sort=&fields=&filter=SOME_STRING_VALUE&search=SOME_STRING_VALUE' \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "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"
}
], - "admin": {
- "id": "string",
- "roleName": "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_date": "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"
}
], - "restrictedFields": [
- {
- "field": "addresses",
- "id": "string",
- "type": "active_directory"
}
], - "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
}
"This endpoint allows you to create a new system user.
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.
curl -X POST https://console.jumpcloud.com/api/systemusers \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d '{
"username":"{username}",
"email":"{email_address}",
"firstname":"{Name}",
"lastname":"{Name}"
}'
fullValidationDetails | string 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 validation flagUse the
Without the flag, default behavior will be a normal 400 with only a single validation string error Expected BehaviorClients can expect a list of validation error mappings for the validation query field in the details provided on the response:
|
x-org-id | string Default: |
account_locked | boolean |
activated | boolean |
Array of objects | |
allow_public_key | boolean |
alternateEmail | string |
Array of objects | |
company | string |
costCenter | string |
department | string |
description | string <= 1024 characters |
disableDeviceMaxLoginAttempts | boolean |
displayname | string |
email required | string <= 1024 characters |
employeeIdentifier | string <= 256 characters Must be unique per user. |
employeeType | string |
enable_managed_uid | boolean |
enable_user_portal_multifactor | boolean |
external_dn | string |
external_password_expiration_date | string <date-time> |
external_source_type | string |
externally_managed | boolean (externallymanagedpropertyinfo) The externally_managed property has been deprecated. Whenever a user has their externally_managed field modified their restrictedFields property gets populated with the appropriate value, even if it is already set to a value an administrator manually set. |
firstname | string |
jobTitle | string |
lastname | string |
ldap_binding_user | boolean |
location | string |
managedAppleId | string <= 1024 characters |
manager | string Relation with another systemuser to identify the last as a manager. |
object (mfa) | |
middlename | string |
password | string |
password_never_expires | boolean |
passwordless_sudo | boolean |
Array of objects | |
public_key | string |
object | |
Array of objects | |
Array of objects (restrictedField) | |
samba_service_user | boolean |
state | string Enum: "STAGED" "ACTIVATED" "SUSPENDED" |
sudo | boolean |
suspended | boolean |
tags | Array of strings |
unix_guid | integer >= 1 |
unix_uid | integer >= 1 |
username required | 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": "string",
- "value": "string"
}
], - "company": "string",
- "costCenter": "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": "2019-08-24T14:15:22Z",
- "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"
}, - "middlename": "string",
- "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": "addresses",
- "id": "string",
- "type": "active_directory"
}
], - "samba_service_user": true,
- "state": "STAGED",
- "sudo": true,
- "suspended": true,
- "tags": [
- "string"
], - "unix_guid": 1,
- "unix_uid": 1,
- "username": "string"
}
{- "_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"
}
], - "admin": {
- "id": "string",
- "roleName": "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_date": "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"
}
], - "restrictedFields": [
- {
- "field": "addresses",
- "id": "string",
- "type": "active_directory"
}
], - "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"
}
This endpoint allows you to delete a particular system user.
curl -X DELETE https://console.jumpcloud.com/api/systemusers/{UserID} \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}'
id required | string |
cascade_manager | string 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. |
x-org-id | string Default: |
curl --request DELETE \ --url 'https://console.jumpcloud.com/api/systemusers/{id}?cascade_manager=SOME_STRING_VALUE' \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "_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"
}
], - "admin": {
- "id": "string",
- "roleName": "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_date": "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"
}
], - "restrictedFields": [
- {
- "field": "addresses",
- "id": "string",
- "type": "active_directory"
}
], - "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"
}
This endpoint returns a particular System User.
curl -X GET https://console.jumpcloud.com/api/systemusers/{UserID} \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}'
id required | string |
fields | string Default: "" 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. |
filter | string A filter to apply to the query. See the supported operators below. For more complex searches,
see the related Filter structure: field = Populate with a valid field from an endpoint response. operator = Supported operators are:
Note: v1 operators differ from v2 operators. Note: For v1 operators, excluding the value = Populate with the value you want to search for. Case sensitive. Examples
|
x-org-id | string Default: |
curl --request GET \ --url 'https://console.jumpcloud.com/api/systemusers/{id}?fields=&filter=SOME_STRING_VALUE' \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "_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"
}
], - "admin": {
- "id": "string",
- "roleName": "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_date": "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"
}
], - "restrictedFields": [
- {
- "field": "addresses",
- "id": "string",
- "type": "active_directory"
}
], - "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"
}
This endpoint allows you to update a system user.
curl -X PUT https://console.jumpcloud.com/api/systemusers/{UserID} \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d '{
"email":"{email_address}",
"firstname":"{Name}",
"lastname":"{Name}"
}'
id required | string |
fullValidationDetails | string This endpoint can take in a query when a client wants all validation errors to be returned with error response for the form field specified, i.e. 'password' Password validation flagUse the "password" validation flag to receive details on a possible bad request response
Without the
Expected BehaviorClients can expect a list of validation error mappings for the validation query field in the details provided on the response:
|
x-org-id | string Default: |
account_locked | boolean |
Array of objects type, poBox, extendedAddress, streetAddress, locality, region, postalCode, country | |
allow_public_key | boolean |
alternateEmail | string |
Array of objects | |
company | string <= 1024 characters |
costCenter | string <= 1024 characters |
department | string <= 1024 characters |
description | string <= 1024 characters |
disableDeviceMaxLoginAttempts | boolean |
displayname | string <= 1024 characters |
string <= 1024 characters | |
employeeIdentifier | string <= 256 characters Must be unique per user. |
employeeType | string <= 1024 characters |
enable_managed_uid | boolean |
enable_user_portal_multifactor | boolean |
external_dn | string |
external_password_expiration_date | string |
external_source_type | string |
externally_managed | boolean (externallymanagedpropertyinfo) The externally_managed property has been deprecated. Whenever a user has their externally_managed field modified their restrictedFields property gets populated with the appropriate value, even if it is already set to a value an administrator manually set. |
firstname | string <= 1024 characters |
jobTitle | string <= 1024 characters |
lastname | string <= 1024 characters |
ldap_binding_user | boolean |
location | string <= 1024 characters |
managedAppleId | string <= 1024 characters |
manager | string Relation with another systemuser to identify the last as a manager. |
object (mfa) | |
middlename | string <= 1024 characters |
password | string |
password_never_expires | boolean |
Array of objects | |
public_key | string |
Array of objects | |
Array of objects (restrictedField) | |
samba_service_user | boolean |
Array of objects (SSHKeyPost) | |
state | string Enum: "ACTIVATED" "SUSPENDED" |
sudo | boolean |
suspended | boolean |
tags | Array of strings |
unix_guid | integer >= 1 |
unix_uid | integer >= 1 |
username | string <= 1024 characters |
{- "account_locked": 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": "string",
- "value": "string"
}
], - "company": "string",
- "costCenter": "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"
}, - "middlename": "string",
- "password": "string",
- "password_never_expires": true,
- "phoneNumbers": [
- {
- "number": "string",
- "type": "string"
}
], - "public_key": "string",
- "relationships": [
- {
- "type": "string",
- "value": "string"
}
], - "restrictedFields": [
- {
- "field": "addresses",
- "id": "string",
- "type": "active_directory"
}
], - "samba_service_user": true,
- "ssh_keys": [
- {
- "name": "string",
- "public_key": "string"
}
], - "state": "ACTIVATED",
- "sudo": true,
- "suspended": true,
- "tags": [
- "string"
], - "unix_guid": 1,
- "unix_uid": 1,
- "username": "string"
}
{- "_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"
}
], - "admin": {
- "id": "string",
- "roleName": "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_date": "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"
}
], - "restrictedFields": [
- {
- "field": "addresses",
- "id": "string",
- "type": "active_directory"
}
], - "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"
}
This endpoint allows you to expire a user's password.
id required | string |
x-org-id | string Default: |
curl --request POST \ --url https://console.jumpcloud.com/api/systemusers/{id}/expire \ --header 'x-api-key: REPLACE_KEY_VALUE'
"string"
This endpoint allows you to re-sync a user's mfa enrollment status
curl -X POST \
https://console.jumpcloud.com/api/systemusers/{UserID}/mfasync \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
id required | string |
curl --request POST \ --url https://console.jumpcloud.com/api/systemusers/{id}/mfasync \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "code": 0,
- "message": "string",
- "status": "string"
}
This endpoint allows you to reset the TOTP key for a specified system user and put them in an TOTP MFA enrollment period. This will result in the user being prompted to setup TOTP MFA when logging into userportal. Please be aware that if the user does not complete TOTP MFA setup before the exclusionUntil
date, they will be locked out of any resources that require TOTP MFA.
Please refer to our Knowledge Base Article on setting up MFA for more information.
curl -X POST \
https://console.jumpcloud.com/api/systemusers/{UserID}/resetmfa \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d '{"exclusion": true, "exclusionUntil": "{date-time}"}'
id required | string |
x-org-id | string Default: |
exclusion | boolean |
exclusionDays | number >= 1 |
exclusionUntil | string <date-time> |
{- "exclusion": true,
- "exclusionDays": 1,
- "exclusionUntil": "2019-08-24T14:15:22Z"
}
"string"
This endpoint will return a specific System User's public SSH key.
id required | string |
x-org-id | string Default: |
curl --request GET \ --url https://console.jumpcloud.com/api/systemusers/{id}/sshkeys \ --header 'x-api-key: REPLACE_KEY_VALUE'
[- {
- "_id": "string",
- "create_date": "string",
- "name": "string",
- "public_key": "string"
}
]
This endpoint will create a specific System User's Public SSH Key.
id required | string |
x-org-id | string Default: |
name required | string The name of the SSH key. |
public_key required | string The Public SSH key. |
{- "name": "string",
- "public_key": "string"
}
{- "_id": "string",
- "create_date": "string",
- "name": "string",
- "public_key": "string"
}
This endpoint changes the state of a STAGED user to ACTIVATED.
Use the "email" flag to determine whether or not to send a Welcome or
Activation email to the newly activated user. Sending an empty body
without the email
flag, will send an email with default behavior
(see the "Behavior" section below)
{}
Sending email=true
flag will send an email with default behavior (see Behavior
below)
{ "email": true }
Populated email will override the default behavior and send to the specified email value
{ "email": "example@example.com" }
Sending email=false
will suppress sending the email
{ "email": false }
Users with a password will be sent a Welcome email to:
email
flag in the requestemail
flag, the user's primary email address (default behavior)
Users without a password will be sent an Activation email to:email
flag in the requestemail
flag, the user's alternate email address (default behavior)curl -X POST https://console.jumpcloud.com/api/systemusers/{id}/state/activate \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: <api-key>' \
-d '{ "email": "alternate-activation-email@email.com" }'
id required | string |
object |
{- "email": { }
}
"string"
This endpoint will return info for a specific System User's TOTP enrollment.
id required | string |
x-org-id | string Default: |
curl --request GET \ --url https://console.jumpcloud.com/api/systemusers/{id}/totpinfo \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "enrollmentDate": "2019-08-24T14:15:22Z"
}
This endpoint allows you to unlock a user's account.
id required | string |
x-org-id | string Default: |
curl --request POST \ --url https://console.jumpcloud.com/api/systemusers/{id}/unlock \ --header 'x-api-key: REPLACE_KEY_VALUE'
"string"
This endpoint will delete a specific System User's SSH Key.
systemuser_id required | string |
id required | string |
x-org-id | string Default: |
curl --request DELETE \ --url https://console.jumpcloud.com/api/systemusers/{systemuser_id}/sshkeys/{id} \ --header 'x-api-key: REPLACE_KEY_VALUE'
"string"
This endpoint triggers the sending of a reactivation e-mail to an administrator.
id required | string |
curl --request GET \ --url https://console.jumpcloud.com/api/users/reactivate/{id} \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "code": 0,
- "message": "string",
- "status": "string"
}
This endpoint initiates a TOTP reset for an admin. This request does not accept a body.
id required | string |
curl --request POST \ --url https://console.jumpcloud.com/api/users/resettotp/{id} \ --header 'x-api-key: REPLACE_KEY_VALUE'
{- "code": 0,
- "message": "string",
- "status": "string"
}
This endpoint allows you to update a user.
id required | string |
x-org-id | string Default: |
apiKeyAllowed | boolean |
string <email> <= 1024 characters | |
enableMultiFactor | boolean |
firstname | string |
growthData | object |
lastWhatsNewChecked | string <date> |
lastname | string |
roleName | string |
{- "apiKeyAllowed": true,
- "email": "user@example.com",
- "enableMultiFactor": true,
- "firstname": "string",
- "growthData": { },
- "lastWhatsNewChecked": "2019-08-24",
- "lastname": "string",
- "roleName": "string"
}
{- "_id": "string",
- "apiKeyAllowed": true,
- "apiKeyHash": {
- "createdAt": "2019-08-24T14:15:22Z",
- "expireAt": "2019-08-24T14:15:22Z",
- "prefix": "string"
}, - "apiKeySet": true,
- "apiKeyUpdatedAt": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "disableIntroduction": true,
- "email": "string",
- "enableMultiFactor": true,
- "firstname": "string",
- "growthData": {
- "experimentStates": { },
- "onboardingState": { }
}, - "lastWhatsNewChecked": "2019-08-24T14:15:22Z",
- "lastname": "string",
- "organization": "string",
- "passwordUpdatedAt": "2019-08-24T14:15:22Z",
- "provider": "string",
- "role": "string",
- "roleName": "string",
- "sessionCount": 0,
- "suspended": true,
- "totpEnrolled": true,
- "totpUpdatedAt": "2019-08-24T14:15:22Z",
- "usersTimeZone": "string"
}