JumpCloud

https://docs.jumpcloud.com/
Admin
JumpCloud is a cloud directory platform that unifies identity, access, and device management,...
Tokens:1,197,428
Snippets:7,151
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Get G Suite - Python Example

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Python example for getting a specific G Suite. Uses the requests library with headers x-org-id and x-api-key, then prints the response text.

```Python
import requests

url = "https://console.jumpcloud.com/api/v2/gsuites/{id}"

headers = {
    "x-org-id": "SOME_STRING_VALUE",
    "x-api-key": "REPLACE_KEY_VALUE"
}

response = requests.request("GET", url, headers=headers)

print(response.text)
```

--------------------------------

### Get G Suite - PowerShell Example

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

PowerShell example for getting a specific G Suite. Uses Invoke-RestMethod with headers x-org-id and x-api-key.

```Powershell
$headers=@{}
$headers.Add("x-org-id", "SOME_STRING_VALUE")
$headers.Add("x-api-key", "REPLACE_KEY_VALUE")
$response = Invoke-RestMethod -Uri 'https://console.jumpcloud.com/api/v2/gsuites/{id}' -Method GET -Headers $headers
```

--------------------------------

### Get Office 365 Instance (Shell)

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Shell example for getting a specific Office 365 instance. Requires x-api-key and x-org-id headers.

```Shell
curl --request GET \
  --url https://console.jumpcloud.com/api/v2/office365s/{office365_id} \
  --header 'x-api-key: REPLACE_KEY_VALUE' \
  --header 'x-org-id: SOME_STRING_VALUE'
```

--------------------------------

### Get sample data (GET /sample-data)

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Retrieves sample data from the JumpCloud v2 API. Replace REPLACE_KEY_VALUE with your API key. The Shell example uses curl, the Python example uses the requests library, and the PowerShell example uses Invoke-RestMethod.

```Shell
curl --request GET \
  --url 'https://console.jumpcloud.com/api/v2/sample-data' \
  --header 'x-api-key: REPLACE_KEY_VALUE'
```

```Python
import requests

url = "https://console.jumpcloud.com/api/v2/sample-data"

headers = {"x-api-key": "REPLACE_KEY_VALUE"}

response = requests.request("GET", url, headers=headers)

print(response.text)
```

```Powershell
$headers=@{}
$headers.Add("x-api-key", "REPLACE_KEY_VALUE")
$response = Invoke-RestMethod -Uri 'https://console.jumpcloud.com/api/v2/sample-data' -Method GET -Headers $headers
```

--------------------------------

### Get G Suite - Shell Example

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Shell example for getting a specific G Suite. Uses the endpoint /gsuites/{id} with headers x-api-key and x-org-id.

```Shell
curl --request GET \
  --url https://console.jumpcloud.com/api/v2/gsuites/{id} \
  --header 'x-api-key: REPLACE_KEY_VALUE' \
  --header 'x-org-id: SOME_STRING_VALUE'
```

--------------------------------

### Example | startsWith (prefix)

Source: https://docs.jumpcloud.com/new/reference/index.html

Query that matches events where the username field starts with the prefix 'adm'.

```json
{
  "service": ["all"],
  "start_time": "2026-05-01T00:00:00Z",
  "search_term": {
    "and": [
      {
        "field": "username",
        "operator": "startsWith",
        "value": "adm"
      }
    ]
  }
}

```

--------------------------------

### Get Device Asset with Python

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Python example using the requests library to GET a device asset. Replace {id} and REPLACE_KEY_VALUE with your values.

```Python
import requests

url = "https://console.jumpcloud.com/api/v2/assets/devices/{id}"

headers = {"x-api-key": "REPLACE_KEY_VALUE"}

response = requests.request("GET", url, headers=headers)
```

--------------------------------

### Get Office 365 Instance (Python)

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Python example using the requests library to get a specific Office 365 instance. Requires x-org-id and x-api-key headers.

```Python
import requests

url = "https://console.jumpcloud.com/api/v2/office365s/{office365_id}"

headers = {
    "x-org-id": "SOME_STRING_VALUE",
    "x-api-key": "REPLACE_KEY_VALUE"
}

response = requests.request("GET", url, headers=headers)

print(response.text)
```

--------------------------------

### List devices (Python example)

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Python example for the Devices_ListDevices operation. Uses the requests library to send a GET request with query parameters and an API key header. Prints the response text.

```python
import requests

url = "https://console.jumpcloud.com/api/v2/google-emm/enterprises/{enterpriseObjectId}/devices"

querystring = {"limit":"SOME_STRING_VALUE","skip":"SOME_STRING_VALUE","filter":"SOME_ARRAY_VALUE"}

headers = {"x-api-key": "REPLACE_KEY_VALUE"}

response = requests.request("GET", url, headers=headers, params=querystring)

print(response.text)
```

--------------------------------

### GET /api/systemusers example

Source: https://docs.jumpcloud.com/new

Example JumpCloud API request and response for GET /api/systemusers. Shows a sample response with user fields and totalCount.

```http
GET /api/systemusers
{
  "results": [
    {
      "_id": "5f14e379abf74…",
      "username": "jane.doe",
      "email": "jane@example.com",
      "state": "ACTIVATED",
      "firstname": "Jane",
      "lastname": "Doe"
    }
  ],
  "totalCount": 42
}
```

--------------------------------

### Python Setup for Creating Authentication Policy

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Python example using the requests library to set up the URL for creating an authentication policy. The snippet is incomplete as shown; it only defines the URL and does not include the request call.

```Python
import requests

url = "https://console.jumpcloud.com/api/v2/authn/policies"
```

--------------------------------

### List devices (Shell example)

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Shell example for the Devices_ListDevices operation. Uses query parameters limit, skip, and filter. Replace the placeholder values and API key.

```shell
curl --request GET \
  --url 'https://console.jumpcloud.com/api/v2/google-emm/enterprises/{enterpriseObjectId}/devices?limit=SOME_STRING_VALUE&skip=SOME_STRING_VALUE&filter=SOME_ARRAY_VALUE' \
  --header 'x-api-key: REPLACE_KEY_VALUE'
```

--------------------------------

### Get ADUE JSON Configuration (GET /applemdms/{organizationObjectId}/account-driven-service-discovery/config)

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Retrieves the JSON Configuration for Account Driven Enrollment Configuration (ADUE). The endpoint is GET /applemdms/{organizationObjectId}/account-driven-service-discovery/config. The Shell example uses curl with a GET request; the Python example uses the requests library; the Powershell example uses Invoke-RestMethod. Replace {organizationObjectId} with the actual organization object ID.

```Shell
curl --request GET \
  --url https://console.jumpcloud.com/api/v2/applemdms/{organizationObjectId}/account-driven-service-discovery/config
```

```Python
import requests

url = "https://console.jumpcloud.com/api/v2/applemdms/{organizationObjectId}/account-driven-service-discovery/config"

response = requests.request("GET", url)

print(response.text)
```

```Powershell
$response = Invoke-RestMethod -Uri 'https://console.jumpcloud.com/api/v2/applemdms/{organizationObjectId}/account-driven-service-discovery/config' -Method GET 
```

--------------------------------

### Get ADUE Redirect URL (GET /applemdms/{organizationObjectId}/account-driven-service-discovery)

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Retrieves the Redirect URL for Account Driven Enrollment Configuration (ADUE). The endpoint is GET /applemdms/{organizationObjectId}/account-driven-service-discovery. The Shell example uses curl with a GET request; the Python example uses the requests library; the Powershell example uses Invoke-RestMethod. Replace {organizationObjectId} with the actual organization object ID.

```Shell
curl --request GET \
  --url https://console.jumpcloud.com/api/v2/applemdms/{organizationObjectId}/account-driven-service-discovery
```

```Python
import requests

url = "https://console.jumpcloud.com/api/v2/applemdms/{organizationObjectId}/account-driven-service-discovery"

response = requests.request("GET", url)

print(response.text)
```

```Powershell
$response = Invoke-RestMethod -Uri 'https://console.jumpcloud.com/api/v2/applemdms/{organizationObjectId}/account-driven-service-discovery' -Method GET 
```

--------------------------------

### Example Request with One Organization

Source: https://docs.jumpcloud.com/new/api/insights/directory/index.yaml

Example request for MSPs querying a single client organization. Uses an MSP admin API key and an organization ID.

```bash
curl -X POST \
  -H 'x-api-key: REPLACE_KEY_VALUE' \
  -H 'Content-Type: application/json' \
  --data '{"service": ["all"], "start_time": "2020-03-03T14:00:00Z", "org_id": "REPLACE_ORG_ID"}' \
  --url https://api.jumpcloud.com/insights/directory/v1/events
```

--------------------------------

### List Policies - Shell (x-codeSamples)

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Alternative Shell example for listing policies with query parameters. Replace placeholder values with actual values.

```Shell
curl --request GET \
  --url 'https://console.jumpcloud.com/api/v2/policies?fields=SOME_ARRAY_VALUE&filter=SOME_ARRAY_VALUE&limit=SOME_INTEGER_VALUE&skip=SOME_INTEGER_VALUE&sort=SOME_ARRAY_VALUE' \
  --header 'x-api-key: REPLACE_KEY_VALUE' \
  --header 'x-org-id: SOME_STRING_VALUE'
```

--------------------------------

### List subscriptions (Python)

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Python sample to list all pricing & packaging subscriptions using the requests library.

```Python
import requests

url = "https://console.jumpcloud.com/api/v2/subscriptions"

response = requests.request("GET", url)

print(response.text)
```

--------------------------------

### List System Group Associations (GET) - Shell (x-codeSamples)

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Alternative Shell example from the x-codeSamples section for listing associations. Uses query parameters for targets, limit, and skip, and includes x-org-id header.

```Shell
curl --request GET \
  --url 'https://console.jumpcloud.com/api/v2/systemgroups/{group_id}/associations?targets=SOME_ARRAY_VALUE&limit=SOME_INTEGER_VALUE&skip=SOME_INTEGER_VALUE' \
  --header 'x-api-key: REPLACE_KEY_VALUE' \
  --header 'x-org-id: SOME_STRING_VALUE'
```

--------------------------------

### GET /users/{user_id}/policies - Python Example

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Python example for the Graph User Traverse Policy endpoint. Uses the requests library to send a GET request with query parameters and headers.

```Python
import requests

url = "https://console.jumpcloud.com/api/v2/users/{user_id}/policies"

querystring = {"limit":"SOME_INTEGER_VALUE","skip":"SOME_INTEGER_VALUE","filter":"SOME_ARRAY_VALUE"}

headers = {
    "x-org-id": "SOME_STRING_VALUE",
    "x-api-key": "REPLACE_KEY_VALUE"
}

response = requests.request("GET", url, headers=headers, params=querystring)

print(response.text)
```

--------------------------------

### Get a Duo Application (GET /duo/accounts/{account_id}/applications/{application_id})

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Get a specific Duo application associated with a Duo account. The first curl example uses uppercase placeholders and includes accept and content-type headers; the other examples use lowercase placeholders and require x-api-key and x-org-id headers. The Python example uses the requests library and prints the response text.

```Shell
curl https://console.jumpcloud.com/api/v2/duo/accounts/{ACCOUNT_ID}/applications/{APPLICATION_ID} \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}'
```

```Shell
curl --request GET \
  --url https://console.jumpcloud.com/api/v2/duo/accounts/{account_id}/applications/{application_id} \
  --header 'x-api-key: REPLACE_KEY_VALUE' \
  --header 'x-org-id: SOME_STRING_VALUE'
```

```Python
import requests

url = "https://console.jumpcloud.com/api/v2/duo/accounts/{account_id}/applications/{application_id}"

headers = {
    "x-org-id": "SOME_STRING_VALUE",
    "x-api-key": "REPLACE_KEY_VALUE"
}

response = requests.request("GET", url, headers=headers)

print(response.text)
```

--------------------------------

### GET /api/systemusers example

Source: https://docs.jumpcloud.com/new/index.html

Example JumpCloud API request and response for GET /api/systemusers. Shows a paginated list of system users with fields such as _id, username, email, state, firstname, lastname, and totalCount.

```http
GET /api/systemusers
{
  "results": [
    {
      "_id": "5f14e379abf74…",
      "username": "jane.doe",
      "email": "jane@example.com",
      "state": "ACTIVATED",
      "firstname": "Jane",
      "lastname": "Doe"
    }
  ],
  "totalCount": 42
}

```

--------------------------------

### List Authentication Policies with Python

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Python example using the requests library to list authentication policies. Includes query parameters and required headers.

```python
import requests

url = "https://console.jumpcloud.com/api/v2/authn/policies"

querystring = {"limit":"SOME_INTEGER_VALUE","skip":"SOME_INTEGER_VALUE","filter":"SOME_ARRAY_VALUE","sort":"SOME_ARRAY_VALUE"}

headers = {
    "x-org-id": "SOME_STRING_VALUE",
    "x-total-count": "SOME_INTEGER_VALUE",
    "x-api-key": "REPLACE_KEY_VALUE"
}

response = requests.request("GET", url, headers=headers, params=querystring)

print(response.text)
```

--------------------------------

### Create Policy - Shell (x-codeSamples)

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Alternative Shell example for creating a policy with a full request body. Replace placeholder values with actual data.

```Shell
curl --request POST \
  --url https://console.jumpcloud.com/api/v2/policies \
  --header 'content-type: application/json' \
  --header 'x-api-key: REPLACE_KEY_VALUE' \
  --header 'x-org-id: SOME_STRING_VALUE' \
  --data '{"name":"string","notes":"string","template":{"id":"string"},"values":[{"configFieldID":"string","value":"string","sensitive":true}]}'
```

--------------------------------

### GET policy statuses for a policy (policystatuses)

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Sample requests for the GET /policies/{policy_id}/policystatuses endpoint. The Shell example uses curl with x-api-key and x-org-id headers. The Python example uses the requests library and prints the response text. The Powershell example uses Invoke-RestMethod with the same headers.

```Shell
curl --request GET \
  --url 'https://console.jumpcloud.com/api/v2/policies/{policy_id}/policystatuses?fields=SOME_ARRAY_VALUE&filter=SOME_ARRAY_VALUE&limit=SOME_INTEGER_VALUE&skip=SOME_INTEGER_VALUE&sort=SOME_ARRAY_VALUE' \
  --header 'x-api-key: REPLACE_KEY_VALUE' \
  --header 'x-org-id: SOME_STRING_VALUE'
```

```Python
import requests

url = "https://console.jumpcloud.com/api/v2/policies/{policy_id}/policystatuses"

querystring = {"fields":"SOME_ARRAY_VALUE","filter":"SOME_ARRAY_VALUE","limit":"SOME_INTEGER_VALUE","skip":"SOME_INTEGER_VALUE","sort":"SOME_ARRAY_VALUE"}

headers = {
    "x-org-id": "SOME_STRING_VALUE",
    "x-api-key": "REPLACE_KEY_VALUE"
}

response = requests.request("GET", url, headers=headers, params=querystring)

print(response.text)
```

```Powershell
$headers=@{}
$headers.Add("x-org-id", "SOME_STRING_VALUE")
$headers.Add("x-api-key", "REPLACE_KEY_VALUE")
$response = Invoke-RestMethod -Uri 'https://console.jumpcloud.com/api/v2/policies/{policy_id}/policystatuses?fields=SOME_ARRAY_VALUE&filter=SOME_ARRAY_VALUE&limit=SOME_INTEGER_VALUE&skip=SOME_INTEGER_VALUE&sort=SOME_ARRAY_VALUE' -Method GET -Headers $headers
```

--------------------------------

### GET policy results for a policy (policyresults)

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Sample requests for the GET /policies/{policy_id}/policyresults endpoint. The Shell example uses curl with the x-api-key and x-org-id headers. The Python example uses the requests library and prints the response text. The Powershell example uses Invoke-RestMethod with the same headers.

```Shell
curl --request GET \
  --url 'https://console.jumpcloud.com/api/v2/policies/{policy_id}/policyresults?fields=SOME_ARRAY_VALUE&filter=SOME_ARRAY_VALUE&limit=SOME_INTEGER_VALUE&skip=SOME_INTEGER_VALUE&sort=SOME_ARRAY_VALUE' \
  --header 'x-api-key: REPLACE_KEY_VALUE' \
  --header 'x-org-id: SOME_STRING_VALUE'
```

```Python
import requests

url = "https://console.jumpcloud.com/api/v2/policies/{policy_id}/policyresults"

querystring = {"fields":"SOME_ARRAY_VALUE","filter":"SOME_ARRAY_VALUE","limit":"SOME_INTEGER_VALUE","skip":"SOME_INTEGER_VALUE","sort":"SOME_ARRAY_VALUE"}

headers = {
    "x-org-id": "SOME_STRING_VALUE",
    "x-api-key": "REPLACE_KEY_VALUE"
}

response = requests.request("GET", url, headers=headers, params=querystring)

print(response.text)
```

```Powershell
$headers=@{}
$headers.Add("x-org-id", "SOME_STRING_VALUE")
$headers.Add("x-api-key", "REPLACE_KEY_VALUE")
$response = Invoke-RestMethod -Uri 'https://console.jumpcloud.com/api/v2/policies/{policy_id}/policyresults?fields=SOME_ARRAY_VALUE&filter=SOME_ARRAY_VALUE&limit=SOME_INTEGER_VALUE&skip=SOME_INTEGER_VALUE&sort=SOME_ARRAY_VALUE' -Method GET -Headers $headers
```

--------------------------------

### Create sample data with Python

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Uses the requests library to POST to the sample-data endpoint with the required resourceTypes array. Replace REPLACE_KEY_VALUE with your API key.

```Python
import requests

url = "https://console.jumpcloud.com/api/v2/sample-data"

payload = {"resourceTypes": ["users", "usergroups"]}
headers = {
    "x-api-key": "REPLACE_KEY_VALUE",
    "content-type": "application/json"
}

response = requests.request("POST", url, json=payload, headers=headers)
```

--------------------------------

### POST websites with Python

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Python example for the POST /websites endpoint. Imports the requests library and sets the API URL.

```Python
import requests

url = "https://console.jumpcloud.com/api/v2/password-vault/websites"
```

--------------------------------

### Get cases metadata (GET /cases/metadata)

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Retrieves metadata for cases from the JumpCloud v2 API. Replace REPLACE_KEY_VALUE with your API key. The Shell example uses curl, the Python example uses the requests library.

```Shell
curl --request GET \
  --url https://console.jumpcloud.com/api/v2/cases/metadata \
  --header 'x-api-key: REPLACE_KEY_VALUE'
```

```Python
import requests

url = "https://console.jumpcloud.com/api/v2/cases/metadata"

headers = {"x-api-key": "REPLACE_KEY_VALUE"}

response = requests.request("GET", url, headers=headers)

print(response.text)
```

--------------------------------

### List G Suite Users - Shell Example

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Shell example for listing users bound to a G Suite instance. Includes query parameters limit, skip, filter, and syncStatus, plus headers x-api-key and x-org-id.

```Shell
curl --request GET \
  --url 'https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/users?limit=SOME_INTEGER_VALUE&skip=SOME_INTEGER_VALUE&filter=SOME_ARRAY_VALUE&syncStatus=SOME_BOOLEAN_VALUE' \
  --header 'x-api-key: REPLACE_KEY_VALUE' \
  --header 'x-org-id: SOME_STRING_VALUE'
```

--------------------------------

### Get Office 365 translation rule (GET /office365s/{office365_id}/translationrules/{id})

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Retrieves a specific Office 365 translation rule by its ID. The first Shell example uses the documented endpoint with Accept, Content-Type, and x-api-key headers; the second Shell example is the official code sample using --request GET and REPLACE_KEY_VALUE placeholder. The Python example uses the requests library and prints the response text. The PowerShell example uses Invoke-RestMethod with a headers hashtable.

```Shell
curl -X GET https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}'
```

```Shell
curl --request GET \
  --url https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \
  --header 'x-api-key: REPLACE_KEY_VALUE'
```

```Python
import requests

url = "https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id}"

headers = {"x-api-key": "REPLACE_KEY_VALUE"}

response = requests.request("GET", url, headers=headers)

print(response.text)
```

```Powershell
$headers=@{}
$headers.Add("x-api-key", "REPLACE_KEY_VALUE")
$response = Invoke-RestMethod -Uri 'https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id}' -Method GET -Headers $headers
```

--------------------------------

### Get all cases for provider (GET /providers/{provider_id}/cases)

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Retrieves all cases (support/feature requests) for a provider. Replace {provider_id} with the provider's ID and REPLACE_KEY_VALUE with your API key. The Shell example uses curl, the Python example uses the requests library, and the PowerShell example uses Invoke-RestMethod.

```Shell
curl --request GET \
  --url 'https://console.jumpcloud.com/api/v2/providers/{provider_id}/cases?skip=SOME_INTEGER_VALUE&sort=SOME_ARRAY_VALUE&limit=SOME_INTEGER_VALUE&filter=SOME_ARRAY_VALUE' \
  --header 'x-api-key: REPLACE_KEY_VALUE'
```

```Python
import requests

url = "https://console.jumpcloud.com/api/v2/providers/{provider_id}/cases"

querystring = {"skip":"SOME_INTEGER_VALUE","sort":"SOME_ARRAY_VALUE","limit":"SOME_INTEGER_VALUE","filter":"SOME_ARRAY_VALUE"}

headers = {"x-api-key": "REPLACE_KEY_VALUE"}

response = requests.request("GET", url, headers=headers, params=querystring)

print(response.text)
```

```Powershell
$headers=@{}
$headers.Add("x-api-key", "REPLACE_KEY_VALUE")
$response = Invoke-RestMethod -Uri 'https://console.jumpcloud.com/api/v2/providers/{provider_id}/cases?skip=SOME_INTEGER_VALUE&sort=SOME_ARRAY_VALUE&limit=SOME_INTEGER_VALUE&filter=SOME_ARRAY_VALUE' -Method GET -Headers $headers
```

--------------------------------

### Add a domain to an Office 365 instance (Shell - x-codeSamples)

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Alternative Shell sample using curl with --request and --url flags. Replace REPLACE_KEY_VALUE with your API key.

```Shell
curl --request POST \
  --url https://console.jumpcloud.com/api/v2/office365s/{office365_id}/domains \
  --header 'content-type: application/json' \
  --header 'x-api-key: REPLACE_KEY_VALUE' \
  --data '{"domain":"string"}'
```

--------------------------------

### Get an IP list with Python

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Python example for the Get an IP list endpoint. Uses the requests library to send a GET request with the required headers.

```python
import requests

url = "https://console.jumpcloud.com/api/v2/iplists/{id}"

headers = {
    "x-org-id": "SOME_STRING_VALUE",
    "x-api-key": "REPLACE_KEY_VALUE"
}

response = requests.request("GET", url, headers=headers)

print(response.text)
```

--------------------------------

### GET scope-groups with curl

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Shell example for the scope-groups GET endpoint. Includes all query parameters and headers with placeholder values.

```Shell
curl --request GET \
  --url 'https://console.jumpcloud.com/api/v2/scope-groups?limit=SOME_INTEGER_VALUE&skip=SOME_INTEGER_VALUE&filter=SOME_ARRAY_VALUE&sort=SOME_ARRAY_VALUE' \
  --header 'x-api-key: REPLACE_KEY_VALUE' \
  --header 'x-org-id: SOME_STRING_VALUE' \
  --header 'x-provider-id: SOME_STRING_VALUE' \
  --header 'x-total-count: SOME_INTEGER_VALUE'
```

--------------------------------

### List all Pricing & Packaging Subscriptions with curl

Source: https://docs.jumpcloud.com/new/console/index.yaml

Sample request to list all pricing & packaging subscriptions. Uses the x-api-key header for authentication. Replace {API_KEY} with your actual API key.

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

--------------------------------

### Get an IP list with PowerShell

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

PowerShell example for the Get an IP list endpoint. Uses Invoke-RestMethod with the required headers.

```powershell
$headers=@{}
$headers.Add("x-org-id", "SOME_STRING_VALUE")
$headers.Add("x-api-key", "REPLACE_KEY_VALUE")
$response = Invoke-RestMethod -Uri 'https://console.jumpcloud.com/api/v2/iplists/{id}' -Method GET -Headers $headers
```

--------------------------------

### Create sample data (POST /sample-data)

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Creates sample data for the specified resource types (users and usergroups) via the JumpCloud v2 API. Replace REPLACE_KEY_VALUE with your API key. The Shell example uses curl, the Python example uses the requests library, and the PowerShell example uses Invoke-RestMethod.

```Shell
curl --request POST \
  --url 'https://console.jumpcloud.com/api/v2/sample-data' \
  --header 'x-api-key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"resourceTypes":["users","usergroups"]}'
```

```Python
import requests

url = "https://console.jumpcloud.com/api/v2/sample-data"

payload = {"resourceTypes":["users","usergroups"]}
headers = {"x-api-key": "REPLACE_KEY_VALUE", "content-type": "application/json"}

response = requests.request("POST", url, json=payload, headers=headers)

print(response.text)
```

```Powershell
$headers=@{}
$headers.Add("x-api-key", "REPLACE_KEY_VALUE")
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri 'https://console.jumpcloud.com/api/v2/sample-data' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"resourceTypes":["users","usergroups"]}'
```

--------------------------------

### Get Radius Server with /api/radiusservers/{id}

Source: https://docs.jumpcloud.com/new/console/index.yaml

Gets a RADIUS server by ID. The example uses PUT instead of GET, but the operation is documented as getApiRadiusserversById. Requires the radius.readonly scope.

```bash
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}' \
```

--------------------------------

### List Active Directories - Sample Request

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Sample request to list all Active Directory instances. Uses the x-api-key header for authentication.

```Shell
curl -X GET https://console.jumpcloud.com/api/v2/activedirectories/ \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}'
  
```

--------------------------------

### Example to Request Multi-Tenant Portal Events Only

Source: https://docs.jumpcloud.com/api/insights/directory/1.0/index.html

Sends a POST request to retrieve events from the Multi-Tenant Portal only by including the x-provider-id header with your provider key. Replace YOUR_PROVIDER_KEY_HERE with your actual provider key. This is used by Managed Service Providers to query events generated in the Multi-Tenant Portal.

```bash
curl -X POST -H 'x-api-key: REPLACE_KEY_VALUE' -H 'x-provider-id: YOUR_PROVIDER_KEY_HERE' -H 'Content-Type: application/json' --data '{"service": ["all"], "start_time": "2020-03-03T14:00:00Z"}' https://api.jumpcloud.com/insights/directory/v1/events

```

--------------------------------

### Get all workflow access requests

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Get all workflow access requests. The Python example is incomplete in the source; only the URL assignment is shown.

```Shell
curl --request GET \
  --url 'https://console.jumpcloud.com/api/v2/approvalflowrequest?organizationObjectId=SOME_STRING_VALUE&limit=SOME_STRING_VALUE&skip=SOME_STRING_VALUE&sort=SOME_STRING_VALUE&fields=SOME_ARRAY_VALUE&filter=SOME_ARRAY_VALUE' \
  --header 'x-api-key: REPLACE_KEY_VALUE'
```

```Python
import requests

url = "https://console.jumpcloud.com/api/v2/approvalflowrequest"
```

--------------------------------

### Get an IP list with curl (Shell)

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Shell example for the Get an IP list endpoint. Uses the x-api-key and x-org-id headers.

```bash
curl --request GET \
  --url https://console.jumpcloud.com/api/v2/iplists/{id} \
  --header 'x-api-key: REPLACE_KEY_VALUE' \
  --header 'x-org-id: SOME_STRING_VALUE'
```

--------------------------------

### List Authentication Policies with curl (Shell)

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Shell example for listing authentication policies with query parameters and required headers. Replace placeholder values with actual ones.

```shell
curl --request GET \
  --url 'https://console.jumpcloud.com/api/v2/authn/policies?limit=SOME_INTEGER_VALUE&skip=SOME_INTEGER_VALUE&filter=SOME_ARRAY_VALUE&sort=SOME_ARRAY_VALUE' \
  --header 'x-api-key: REPLACE_KEY_VALUE' \
  --header 'x-org-id: SOME_STRING_VALUE' \
  --header 'x-total-count: SOME_INTEGER_VALUE'
```

--------------------------------

### Get a Duo Account (GET /api/v2/duo/accounts/{id})

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Get a specific Duo account by its ID. The first curl example uses the older style with -H headers; the other examples use the modern --request/--url style and include the x-org-id header. Replace {id} with the account's ObjectID and {API_KEY} or REPLACE_KEY_VALUE with your API key.

```Shell
curl https://console.jumpcloud.com/api/v2/duo/accounts/{id} \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}'
```

```Shell
curl --request GET \
  --url https://console.jumpcloud.com/api/v2/duo/accounts/{id} \
  --header 'x-api-key: REPLACE_KEY_VALUE' \
  --header 'x-org-id: SOME_STRING_VALUE'
```

```Python
import requests

url = "https://console.jumpcloud.com/api/v2/duo/accounts/{id}"

headers = {
    "x-org-id": "SOME_STRING_VALUE",
    "x-api-key": "REPLACE_KEY_VALUE"
}

response = requests.request("GET", url, headers=headers)

print(response.text)
```

```Powershell
$headers=@{}
$headers.Add("x-org-id", "SOME_STRING_VALUE")
$headers.Add("x-api-key", "REPLACE_KEY_VALUE")
$response = Invoke-RestMethod -Uri 'https://console.jumpcloud.com/api/v2/duo/accounts/{id}' -Method GET -Headers $headers
```

--------------------------------

### Create System Group (Python)

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Python example using the requests library to create a System Group. Sends a POST request with the required headers and prints the response.

```Python
import requests

url = "https://console.jumpcloud.com/api/v2/systemgroups"

payload = {
    "attributes": {},
    "email": "string",
    "description": "string",
    "name": "string",
    "memberQuery": {
        "queryType": "Filter",
        "filters": [None]
    },
    "membershipMethod": "NOTSET",
    "memberSuggestionsNotify": True,
    "memberQueryExemptions": [
        {
            "id": "string",
            "organizationId": "string",
            "type": "string"
        }
    ]
}
headers = {
    "x-org-id": "SOME_STRING_VALUE",
    "x-query-dsl": "SOME_STRING_VALUE",
    "x-api-key": "REPLACE_KEY_VALUE",
    "content-type": "application/json"
}

response = requests.request("POST", url, json=payload, headers=headers)

print(response.text)
```

--------------------------------

### List devices (PowerShell example)

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

PowerShell example for the Devices_ListDevices operation. Uses Invoke-RestMethod with an API key header and query parameters. The response is stored in $response.

```powershell
$headers=@{}
$headers.Add("x-api-key", "REPLACE_KEY_VALUE")
$response = Invoke-RestMethod -Uri 'https://console.jumpcloud.com/api/v2/google-emm/enterprises/{enterpriseObjectId}/devices?limit=SOME_STRING_VALUE&skip=SOME_STRING_VALUE&filter=SOME_ARRAY_VALUE' -Method GET -Headers $headers
```

--------------------------------

### Create ADE Token - Shell Example

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Shell example for creating an ADE token. Replace {deviceManagerObjectId} and REPLACE_KEY_VALUE with your values.

```Shell
curl --request POST \
  --url https://console.jumpcloud.com/api/v2/applemdms/{deviceManagerObjectId}/ade_tokens \
  --header 'content-type: application/json' \
  --header 'x-api-key: REPLACE_KEY_VALUE' \
  --data '{"encryptedServerToken":"string"}'

```

--------------------------------

### Get User Group Suggestions (PowerShell)

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

PowerShell example using Invoke-RestMethod to GET suggestions. Includes query parameters limit and skip.

```Powershell
$headers=@{}
$headers.Add("x-org-id", "SOME_STRING_VALUE")
$headers.Add("x-api-key", "REPLACE_KEY_VALUE")
$response = Invoke-RestMethod -Uri 'https://console.jumpcloud.com/api/v2/usergroups/{group_id}/suggestions?limit=SOME_INTEGER_VALUE&skip=SOME_INTEGER_VALUE' -Method GET -Headers $headers
```

--------------------------------

### List Systems bound to a Command (Python)

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Python code sample using the requests library to call the endpoint. Includes query parameters and headers, then prints the response text.

```python
import requests

url = "https://console.jumpcloud.com/api/v2/commands/{command_id}/systems"

querystring = {"limit":"SOME_INTEGER_VALUE","skip":"SOME_INTEGER_VALUE","filter":"SOME_ARRAY_VALUE"}

headers = {
    "x-org-id": "SOME_STRING_VALUE",
    "x-api-key": "REPLACE_KEY_VALUE"
}

response = requests.request("GET", url, headers=headers, params=querystring)

print(response.text)
```

--------------------------------

### List subscriptions (Shell)

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

Shell sample to list all pricing & packaging subscriptions using curl. Requires an API key.

```Shell
curl --request GET \
  --url https://console.jumpcloud.com/api/v2/subscriptions
```

--------------------------------

### Get an Active Directory with PowerShell

Source: https://docs.jumpcloud.com/api/2.0/index.yaml

PowerShell example using Invoke-RestMethod to GET an Active Directory. Replace the placeholder API key and organization ID.

```Powershell
$headers=@{}
$headers.Add("x-org-id", "SOME_STRING_VALUE")
$headers.Add("x-api-key", "REPLACE_KEY_VALUE")
$response = Invoke-RestMethod -Uri 'https://console.jumpcloud.com/api/v2/activedirectories/{id}' -Method GET -Headers $headers
```
Tokens:
Raw