Skip to content

Commit

Permalink
Merge pull request #11 from TheJumpCloud/PYTHON-SDK-V1-Updates-6.11.18
Browse files Browse the repository at this point in the history
PYTHON-SDK-V1-Updates-6.11.18
  • Loading branch information
jpvajda authored Jun 18, 2018
2 parents 7dec57d + 5e3ad26 commit 864cba0
Show file tree
Hide file tree
Showing 48 changed files with 2,735 additions and 293 deletions.
2 changes: 1 addition & 1 deletion config_v1.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"packageName": "jcapiv1",
"packageVersion": "1.0.1"
"packageVersion": "1.0.2"
}
10 changes: 9 additions & 1 deletion jcapiv1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,14 +84,17 @@ Class | Method | HTTP request | Description
*CommandResultsApi* | [**command_results_get**](docs/CommandResultsApi.md#command_results_get) | **GET** /commandresults/{id} | List an individual Command result
*CommandResultsApi* | [**command_results_list**](docs/CommandResultsApi.md#command_results_list) | **GET** /commandresults | List all Command Results
*CommandTriggersApi* | [**command_trigger_webhook_post**](docs/CommandTriggersApi.md#command_trigger_webhook_post) | **POST** /command/trigger/{triggername} | Launch a command via a Trigger
*CommandsApi* | [**command_file_get**](docs/CommandsApi.md#command_file_get) | **GET** /files/command/{id} | Get a Command File
*CommandsApi* | [**commands_delete**](docs/CommandsApi.md#commands_delete) | **DELETE** /commands/{id} | Delete a Command
*CommandsApi* | [**commands_get**](docs/CommandsApi.md#commands_get) | **GET** /commands/{id} | List an individual Command
*CommandsApi* | [**commands_list**](docs/CommandsApi.md#commands_list) | **GET** /commands/ | List All Commands
*CommandsApi* | [**commands_post**](docs/CommandsApi.md#commands_post) | **POST** /commands/ | Create A Command
*CommandsApi* | [**commands_put**](docs/CommandsApi.md#commands_put) | **PUT** /commands/{id} | Update a Command
*RadiusServersApi* | [**radius_servers_list**](docs/RadiusServersApi.md#radius_servers_list) | **GET** /radiusservers | List Radius Servers
*RadiusServersApi* | [**radius_servers_post**](docs/RadiusServersApi.md#radius_servers_post) | **POST** /radiusservers | Create a Radius Server
*RadiusServersApi* | [**radius_servers_put**](docs/RadiusServersApi.md#radius_servers_put) | **PUT** /radiusservers:id | Update Radius Servers
*SearchApi* | [**search_systemusers_post**](docs/SearchApi.md#search_systemusers_post) | **POST** /search/systemusers | List System Users
*SearchApi* | [**search_systems_post**](docs/SearchApi.md#search_systems_post) | **POST** /search/systems | Search Systems
*SearchApi* | [**search_systemusers_post**](docs/SearchApi.md#search_systemusers_post) | **POST** /search/systemusers | Search System Users
*SystemsApi* | [**systems_delete**](docs/SystemsApi.md#systems_delete) | **DELETE** /systems/{id} | Delete a System
*SystemsApi* | [**systems_get**](docs/SystemsApi.md#systems_get) | **GET** /systems/{id} | List an individual system
*SystemsApi* | [**systems_list**](docs/SystemsApi.md#systems_list) | **GET** /systems | List All Systems
Expand All @@ -103,6 +106,7 @@ Class | Method | HTTP request | Description
*SystemusersApi* | [**systemusers_list**](docs/SystemusersApi.md#systemusers_list) | **GET** /systemusers | List all system users
*SystemusersApi* | [**systemusers_post**](docs/SystemusersApi.md#systemusers_post) | **POST** /systemusers | Create a system user
*SystemusersApi* | [**systemusers_put**](docs/SystemusersApi.md#systemusers_put) | **PUT** /systemusers/{id} | Update a system user
*SystemusersApi* | [**systemusers_resetmfa**](docs/SystemusersApi.md#systemusers_resetmfa) | **POST** /systemusers/{id}/resetmfa | Reset a system user's MFA token
*SystemusersApi* | [**systemusers_systems_binding_list**](docs/SystemusersApi.md#systemusers_systems_binding_list) | **GET** /systemusers/{id}/systems | List system user binding
*SystemusersApi* | [**systemusers_systems_binding_put**](docs/SystemusersApi.md#systemusers_systems_binding_put) | **PUT** /systemusers/{id}/systems | Update a system user binding
*TagsApi* | [**tags_delete**](docs/TagsApi.md#tags_delete) | **DELETE** /tags/{name} | Delete a Tag
Expand All @@ -125,12 +129,15 @@ Class | Method | HTTP request | Description
- [Applicationslist](docs/Applicationslist.md)
- [Body](docs/Body.md)
- [Command](docs/Command.md)
- [Commandfilereturn](docs/Commandfilereturn.md)
- [Commandresult](docs/Commandresult.md)
- [CommandresultResponse](docs/CommandresultResponse.md)
- [CommandresultResponseData](docs/CommandresultResponseData.md)
- [Commandresultslist](docs/Commandresultslist.md)
- [Commandslist](docs/Commandslist.md)
- [InlineResponse400](docs/InlineResponse400.md)
- [Radiusserver](docs/Radiusserver.md)
- [Radiusserverpost](docs/Radiusserverpost.md)
- [Radiusserverput](docs/Radiusserverput.md)
- [Radiusserverslist](docs/Radiusserverslist.md)
- [Search](docs/Search.md)
Expand All @@ -142,6 +149,7 @@ Class | Method | HTTP request | Description
- [Systemuser](docs/Systemuser.md)
- [Systemuserbinding](docs/Systemuserbinding.md)
- [Systemuserbindingsput](docs/Systemuserbindingsput.md)
- [Systemuserput](docs/Systemuserput.md)
- [Systemuserputpost](docs/Systemuserputpost.md)
- [Systemuserreturn](docs/Systemuserreturn.md)
- [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
```python
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** | **str** | | [optional]
**command** | **str** | The command to execute on the server. |
**user** | **str** | The ID of the JC managed user to run the command as. |
**systems** | **list[str]** | An array of system IDs to run the command on. | [optional]
**user** | **str** | The ID of the system user to run the command as. |
**systems** | **list[str]** | An array of system IDs to run the command on. Not available if you are using Groups. | [optional]
**schedule** | **str** | 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** | **list[str]** | An array of file IDs to include with the command. | [optional]
**tags** | **list[str]** | An array of tag IDs to run the command on. | [optional]
**tags** | **list[str]** | An array of tag IDs to run the command on. Not available if you are using Groups. | [optional]
**timeout** | **str** | The time in seconds to allow the command to run for. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
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
```python
Expand Down Expand Up @@ -71,7 +71,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
```python
Expand All @@ -91,10 +91,10 @@ api_instance = jcapiv1.CommandResultsApi()
id = 'id_example' # str |
content_type = 'application/json' # str | (default to application/json)
accept = 'application/json' # str | (default to application/json)
fields = '' # str | The comma separated fields included in the returned records. If omitted the default list of fields will be returned. (optional) (default to )
limit = 10 # int | The number of records to return at once. (optional) (default to 10)
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 | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. (optional) (default to )
sort = '' # str | Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending. (optional) (default to )

try:
# List an individual Command result
Expand All @@ -111,10 +111,10 @@ Name | Type | Description | Notes
**id** | **str**| |
**content_type** | **str**| | [default to application/json]
**accept** | **str**| | [default to application/json]
**fields** | **str**| The comma separated fields included in the returned records. If omitted the default list of fields will be returned. | [optional] [default to ]
**limit** | **int**| The number of records to return at once. | [optional] [default to 10]
**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**| The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. | [optional] [default to ]
**sort** | **str**| 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 @@ -136,7 +136,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
```python
Expand All @@ -155,10 +155,10 @@ jcapiv1.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
api_instance = jcapiv1.CommandResultsApi()
content_type = 'application/json' # str | (default to application/json)
accept = 'application/json' # str | (default to application/json)
fields = '' # str | The comma separated fields included in the returned records. If omitted the default list of fields will be returned. (optional) (default to )
limit = 10 # int | The number of records to return at once. (optional) (default to 10)
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 | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. (optional) (default to )
sort = '' # str | Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending. (optional) (default to )

try:
# List all Command Results
Expand All @@ -174,10 +174,10 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**content_type** | **str**| | [default to application/json]
**accept** | **str**| | [default to application/json]
**fields** | **str**| The comma separated fields included in the returned records. If omitted the default list of fields will be returned. | [optional] [default to ]
**limit** | **int**| The number of records to return at once. | [optional] [default to 10]
**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**| The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. | [optional] [default to ]
**sort** | **str**| 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
```python
Expand Down
12 changes: 12 additions & 0 deletions jcapiv1/docs/Commandfilereturn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Commandfilereturn

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

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


Loading

0 comments on commit 864cba0

Please sign in to comment.