jcapiv1.SystemsApi

All URIs are relative to https://console.jumpcloud.com/api

Method	HTTP request	Description
systems_delete	DELETE /systems/{id}	Delete a System
systems_get	GET /systems/{id}	List an individual system
systems_list	GET /systems	List All Systems
systems_put	PUT /systems/{id}	Update a system
systems_systemusers_binding_list	GET /systems/{id}/systemusers	List system user bindings
systems_systemusers_binding_put	PUT /systems/{id}/systemusers	Update a system's or user's binding

systems_delete

System systems_delete(id, content_type, accept, _date=_date, authorization=authorization, x_org_id=x_org_id)

Delete a System

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. #### Sample Request 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}'

Example

from __future__ import print_function
import time
import jcapiv1
from jcapiv1.rest import ApiException
from pprint import pprint

# Configure API key authorization: x-api-key
configuration = jcapiv1.Configuration()
configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = jcapiv1.SystemsApi(jcapiv1.ApiClient(configuration))
id = 'id_example' # str | 
content_type = 'application/json' # str |  (default to application/json)
accept = 'application/json' # str |  (default to application/json)
_date = '_date_example' # str | Current date header for the System Context API (optional)
authorization = 'authorization_example' # str | Authorization header for the System Context API (optional)
x_org_id = '' # str |  (optional) (default to )

try:
    # Delete a System
    api_response = api_instance.systems_delete(id, content_type, accept, _date=_date, authorization=authorization, x_org_id=x_org_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemsApi->systems_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
content_type	str		[default to application/json]
accept	str		[default to application/json]
_date	str	Current date header for the System Context API	[optional]
authorization	str	Authorization header for the System Context API	[optional]
x_org_id	str		[optional] [default to ]

Return type

System

Authorization

x-api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

systems_get

System systems_get(id, content_type, accept, fields=fields, filter=filter, _date=_date, authorization=authorization, x_org_id=x_org_id)

List an individual system

This endpoint returns an individual system. #### Sample Request 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}'

Example

from __future__ import print_function
import time
import jcapiv1
from jcapiv1.rest import ApiException
from pprint import pprint

# Configure API key authorization: x-api-key
configuration = jcapiv1.Configuration()
configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = jcapiv1.SystemsApi(jcapiv1.ApiClient(configuration))
id = 'id_example' # str | 
content_type = 'application/json' # str |  (default to application/json)
accept = 'application/json' # str |  (default to application/json)
fields = '' # str | 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.  (optional) (default to )
filter = 'filter_example' # str | A filter to apply to the query. (optional)
_date = '_date_example' # str | Current date header for the System Context API (optional)
authorization = 'authorization_example' # str | Authorization header for the System Context API (optional)
x_org_id = '' # str |  (optional) (default to )

try:
    # List an individual system
    api_response = api_instance.systems_get(id, content_type, accept, fields=fields, filter=filter, _date=_date, authorization=authorization, x_org_id=x_org_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemsApi->systems_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
content_type	str		[default to application/json]
accept	str		[default to application/json]
fields	str	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.	[optional] [default to ]
filter	str	A filter to apply to the query.	[optional]
_date	str	Current date header for the System Context API	[optional]
authorization	str	Authorization header for the System Context API	[optional]
x_org_id	str		[optional] [default to ]

Return type

System

Authorization

x-api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

systems_list

Systemslist systems_list(content_type, accept, fields=fields, limit=limit, x_org_id=x_org_id, search=search, skip=skip, sort=sort, filter=filter)

List All Systems

This endpoint returns all Systems. #### Sample Requests curl -X GET https://console.jumpcloud.com/api/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Example

from __future__ import print_function
import time
import jcapiv1
from jcapiv1.rest import ApiException
from pprint import pprint

# Configure API key authorization: x-api-key
configuration = jcapiv1.Configuration()
configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = jcapiv1.SystemsApi(jcapiv1.ApiClient(configuration))
content_type = 'application/json' # str |  (default to application/json)
accept = 'application/json' # str |  (default to application/json)
fields = '' # str | 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.  (optional) (default to )
limit = 10 # int | The number of records to return at once. Limited to 100. (optional) (default to 10)
x_org_id = '' # str |  (optional) (default to )
search = 'search_example' # str | A nested object containing a string `searchTerm` and a list of `fields` to search on. (optional)
skip = 0 # int | The offset into the records to return. (optional) (default to 0)
sort = '' # str | Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending.  (optional) (default to )
filter = 'filter_example' # str | A filter to apply to the query. (optional)

try:
    # List All Systems
    api_response = api_instance.systems_list(content_type, accept, fields=fields, limit=limit, x_org_id=x_org_id, search=search, skip=skip, sort=sort, filter=filter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemsApi->systems_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
content_type	str		[default to application/json]
accept	str		[default to application/json]
fields	str	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.	[optional] [default to ]
limit	int	The number of records to return at once. Limited to 100.	[optional] [default to 10]
x_org_id	str		[optional] [default to ]
search	str	A nested object containing a string `searchTerm` and a list of `fields` to search on.	[optional]
skip	int	The offset into the records to return.	[optional] [default to 0]
sort	str	Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending.	[optional] [default to ]
filter	str	A filter to apply to the query.	[optional]

Return type

Systemslist

Authorization

x-api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

systems_put

System systems_put(id, content_type, accept, body=body, _date=_date, authorization=authorization, x_org_id=x_org_id)

Update a system

This endpoint allows you to update a system. #### Sample Request 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\" }'

Example

from __future__ import print_function
import time
import jcapiv1
from jcapiv1.rest import ApiException
from pprint import pprint

# Configure API key authorization: x-api-key
configuration = jcapiv1.Configuration()
configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = jcapiv1.SystemsApi(jcapiv1.ApiClient(configuration))
id = 'id_example' # str | 
content_type = 'application/json' # str |  (default to application/json)
accept = 'application/json' # str |  (default to application/json)
body = jcapiv1.Systemput() # Systemput |  (optional)
_date = '_date_example' # str | Current date header for the System Context API (optional)
authorization = 'authorization_example' # str | Authorization header for the System Context API (optional)
x_org_id = '' # str |  (optional) (default to )

try:
    # Update a system
    api_response = api_instance.systems_put(id, content_type, accept, body=body, _date=_date, authorization=authorization, x_org_id=x_org_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemsApi->systems_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
content_type	str		[default to application/json]
accept	str		[default to application/json]
body	Systemput		[optional]
_date	str	Current date header for the System Context API	[optional]
authorization	str	Authorization header for the System Context API	[optional]
x_org_id	str		[optional] [default to ]

Return type

System

Authorization

x-api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

systems_systemusers_binding_list

Systemuserbinding systems_systemusers_binding_list(id, content_type, accept, fields=fields, limit=limit, skip=skip, sort=sort, filter=filter, x_org_id=x_org_id)

List system user bindings

Hidden as Tags is deprecated List system user bindings for a specific system in a system and user binding format. This endpoint is only used for users still using JumpCloud Tags. If you are using JumpCloud Groups please refer to the documentation found here. #### Sample Request List system user bindings for specific system curl -X https://console.jumpcloud.com/api/systems/{SystemID}/systemusers\\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ \"

Example

from __future__ import print_function
import time
import jcapiv1
from jcapiv1.rest import ApiException
from pprint import pprint

# Configure API key authorization: x-api-key
configuration = jcapiv1.Configuration()
configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = jcapiv1.SystemsApi(jcapiv1.ApiClient(configuration))
id = 'id_example' # str | 
content_type = 'application/json' # str |  (default to application/json)
accept = 'application/json' # str |  (default to application/json)
fields = '' # str | 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.  (optional) (default to )
limit = 10 # int | The number of records to return at once. Limited to 100. (optional) (default to 10)
skip = 0 # int | The offset into the records to return. (optional) (default to 0)
sort = '' # str | Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending.  (optional) (default to )
filter = 'filter_example' # str | A filter to apply to the query. (optional)
x_org_id = '' # str |  (optional) (default to )

try:
    # List system user bindings
    api_response = api_instance.systems_systemusers_binding_list(id, content_type, accept, fields=fields, limit=limit, skip=skip, sort=sort, filter=filter, x_org_id=x_org_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemsApi->systems_systemusers_binding_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
content_type	str		[default to application/json]
accept	str		[default to application/json]
fields	str	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.	[optional] [default to ]
limit	int	The number of records to return at once. Limited to 100.	[optional] [default to 10]
skip	int	The offset into the records to return.	[optional] [default to 0]
sort	str	Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending.	[optional] [default to ]
filter	str	A filter to apply to the query.	[optional]
x_org_id	str		[optional] [default to ]

Return type

Systemuserbinding

Authorization

x-api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

systems_systemusers_binding_put

systems_systemusers_binding_put(id, content_type, accept, body=body, x_org_id=x_org_id)

Update a system's or user's binding

Hidden as Tags is deprecated Adds or removes a user binding for a system. This endpoint is only used for users still using JumpCloud Tags. If you are using JumpCloud Groups please refer to the documentation found here. #### Sample Request Add (or remove) a system user to (from) a system ``` curl \ -d '{ "add": ["[SYSTEM_USER_ID_TO_ADD_HERE]"], "remove": ["[SYSTEM_USER_ID_TO_REMOVE_HERE]"] }' \ -X PUT \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H "x-api-key: [YOUR_API_KEY_HERE]" \ "https://console.jumpcloud.com/api/systems/[SYSTEM_ID_HERE]/systemusers

Example

from __future__ import print_function
import time
import jcapiv1
from jcapiv1.rest import ApiException
from pprint import pprint

# Configure API key authorization: x-api-key
configuration = jcapiv1.Configuration()
configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = jcapiv1.SystemsApi(jcapiv1.ApiClient(configuration))
id = 'id_example' # str | 
content_type = 'application/json' # str |  (default to application/json)
accept = 'application/json' # str |  (default to application/json)
body = jcapiv1.Systemuserbindingsput() # Systemuserbindingsput |  (optional)
x_org_id = '' # str |  (optional) (default to )

try:
    # Update a system's or user's binding
    api_instance.systems_systemusers_binding_put(id, content_type, accept, body=body, x_org_id=x_org_id)
except ApiException as e:
    print("Exception when calling SystemsApi->systems_systemusers_binding_put: %s\n" % e)

Parameters

Name	Type	Notes
id	str
content_type	str	[default to application/json]
accept	str	[default to application/json]
body	Systemuserbindingsput	[optional]
x_org_id	str	[optional] [default to ]

Return type

void (empty response body)

Authorization

x-api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

SystemsApi.md

Latest commit

History

SystemsApi.md

File metadata and controls

jcapiv1.SystemsApi

systems_delete

Example

Parameters

Return type

Authorization

HTTP request headers

systems_get

Example

Parameters

Return type

Authorization

HTTP request headers

systems_list

Example

Parameters

Return type

Authorization

HTTP request headers

systems_put

Example

Parameters

Return type

Authorization

HTTP request headers

systems_systemusers_binding_list

Example

Parameters

Return type

Authorization

HTTP request headers

systems_systemusers_binding_put

Example

Parameters

Return type

Authorization

HTTP request headers