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

API v1 and v2 updates 2019-2-20 #16

Merged
merged 6 commits into from
Feb 28, 2019
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.3.0"
"gemVersion": "2.1.0"
}
2 changes: 1 addition & 1 deletion config_v2.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"gemName": "jcapiv2",
"moduleName": "JCAPIv2",
"gemVersion": "1.3.0"
"gemVersion": "2.1.0"
}
11 changes: 7 additions & 4 deletions jcapiv1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ JCAPIv1 - the Ruby gem for the JumpCloud APIs
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 1.0
- Package version: 1.3.0
- Package version: 2.1.0
- Build package: io.swagger.codegen.languages.RubyClientCodegen

## Installation
Expand All @@ -23,15 +23,15 @@ gem build jcapiv1.gemspec
Then either install the gem locally:

```shell
gem install ./jcapiv1-1.3.0.gem
gem install ./jcapiv1-2.1.0.gem
```
(for development, run `gem install --dev ./jcapiv1-1.3.0.gem` to install the development dependencies)
(for development, run `gem install --dev ./jcapiv1-2.1.0.gem` to install the development dependencies)

or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).

Finally add this to the Gemfile:

gem 'jcapiv1', '~> 1.3.0'
gem 'jcapiv1', '~> 2.1.0'

### Install from Git

Expand Down Expand Up @@ -73,6 +73,7 @@ opts = {
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 |
}

Expand Down Expand Up @@ -127,6 +128,7 @@ Class | Method | HTTP request | Description
*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::SystemusersApi* | [**systemusers_unlock**](docs/SystemusersApi.md#systemusers_unlock) | **POST** /systemusers/{id}/unlock | Unlock a system user
*JCAPIv1::TagsApi* | [**tags_delete**](docs/TagsApi.md#tags_delete) | **DELETE** /tags/{name} | Delete a Tag
*JCAPIv1::TagsApi* | [**tags_get**](docs/TagsApi.md#tags_get) | **GET** /Tags/{name} | List a Tag
*JCAPIv1::TagsApi* | [**tags_list**](docs/TagsApi.md#tags_list) | **GET** /tags | List All Tags
Expand Down Expand Up @@ -158,6 +160,7 @@ Class | Method | HTTP request | Description
- [JCAPIv1::CommandslistResults](docs/CommandslistResults.md)
- [JCAPIv1::Errorresponse](docs/Errorresponse.md)
- [JCAPIv1::Fde](docs/Fde.md)
- [JCAPIv1::Mfa](docs/Mfa.md)
- [JCAPIv1::Organizationslist](docs/Organizationslist.md)
- [JCAPIv1::OrganizationslistResults](docs/OrganizationslistResults.md)
- [JCAPIv1::Radiusserver](docs/Radiusserver.md)
Expand Down
2 changes: 2 additions & 0 deletions jcapiv1/docs/ApplicationsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ opts = {
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 |
}

Expand All @@ -59,6 +60,7 @@ Name | Type | Description | Notes
**limit** | **Integer**| The number of records to return at once. | [optional]
**skip** | **Integer**| The offset into the records to return. | [optional]
**sort** | **String**| | [optional] [default to The comma separated fields used to sort the collection. Default sort is ascending, prefix with - to sort descending.]
**filter** | **String**| A filter to apply to the query. | [optional]
**x_org_id** | **String**| | [optional] [default to ]

### Return type
Expand Down
8 changes: 6 additions & 2 deletions jcapiv1/docs/CommandResultsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Name | Type | Description | Notes

List an individual 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}' ```
This endpoint returns a specific command result. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/commandresults/{CommandResultID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ```

### Example
```ruby
Expand All @@ -102,6 +102,7 @@ accept = "application/json" # String |

opts = {
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.
filter: "filter_example" # String | A filter to apply to the query.
x_org_id: "" # String |
}

Expand All @@ -122,6 +123,7 @@ Name | Type | Description | Notes
**content_type** | **String**| | [default to application/json]
**accept** | **String**| | [default to application/json]
**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 ]
**filter** | **String**| A filter to apply to the query. | [optional]
**x_org_id** | **String**| | [optional] [default to ]

### Return type
Expand Down Expand Up @@ -168,7 +170,8 @@ opts = {
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 | Use space separated sort parameters 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.
filter: "filter_example" # String | A filter to apply to the query.
x_org_id: "" # String |
}

Expand All @@ -191,6 +194,7 @@ Name | Type | Description | Notes
**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**| Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending. | [optional] [default to ]
**filter** | **String**| A filter to apply to the query. | [optional]
**x_org_id** | **String**| | [optional] [default to ]

### Return type
Expand Down
6 changes: 5 additions & 1 deletion jcapiv1/docs/CommandsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,7 @@ accept = "application/json" # String |

opts = {
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.
filter: "filter_example" # String | A filter to apply to the query.
x_org_id: "" # String |
}

Expand All @@ -194,6 +195,7 @@ Name | Type | Description | Notes
**content_type** | **String**| | [default to application/json]
**accept** | **String**| | [default to application/json]
**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 ]
**filter** | **String**| A filter to apply to the query. | [optional]
**x_org_id** | **String**| | [optional] [default to ]

### Return type
Expand Down Expand Up @@ -240,7 +242,8 @@ opts = {
skip: 0, # Integer | The offset into the records to return.
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.
sort: "" # String | Use space separated sort parameters 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.
filter: "filter_example" # String | A filter to apply to the query.
x_org_id: "" # String |
}

Expand All @@ -263,6 +266,7 @@ Name | Type | Description | Notes
**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]
**sort** | **String**| Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending. | [optional] [default to ]
**filter** | **String**| A filter to apply to the query. | [optional]
**x_org_id** | **String**| | [optional] [default to ]

### Return type
Expand Down
10 changes: 10 additions & 0 deletions jcapiv1/docs/Mfa.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# JCAPIv1::Mfa

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**exclusion** | **BOOLEAN** | | [optional]
**exclusion_until** | **DateTime** | | [optional]
**configured** | **BOOLEAN** | | [optional]


8 changes: 5 additions & 3 deletions jcapiv1/docs/OrganizationsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,11 @@ accept = "application/json" # String |

opts = {
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.
filter: "filter_example" # String | A filter to apply to the query.
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 | Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending.
search: "search_example" # String |
sort: "", # String | Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending.
search: "search_example", # String | A nested object containing a string `searchTerm` and a list of `fields` to search on.
}

begin
Expand All @@ -56,10 +57,11 @@ Name | Type | Description | Notes
**content_type** | **String**| | [default to application/json]
**accept** | **String**| | [default to application/json]
**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 ]
**filter** | **String**| A filter to apply to the query. | [optional]
**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**| Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending. | [optional] [default to ]
**search** | **String**| | [optional]
**search** | **String**| A nested object containing a string `searchTerm` and a list of `fields` to search on. | [optional]

### Return type

Expand Down
4 changes: 3 additions & 1 deletion jcapiv1/docs/RadiusServersApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,10 @@ accept = "application/json" # String |

opts = {
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.
filter: "filter_example" # String | A filter to apply to the query.
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 | Use space separated sort parameters 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.
x_org_id: "" # String |
}

Expand All @@ -58,6 +59,7 @@ Name | Type | Description | Notes
**content_type** | **String**| | [default to application/json]
**accept** | **String**| | [default to application/json]
**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 ]
**filter** | **String**| A filter to apply to the query. | [optional]
**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**| Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending. | [optional] [default to ]
Expand Down
Loading