Skip to content
This repository has been archived by the owner on Oct 30, 2023. It is now read-only.

Latest commit

 

History

History
220 lines (179 loc) · 13.2 KB

README.md

File metadata and controls

220 lines (179 loc) · 13.2 KB

jcapiv1

JCAPIv1 - the Ruby gem for the JumpCloud APIs

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

This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0
  • Package version: 3.0.0
  • Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build jcapiv1.gemspec

Then either install the gem locally:

gem install ./jcapiv1-3.0.0.gem

(for development, run gem install --dev ./jcapiv1-3.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'jcapiv1', '~> 3.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'jcapiv1', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'jcapiv1'

# Setup authorization
JCAPIv1.configure do |config|
  # Configure API key authorization: x-api-key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = JCAPIv1::ApplicationTemplatesApi.new

id = "id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  fields: "fields_example", # String | The comma separated fields included in the returned records. If omitted the default list of fields will be returned.
  limit: 56, # Integer | The number of records to return at once.
  skip: 56, # Integer | The offset into the records to return.
  sort: "The comma separated fields used to sort the collection. Default sort is ascending, prefix with - to sort descending.", # String | 
  filter: "filter_example" # String | A filter to apply to the query.
  x_org_id: "" # String | 
}

begin
  #Get an Application Template
  result = api_instance.application_templates_get(id, content_type, accept, opts)
  p result
rescue JCAPIv1::ApiError => e
  puts "Exception when calling ApplicationTemplatesApi->application_templates_get: #{e}"
end

Documentation for API Endpoints

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

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