Skip to content

Latest commit

 

History

History
214 lines (179 loc) · 12.6 KB

README.md

File metadata and controls

214 lines (179 loc) · 12.6 KB

jcapiv1

JumpCloud's V1 API. This set of endpoints allows JumpCloud customers to manage commands, systems, & system users.

This Python package is automatically generated by the Swagger Codegen project:

  • API version: 1.0
  • Package version: 4.0.0
  • Build package: io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import jcapiv1 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import jcapiv1

Getting Started

Please follow the installation procedure and then run the following:

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.ApplicationTemplatesApi(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 = 'fields_example' # str | The comma separated fields included in the returned records. If omitted the default list of fields will be returned. (optional)
limit = 56 # int | The number of records to return at once. (optional)
skip = 56 # int | The offset into the records to return. (optional)
sort = 'The comma separated fields used to sort the collection. Default sort is ascending, prefix with - to sort descending.' # str |  (optional) (default to The comma separated fields used to sort the collection. Default sort is ascending, prefix with - to sort descending.)
filter = 'filter_example' # str | A filter to apply to the query. (optional)
x_org_id = '' # str |  (optional) (default to )

try:
    # Get an Application Template
    api_response = api_instance.application_templates_get(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 ApplicationTemplatesApi->application_templates_get: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
ApplicationTemplatesApi application_templates_get GET /application-templates/{id} Get an Application Template
ApplicationTemplatesApi application_templates_list GET /application-templates List Application Templates
ApplicationsApi applications_delete DELETE /applications/{id} Delete an Application
ApplicationsApi applications_get GET /applications/{id} Get an Application
ApplicationsApi applications_list GET /applications Applications
ApplicationsApi applications_post POST /applications Create an Application
ApplicationsApi applications_put PUT /applications/{id} Update an Application
CommandResultsApi command_results_delete DELETE /commandresults/{id} Delete a Command result
CommandResultsApi command_results_get GET /commandresults/{id} List an individual Command result
CommandResultsApi command_results_list GET /commandresults List all Command Results
CommandTriggersApi command_trigger_webhook_post POST /command/trigger/{triggername} Launch a command via a Trigger
CommandsApi command_file_get GET /files/command/{id} Get a Command File
CommandsApi commands_delete DELETE /commands/{id} Delete a Command
CommandsApi commands_get GET /commands/{id} List an individual Command
CommandsApi commands_list GET /commands List All Commands
CommandsApi commands_post POST /commands Create A Command
CommandsApi commands_put PUT /commands/{id} Update a Command
OrganizationsApi organization_list GET /organizations Get Organization Details
RadiusServersApi radius_servers_list GET /radiusservers List Radius Servers
RadiusServersApi radius_servers_post POST /radiusservers Create a Radius Server
RadiusServersApi radius_servers_put PUT /radiusservers/{id} Update Radius Servers
SearchApi search_organizations_post POST /search/organizations Search Organizations
SearchApi search_systems_post POST /search/systems Search Systems
SearchApi search_systemusers_post POST /search/systemusers Search System Users
SystemsApi systems_delete DELETE /systems/{id} Delete a System
SystemsApi systems_get GET /systems/{id} List an individual system
SystemsApi systems_list GET /systems List All Systems
SystemsApi systems_put PUT /systems/{id} Update a system
SystemsApi systems_systemusers_binding_list GET /systems/{id}/systemusers List system user bindings
SystemsApi systems_systemusers_binding_put PUT /systems/{id}/systemusers Update a system's or user's binding
SystemusersApi sshkey_delete DELETE /systemusers/{systemuser_id}/sshkeys/{id} Delete a system user's Public SSH Keys
SystemusersApi sshkey_list GET /systemusers/{id}/sshkeys List a system user's public SSH keys
SystemusersApi sshkey_post POST /systemusers/{id}/sshkeys Create a system user's Public SSH Key
SystemusersApi systemusers_delete DELETE /systemusers/{id} Delete a system user
SystemusersApi systemusers_get GET /systemusers/{id} List a system user
SystemusersApi systemusers_list GET /systemusers List all system users
SystemusersApi systemusers_post POST /systemusers Create a system user
SystemusersApi systemusers_put PUT /systemusers/{id} Update a system user
SystemusersApi systemusers_resetmfa POST /systemusers/{id}/resetmfa Reset a system user's MFA token
SystemusersApi systemusers_systems_binding_list GET /systemusers/{id}/systems List system user binding
SystemusersApi systemusers_systems_binding_put PUT /systemusers/{id}/systems Update a system user binding
SystemusersApi systemusers_unlock POST /systemusers/{id}/unlock Unlock a system user
TagsApi tags_delete DELETE /tags/{name} Delete a Tag
TagsApi tags_get GET /Tags/{name} List a Tag
TagsApi tags_list GET /tags List All Tags
TagsApi tags_post POST /tags Create a Tag
TagsApi tags_put PUT /Tag/{name} Update a Tag

Documentation For Models

Documentation For Authorization

x-api-key

  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header

Author