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

RUBY-SDK-V1-Updates-6.11.18 #6

Merged
merged 2 commits into from
Jun 21, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion config_v1.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"gemName": "jcapiv1",
"moduleName": "JCAPIv1",
"gemVersion": "1.0.0"
"gemVersion": "1.0.1"
}
2 changes: 1 addition & 1 deletion jcapiv1/.swagger-codegen/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.3.0-SNAPSHOT
2.3.1
10 changes: 9 additions & 1 deletion jcapiv1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,14 +96,17 @@ Class | Method | HTTP request | Description
*JCAPIv1::CommandResultsApi* | [**command_results_get**](docs/CommandResultsApi.md#command_results_get) | **GET** /commandresults/{id} | List an individual Command result
*JCAPIv1::CommandResultsApi* | [**command_results_list**](docs/CommandResultsApi.md#command_results_list) | **GET** /commandresults | List all Command Results
*JCAPIv1::CommandTriggersApi* | [**command_trigger_webhook_post**](docs/CommandTriggersApi.md#command_trigger_webhook_post) | **POST** /command/trigger/{triggername} | Launch a command via a Trigger
*JCAPIv1::CommandsApi* | [**command_file_get**](docs/CommandsApi.md#command_file_get) | **GET** /files/command/{id} | Get a Command File
*JCAPIv1::CommandsApi* | [**commands_delete**](docs/CommandsApi.md#commands_delete) | **DELETE** /commands/{id} | Delete a Command
*JCAPIv1::CommandsApi* | [**commands_get**](docs/CommandsApi.md#commands_get) | **GET** /commands/{id} | List an individual Command
*JCAPIv1::CommandsApi* | [**commands_list**](docs/CommandsApi.md#commands_list) | **GET** /commands/ | List All Commands
*JCAPIv1::CommandsApi* | [**commands_post**](docs/CommandsApi.md#commands_post) | **POST** /commands/ | Create A Command
*JCAPIv1::CommandsApi* | [**commands_put**](docs/CommandsApi.md#commands_put) | **PUT** /commands/{id} | Update a Command
*JCAPIv1::RadiusServersApi* | [**radius_servers_list**](docs/RadiusServersApi.md#radius_servers_list) | **GET** /radiusservers | List Radius Servers
*JCAPIv1::RadiusServersApi* | [**radius_servers_post**](docs/RadiusServersApi.md#radius_servers_post) | **POST** /radiusservers | Create a Radius Server
*JCAPIv1::RadiusServersApi* | [**radius_servers_put**](docs/RadiusServersApi.md#radius_servers_put) | **PUT** /radiusservers:id | Update Radius Servers
*JCAPIv1::SearchApi* | [**search_systemusers_post**](docs/SearchApi.md#search_systemusers_post) | **POST** /search/systemusers | List System Users
*JCAPIv1::SearchApi* | [**search_systems_post**](docs/SearchApi.md#search_systems_post) | **POST** /search/systems | Search Systems
*JCAPIv1::SearchApi* | [**search_systemusers_post**](docs/SearchApi.md#search_systemusers_post) | **POST** /search/systemusers | Search System Users
*JCAPIv1::SystemsApi* | [**systems_delete**](docs/SystemsApi.md#systems_delete) | **DELETE** /systems/{id} | Delete a System
*JCAPIv1::SystemsApi* | [**systems_get**](docs/SystemsApi.md#systems_get) | **GET** /systems/{id} | List an individual system
*JCAPIv1::SystemsApi* | [**systems_list**](docs/SystemsApi.md#systems_list) | **GET** /systems | List All Systems
Expand All @@ -115,6 +118,7 @@ Class | Method | HTTP request | Description
*JCAPIv1::SystemusersApi* | [**systemusers_list**](docs/SystemusersApi.md#systemusers_list) | **GET** /systemusers | List all system users
*JCAPIv1::SystemusersApi* | [**systemusers_post**](docs/SystemusersApi.md#systemusers_post) | **POST** /systemusers | Create a system user
*JCAPIv1::SystemusersApi* | [**systemusers_put**](docs/SystemusersApi.md#systemusers_put) | **PUT** /systemusers/{id} | Update a system user
*JCAPIv1::SystemusersApi* | [**systemusers_resetmfa**](docs/SystemusersApi.md#systemusers_resetmfa) | **POST** /systemusers/{id}/resetmfa | Reset a system user's MFA token
*JCAPIv1::SystemusersApi* | [**systemusers_systems_binding_list**](docs/SystemusersApi.md#systemusers_systems_binding_list) | **GET** /systemusers/{id}/systems | List system user binding
*JCAPIv1::SystemusersApi* | [**systemusers_systems_binding_put**](docs/SystemusersApi.md#systemusers_systems_binding_put) | **PUT** /systemusers/{id}/systems | Update a system user binding
*JCAPIv1::TagsApi* | [**tags_delete**](docs/TagsApi.md#tags_delete) | **DELETE** /tags/{name} | Delete a Tag
Expand All @@ -137,12 +141,15 @@ Class | Method | HTTP request | Description
- [JCAPIv1::Applicationslist](docs/Applicationslist.md)
- [JCAPIv1::Body](docs/Body.md)
- [JCAPIv1::Command](docs/Command.md)
- [JCAPIv1::Commandfilereturn](docs/Commandfilereturn.md)
- [JCAPIv1::Commandresult](docs/Commandresult.md)
- [JCAPIv1::CommandresultResponse](docs/CommandresultResponse.md)
- [JCAPIv1::CommandresultResponseData](docs/CommandresultResponseData.md)
- [JCAPIv1::Commandresultslist](docs/Commandresultslist.md)
- [JCAPIv1::Commandslist](docs/Commandslist.md)
- [JCAPIv1::InlineResponse400](docs/InlineResponse400.md)
- [JCAPIv1::Radiusserver](docs/Radiusserver.md)
- [JCAPIv1::Radiusserverpost](docs/Radiusserverpost.md)
- [JCAPIv1::Radiusserverput](docs/Radiusserverput.md)
- [JCAPIv1::Radiusserverslist](docs/Radiusserverslist.md)
- [JCAPIv1::Search](docs/Search.md)
Expand All @@ -154,6 +161,7 @@ Class | Method | HTTP request | Description
- [JCAPIv1::Systemuser](docs/Systemuser.md)
- [JCAPIv1::Systemuserbinding](docs/Systemuserbinding.md)
- [JCAPIv1::Systemuserbindingsput](docs/Systemuserbindingsput.md)
- [JCAPIv1::Systemuserput](docs/Systemuserput.md)
- [JCAPIv1::Systemuserputpost](docs/Systemuserputpost.md)
- [JCAPIv1::Systemuserreturn](docs/Systemuserreturn.md)
- [JCAPIv1::Systemuserslist](docs/Systemuserslist.md)
Expand Down
2 changes: 1 addition & 1 deletion jcapiv1/docs/ApplicationsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Method | HTTP request | Description

Applications

The endpoint is used to return all your SSO Applications.
The endpoint returns all your SSO / SAML Applications. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/applications \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ```

### Example
```ruby
Expand Down
6 changes: 3 additions & 3 deletions jcapiv1/docs/Command.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | | [optional]
**command** | **String** | The command to execute on the server. |
**user** | **String** | The ID of the JC managed user to run the command as. |
**systems** | **Array<String>** | An array of system IDs to run the command on. | [optional]
**user** | **String** | The ID of the system user to run the command as. |
**systems** | **Array<String>** | An array of system IDs to run the command on. Not available if you are using Groups. | [optional]
**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. | [optional]
**files** | **Array<String>** | An array of file IDs to include with the command. | [optional]
**tags** | **Array<String>** | An array of tag IDs to run the command on. | [optional]
**tags** | **Array<String>** | An array of tag IDs to run the command on. Not available if you are using Groups. | [optional]
**timeout** | **String** | The time in seconds to allow the command to run for. | [optional]


30 changes: 15 additions & 15 deletions jcapiv1/docs/CommandResultsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Method | HTTP request | Description

Delete a Command result

Deletes a specific command result.
This endpoint deletes a specific command result. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/commandresults/{CommandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ````

### Example
```ruby
Expand Down Expand Up @@ -74,7 +74,7 @@ Name | Type | Description | Notes

List an individual Command result

Returns a specific command result.
This endpoint returns a specific command result. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/commandresults/{CommandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ```

### Example
```ruby
Expand All @@ -97,10 +97,10 @@ content_type = "application/json" # String |
accept = "application/json" # String |

opts = {
fields: "", # String | The comma separated fields included in the returned records. If omitted the default list of fields will be returned.
limit: 10, # Integer | The number of records to return at once.
fields: "", # String | 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: 10, # Integer | The number of records to return at once. Limited to 100.
skip: 0, # Integer | The offset into the records to return.
sort: "" # String | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending.
sort: "" # String | Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending.
}

begin
Expand All @@ -119,10 +119,10 @@ Name | Type | Description | Notes
**id** | **String**| |
**content_type** | **String**| | [default to application/json]
**accept** | **String**| | [default to application/json]
**fields** | **String**| The comma separated fields included in the returned records. If omitted the default list of fields will be returned. | [optional] [default to ]
**limit** | **Integer**| The number of records to return at once. | [optional] [default to 10]
**fields** | **String**| 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** | **Integer**| The number of records to return at once. Limited to 100. | [optional] [default to 10]
**skip** | **Integer**| The offset into the records to return. | [optional] [default to 0]
**sort** | **String**| The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. | [optional] [default to ]
**sort** | **String**| Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending. | [optional] [default to ]

### Return type

Expand All @@ -144,7 +144,7 @@ Name | Type | Description | Notes

List all Command Results

Returns all command results.
This endpoint returns all command results. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/commandresults \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key:{API_KEY}' ```

### Example
```ruby
Expand All @@ -165,10 +165,10 @@ content_type = "application/json" # String |
accept = "application/json" # String |

opts = {
fields: "", # String | The comma separated fields included in the returned records. If omitted the default list of fields will be returned.
limit: 10, # Integer | The number of records to return at once.
fields: "", # String | 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: 10, # Integer | The number of records to return at once. Limited to 100.
skip: 0, # Integer | The offset into the records to return.
sort: "" # String | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending.
sort: "" # String | Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending.
}

begin
Expand All @@ -186,10 +186,10 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**content_type** | **String**| | [default to application/json]
**accept** | **String**| | [default to application/json]
**fields** | **String**| The comma separated fields included in the returned records. If omitted the default list of fields will be returned. | [optional] [default to ]
**limit** | **Integer**| The number of records to return at once. | [optional] [default to 10]
**fields** | **String**| 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** | **Integer**| The number of records to return at once. Limited to 100. | [optional] [default to 10]
**skip** | **Integer**| The offset into the records to return. | [optional] [default to 0]
**sort** | **String**| The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. | [optional] [default to ]
**sort** | **String**| Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending. | [optional] [default to ]

### Return type

Expand Down
2 changes: 1 addition & 1 deletion jcapiv1/docs/CommandTriggersApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Method | HTTP request | Description

Launch a command via a Trigger

### Examples ##### Launch a Command via a Trigger ``` curl --silent \\ -X 'POST' \\ -H \"x-api-key: [YOUR_API_KEY_HERE]\" \\ \"https://console.jumpcloud.com/api/command/trigger/[TRIGGER_NAME_HERE]\" ``` ##### Launch a Command via a Trigger passing a JSON object to the command ``` curl --silent \\ -X 'POST' \\ -H \"x-api-key: [YOUR_API_KEY_HERE]\" \\ -H 'Accept: application/json' \\ -d '{ \"srcip\":\"192.168.2.32\", \"attack\":\"Cross Site Scripting Attempt\" }' \\ \"https://console.jumpcloud.com/api/command/trigger/[TRIGGER_NAME_HERE]\" ```
This endpoint allows you to launch a command based on a defined trigger. #### Sample Requests **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}\" ```

### Example
```ruby
Expand Down
10 changes: 10 additions & 0 deletions jcapiv1/docs/Commandfilereturn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# JCAPIv1::Commandfilereturn

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | name of file. | [optional]
**destination** | **String** | the destination on the local machine where the file will be stored. | [optional]
**_id** | **String** | the ID of the file. | [optional]


Loading