From 814f68b0ddb254b624120721bd201f7b08b3d94d Mon Sep 17 00:00:00 2001 From: Bob Bawn Date: Mon, 7 Jan 2019 16:02:57 -0700 Subject: [PATCH 1/2] regenerate from current OAS specs --- config_v1.json | 2 +- config_v2.json | 2 +- jcapiv1/README.md | 10 +- jcapiv1/docs/ApplicationsApi.md | 2 +- jcapiv1/docs/Body1.md | 9 + jcapiv1/docs/CommandResultsApi.md | 4 +- jcapiv1/docs/Commandresult.md | 4 +- jcapiv1/docs/CommandsApi.md | 4 +- jcapiv1/docs/Fde.md | 1 + jcapiv1/docs/OrganizationsApi.md | 2 +- jcapiv1/docs/RadiusServersApi.md | 2 +- jcapiv1/docs/SearchApi.md | 6 +- jcapiv1/docs/System.md | 3 +- jcapiv1/docs/SystemSshdParams.md | 9 + jcapiv1/docs/SystemsApi.md | 4 +- jcapiv1/docs/SystemusersApi.md | 12 +- jcapiv1/lib/jcapiv1.rb | 2 + jcapiv1/lib/jcapiv1/api/applications_api.rb | 4 +- .../lib/jcapiv1/api/command_results_api.rb | 8 +- jcapiv1/lib/jcapiv1/api/commands_api.rb | 8 +- jcapiv1/lib/jcapiv1/api/organizations_api.rb | 4 +- jcapiv1/lib/jcapiv1/api/radius_servers_api.rb | 4 +- jcapiv1/lib/jcapiv1/api/search_api.rb | 12 +- jcapiv1/lib/jcapiv1/api/systems_api.rb | 8 +- jcapiv1/lib/jcapiv1/api/systemusers_api.rb | 24 +- jcapiv1/lib/jcapiv1/models/body_1.rb | 197 ++++++++++++ jcapiv1/lib/jcapiv1/models/commandresult.rb | 4 +- jcapiv1/lib/jcapiv1/models/fde.rb | 17 +- jcapiv1/lib/jcapiv1/models/system.rb | 19 +- .../lib/jcapiv1/models/system_sshd_params.rb | 197 ++++++++++++ jcapiv1/lib/jcapiv1/models/systemuser.rb | 20 +- jcapiv1/lib/jcapiv1/models/systemuserput.rb | 20 +- .../lib/jcapiv1/models/systemuserputpost.rb | 20 +- .../lib/jcapiv1/models/systemuserreturn.rb | 20 +- jcapiv1/lib/jcapiv1/version.rb | 2 +- jcapiv1/spec/api/applications_api_spec.rb | 2 +- jcapiv1/spec/api/command_results_api_spec.rb | 4 +- jcapiv1/spec/api/commands_api_spec.rb | 4 +- jcapiv1/spec/api/organizations_api_spec.rb | 2 +- jcapiv1/spec/api/radius_servers_api_spec.rb | 2 +- jcapiv1/spec/api/search_api_spec.rb | 6 +- jcapiv1/spec/api/systems_api_spec.rb | 4 +- jcapiv1/spec/api/systemusers_api_spec.rb | 11 +- jcapiv1/spec/models/body_1_spec.rb | 48 +++ jcapiv1/spec/models/fde_spec.rb | 6 + jcapiv1/spec/models/system_spec.rb | 6 + .../spec/models/system_sshd_params_spec.rb | 48 +++ jcapiv2/README.md | 34 +- jcapiv2/docs/ApplicationsApi.md | 2 +- jcapiv2/docs/BulkJobRequestsApi.md | 74 ++++- jcapiv2/docs/BulkUserCreate.md | 2 +- jcapiv2/docs/BulkUserUpdate.md | 9 + jcapiv2/docs/GSuiteApi.md | 265 +++++++++++++++ jcapiv2/docs/GSuiteBuiltinTranslation.md | 7 + jcapiv2/docs/GSuiteTranslationRule.md | 9 + jcapiv2/docs/GSuiteTranslationRuleRequest.md | 8 + jcapiv2/docs/GraphApi.md | 54 ++-- jcapiv2/docs/InlineResponse201.md | 8 + jcapiv2/docs/InlineResponse2011.md | 8 + jcapiv2/docs/Office365Api.md | 265 +++++++++++++++ jcapiv2/docs/Office365BuiltinTranslation.md | 7 + jcapiv2/docs/Office365TranslationRule.md | 9 + .../docs/Office365TranslationRuleRequest.md | 8 + jcapiv2/docs/PoliciesApi.md | 40 +-- jcapiv2/docs/PolicyResult.md | 2 + jcapiv2/docs/RADIUSServersApi.md | 4 +- jcapiv2/docs/SambaDomainsApi.md | 4 +- jcapiv2/docs/SystemsApi.md | 14 +- jcapiv2/docs/UserGroupAssociationsApi.md | 8 +- jcapiv2/docs/UserGroupsApi.md | 10 +- jcapiv2/docs/UsersApi.md | 34 +- jcapiv2/docs/WorkdayImportApi.md | 8 +- jcapiv2/lib/jcapiv2.rb | 9 + jcapiv2/lib/jcapiv2/api/applications_api.rb | 4 +- .../lib/jcapiv2/api/bulk_job_requests_api.rb | 80 ++++- jcapiv2/lib/jcapiv2/api/g_suite_api.rb | 304 ++++++++++++++++++ jcapiv2/lib/jcapiv2/api/graph_api.rb | 100 +++--- jcapiv2/lib/jcapiv2/api/office365_api.rb | 304 ++++++++++++++++++ jcapiv2/lib/jcapiv2/api/policies_api.rb | 68 ++-- jcapiv2/lib/jcapiv2/api/radius_servers_api.rb | 8 +- jcapiv2/lib/jcapiv2/api/samba_domains_api.rb | 8 +- jcapiv2/lib/jcapiv2/api/systems_api.rb | 25 +- .../api/user_group_associations_api.rb | 16 +- jcapiv2/lib/jcapiv2/api/user_groups_api.rb | 20 +- jcapiv2/lib/jcapiv2/api/users_api.rb | 59 ++-- jcapiv2/lib/jcapiv2/api/workday_import_api.rb | 16 +- .../lib/jcapiv2/models/bulk_user_create.rb | 3 +- .../lib/jcapiv2/models/bulk_user_update.rb | 201 ++++++++++++ jcapiv2/lib/jcapiv2/models/emailrequest.rb | 33 ++ .../models/g_suite_builtin_translation.rb | 43 +++ .../models/g_suite_translation_rule.rb | 198 ++++++++++++ .../g_suite_translation_rule_request.rb | 188 +++++++++++ .../lib/jcapiv2/models/inline_response_201.rb | 188 +++++++++++ .../jcapiv2/models/inline_response_201_1.rb | 188 +++++++++++ .../models/office365_builtin_translation.rb | 39 +++ .../models/office365_translation_rule.rb | 198 ++++++++++++ .../office365_translation_rule_request.rb | 188 +++++++++++ jcapiv2/lib/jcapiv2/models/policy_result.rb | 28 +- jcapiv2/lib/jcapiv2/models/systemuser.rb | 20 +- .../lib/jcapiv2/models/systemuserputpost.rb | 20 +- jcapiv2/lib/jcapiv2/version.rb | 2 +- jcapiv2/spec/api/applications_api_spec.rb | 2 +- .../spec/api/bulk_job_requests_api_spec.rb | 21 +- jcapiv2/spec/api/g_suite_api_spec.rb | 64 ++++ jcapiv2/spec/api/graph_api_spec.rb | 48 +-- jcapiv2/spec/api/office365_api_spec.rb | 64 ++++ jcapiv2/spec/api/policies_api_spec.rb | 20 +- jcapiv2/spec/api/radius_servers_api_spec.rb | 4 +- jcapiv2/spec/api/samba_domains_api_spec.rb | 4 +- jcapiv2/spec/api/systems_api_spec.rb | 11 +- .../api/user_group_associations_api_spec.rb | 8 +- jcapiv2/spec/api/user_groups_api_spec.rb | 10 +- jcapiv2/spec/api/users_api_spec.rb | 25 +- jcapiv2/spec/api/workday_import_api_spec.rb | 8 +- jcapiv2/spec/models/bulk_user_update_spec.rb | 48 +++ jcapiv2/spec/models/emailrequest_spec.rb | 4 + .../g_suite_builtin_translation_spec.rb | 36 +++ .../g_suite_translation_rule_request_spec.rb | 42 +++ .../models/g_suite_translation_rule_spec.rb | 48 +++ .../spec/models/inline_response_201_1_spec.rb | 42 +++ .../spec/models/inline_response_201_spec.rb | 42 +++ .../office365_builtin_translation_spec.rb | 36 +++ ...office365_translation_rule_request_spec.rb | 42 +++ .../models/office365_translation_rule_spec.rb | 48 +++ jcapiv2/spec/models/policy_result_spec.rb | 12 + 125 files changed, 4461 insertions(+), 488 deletions(-) create mode 100644 jcapiv1/docs/Body1.md create mode 100644 jcapiv1/docs/SystemSshdParams.md create mode 100644 jcapiv1/lib/jcapiv1/models/body_1.rb create mode 100644 jcapiv1/lib/jcapiv1/models/system_sshd_params.rb create mode 100644 jcapiv1/spec/models/body_1_spec.rb create mode 100644 jcapiv1/spec/models/system_sshd_params_spec.rb create mode 100644 jcapiv2/docs/BulkUserUpdate.md create mode 100644 jcapiv2/docs/GSuiteBuiltinTranslation.md create mode 100644 jcapiv2/docs/GSuiteTranslationRule.md create mode 100644 jcapiv2/docs/GSuiteTranslationRuleRequest.md create mode 100644 jcapiv2/docs/InlineResponse201.md create mode 100644 jcapiv2/docs/InlineResponse2011.md create mode 100644 jcapiv2/docs/Office365BuiltinTranslation.md create mode 100644 jcapiv2/docs/Office365TranslationRule.md create mode 100644 jcapiv2/docs/Office365TranslationRuleRequest.md create mode 100644 jcapiv2/lib/jcapiv2/models/bulk_user_update.rb create mode 100644 jcapiv2/lib/jcapiv2/models/g_suite_builtin_translation.rb create mode 100644 jcapiv2/lib/jcapiv2/models/g_suite_translation_rule.rb create mode 100644 jcapiv2/lib/jcapiv2/models/g_suite_translation_rule_request.rb create mode 100644 jcapiv2/lib/jcapiv2/models/inline_response_201.rb create mode 100644 jcapiv2/lib/jcapiv2/models/inline_response_201_1.rb create mode 100644 jcapiv2/lib/jcapiv2/models/office365_builtin_translation.rb create mode 100644 jcapiv2/lib/jcapiv2/models/office365_translation_rule.rb create mode 100644 jcapiv2/lib/jcapiv2/models/office365_translation_rule_request.rb create mode 100644 jcapiv2/spec/models/bulk_user_update_spec.rb create mode 100644 jcapiv2/spec/models/g_suite_builtin_translation_spec.rb create mode 100644 jcapiv2/spec/models/g_suite_translation_rule_request_spec.rb create mode 100644 jcapiv2/spec/models/g_suite_translation_rule_spec.rb create mode 100644 jcapiv2/spec/models/inline_response_201_1_spec.rb create mode 100644 jcapiv2/spec/models/inline_response_201_spec.rb create mode 100644 jcapiv2/spec/models/office365_builtin_translation_spec.rb create mode 100644 jcapiv2/spec/models/office365_translation_rule_request_spec.rb create mode 100644 jcapiv2/spec/models/office365_translation_rule_spec.rb diff --git a/config_v1.json b/config_v1.json index e2de389..6335c5a 100644 --- a/config_v1.json +++ b/config_v1.json @@ -1,5 +1,5 @@ { "gemName": "jcapiv1", "moduleName": "JCAPIv1", - "gemVersion": "1.2.0" + "gemVersion": "1.3.0" } diff --git a/config_v2.json b/config_v2.json index a86e622..bd7809d 100644 --- a/config_v2.json +++ b/config_v2.json @@ -1,5 +1,5 @@ { "gemName": "jcapiv2", "moduleName": "JCAPIv2", - "gemVersion": "1.2.0" + "gemVersion": "1.3.0" } diff --git a/jcapiv1/README.md b/jcapiv1/README.md index 415aa90..711e58a 100644 --- a/jcapiv1/README.md +++ b/jcapiv1/README.md @@ -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.2.0 +- Package version: 1.3.0 - Build package: io.swagger.codegen.languages.RubyClientCodegen ## Installation @@ -23,15 +23,15 @@ gem build jcapiv1.gemspec Then either install the gem locally: ```shell -gem install ./jcapiv1-1.2.0.gem +gem install ./jcapiv1-1.3.0.gem ``` -(for development, run `gem install --dev ./jcapiv1-1.2.0.gem` to install the development dependencies) +(for development, run `gem install --dev ./jcapiv1-1.3.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.2.0' + gem 'jcapiv1', '~> 1.3.0' ### Install from Git @@ -146,6 +146,7 @@ Class | Method | HTTP request | Description - [JCAPIv1::ApplicationConfigIdpEntityIdTooltipVariables](docs/ApplicationConfigIdpEntityIdTooltipVariables.md) - [JCAPIv1::Applicationslist](docs/Applicationslist.md) - [JCAPIv1::Body](docs/Body.md) + - [JCAPIv1::Body1](docs/Body1.md) - [JCAPIv1::Command](docs/Command.md) - [JCAPIv1::Commandfilereturn](docs/Commandfilereturn.md) - [JCAPIv1::CommandfilereturnResults](docs/CommandfilereturnResults.md) @@ -168,6 +169,7 @@ Class | Method | HTTP request | Description - [JCAPIv1::Sshkeypost](docs/Sshkeypost.md) - [JCAPIv1::System](docs/System.md) - [JCAPIv1::SystemNetworkInterfaces](docs/SystemNetworkInterfaces.md) + - [JCAPIv1::SystemSshdParams](docs/SystemSshdParams.md) - [JCAPIv1::Systemput](docs/Systemput.md) - [JCAPIv1::SystemputAgentBoundMessages](docs/SystemputAgentBoundMessages.md) - [JCAPIv1::Systemslist](docs/Systemslist.md) diff --git a/jcapiv1/docs/ApplicationsApi.md b/jcapiv1/docs/ApplicationsApi.md index 6f8cc76..bca1a67 100644 --- a/jcapiv1/docs/ApplicationsApi.md +++ b/jcapiv1/docs/ApplicationsApi.md @@ -12,7 +12,7 @@ Method | HTTP request | Description 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}' ``` +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 diff --git a/jcapiv1/docs/Body1.md b/jcapiv1/docs/Body1.md new file mode 100644 index 0000000..33188a2 --- /dev/null +++ b/jcapiv1/docs/Body1.md @@ -0,0 +1,9 @@ +# JCAPIv1::Body1 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**exclusion** | **BOOLEAN** | | [optional] +**exclusion_until** | **DateTime** | | [optional] + + diff --git a/jcapiv1/docs/CommandResultsApi.md b/jcapiv1/docs/CommandResultsApi.md index 2277019..4f8a1ce 100644 --- a/jcapiv1/docs/CommandResultsApi.md +++ b/jcapiv1/docs/CommandResultsApi.md @@ -14,7 +14,7 @@ Method | HTTP request | Description Delete a 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}' ```` +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 @@ -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/{CommandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby diff --git a/jcapiv1/docs/Commandresult.md b/jcapiv1/docs/Commandresult.md index ee20cb4..db5d384 100644 --- a/jcapiv1/docs/Commandresult.md +++ b/jcapiv1/docs/Commandresult.md @@ -13,8 +13,8 @@ Name | Type | Description | Notes **user** | **String** | The user the command ran as. | [optional] **sudo** | **BOOLEAN** | If the user had sudo rights | [optional] **files** | **Array<String>** | An array of file ids that were included in the command | [optional] -**request_time** | **Integer** | The time that the command was sent. | [optional] -**response_time** | **Integer** | The time that the command was completed. | [optional] +**request_time** | **String** | The time that the command was sent. | [optional] +**response_time** | **String** | The time that the command was completed. | [optional] **response** | [**CommandresultResponse**](CommandresultResponse.md) | | [optional] **_id** | **String** | The ID of the command. | [optional] diff --git a/jcapiv1/docs/CommandsApi.md b/jcapiv1/docs/CommandsApi.md index d29da02..671b801 100644 --- a/jcapiv1/docs/CommandsApi.md +++ b/jcapiv1/docs/CommandsApi.md @@ -17,7 +17,7 @@ Method | HTTP request | Description Get a Command File -This endpoint returns the uploaded file(s) associated with a specific command. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/files/command/{commandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint returns the uploaded file(s) associated with a specific command. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/files/command/{commandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -150,7 +150,7 @@ nil (empty response body) List an individual Command -This endpoint returns a specific command based on the command ID. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/commands/{CommandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint returns a specific command based on the command ID. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/commands/{CommandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby diff --git a/jcapiv1/docs/Fde.md b/jcapiv1/docs/Fde.md index ed25b28..11dedd8 100644 --- a/jcapiv1/docs/Fde.md +++ b/jcapiv1/docs/Fde.md @@ -4,5 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **key_present** | **BOOLEAN** | | [optional] +**active** | **BOOLEAN** | | [optional] diff --git a/jcapiv1/docs/OrganizationsApi.md b/jcapiv1/docs/OrganizationsApi.md index 259ddcb..8d47186 100644 --- a/jcapiv1/docs/OrganizationsApi.md +++ b/jcapiv1/docs/OrganizationsApi.md @@ -12,7 +12,7 @@ Method | HTTP request | Description Get Organization Details -This endpoint returns Organization Details. #### Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/organizations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint returns Organization Details. #### Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/organizations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby diff --git a/jcapiv1/docs/RadiusServersApi.md b/jcapiv1/docs/RadiusServersApi.md index 9ee8b7a..8f71c24 100644 --- a/jcapiv1/docs/RadiusServersApi.md +++ b/jcapiv1/docs/RadiusServersApi.md @@ -146,7 +146,7 @@ Name | Type | Description | Notes Update Radius Servers -This endpoint allows you to update RADIUS servers in your organization. #### ``` curl -X PUT https://console.jumpcloud.com/api/radiusservers/{ServerID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"name\": \"{name_update}\", \"networkSourceIp\": \"{0.0.0.0}\" }' ``` +This endpoint allows you to update RADIUS servers in your organization. #### ``` curl -X PUT https://console.jumpcloud.com/api/radiusservers/{ServerID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"name\": \"{name_update}\", \"networkSourceIp\": \"{0.0.0.0}\" }' ``` ### Example ```ruby diff --git a/jcapiv1/docs/SearchApi.md b/jcapiv1/docs/SearchApi.md index 0586b95..a9a097b 100644 --- a/jcapiv1/docs/SearchApi.md +++ b/jcapiv1/docs/SearchApi.md @@ -14,7 +14,7 @@ Method | HTTP request | Description Search Organizations -This endpoint will return Organization data based on your search parameters. This endpoint WILL NOT allow you to add a new Organization. You can use the supported parameters and pass those in the body of request. The parameters must be passed as Content-Type application/json. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/organizations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"search\":{ \"fields\" : [\"settings.name\"], \"searchTerm\": \"Second\" }, \"fields\": [\"_id\", \"displayName\", \"logoUrl\"], \"limit\" : 0, \"skip\" : 0 }' ``` +This endpoint will return Organization data based on your search parameters. This endpoint WILL NOT allow you to add a new Organization. You can use the supported parameters and pass those in the body of request. The parameters must be passed as Content-Type application/json. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/organizations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"search\":{ \"fields\" : [\"settings.name\"], \"searchTerm\": \"Second\" }, \"fields\": [\"_id\", \"displayName\", \"logoUrl\"], \"limit\" : 0, \"skip\" : 0 }' ``` ### Example ```ruby @@ -81,7 +81,7 @@ Name | Type | Description | Notes Search Systems -Return Systems in multi-record format allowing for the passing of the 'filter' parameter. This WILL NOT allow you to add a new system. To support advanced filtering you can use the `filter` parameter that can only be passed in the body of POST /api/search/* routes. The `filter` parameter must be passed as Content-Type application/json supports advanced filtering using the MongoDB JSON query syntax. The `filter` parameter is an object with a single property, either and or or with the value of the property being an array of query expressions. This allows you to filter records using the logic of matching ALL or ANY records in the array of query expressions. If the and or or are not included the default behavior is to match ALL query expressions. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"filter\" : { \"or\" : [ {\"hostname\" : { \"$regex\" : \"^www\" }}, {\"hostname\" : {\"$regex\" : \"^db\"}} ] }, \"fields\" : \"os hostname displayName\" }' ``` +Return Systems in multi-record format allowing for the passing of the 'filter' parameter. This WILL NOT allow you to add a new system. To support advanced filtering you can use the `filter` parameter that can only be passed in the body of POST /api/search/* routes. The `filter` parameter must be passed as Content-Type application/json. The `filter` parameter is an object with a single property, either `and` or `or` with the value of the property being an array of query expressions. This allows you to filter records using the logic of matching ALL or ANY records in the array of query expressions. If the `and` or `or` are not included the default behavior is to match ALL query expressions. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"filter\" : { \"or\" : [ {\"hostname\" : \"my-hostname\"}, {\"hostname\" : \"other-hostname\"} ] }, \"fields\" : \"os hostname displayName\" }' ``` ### Example ```ruby @@ -150,7 +150,7 @@ Name | Type | Description | Notes Search System Users -Return System Users in multi-record format allowing for the passing of the 'filter' parameter. This WILL NOT allow you to add a new system user. To support advanced filtering you can use the `filter` parameter that can only be passed in the body of POST /api/search/* routes. The `filter` parameter must be passed as Content-Type application/json supports advanced filtering using the MongoDB JSON query syntax. The `filter` parameter is an object with a single property, either and or or with the value of the property being an array of query expressions. This allows you to filter records using the logic of matching ALL or ANY records in the array of query expressions. If the and or or are not included the default behavior is to match ALL query expressions. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/systemusers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"filter\" : [{\"email\" : { \"$regex\" : \"gmail.com$\"}}], \"fields\" : \"email username sudo\" }' ``` +Return System Users in multi-record format allowing for the passing of the 'filter' parameter. This WILL NOT allow you to add a new system user. To support advanced filtering you can use the `filter` parameter that can only be passed in the body of POST /api/search/* routes. The `filter` parameter must be passed as Content-Type application/json. The `filter` parameter is an object with a single property, either `and` or `or` with the value of the property being an array of query expressions. This allows you to filter records using the logic of matching ALL or ANY records in the array of query expressions. If the `and` or `or` are not included the default behavior is to match ALL query expressions. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/systemusers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"filter\" : [{\"email\" : \"example@jumpcloud.com\"}], \"fields\" : \"email username sudo\" }' ``` ### Example ```ruby diff --git a/jcapiv1/docs/System.md b/jcapiv1/docs/System.md index 7d53af1..26803da 100644 --- a/jcapiv1/docs/System.md +++ b/jcapiv1/docs/System.md @@ -16,7 +16,7 @@ Name | Type | Description | Notes **template_name** | **String** | | [optional] **remote_ip** | **String** | | [optional] **active** | **BOOLEAN** | | [optional] -**sshd_params** | **Array<String>** | | [optional] +**sshd_params** | [**Array<SystemSshdParams>**](SystemSshdParams.md) | | [optional] **allow_ssh_password_authentication** | **BOOLEAN** | | [optional] **allow_ssh_root_login** | **BOOLEAN** | | [optional] **allow_multi_factor_authentication** | **BOOLEAN** | | [optional] @@ -28,5 +28,6 @@ Name | Type | Description | Notes **tags** | **Array<String>** | | [optional] **_id** | **String** | | [optional] **fde** | [**Fde**](Fde.md) | | [optional] +**amazon_instance_id** | **String** | | [optional] diff --git a/jcapiv1/docs/SystemSshdParams.md b/jcapiv1/docs/SystemSshdParams.md new file mode 100644 index 0000000..d2bfc98 --- /dev/null +++ b/jcapiv1/docs/SystemSshdParams.md @@ -0,0 +1,9 @@ +# JCAPIv1::SystemSshdParams + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | | [optional] +**value** | **String** | | [optional] + + diff --git a/jcapiv1/docs/SystemsApi.md b/jcapiv1/docs/SystemsApi.md index 824671c..65170ee 100644 --- a/jcapiv1/docs/SystemsApi.md +++ b/jcapiv1/docs/SystemsApi.md @@ -85,7 +85,7 @@ Name | Type | Description | Notes List an individual system -This endpoint returns an individual system. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/systems/{SystemID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint returns an individual system. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/systems/{SystemID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -155,7 +155,7 @@ Name | Type | Description | Notes List All Systems -This endpoint returns all Systems. #### Sample Requests ``` curl -X GET https://console.jumpcloud.com/api/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint returns all Systems. #### Sample Requests ``` curl -X GET https://console.jumpcloud.com/api/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby diff --git a/jcapiv1/docs/SystemusersApi.md b/jcapiv1/docs/SystemusersApi.md index 6c72ec2..736552c 100644 --- a/jcapiv1/docs/SystemusersApi.md +++ b/jcapiv1/docs/SystemusersApi.md @@ -215,7 +215,7 @@ Name | Type | Description | Notes Delete a system user -This endpoint allows you to delete a particular system user. #### Sample Request ``` curl -X DELETE https://console.jumpcloud.com/api/systemusers/{UserID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint allows you to delete a particular system user. #### Sample Request ``` curl -X DELETE https://console.jumpcloud.com/api/systemusers/{UserID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -345,7 +345,7 @@ Name | Type | Description | Notes List all system users -This endpoint returns all systemusers. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/systemusers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint returns all systemusers. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/systemusers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -545,7 +545,7 @@ Name | Type | Description | Notes Reset a system user's MFA token -This endpoint allows you to reset the MFA TOTP token for a specified system user. This will result in a user being required to complete the setup of their MFA TOTP token via an email notification sent from Jumpcloud. Please be aware, that until MFA setup is complete, a user may be locked out of systems or applications. Please refer to our [Knowledge Base Article](https://support.jumpcloud.com/customer/en/portal/articles/2443975-how-to-enable-multifactor-authentication-for-the-jumpcloud-user-portal) on setting up MFA for more information. #### Sample Request ``` curl -X POST \\ https://console.jumpcloud.com/api/systemusers/{UserID}/resetmfa \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint allows you to reset the MFA TOTP token for a specified system user and put them in an MFA enrollment period. This will result in the user being prompted to setup MFA when logging into userportal. Please be aware that if the user does not complete MFA setup before the `exclusionUntil` date, they will be locked out of any resources that require MFA. Please refer to our [Knowledge Base Article](https://support.jumpcloud.com/customer/en/portal/articles/2959138-using-multifactor-authentication-with-jumpcloud) on setting up MFA for more information. #### Sample Request ``` curl -X POST \\ https://console.jumpcloud.com/api/systemusers/{UserID}/resetmfa \\ -H 'x-api-key: {API_KEY}' \\ -H 'Content-Type: application/json' \\ -d '{\"exclusion\": true, \"exclusionUntil\": \"{date-time}\"}' ``` ### Example ```ruby @@ -566,6 +566,7 @@ id = "id_example" # String | x_api_key = "x_api_key_example" # String | opts = { + body: JCAPIv1::Body1.new, # Body1 | x_org_id: "" # String | } @@ -584,6 +585,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | **x_api_key** | **String**| | + **body** | [**Body1**](Body1.md)| | [optional] **x_org_id** | **String**| | [optional] [default to ] ### Return type @@ -606,7 +608,7 @@ Name | Type | Description | Notes List system user binding -Hidden as Tags is deprecated Adds or removes a system binding for a user. This endpoint is only used for users still using JumpCloud Tags. If you are using JumpCloud Groups please refer to the documentation found [here](https://docs.jumpcloud.com/2.0/systems/manage-associations-of-a-system). List system bindings for a specific system user in a system and user binding format. ### Examples #### List system bindings for specific system user ``` curl \\ -H 'Content-Type: application/json' \\ -H \"x-api-key: [YOUR_API_KEY_HERE]\" \\ \"https://console.jumpcloud.com/api/systemusers/[SYSTEM_USER_ID_HERE]/systems\" ``` +Hidden as Tags is deprecated Adds or removes a system binding for a user. This endpoint is only used for users still using JumpCloud Tags. If you are using JumpCloud Groups please refer to the documentation found [here](https://docs.jumpcloud.com/2.0/systems/manage-associations-of-a-system). List system bindings for a specific system user in a system and user binding format. ### Examples #### List system bindings for specific system user ``` curl \\ -H 'Content-Type: application/json' \\ -H \"x-api-key: [YOUR_API_KEY_HERE]\" \\ \"https://console.jumpcloud.com/api/systemusers/[SYSTEM_USER_ID_HERE]/systems\" ``` ### Example ```ruby @@ -678,7 +680,7 @@ Name | Type | Description | Notes Update a system user binding -Hidden as Tags is deprecated Adds or removes a system binding for a user. This endpoint is only used for users still using JumpCloud Tags. If you are using JumpCloud Groups please refer to the documentation found [here](https://docs.jumpcloud.com/2.0/systems/manage-associations-of-a-system). ### Example #### Add (or remove) system to system user ``` curl \\ -d '{ \"add\": [\"[SYSTEM_ID_TO_ADD_HERE]\"], \"remove\": [\"[SYSTEM_ID_TO_REMOVE_HERE]\"] }' \\ -X PUT \\ -H 'Content-Type: application/json' \\ -H 'Accept: application/json' \\ -H \"x-api-key: [YOUR_API_KEY_HERE]\" \\ \"https://console.jumpcloud.com/api/systemusers/[SYSTEM_USER_ID_HERE]/systems\" ``` +Hidden as Tags is deprecated Adds or removes a system binding for a user. This endpoint is only used for users still using JumpCloud Tags. If you are using JumpCloud Groups please refer to the documentation found [here](https://docs.jumpcloud.com/2.0/systems/manage-associations-of-a-system). ### Example #### Add (or remove) system to system user ``` curl \\ -d '{ \"add\": [\"[SYSTEM_ID_TO_ADD_HERE]\"], \"remove\": [\"[SYSTEM_ID_TO_REMOVE_HERE]\"] }' \\ -X PUT \\ -H 'Content-Type: application/json' \\ -H 'Accept: application/json' \\ -H \"x-api-key: [YOUR_API_KEY_HERE]\" \\ \"https://console.jumpcloud.com/api/systemusers/[SYSTEM_USER_ID_HERE]/systems\" ``` ### Example ```ruby diff --git a/jcapiv1/lib/jcapiv1.rb b/jcapiv1/lib/jcapiv1.rb index a461b3b..7874907 100644 --- a/jcapiv1/lib/jcapiv1.rb +++ b/jcapiv1/lib/jcapiv1.rb @@ -27,6 +27,7 @@ require 'jcapiv1/models/application_config_idp_entity_id_tooltip_variables' require 'jcapiv1/models/applicationslist' require 'jcapiv1/models/body' +require 'jcapiv1/models/body_1' require 'jcapiv1/models/command' require 'jcapiv1/models/commandfilereturn' require 'jcapiv1/models/commandfilereturn_results' @@ -49,6 +50,7 @@ require 'jcapiv1/models/sshkeypost' require 'jcapiv1/models/system' require 'jcapiv1/models/system_network_interfaces' +require 'jcapiv1/models/system_sshd_params' require 'jcapiv1/models/systemput' require 'jcapiv1/models/systemput_agent_bound_messages' require 'jcapiv1/models/systemslist' diff --git a/jcapiv1/lib/jcapiv1/api/applications_api.rb b/jcapiv1/lib/jcapiv1/api/applications_api.rb index 9bd2e6d..d27aeda 100644 --- a/jcapiv1/lib/jcapiv1/api/applications_api.rb +++ b/jcapiv1/lib/jcapiv1/api/applications_api.rb @@ -21,7 +21,7 @@ def initialize(api_client = ApiClient.default) end # 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}' ``` + # 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}' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -37,7 +37,7 @@ def applications_list(content_type, accept, opts = {}) end # 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}' ``` + # 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}' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters diff --git a/jcapiv1/lib/jcapiv1/api/command_results_api.rb b/jcapiv1/lib/jcapiv1/api/command_results_api.rb index 5701074..3f579fa 100644 --- a/jcapiv1/lib/jcapiv1/api/command_results_api.rb +++ b/jcapiv1/lib/jcapiv1/api/command_results_api.rb @@ -21,7 +21,7 @@ def initialize(api_client = ApiClient.default) end # Delete a 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}' ```` + # 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}' ```` # @param id # @param content_type # @param accept @@ -34,7 +34,7 @@ def command_results_delete(id, content_type, accept, opts = {}) end # Delete a 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}' ```` + # 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}' ```` # @param id # @param content_type # @param accept @@ -93,7 +93,7 @@ def command_results_delete_with_http_info(id, content_type, accept, opts = {}) end # 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/{CommandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param id # @param content_type # @param accept @@ -107,7 +107,7 @@ def command_results_get(id, content_type, accept, opts = {}) end # 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/{CommandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param id # @param content_type # @param accept diff --git a/jcapiv1/lib/jcapiv1/api/commands_api.rb b/jcapiv1/lib/jcapiv1/api/commands_api.rb index 02b5d9a..3d6cbb7 100644 --- a/jcapiv1/lib/jcapiv1/api/commands_api.rb +++ b/jcapiv1/lib/jcapiv1/api/commands_api.rb @@ -21,7 +21,7 @@ def initialize(api_client = ApiClient.default) end # Get a Command File - # This endpoint returns the uploaded file(s) associated with a specific command. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/files/command/{commandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint returns the uploaded file(s) associated with a specific command. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/files/command/{commandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param id # @param content_type # @param accept @@ -37,7 +37,7 @@ def command_file_get(id, content_type, accept, opts = {}) end # Get a Command File - # This endpoint returns the uploaded file(s) associated with a specific command. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/files/command/{commandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint returns the uploaded file(s) associated with a specific command. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/files/command/{commandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param id # @param content_type # @param accept @@ -173,7 +173,7 @@ def commands_delete_with_http_info(id, content_type, accept, opts = {}) end # List an individual Command - # This endpoint returns a specific command based on the command ID. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/commands/{CommandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint returns a specific command based on the command ID. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/commands/{CommandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param id # @param content_type # @param accept @@ -187,7 +187,7 @@ def commands_get(id, content_type, accept, opts = {}) end # List an individual Command - # This endpoint returns a specific command based on the command ID. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/commands/{CommandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint returns a specific command based on the command ID. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/commands/{CommandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param id # @param content_type # @param accept diff --git a/jcapiv1/lib/jcapiv1/api/organizations_api.rb b/jcapiv1/lib/jcapiv1/api/organizations_api.rb index 6a0e739..b8777f7 100644 --- a/jcapiv1/lib/jcapiv1/api/organizations_api.rb +++ b/jcapiv1/lib/jcapiv1/api/organizations_api.rb @@ -21,7 +21,7 @@ def initialize(api_client = ApiClient.default) end # Get Organization Details - # This endpoint returns Organization Details. #### Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/organizations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint returns Organization Details. #### Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/organizations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -37,7 +37,7 @@ def organization_list(content_type, accept, opts = {}) end # Get Organization Details - # This endpoint returns Organization Details. #### Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/organizations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint returns Organization Details. #### Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/organizations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters diff --git a/jcapiv1/lib/jcapiv1/api/radius_servers_api.rb b/jcapiv1/lib/jcapiv1/api/radius_servers_api.rb index 9d327c7..40bfd37 100644 --- a/jcapiv1/lib/jcapiv1/api/radius_servers_api.rb +++ b/jcapiv1/lib/jcapiv1/api/radius_servers_api.rb @@ -167,7 +167,7 @@ def radius_servers_post_with_http_info(content_type, accept, opts = {}) end # Update Radius Servers - # This endpoint allows you to update RADIUS servers in your organization. #### ``` curl -X PUT https://console.jumpcloud.com/api/radiusservers/{ServerID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"name\": \"{name_update}\", \"networkSourceIp\": \"{0.0.0.0}\" }' ``` + # This endpoint allows you to update RADIUS servers in your organization. #### ``` curl -X PUT https://console.jumpcloud.com/api/radiusservers/{ServerID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"name\": \"{name_update}\", \"networkSourceIp\": \"{0.0.0.0}\" }' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -180,7 +180,7 @@ def radius_servers_put(content_type, accept, opts = {}) end # Update Radius Servers - # This endpoint allows you to update RADIUS servers in your organization. #### ``` curl -X PUT https://console.jumpcloud.com/api/radiusservers/{ServerID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"name\": \"{name_update}\", \"networkSourceIp\": \"{0.0.0.0}\" }' ``` + # This endpoint allows you to update RADIUS servers in your organization. #### ``` curl -X PUT https://console.jumpcloud.com/api/radiusservers/{ServerID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"name\": \"{name_update}\", \"networkSourceIp\": \"{0.0.0.0}\" }' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters diff --git a/jcapiv1/lib/jcapiv1/api/search_api.rb b/jcapiv1/lib/jcapiv1/api/search_api.rb index bc5d7cb..35e4558 100644 --- a/jcapiv1/lib/jcapiv1/api/search_api.rb +++ b/jcapiv1/lib/jcapiv1/api/search_api.rb @@ -21,7 +21,7 @@ def initialize(api_client = ApiClient.default) end # Search Organizations - # This endpoint will return Organization data based on your search parameters. This endpoint WILL NOT allow you to add a new Organization. You can use the supported parameters and pass those in the body of request. The parameters must be passed as Content-Type application/json. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/organizations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"search\":{ \"fields\" : [\"settings.name\"], \"searchTerm\": \"Second\" }, \"fields\": [\"_id\", \"displayName\", \"logoUrl\"], \"limit\" : 0, \"skip\" : 0 }' ``` + # This endpoint will return Organization data based on your search parameters. This endpoint WILL NOT allow you to add a new Organization. You can use the supported parameters and pass those in the body of request. The parameters must be passed as Content-Type application/json. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/organizations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"search\":{ \"fields\" : [\"settings.name\"], \"searchTerm\": \"Second\" }, \"fields\": [\"_id\", \"displayName\", \"logoUrl\"], \"limit\" : 0, \"skip\" : 0 }' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -36,7 +36,7 @@ def search_organizations_post(content_type, accept, opts = {}) end # Search Organizations - # This endpoint will return Organization data based on your search parameters. This endpoint WILL NOT allow you to add a new Organization. You can use the supported parameters and pass those in the body of request. The parameters must be passed as Content-Type application/json. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/organizations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"search\":{ \"fields\" : [\"settings.name\"], \"searchTerm\": \"Second\" }, \"fields\": [\"_id\", \"displayName\", \"logoUrl\"], \"limit\" : 0, \"skip\" : 0 }' ``` + # This endpoint will return Organization data based on your search parameters. This endpoint WILL NOT allow you to add a new Organization. You can use the supported parameters and pass those in the body of request. The parameters must be passed as Content-Type application/json. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/organizations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"search\":{ \"fields\" : [\"settings.name\"], \"searchTerm\": \"Second\" }, \"fields\": [\"_id\", \"displayName\", \"logoUrl\"], \"limit\" : 0, \"skip\" : 0 }' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -95,7 +95,7 @@ def search_organizations_post_with_http_info(content_type, accept, opts = {}) end # Search Systems - # Return Systems in multi-record format allowing for the passing of the 'filter' parameter. This WILL NOT allow you to add a new system. To support advanced filtering you can use the `filter` parameter that can only be passed in the body of POST /api/search/* routes. The `filter` parameter must be passed as Content-Type application/json supports advanced filtering using the MongoDB JSON query syntax. The `filter` parameter is an object with a single property, either and or or with the value of the property being an array of query expressions. This allows you to filter records using the logic of matching ALL or ANY records in the array of query expressions. If the and or or are not included the default behavior is to match ALL query expressions. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"filter\" : { \"or\" : [ {\"hostname\" : { \"$regex\" : \"^www\" }}, {\"hostname\" : {\"$regex\" : \"^db\"}} ] }, \"fields\" : \"os hostname displayName\" }' ``` + # Return Systems in multi-record format allowing for the passing of the 'filter' parameter. This WILL NOT allow you to add a new system. To support advanced filtering you can use the `filter` parameter that can only be passed in the body of POST /api/search/* routes. The `filter` parameter must be passed as Content-Type application/json. The `filter` parameter is an object with a single property, either `and` or `or` with the value of the property being an array of query expressions. This allows you to filter records using the logic of matching ALL or ANY records in the array of query expressions. If the `and` or `or` are not included the default behavior is to match ALL query expressions. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"filter\" : { \"or\" : [ {\"hostname\" : \"my-hostname\"}, {\"hostname\" : \"other-hostname\"} ] }, \"fields\" : \"os hostname displayName\" }' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -111,7 +111,7 @@ def search_systems_post(content_type, accept, opts = {}) end # Search Systems - # Return Systems in multi-record format allowing for the passing of the 'filter' parameter. This WILL NOT allow you to add a new system. To support advanced filtering you can use the `filter` parameter that can only be passed in the body of POST /api/search/* routes. The `filter` parameter must be passed as Content-Type application/json supports advanced filtering using the MongoDB JSON query syntax. The `filter` parameter is an object with a single property, either and or or with the value of the property being an array of query expressions. This allows you to filter records using the logic of matching ALL or ANY records in the array of query expressions. If the and or or are not included the default behavior is to match ALL query expressions. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"filter\" : { \"or\" : [ {\"hostname\" : { \"$regex\" : \"^www\" }}, {\"hostname\" : {\"$regex\" : \"^db\"}} ] }, \"fields\" : \"os hostname displayName\" }' ``` + # Return Systems in multi-record format allowing for the passing of the 'filter' parameter. This WILL NOT allow you to add a new system. To support advanced filtering you can use the `filter` parameter that can only be passed in the body of POST /api/search/* routes. The `filter` parameter must be passed as Content-Type application/json. The `filter` parameter is an object with a single property, either `and` or `or` with the value of the property being an array of query expressions. This allows you to filter records using the logic of matching ALL or ANY records in the array of query expressions. If the `and` or `or` are not included the default behavior is to match ALL query expressions. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"filter\" : { \"or\" : [ {\"hostname\" : \"my-hostname\"}, {\"hostname\" : \"other-hostname\"} ] }, \"fields\" : \"os hostname displayName\" }' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -172,7 +172,7 @@ def search_systems_post_with_http_info(content_type, accept, opts = {}) end # Search System Users - # Return System Users in multi-record format allowing for the passing of the 'filter' parameter. This WILL NOT allow you to add a new system user. To support advanced filtering you can use the `filter` parameter that can only be passed in the body of POST /api/search/* routes. The `filter` parameter must be passed as Content-Type application/json supports advanced filtering using the MongoDB JSON query syntax. The `filter` parameter is an object with a single property, either and or or with the value of the property being an array of query expressions. This allows you to filter records using the logic of matching ALL or ANY records in the array of query expressions. If the and or or are not included the default behavior is to match ALL query expressions. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/systemusers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"filter\" : [{\"email\" : { \"$regex\" : \"gmail.com$\"}}], \"fields\" : \"email username sudo\" }' ``` + # Return System Users in multi-record format allowing for the passing of the 'filter' parameter. This WILL NOT allow you to add a new system user. To support advanced filtering you can use the `filter` parameter that can only be passed in the body of POST /api/search/* routes. The `filter` parameter must be passed as Content-Type application/json. The `filter` parameter is an object with a single property, either `and` or `or` with the value of the property being an array of query expressions. This allows you to filter records using the logic of matching ALL or ANY records in the array of query expressions. If the `and` or `or` are not included the default behavior is to match ALL query expressions. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/systemusers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"filter\" : [{\"email\" : \"example@jumpcloud.com\"}], \"fields\" : \"email username sudo\" }' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -188,7 +188,7 @@ def search_systemusers_post(content_type, accept, opts = {}) end # Search System Users - # Return System Users in multi-record format allowing for the passing of the 'filter' parameter. This WILL NOT allow you to add a new system user. To support advanced filtering you can use the `filter` parameter that can only be passed in the body of POST /api/search/* routes. The `filter` parameter must be passed as Content-Type application/json supports advanced filtering using the MongoDB JSON query syntax. The `filter` parameter is an object with a single property, either and or or with the value of the property being an array of query expressions. This allows you to filter records using the logic of matching ALL or ANY records in the array of query expressions. If the and or or are not included the default behavior is to match ALL query expressions. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/systemusers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"filter\" : [{\"email\" : { \"$regex\" : \"gmail.com$\"}}], \"fields\" : \"email username sudo\" }' ``` + # Return System Users in multi-record format allowing for the passing of the 'filter' parameter. This WILL NOT allow you to add a new system user. To support advanced filtering you can use the `filter` parameter that can only be passed in the body of POST /api/search/* routes. The `filter` parameter must be passed as Content-Type application/json. The `filter` parameter is an object with a single property, either `and` or `or` with the value of the property being an array of query expressions. This allows you to filter records using the logic of matching ALL or ANY records in the array of query expressions. If the `and` or `or` are not included the default behavior is to match ALL query expressions. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/systemusers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"filter\" : [{\"email\" : \"example@jumpcloud.com\"}], \"fields\" : \"email username sudo\" }' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters diff --git a/jcapiv1/lib/jcapiv1/api/systems_api.rb b/jcapiv1/lib/jcapiv1/api/systems_api.rb index ad86e63..d6349da 100644 --- a/jcapiv1/lib/jcapiv1/api/systems_api.rb +++ b/jcapiv1/lib/jcapiv1/api/systems_api.rb @@ -99,7 +99,7 @@ def systems_delete_with_http_info(id, content_type, accept, opts = {}) end # List an individual system - # This endpoint returns an individual system. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/systems/{SystemID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint returns an individual system. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/systems/{SystemID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param id # @param content_type # @param accept @@ -115,7 +115,7 @@ def systems_get(id, content_type, accept, opts = {}) end # List an individual system - # This endpoint returns an individual system. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/systems/{SystemID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint returns an individual system. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/systems/{SystemID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param id # @param content_type # @param accept @@ -180,7 +180,7 @@ def systems_get_with_http_info(id, content_type, accept, opts = {}) end # List All Systems - # This endpoint returns all Systems. #### Sample Requests ``` curl -X GET https://console.jumpcloud.com/api/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint returns all Systems. #### Sample Requests ``` curl -X GET https://console.jumpcloud.com/api/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -196,7 +196,7 @@ def systems_list(content_type, accept, opts = {}) end # List All Systems - # This endpoint returns all Systems. #### Sample Requests ``` curl -X GET https://console.jumpcloud.com/api/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint returns all Systems. #### Sample Requests ``` curl -X GET https://console.jumpcloud.com/api/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters diff --git a/jcapiv1/lib/jcapiv1/api/systemusers_api.rb b/jcapiv1/lib/jcapiv1/api/systemusers_api.rb index 77a8316..16ab25a 100644 --- a/jcapiv1/lib/jcapiv1/api/systemusers_api.rb +++ b/jcapiv1/lib/jcapiv1/api/systemusers_api.rb @@ -238,7 +238,7 @@ def sshkey_post_with_http_info(id, content_type, accept, opts = {}) end # Delete a system user - # This endpoint allows you to delete a particular system user. #### Sample Request ``` curl -X DELETE https://console.jumpcloud.com/api/systemusers/{UserID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint allows you to delete a particular system user. #### Sample Request ``` curl -X DELETE https://console.jumpcloud.com/api/systemusers/{UserID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param id # @param content_type # @param accept @@ -251,7 +251,7 @@ def systemusers_delete(id, content_type, accept, opts = {}) end # Delete a system user - # This endpoint allows you to delete a particular system user. #### Sample Request ``` curl -X DELETE https://console.jumpcloud.com/api/systemusers/{UserID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint allows you to delete a particular system user. #### Sample Request ``` curl -X DELETE https://console.jumpcloud.com/api/systemusers/{UserID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param id # @param content_type # @param accept @@ -385,7 +385,7 @@ def systemusers_get_with_http_info(id, content_type, accept, opts = {}) end # List all system users - # This endpoint returns all systemusers. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/systemusers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint returns all systemusers. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/systemusers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -402,7 +402,7 @@ def systemusers_list(content_type, accept, opts = {}) end # List all system users - # This endpoint returns all systemusers. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/systemusers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint returns all systemusers. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/systemusers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -608,10 +608,11 @@ def systemusers_put_with_http_info(id, content_type, accept, opts = {}) end # Reset a system user's MFA token - # This endpoint allows you to reset the MFA TOTP token for a specified system user. This will result in a user being required to complete the setup of their MFA TOTP token via an email notification sent from Jumpcloud. Please be aware, that until MFA setup is complete, a user may be locked out of systems or applications. Please refer to our [Knowledge Base Article](https://support.jumpcloud.com/customer/en/portal/articles/2443975-how-to-enable-multifactor-authentication-for-the-jumpcloud-user-portal) on setting up MFA for more information. #### Sample Request ``` curl -X POST \\ https://console.jumpcloud.com/api/systemusers/{UserID}/resetmfa \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint allows you to reset the MFA TOTP token for a specified system user and put them in an MFA enrollment period. This will result in the user being prompted to setup MFA when logging into userportal. Please be aware that if the user does not complete MFA setup before the `exclusionUntil` date, they will be locked out of any resources that require MFA. Please refer to our [Knowledge Base Article](https://support.jumpcloud.com/customer/en/portal/articles/2959138-using-multifactor-authentication-with-jumpcloud) on setting up MFA for more information. #### Sample Request ``` curl -X POST \\ https://console.jumpcloud.com/api/systemusers/{UserID}/resetmfa \\ -H 'x-api-key: {API_KEY}' \\ -H 'Content-Type: application/json' \\ -d '{\"exclusion\": true, \"exclusionUntil\": \"{date-time}\"}' ``` # @param id # @param x_api_key # @param [Hash] opts the optional parameters + # @option opts [Body1] :body # @option opts [String] :x_org_id (default to ) # @return [String] def systemusers_resetmfa(id, x_api_key, opts = {}) @@ -620,10 +621,11 @@ def systemusers_resetmfa(id, x_api_key, opts = {}) end # Reset a system user's MFA token - # This endpoint allows you to reset the MFA TOTP token for a specified system user. This will result in a user being required to complete the setup of their MFA TOTP token via an email notification sent from Jumpcloud. Please be aware, that until MFA setup is complete, a user may be locked out of systems or applications. Please refer to our [Knowledge Base Article](https://support.jumpcloud.com/customer/en/portal/articles/2443975-how-to-enable-multifactor-authentication-for-the-jumpcloud-user-portal) on setting up MFA for more information. #### Sample Request ``` curl -X POST \\ https://console.jumpcloud.com/api/systemusers/{UserID}/resetmfa \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint allows you to reset the MFA TOTP token for a specified system user and put them in an MFA enrollment period. This will result in the user being prompted to setup MFA when logging into userportal. Please be aware that if the user does not complete MFA setup before the `exclusionUntil` date, they will be locked out of any resources that require MFA. Please refer to our [Knowledge Base Article](https://support.jumpcloud.com/customer/en/portal/articles/2959138-using-multifactor-authentication-with-jumpcloud) on setting up MFA for more information. #### Sample Request ``` curl -X POST \\ https://console.jumpcloud.com/api/systemusers/{UserID}/resetmfa \\ -H 'x-api-key: {API_KEY}' \\ -H 'Content-Type: application/json' \\ -d '{\"exclusion\": true, \"exclusionUntil\": \"{date-time}\"}' ``` # @param id # @param x_api_key # @param [Hash] opts the optional parameters + # @option opts [Body1] :body # @option opts [String] :x_org_id # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers def systemusers_resetmfa_with_http_info(id, x_api_key, opts = {}) @@ -657,7 +659,7 @@ def systemusers_resetmfa_with_http_info(id, x_api_key, opts = {}) form_params = {} # http body (model) - post_body = nil + post_body = @api_client.object_to_http_body(opts[:'body']) auth_names = ['x-api-key'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, @@ -673,7 +675,7 @@ def systemusers_resetmfa_with_http_info(id, x_api_key, opts = {}) end # List system user binding - # Hidden as Tags is deprecated Adds or removes a system binding for a user. This endpoint is only used for users still using JumpCloud Tags. If you are using JumpCloud Groups please refer to the documentation found [here](https://docs.jumpcloud.com/2.0/systems/manage-associations-of-a-system). List system bindings for a specific system user in a system and user binding format. ### Examples #### List system bindings for specific system user ``` curl \\ -H 'Content-Type: application/json' \\ -H \"x-api-key: [YOUR_API_KEY_HERE]\" \\ \"https://console.jumpcloud.com/api/systemusers/[SYSTEM_USER_ID_HERE]/systems\" ``` + # Hidden as Tags is deprecated Adds or removes a system binding for a user. This endpoint is only used for users still using JumpCloud Tags. If you are using JumpCloud Groups please refer to the documentation found [here](https://docs.jumpcloud.com/2.0/systems/manage-associations-of-a-system). List system bindings for a specific system user in a system and user binding format. ### Examples #### List system bindings for specific system user ``` curl \\ -H 'Content-Type: application/json' \\ -H \"x-api-key: [YOUR_API_KEY_HERE]\" \\ \"https://console.jumpcloud.com/api/systemusers/[SYSTEM_USER_ID_HERE]/systems\" ``` # @param id # @param content_type # @param accept @@ -690,7 +692,7 @@ def systemusers_systems_binding_list(id, content_type, accept, opts = {}) end # List system user binding - # Hidden as Tags is deprecated Adds or removes a system binding for a user. This endpoint is only used for users still using JumpCloud Tags. If you are using JumpCloud Groups please refer to the documentation found [here](https://docs.jumpcloud.com/2.0/systems/manage-associations-of-a-system). List system bindings for a specific system user in a system and user binding format. ### Examples #### List system bindings for specific system user ``` curl \\ -H 'Content-Type: application/json' \\ -H \"x-api-key: [YOUR_API_KEY_HERE]\" \\ \"https://console.jumpcloud.com/api/systemusers/[SYSTEM_USER_ID_HERE]/systems\" ``` + # Hidden as Tags is deprecated Adds or removes a system binding for a user. This endpoint is only used for users still using JumpCloud Tags. If you are using JumpCloud Groups please refer to the documentation found [here](https://docs.jumpcloud.com/2.0/systems/manage-associations-of-a-system). List system bindings for a specific system user in a system and user binding format. ### Examples #### List system bindings for specific system user ``` curl \\ -H 'Content-Type: application/json' \\ -H \"x-api-key: [YOUR_API_KEY_HERE]\" \\ \"https://console.jumpcloud.com/api/systemusers/[SYSTEM_USER_ID_HERE]/systems\" ``` # @param id # @param content_type # @param accept @@ -757,7 +759,7 @@ def systemusers_systems_binding_list_with_http_info(id, content_type, accept, op end # Update a system user binding - # Hidden as Tags is deprecated Adds or removes a system binding for a user. This endpoint is only used for users still using JumpCloud Tags. If you are using JumpCloud Groups please refer to the documentation found [here](https://docs.jumpcloud.com/2.0/systems/manage-associations-of-a-system). ### Example #### Add (or remove) system to system user ``` curl \\ -d '{ \"add\": [\"[SYSTEM_ID_TO_ADD_HERE]\"], \"remove\": [\"[SYSTEM_ID_TO_REMOVE_HERE]\"] }' \\ -X PUT \\ -H 'Content-Type: application/json' \\ -H 'Accept: application/json' \\ -H \"x-api-key: [YOUR_API_KEY_HERE]\" \\ \"https://console.jumpcloud.com/api/systemusers/[SYSTEM_USER_ID_HERE]/systems\" ``` + # Hidden as Tags is deprecated Adds or removes a system binding for a user. This endpoint is only used for users still using JumpCloud Tags. If you are using JumpCloud Groups please refer to the documentation found [here](https://docs.jumpcloud.com/2.0/systems/manage-associations-of-a-system). ### Example #### Add (or remove) system to system user ``` curl \\ -d '{ \"add\": [\"[SYSTEM_ID_TO_ADD_HERE]\"], \"remove\": [\"[SYSTEM_ID_TO_REMOVE_HERE]\"] }' \\ -X PUT \\ -H 'Content-Type: application/json' \\ -H 'Accept: application/json' \\ -H \"x-api-key: [YOUR_API_KEY_HERE]\" \\ \"https://console.jumpcloud.com/api/systemusers/[SYSTEM_USER_ID_HERE]/systems\" ``` # @param id # @param content_type # @param accept @@ -771,7 +773,7 @@ def systemusers_systems_binding_put(id, content_type, accept, opts = {}) end # Update a system user binding - # Hidden as Tags is deprecated Adds or removes a system binding for a user. This endpoint is only used for users still using JumpCloud Tags. If you are using JumpCloud Groups please refer to the documentation found [here](https://docs.jumpcloud.com/2.0/systems/manage-associations-of-a-system). ### Example #### Add (or remove) system to system user ``` curl \\ -d '{ \"add\": [\"[SYSTEM_ID_TO_ADD_HERE]\"], \"remove\": [\"[SYSTEM_ID_TO_REMOVE_HERE]\"] }' \\ -X PUT \\ -H 'Content-Type: application/json' \\ -H 'Accept: application/json' \\ -H \"x-api-key: [YOUR_API_KEY_HERE]\" \\ \"https://console.jumpcloud.com/api/systemusers/[SYSTEM_USER_ID_HERE]/systems\" ``` + # Hidden as Tags is deprecated Adds or removes a system binding for a user. This endpoint is only used for users still using JumpCloud Tags. If you are using JumpCloud Groups please refer to the documentation found [here](https://docs.jumpcloud.com/2.0/systems/manage-associations-of-a-system). ### Example #### Add (or remove) system to system user ``` curl \\ -d '{ \"add\": [\"[SYSTEM_ID_TO_ADD_HERE]\"], \"remove\": [\"[SYSTEM_ID_TO_REMOVE_HERE]\"] }' \\ -X PUT \\ -H 'Content-Type: application/json' \\ -H 'Accept: application/json' \\ -H \"x-api-key: [YOUR_API_KEY_HERE]\" \\ \"https://console.jumpcloud.com/api/systemusers/[SYSTEM_USER_ID_HERE]/systems\" ``` # @param id # @param content_type # @param accept diff --git a/jcapiv1/lib/jcapiv1/models/body_1.rb b/jcapiv1/lib/jcapiv1/models/body_1.rb new file mode 100644 index 0000000..e6e9173 --- /dev/null +++ b/jcapiv1/lib/jcapiv1/models/body_1.rb @@ -0,0 +1,197 @@ +=begin +#JumpCloud APIs + +# JumpCloud's V1 API. This set of endpoints allows JumpCloud customers to manage commands, systems, & system users. + +OpenAPI spec version: 1.0 + +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.3.1 + +=end + +require 'date' + +module JCAPIv1 + + class Body1 + attr_accessor :exclusion + + attr_accessor :exclusion_until + + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'exclusion' => :'exclusion', + :'exclusion_until' => :'exclusionUntil' + } + end + + # Attribute type mapping. + def self.swagger_types + { + :'exclusion' => :'BOOLEAN', + :'exclusion_until' => :'DateTime' + } + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + return unless attributes.is_a?(Hash) + + # convert string to symbol for hash key + attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} + + if attributes.has_key?(:'exclusion') + self.exclusion = attributes[:'exclusion'] + end + + if attributes.has_key?(:'exclusionUntil') + self.exclusion_until = attributes[:'exclusionUntil'] + end + + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + return invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + exclusion == o.exclusion && + exclusion_until == o.exclusion_until + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Fixnum] Hash code + def hash + [exclusion, exclusion_until].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.swagger_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :BOOLEAN + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + temp_model = JCAPIv1.const_get(type).new + temp_model.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + next if value.nil? + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map{ |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/jcapiv1/lib/jcapiv1/models/commandresult.rb b/jcapiv1/lib/jcapiv1/models/commandresult.rb index b71e170..70a9d34 100644 --- a/jcapiv1/lib/jcapiv1/models/commandresult.rb +++ b/jcapiv1/lib/jcapiv1/models/commandresult.rb @@ -88,8 +88,8 @@ def self.swagger_types :'user' => :'String', :'sudo' => :'BOOLEAN', :'files' => :'Array', - :'request_time' => :'Integer', - :'response_time' => :'Integer', + :'request_time' => :'String', + :'response_time' => :'String', :'response' => :'CommandresultResponse', :'_id' => :'String' } diff --git a/jcapiv1/lib/jcapiv1/models/fde.rb b/jcapiv1/lib/jcapiv1/models/fde.rb index ce8cd7f..af8d80d 100644 --- a/jcapiv1/lib/jcapiv1/models/fde.rb +++ b/jcapiv1/lib/jcapiv1/models/fde.rb @@ -17,18 +17,22 @@ module JCAPIv1 class Fde attr_accessor :key_present + attr_accessor :active + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { - :'key_present' => :'keyPresent' + :'key_present' => :'keyPresent', + :'active' => :'active' } end # Attribute type mapping. def self.swagger_types { - :'key_present' => :'BOOLEAN' + :'key_present' => :'BOOLEAN', + :'active' => :'BOOLEAN' } end @@ -44,6 +48,10 @@ def initialize(attributes = {}) self.key_present = attributes[:'keyPresent'] end + if attributes.has_key?(:'active') + self.active = attributes[:'active'] + end + end # Show invalid properties with the reasons. Usually used together with valid? @@ -64,7 +72,8 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && - key_present == o.key_present + key_present == o.key_present && + active == o.active end # @see the `==` method @@ -76,7 +85,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Fixnum] Hash code def hash - [key_present].hash + [key_present, active].hash end # Builds the object from hash diff --git a/jcapiv1/lib/jcapiv1/models/system.rb b/jcapiv1/lib/jcapiv1/models/system.rb index 9532ed2..ba58d39 100644 --- a/jcapiv1/lib/jcapiv1/models/system.rb +++ b/jcapiv1/lib/jcapiv1/models/system.rb @@ -65,6 +65,8 @@ class System attr_accessor :fde + attr_accessor :amazon_instance_id + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map @@ -93,7 +95,8 @@ def self.attribute_map :'ssh_root_enabled' => :'sshRootEnabled', :'tags' => :'tags', :'_id' => :'_id', - :'fde' => :'fde' + :'fde' => :'fde', + :'amazon_instance_id' => :'amazonInstanceID' } end @@ -113,7 +116,7 @@ def self.swagger_types :'template_name' => :'String', :'remote_ip' => :'String', :'active' => :'BOOLEAN', - :'sshd_params' => :'Array', + :'sshd_params' => :'Array', :'allow_ssh_password_authentication' => :'BOOLEAN', :'allow_ssh_root_login' => :'BOOLEAN', :'allow_multi_factor_authentication' => :'BOOLEAN', @@ -124,7 +127,8 @@ def self.swagger_types :'ssh_root_enabled' => :'BOOLEAN', :'tags' => :'Array', :'_id' => :'String', - :'fde' => :'Fde' + :'fde' => :'Fde', + :'amazon_instance_id' => :'String' } end @@ -244,6 +248,10 @@ def initialize(attributes = {}) self.fde = attributes[:'fde'] end + if attributes.has_key?(:'amazonInstanceID') + self.amazon_instance_id = attributes[:'amazonInstanceID'] + end + end # Show invalid properties with the reasons. Usually used together with valid? @@ -288,7 +296,8 @@ def ==(o) ssh_root_enabled == o.ssh_root_enabled && tags == o.tags && _id == o._id && - fde == o.fde + fde == o.fde && + amazon_instance_id == o.amazon_instance_id end # @see the `==` method @@ -300,7 +309,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Fixnum] Hash code def hash - [organization, created, last_contact, os, version, arch, network_interfaces, hostname, display_name, system_timezone, template_name, remote_ip, active, sshd_params, allow_ssh_password_authentication, allow_ssh_root_login, allow_multi_factor_authentication, allow_public_key_authentication, modify_sshd_config, agent_version, connection_history, ssh_root_enabled, tags, _id, fde].hash + [organization, created, last_contact, os, version, arch, network_interfaces, hostname, display_name, system_timezone, template_name, remote_ip, active, sshd_params, allow_ssh_password_authentication, allow_ssh_root_login, allow_multi_factor_authentication, allow_public_key_authentication, modify_sshd_config, agent_version, connection_history, ssh_root_enabled, tags, _id, fde, amazon_instance_id].hash end # Builds the object from hash diff --git a/jcapiv1/lib/jcapiv1/models/system_sshd_params.rb b/jcapiv1/lib/jcapiv1/models/system_sshd_params.rb new file mode 100644 index 0000000..698842a --- /dev/null +++ b/jcapiv1/lib/jcapiv1/models/system_sshd_params.rb @@ -0,0 +1,197 @@ +=begin +#JumpCloud APIs + +# JumpCloud's V1 API. This set of endpoints allows JumpCloud customers to manage commands, systems, & system users. + +OpenAPI spec version: 1.0 + +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.3.1 + +=end + +require 'date' + +module JCAPIv1 + + class SystemSshdParams + attr_accessor :name + + attr_accessor :value + + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'name' => :'name', + :'value' => :'value' + } + end + + # Attribute type mapping. + def self.swagger_types + { + :'name' => :'String', + :'value' => :'String' + } + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + return unless attributes.is_a?(Hash) + + # convert string to symbol for hash key + attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} + + if attributes.has_key?(:'name') + self.name = attributes[:'name'] + end + + if attributes.has_key?(:'value') + self.value = attributes[:'value'] + end + + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + return invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + name == o.name && + value == o.value + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Fixnum] Hash code + def hash + [name, value].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.swagger_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :BOOLEAN + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + temp_model = JCAPIv1.const_get(type).new + temp_model.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + next if value.nil? + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map{ |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/jcapiv1/lib/jcapiv1/models/systemuser.rb b/jcapiv1/lib/jcapiv1/models/systemuser.rb index 81dbc5a..4368add 100644 --- a/jcapiv1/lib/jcapiv1/models/systemuser.rb +++ b/jcapiv1/lib/jcapiv1/models/systemuser.rb @@ -369,12 +369,12 @@ def list_invalid_properties invalid_properties.push("invalid value for 'username', the character length must be smaller than or equal to 1024.") end - if !@unix_uid.nil? && @unix_uid < 0 - invalid_properties.push("invalid value for 'unix_uid', must be greater than or equal to 0.") + if !@unix_uid.nil? && @unix_uid < 1 + invalid_properties.push("invalid value for 'unix_uid', must be greater than or equal to 1.") end - if !@unix_guid.nil? && @unix_guid < 0 - invalid_properties.push("invalid value for 'unix_guid', must be greater than or equal to 0.") + if !@unix_guid.nil? && @unix_guid < 1 + invalid_properties.push("invalid value for 'unix_guid', must be greater than or equal to 1.") end if !@firstname.nil? && @firstname.to_s.length > 1024 @@ -437,8 +437,8 @@ def list_invalid_properties def valid? return false if !@email.nil? && @email.to_s.length > 1024 return false if !@username.nil? && @username.to_s.length > 1024 - return false if !@unix_uid.nil? && @unix_uid < 0 - return false if !@unix_guid.nil? && @unix_guid < 0 + return false if !@unix_uid.nil? && @unix_uid < 1 + return false if !@unix_guid.nil? && @unix_guid < 1 return false if !@firstname.nil? && @firstname.to_s.length > 1024 return false if !@lastname.nil? && @lastname.to_s.length > 1024 return false if !@associated_tag_count.nil? && @associated_tag_count < 0 @@ -481,8 +481,8 @@ def username=(username) # @param [Object] unix_uid Value to be assigned def unix_uid=(unix_uid) - if !unix_uid.nil? && unix_uid < 0 - fail ArgumentError, "invalid value for 'unix_uid', must be greater than or equal to 0." + if !unix_uid.nil? && unix_uid < 1 + fail ArgumentError, "invalid value for 'unix_uid', must be greater than or equal to 1." end @unix_uid = unix_uid @@ -492,8 +492,8 @@ def unix_uid=(unix_uid) # @param [Object] unix_guid Value to be assigned def unix_guid=(unix_guid) - if !unix_guid.nil? && unix_guid < 0 - fail ArgumentError, "invalid value for 'unix_guid', must be greater than or equal to 0." + if !unix_guid.nil? && unix_guid < 1 + fail ArgumentError, "invalid value for 'unix_guid', must be greater than or equal to 1." end @unix_guid = unix_guid diff --git a/jcapiv1/lib/jcapiv1/models/systemuserput.rb b/jcapiv1/lib/jcapiv1/models/systemuserput.rb index feec085..ce89c44 100644 --- a/jcapiv1/lib/jcapiv1/models/systemuserput.rb +++ b/jcapiv1/lib/jcapiv1/models/systemuserput.rb @@ -352,12 +352,12 @@ def list_invalid_properties invalid_properties.push("invalid value for 'username', the character length must be smaller than or equal to 1024.") end - if !@unix_uid.nil? && @unix_uid < 0 - invalid_properties.push("invalid value for 'unix_uid', must be greater than or equal to 0.") + if !@unix_uid.nil? && @unix_uid < 1 + invalid_properties.push("invalid value for 'unix_uid', must be greater than or equal to 1.") end - if !@unix_guid.nil? && @unix_guid < 0 - invalid_properties.push("invalid value for 'unix_guid', must be greater than or equal to 0.") + if !@unix_guid.nil? && @unix_guid < 1 + invalid_properties.push("invalid value for 'unix_guid', must be greater than or equal to 1.") end if !@firstname.nil? && @firstname.to_s.length > 1024 @@ -418,8 +418,8 @@ def valid? return false if @email.to_s.length > 1024 return false if @username.nil? return false if @username.to_s.length > 1024 - return false if !@unix_uid.nil? && @unix_uid < 0 - return false if !@unix_guid.nil? && @unix_guid < 0 + return false if !@unix_uid.nil? && @unix_uid < 1 + return false if !@unix_guid.nil? && @unix_guid < 1 return false if !@firstname.nil? && @firstname.to_s.length > 1024 return false if !@lastname.nil? && @lastname.to_s.length > 1024 return false if !@job_title.nil? && @job_title.to_s.length > 1024 @@ -467,8 +467,8 @@ def username=(username) # @param [Object] unix_uid Value to be assigned def unix_uid=(unix_uid) - if !unix_uid.nil? && unix_uid < 0 - fail ArgumentError, "invalid value for 'unix_uid', must be greater than or equal to 0." + if !unix_uid.nil? && unix_uid < 1 + fail ArgumentError, "invalid value for 'unix_uid', must be greater than or equal to 1." end @unix_uid = unix_uid @@ -478,8 +478,8 @@ def unix_uid=(unix_uid) # @param [Object] unix_guid Value to be assigned def unix_guid=(unix_guid) - if !unix_guid.nil? && unix_guid < 0 - fail ArgumentError, "invalid value for 'unix_guid', must be greater than or equal to 0." + if !unix_guid.nil? && unix_guid < 1 + fail ArgumentError, "invalid value for 'unix_guid', must be greater than or equal to 1." end @unix_guid = unix_guid diff --git a/jcapiv1/lib/jcapiv1/models/systemuserputpost.rb b/jcapiv1/lib/jcapiv1/models/systemuserputpost.rb index 6a23d53..1a4bb17 100644 --- a/jcapiv1/lib/jcapiv1/models/systemuserputpost.rb +++ b/jcapiv1/lib/jcapiv1/models/systemuserputpost.rb @@ -353,12 +353,12 @@ def list_invalid_properties invalid_properties.push("invalid value for 'username', username cannot be nil.") end - if !@unix_uid.nil? && @unix_uid < 0 - invalid_properties.push("invalid value for 'unix_uid', must be greater than or equal to 0.") + if !@unix_uid.nil? && @unix_uid < 1 + invalid_properties.push("invalid value for 'unix_uid', must be greater than or equal to 1.") end - if !@unix_guid.nil? && @unix_guid < 0 - invalid_properties.push("invalid value for 'unix_guid', must be greater than or equal to 0.") + if !@unix_guid.nil? && @unix_guid < 1 + invalid_properties.push("invalid value for 'unix_guid', must be greater than or equal to 1.") end if !@description.nil? && @description.to_s.length > 1024 @@ -378,8 +378,8 @@ def valid? return false if @email.nil? return false if @email.to_s.length > 1024 return false if @username.nil? - return false if !@unix_uid.nil? && @unix_uid < 0 - return false if !@unix_guid.nil? && @unix_guid < 0 + return false if !@unix_uid.nil? && @unix_uid < 1 + return false if !@unix_guid.nil? && @unix_guid < 1 return false if !@description.nil? && @description.to_s.length > 1024 return false if !@employee_identifier.nil? && @employee_identifier.to_s.length > 256 return true @@ -403,8 +403,8 @@ def email=(email) # @param [Object] unix_uid Value to be assigned def unix_uid=(unix_uid) - if !unix_uid.nil? && unix_uid < 0 - fail ArgumentError, "invalid value for 'unix_uid', must be greater than or equal to 0." + if !unix_uid.nil? && unix_uid < 1 + fail ArgumentError, "invalid value for 'unix_uid', must be greater than or equal to 1." end @unix_uid = unix_uid @@ -414,8 +414,8 @@ def unix_uid=(unix_uid) # @param [Object] unix_guid Value to be assigned def unix_guid=(unix_guid) - if !unix_guid.nil? && unix_guid < 0 - fail ArgumentError, "invalid value for 'unix_guid', must be greater than or equal to 0." + if !unix_guid.nil? && unix_guid < 1 + fail ArgumentError, "invalid value for 'unix_guid', must be greater than or equal to 1." end @unix_guid = unix_guid diff --git a/jcapiv1/lib/jcapiv1/models/systemuserreturn.rb b/jcapiv1/lib/jcapiv1/models/systemuserreturn.rb index 0b50a9f..8af5dd7 100644 --- a/jcapiv1/lib/jcapiv1/models/systemuserreturn.rb +++ b/jcapiv1/lib/jcapiv1/models/systemuserreturn.rb @@ -399,12 +399,12 @@ def list_invalid_properties invalid_properties.push("invalid value for 'username', the character length must be smaller than or equal to 1024.") end - if !@unix_uid.nil? && @unix_uid < 0 - invalid_properties.push("invalid value for 'unix_uid', must be greater than or equal to 0.") + if !@unix_uid.nil? && @unix_uid < 1 + invalid_properties.push("invalid value for 'unix_uid', must be greater than or equal to 1.") end - if !@unix_guid.nil? && @unix_guid < 0 - invalid_properties.push("invalid value for 'unix_guid', must be greater than or equal to 0.") + if !@unix_guid.nil? && @unix_guid < 1 + invalid_properties.push("invalid value for 'unix_guid', must be greater than or equal to 1.") end if !@firstname.nil? && @firstname.to_s.length > 1024 @@ -467,8 +467,8 @@ def list_invalid_properties def valid? return false if !@email.nil? && @email.to_s.length > 1024 return false if !@username.nil? && @username.to_s.length > 1024 - return false if !@unix_uid.nil? && @unix_uid < 0 - return false if !@unix_guid.nil? && @unix_guid < 0 + return false if !@unix_uid.nil? && @unix_uid < 1 + return false if !@unix_guid.nil? && @unix_guid < 1 return false if !@firstname.nil? && @firstname.to_s.length > 1024 return false if !@lastname.nil? && @lastname.to_s.length > 1024 return false if !@job_title.nil? && @job_title.to_s.length > 1024 @@ -511,8 +511,8 @@ def username=(username) # @param [Object] unix_uid Value to be assigned def unix_uid=(unix_uid) - if !unix_uid.nil? && unix_uid < 0 - fail ArgumentError, "invalid value for 'unix_uid', must be greater than or equal to 0." + if !unix_uid.nil? && unix_uid < 1 + fail ArgumentError, "invalid value for 'unix_uid', must be greater than or equal to 1." end @unix_uid = unix_uid @@ -522,8 +522,8 @@ def unix_uid=(unix_uid) # @param [Object] unix_guid Value to be assigned def unix_guid=(unix_guid) - if !unix_guid.nil? && unix_guid < 0 - fail ArgumentError, "invalid value for 'unix_guid', must be greater than or equal to 0." + if !unix_guid.nil? && unix_guid < 1 + fail ArgumentError, "invalid value for 'unix_guid', must be greater than or equal to 1." end @unix_guid = unix_guid diff --git a/jcapiv1/lib/jcapiv1/version.rb b/jcapiv1/lib/jcapiv1/version.rb index ce00538..5aa60d5 100644 --- a/jcapiv1/lib/jcapiv1/version.rb +++ b/jcapiv1/lib/jcapiv1/version.rb @@ -11,5 +11,5 @@ =end module JCAPIv1 - VERSION = "1.2.0" + VERSION = "1.3.0" end diff --git a/jcapiv1/spec/api/applications_api_spec.rb b/jcapiv1/spec/api/applications_api_spec.rb index 87fd0b4..edd1308 100644 --- a/jcapiv1/spec/api/applications_api_spec.rb +++ b/jcapiv1/spec/api/applications_api_spec.rb @@ -34,7 +34,7 @@ # unit tests for applications_list # 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}' ``` + # 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}' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters diff --git a/jcapiv1/spec/api/command_results_api_spec.rb b/jcapiv1/spec/api/command_results_api_spec.rb index 730705a..2129997 100644 --- a/jcapiv1/spec/api/command_results_api_spec.rb +++ b/jcapiv1/spec/api/command_results_api_spec.rb @@ -34,7 +34,7 @@ # unit tests for command_results_delete # Delete a 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}' ```` + # 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}' ```` # @param id # @param content_type # @param accept @@ -49,7 +49,7 @@ # unit tests for command_results_get # 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/{CommandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param id # @param content_type # @param accept diff --git a/jcapiv1/spec/api/commands_api_spec.rb b/jcapiv1/spec/api/commands_api_spec.rb index eaacee5..9e6e549 100644 --- a/jcapiv1/spec/api/commands_api_spec.rb +++ b/jcapiv1/spec/api/commands_api_spec.rb @@ -34,7 +34,7 @@ # unit tests for command_file_get # Get a Command File - # This endpoint returns the uploaded file(s) associated with a specific command. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/files/command/{commandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint returns the uploaded file(s) associated with a specific command. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/files/command/{commandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param id # @param content_type # @param accept @@ -67,7 +67,7 @@ # unit tests for commands_get # List an individual Command - # This endpoint returns a specific command based on the command ID. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/commands/{CommandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint returns a specific command based on the command ID. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/commands/{CommandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param id # @param content_type # @param accept diff --git a/jcapiv1/spec/api/organizations_api_spec.rb b/jcapiv1/spec/api/organizations_api_spec.rb index 888e014..4f0be1b 100644 --- a/jcapiv1/spec/api/organizations_api_spec.rb +++ b/jcapiv1/spec/api/organizations_api_spec.rb @@ -34,7 +34,7 @@ # unit tests for organization_list # Get Organization Details - # This endpoint returns Organization Details. #### Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/organizations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint returns Organization Details. #### Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/organizations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters diff --git a/jcapiv1/spec/api/radius_servers_api_spec.rb b/jcapiv1/spec/api/radius_servers_api_spec.rb index e298489..27092a8 100644 --- a/jcapiv1/spec/api/radius_servers_api_spec.rb +++ b/jcapiv1/spec/api/radius_servers_api_spec.rb @@ -67,7 +67,7 @@ # unit tests for radius_servers_put # Update Radius Servers - # This endpoint allows you to update RADIUS servers in your organization. #### ``` curl -X PUT https://console.jumpcloud.com/api/radiusservers/{ServerID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"name\": \"{name_update}\", \"networkSourceIp\": \"{0.0.0.0}\" }' ``` + # This endpoint allows you to update RADIUS servers in your organization. #### ``` curl -X PUT https://console.jumpcloud.com/api/radiusservers/{ServerID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"name\": \"{name_update}\", \"networkSourceIp\": \"{0.0.0.0}\" }' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters diff --git a/jcapiv1/spec/api/search_api_spec.rb b/jcapiv1/spec/api/search_api_spec.rb index e19f95e..3250e22 100644 --- a/jcapiv1/spec/api/search_api_spec.rb +++ b/jcapiv1/spec/api/search_api_spec.rb @@ -34,7 +34,7 @@ # unit tests for search_organizations_post # Search Organizations - # This endpoint will return Organization data based on your search parameters. This endpoint WILL NOT allow you to add a new Organization. You can use the supported parameters and pass those in the body of request. The parameters must be passed as Content-Type application/json. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/organizations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"search\":{ \"fields\" : [\"settings.name\"], \"searchTerm\": \"Second\" }, \"fields\": [\"_id\", \"displayName\", \"logoUrl\"], \"limit\" : 0, \"skip\" : 0 }' ``` + # This endpoint will return Organization data based on your search parameters. This endpoint WILL NOT allow you to add a new Organization. You can use the supported parameters and pass those in the body of request. The parameters must be passed as Content-Type application/json. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/organizations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"search\":{ \"fields\" : [\"settings.name\"], \"searchTerm\": \"Second\" }, \"fields\": [\"_id\", \"displayName\", \"logoUrl\"], \"limit\" : 0, \"skip\" : 0 }' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -51,7 +51,7 @@ # unit tests for search_systems_post # Search Systems - # Return Systems in multi-record format allowing for the passing of the 'filter' parameter. This WILL NOT allow you to add a new system. To support advanced filtering you can use the `filter` parameter that can only be passed in the body of POST /api/search/* routes. The `filter` parameter must be passed as Content-Type application/json supports advanced filtering using the MongoDB JSON query syntax. The `filter` parameter is an object with a single property, either and or or with the value of the property being an array of query expressions. This allows you to filter records using the logic of matching ALL or ANY records in the array of query expressions. If the and or or are not included the default behavior is to match ALL query expressions. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"filter\" : { \"or\" : [ {\"hostname\" : { \"$regex\" : \"^www\" }}, {\"hostname\" : {\"$regex\" : \"^db\"}} ] }, \"fields\" : \"os hostname displayName\" }' ``` + # Return Systems in multi-record format allowing for the passing of the 'filter' parameter. This WILL NOT allow you to add a new system. To support advanced filtering you can use the `filter` parameter that can only be passed in the body of POST /api/search/* routes. The `filter` parameter must be passed as Content-Type application/json. The `filter` parameter is an object with a single property, either `and` or `or` with the value of the property being an array of query expressions. This allows you to filter records using the logic of matching ALL or ANY records in the array of query expressions. If the `and` or `or` are not included the default behavior is to match ALL query expressions. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"filter\" : { \"or\" : [ {\"hostname\" : \"my-hostname\"}, {\"hostname\" : \"other-hostname\"} ] }, \"fields\" : \"os hostname displayName\" }' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -69,7 +69,7 @@ # unit tests for search_systemusers_post # Search System Users - # Return System Users in multi-record format allowing for the passing of the 'filter' parameter. This WILL NOT allow you to add a new system user. To support advanced filtering you can use the `filter` parameter that can only be passed in the body of POST /api/search/* routes. The `filter` parameter must be passed as Content-Type application/json supports advanced filtering using the MongoDB JSON query syntax. The `filter` parameter is an object with a single property, either and or or with the value of the property being an array of query expressions. This allows you to filter records using the logic of matching ALL or ANY records in the array of query expressions. If the and or or are not included the default behavior is to match ALL query expressions. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/systemusers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"filter\" : [{\"email\" : { \"$regex\" : \"gmail.com$\"}}], \"fields\" : \"email username sudo\" }' ``` + # Return System Users in multi-record format allowing for the passing of the 'filter' parameter. This WILL NOT allow you to add a new system user. To support advanced filtering you can use the `filter` parameter that can only be passed in the body of POST /api/search/* routes. The `filter` parameter must be passed as Content-Type application/json. The `filter` parameter is an object with a single property, either `and` or `or` with the value of the property being an array of query expressions. This allows you to filter records using the logic of matching ALL or ANY records in the array of query expressions. If the `and` or `or` are not included the default behavior is to match ALL query expressions. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/search/systemusers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"filter\" : [{\"email\" : \"example@jumpcloud.com\"}], \"fields\" : \"email username sudo\" }' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters diff --git a/jcapiv1/spec/api/systems_api_spec.rb b/jcapiv1/spec/api/systems_api_spec.rb index 8553f5a..183be68 100644 --- a/jcapiv1/spec/api/systems_api_spec.rb +++ b/jcapiv1/spec/api/systems_api_spec.rb @@ -51,7 +51,7 @@ # unit tests for systems_get # List an individual system - # This endpoint returns an individual system. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/systems/{SystemID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint returns an individual system. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/systems/{SystemID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param id # @param content_type # @param accept @@ -69,7 +69,7 @@ # unit tests for systems_list # List All Systems - # This endpoint returns all Systems. #### Sample Requests ``` curl -X GET https://console.jumpcloud.com/api/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint returns all Systems. #### Sample Requests ``` curl -X GET https://console.jumpcloud.com/api/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters diff --git a/jcapiv1/spec/api/systemusers_api_spec.rb b/jcapiv1/spec/api/systemusers_api_spec.rb index 9f7c4f7..e57e5ed 100644 --- a/jcapiv1/spec/api/systemusers_api_spec.rb +++ b/jcapiv1/spec/api/systemusers_api_spec.rb @@ -80,7 +80,7 @@ # unit tests for systemusers_delete # Delete a system user - # This endpoint allows you to delete a particular system user. #### Sample Request ``` curl -X DELETE https://console.jumpcloud.com/api/systemusers/{UserID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint allows you to delete a particular system user. #### Sample Request ``` curl -X DELETE https://console.jumpcloud.com/api/systemusers/{UserID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param id # @param content_type # @param accept @@ -111,7 +111,7 @@ # unit tests for systemusers_list # List all system users - # This endpoint returns all systemusers. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/systemusers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint returns all systemusers. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/systemusers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -161,10 +161,11 @@ # unit tests for systemusers_resetmfa # Reset a system user's MFA token - # This endpoint allows you to reset the MFA TOTP token for a specified system user. This will result in a user being required to complete the setup of their MFA TOTP token via an email notification sent from Jumpcloud. Please be aware, that until MFA setup is complete, a user may be locked out of systems or applications. Please refer to our [Knowledge Base Article](https://support.jumpcloud.com/customer/en/portal/articles/2443975-how-to-enable-multifactor-authentication-for-the-jumpcloud-user-portal) on setting up MFA for more information. #### Sample Request ``` curl -X POST \\ https://console.jumpcloud.com/api/systemusers/{UserID}/resetmfa \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint allows you to reset the MFA TOTP token for a specified system user and put them in an MFA enrollment period. This will result in the user being prompted to setup MFA when logging into userportal. Please be aware that if the user does not complete MFA setup before the `exclusionUntil` date, they will be locked out of any resources that require MFA. Please refer to our [Knowledge Base Article](https://support.jumpcloud.com/customer/en/portal/articles/2959138-using-multifactor-authentication-with-jumpcloud) on setting up MFA for more information. #### Sample Request ``` curl -X POST \\ https://console.jumpcloud.com/api/systemusers/{UserID}/resetmfa \\ -H 'x-api-key: {API_KEY}' \\ -H 'Content-Type: application/json' \\ -d '{\"exclusion\": true, \"exclusionUntil\": \"{date-time}\"}' ``` # @param id # @param x_api_key # @param [Hash] opts the optional parameters + # @option opts [Body1] :body # @option opts [String] :x_org_id # @return [String] describe 'systemusers_resetmfa test' do @@ -175,7 +176,7 @@ # unit tests for systemusers_systems_binding_list # List system user binding - # Hidden as Tags is deprecated Adds or removes a system binding for a user. This endpoint is only used for users still using JumpCloud Tags. If you are using JumpCloud Groups please refer to the documentation found [here](https://docs.jumpcloud.com/2.0/systems/manage-associations-of-a-system). List system bindings for a specific system user in a system and user binding format. ### Examples #### List system bindings for specific system user ``` curl \\ -H 'Content-Type: application/json' \\ -H \"x-api-key: [YOUR_API_KEY_HERE]\" \\ \"https://console.jumpcloud.com/api/systemusers/[SYSTEM_USER_ID_HERE]/systems\" ``` + # Hidden as Tags is deprecated Adds or removes a system binding for a user. This endpoint is only used for users still using JumpCloud Tags. If you are using JumpCloud Groups please refer to the documentation found [here](https://docs.jumpcloud.com/2.0/systems/manage-associations-of-a-system). List system bindings for a specific system user in a system and user binding format. ### Examples #### List system bindings for specific system user ``` curl \\ -H 'Content-Type: application/json' \\ -H \"x-api-key: [YOUR_API_KEY_HERE]\" \\ \"https://console.jumpcloud.com/api/systemusers/[SYSTEM_USER_ID_HERE]/systems\" ``` # @param id # @param content_type # @param accept @@ -194,7 +195,7 @@ # unit tests for systemusers_systems_binding_put # Update a system user binding - # Hidden as Tags is deprecated Adds or removes a system binding for a user. This endpoint is only used for users still using JumpCloud Tags. If you are using JumpCloud Groups please refer to the documentation found [here](https://docs.jumpcloud.com/2.0/systems/manage-associations-of-a-system). ### Example #### Add (or remove) system to system user ``` curl \\ -d '{ \"add\": [\"[SYSTEM_ID_TO_ADD_HERE]\"], \"remove\": [\"[SYSTEM_ID_TO_REMOVE_HERE]\"] }' \\ -X PUT \\ -H 'Content-Type: application/json' \\ -H 'Accept: application/json' \\ -H \"x-api-key: [YOUR_API_KEY_HERE]\" \\ \"https://console.jumpcloud.com/api/systemusers/[SYSTEM_USER_ID_HERE]/systems\" ``` + # Hidden as Tags is deprecated Adds or removes a system binding for a user. This endpoint is only used for users still using JumpCloud Tags. If you are using JumpCloud Groups please refer to the documentation found [here](https://docs.jumpcloud.com/2.0/systems/manage-associations-of-a-system). ### Example #### Add (or remove) system to system user ``` curl \\ -d '{ \"add\": [\"[SYSTEM_ID_TO_ADD_HERE]\"], \"remove\": [\"[SYSTEM_ID_TO_REMOVE_HERE]\"] }' \\ -X PUT \\ -H 'Content-Type: application/json' \\ -H 'Accept: application/json' \\ -H \"x-api-key: [YOUR_API_KEY_HERE]\" \\ \"https://console.jumpcloud.com/api/systemusers/[SYSTEM_USER_ID_HERE]/systems\" ``` # @param id # @param content_type # @param accept diff --git a/jcapiv1/spec/models/body_1_spec.rb b/jcapiv1/spec/models/body_1_spec.rb new file mode 100644 index 0000000..7cf1e67 --- /dev/null +++ b/jcapiv1/spec/models/body_1_spec.rb @@ -0,0 +1,48 @@ +=begin +#JumpCloud APIs + +# JumpCloud's V1 API. This set of endpoints allows JumpCloud customers to manage commands, systems, & system users. + +OpenAPI spec version: 1.0 + +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.3.1 + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for JCAPIv1::Body1 +# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) +# Please update as you see appropriate +describe 'Body1' do + before do + # run before each test + @instance = JCAPIv1::Body1.new + end + + after do + # run after each test + end + + describe 'test an instance of Body1' do + it 'should create an instance of Body1' do + expect(@instance).to be_instance_of(JCAPIv1::Body1) + end + end + describe 'test attribute "exclusion"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "exclusion_until"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end + diff --git a/jcapiv1/spec/models/fde_spec.rb b/jcapiv1/spec/models/fde_spec.rb index f857698..f29b5ce 100644 --- a/jcapiv1/spec/models/fde_spec.rb +++ b/jcapiv1/spec/models/fde_spec.rb @@ -38,5 +38,11 @@ end end + describe 'test attribute "active"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + end diff --git a/jcapiv1/spec/models/system_spec.rb b/jcapiv1/spec/models/system_spec.rb index 3b6ef62..3243881 100644 --- a/jcapiv1/spec/models/system_spec.rb +++ b/jcapiv1/spec/models/system_spec.rb @@ -182,5 +182,11 @@ end end + describe 'test attribute "amazon_instance_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + end diff --git a/jcapiv1/spec/models/system_sshd_params_spec.rb b/jcapiv1/spec/models/system_sshd_params_spec.rb new file mode 100644 index 0000000..05fc918 --- /dev/null +++ b/jcapiv1/spec/models/system_sshd_params_spec.rb @@ -0,0 +1,48 @@ +=begin +#JumpCloud APIs + +# JumpCloud's V1 API. This set of endpoints allows JumpCloud customers to manage commands, systems, & system users. + +OpenAPI spec version: 1.0 + +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.3.1 + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for JCAPIv1::SystemSshdParams +# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) +# Please update as you see appropriate +describe 'SystemSshdParams' do + before do + # run before each test + @instance = JCAPIv1::SystemSshdParams.new + end + + after do + # run after each test + end + + describe 'test an instance of SystemSshdParams' do + it 'should create an instance of SystemSshdParams' do + expect(@instance).to be_instance_of(JCAPIv1::SystemSshdParams) + end + end + describe 'test attribute "name"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "value"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end + diff --git a/jcapiv2/README.md b/jcapiv2/README.md index c1ad0b7..f0cbcc2 100644 --- a/jcapiv2/README.md +++ b/jcapiv2/README.md @@ -7,7 +7,7 @@ JCAPIv2 - 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: 2.0 -- Package version: 1.2.0 +- Package version: 1.3.0 - Build package: io.swagger.codegen.languages.RubyClientCodegen ## Installation @@ -23,15 +23,15 @@ gem build jcapiv2.gemspec Then either install the gem locally: ```shell -gem install ./jcapiv2-1.2.0.gem +gem install ./jcapiv2-1.3.0.gem ``` -(for development, run `gem install --dev ./jcapiv2-1.2.0.gem` to install the development dependencies) +(for development, run `gem install --dev ./jcapiv2-1.3.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 'jcapiv2', '~> 1.2.0' + gem 'jcapiv2', '~> 1.3.0' ### Install from Git @@ -101,7 +101,8 @@ Class | Method | HTTP request | Description *JCAPIv2::ApplicationsApi* | [**graph_application_traverse_user**](docs/ApplicationsApi.md#graph_application_traverse_user) | **GET** /applications/{application_id}/users | List the Users bound to an Application *JCAPIv2::ApplicationsApi* | [**graph_application_traverse_user_group**](docs/ApplicationsApi.md#graph_application_traverse_user_group) | **GET** /applications/{application_id}/usergroups | List the User Groups bound to an Application *JCAPIv2::BulkJobRequestsApi* | [**bulk_users_create**](docs/BulkJobRequestsApi.md#bulk_users_create) | **POST** /bulk/users | Bulk Users Create -*JCAPIv2::BulkJobRequestsApi* | [**bulk_users_create_results**](docs/BulkJobRequestsApi.md#bulk_users_create_results) | **GET** /bulk/users/{job_id}/results | List Bulk Users Create Results +*JCAPIv2::BulkJobRequestsApi* | [**bulk_users_create_results**](docs/BulkJobRequestsApi.md#bulk_users_create_results) | **GET** /bulk/users/{job_id}/results | List Bulk Users Results +*JCAPIv2::BulkJobRequestsApi* | [**bulk_users_update**](docs/BulkJobRequestsApi.md#bulk_users_update) | **PATCH** /bulk/users | Bulk Users Update *JCAPIv2::BulkJobRequestsApi* | [**jobs_get**](docs/BulkJobRequestsApi.md#jobs_get) | **GET** /jobs/{id} | Get Job (incomplete) *JCAPIv2::BulkJobRequestsApi* | [**jobs_results**](docs/BulkJobRequestsApi.md#jobs_results) | **GET** /jobs/{id}/results | List Job Results *JCAPIv2::CommandsApi* | [**graph_command_associations_list**](docs/CommandsApi.md#graph_command_associations_list) | **GET** /commands/{command_id}/associations | List the associations of a Command @@ -114,6 +115,10 @@ Class | Method | HTTP request | Description *JCAPIv2::GSuiteApi* | [**graph_g_suite_associations_post**](docs/GSuiteApi.md#graph_g_suite_associations_post) | **POST** /gsuites/{gsuite_id}/associations | Manage the associations of a G Suite instance *JCAPIv2::GSuiteApi* | [**graph_g_suite_traverse_user**](docs/GSuiteApi.md#graph_g_suite_traverse_user) | **GET** /gsuites/{gsuite_id}/users | List the Users bound to a G Suite instance *JCAPIv2::GSuiteApi* | [**graph_g_suite_traverse_user_group**](docs/GSuiteApi.md#graph_g_suite_traverse_user_group) | **GET** /gsuites/{gsuite_id}/usergroups | List the User Groups bound to a G Suite instance +*JCAPIv2::GSuiteApi* | [**translation_rules_g_suite_delete**](docs/GSuiteApi.md#translation_rules_g_suite_delete) | **DELETE** /gsuites/{gsuite_id}/translationrules/{id} | Deletes a G Suite translation rule +*JCAPIv2::GSuiteApi* | [**translation_rules_g_suite_get**](docs/GSuiteApi.md#translation_rules_g_suite_get) | **GET** /gsuites/{gsuite_id}/translationrules/{id} | Gets a specific g suite translation rule +*JCAPIv2::GSuiteApi* | [**translation_rules_g_suite_list**](docs/GSuiteApi.md#translation_rules_g_suite_list) | **GET** /gsuites/{gsuite_id}/translationrules | List all the G Suite Translation Rules +*JCAPIv2::GSuiteApi* | [**translation_rules_g_suite_post**](docs/GSuiteApi.md#translation_rules_g_suite_post) | **POST** /gsuites/{gsuite_id}/translationrules | Create a new G Suite Translation Rule *JCAPIv2::GraphApi* | [**graph_active_directory_associations_list**](docs/GraphApi.md#graph_active_directory_associations_list) | **GET** /activedirectories/{activedirectory_id}/associations | List the associations of an Active Directory instance *JCAPIv2::GraphApi* | [**graph_active_directory_associations_post**](docs/GraphApi.md#graph_active_directory_associations_post) | **POST** /activedirectories/{activedirectory_id}/associations | Manage the associations of an Active Directory instance *JCAPIv2::GraphApi* | [**graph_active_directory_traverse_user_group**](docs/GraphApi.md#graph_active_directory_traverse_user_group) | **GET** /activedirectories/{activedirectory_id}/usergroups | List the User Groups bound to an Active Directory instance @@ -200,6 +205,10 @@ Class | Method | HTTP request | Description *JCAPIv2::Office365Api* | [**graph_office365_associations_post**](docs/Office365Api.md#graph_office365_associations_post) | **POST** /office365s/{office365_id}/associations | Manage the associations of an Office 365 instance *JCAPIv2::Office365Api* | [**graph_office365_traverse_user**](docs/Office365Api.md#graph_office365_traverse_user) | **GET** /office365s/{office365_id}/users | List the Users bound to an Office 365 instance *JCAPIv2::Office365Api* | [**graph_office365_traverse_user_group**](docs/Office365Api.md#graph_office365_traverse_user_group) | **GET** /office365s/{office365_id}/usergroups | List the User Groups bound to an Office 365 instance +*JCAPIv2::Office365Api* | [**translation_rules_office365_delete**](docs/Office365Api.md#translation_rules_office365_delete) | **DELETE** /office365s/{office365_id}/translationrules/{id} | Deletes a Office 365 translation rule +*JCAPIv2::Office365Api* | [**translation_rules_office365_get**](docs/Office365Api.md#translation_rules_office365_get) | **GET** /office365s/{office365_id}/translationrules/{id} | Gets a specific Office 365 translation rule +*JCAPIv2::Office365Api* | [**translation_rules_office365_list**](docs/Office365Api.md#translation_rules_office365_list) | **GET** /office365s/{office365_id}/translationrules | List all the Office 365 Translation Rules +*JCAPIv2::Office365Api* | [**translation_rules_office365_post**](docs/Office365Api.md#translation_rules_office365_post) | **POST** /office365s/{office365_id}/translationrules | Create a new Office 365 Translation Rule *JCAPIv2::PoliciesApi* | [**graph_policy_associations_list**](docs/PoliciesApi.md#graph_policy_associations_list) | **GET** /policies/{policy_id}/associations | List the associations of a Policy *JCAPIv2::PoliciesApi* | [**graph_policy_associations_post**](docs/PoliciesApi.md#graph_policy_associations_post) | **POST** /policies/{policy_id}/associations | Manage the associations of a Policy *JCAPIv2::PoliciesApi* | [**graph_policy_traverse_system**](docs/PoliciesApi.md#graph_policy_traverse_system) | **GET** /policies/{policy_id}/systems | List the Systems bound to a Policy @@ -212,8 +221,8 @@ Class | Method | HTTP request | Description *JCAPIv2::PoliciesApi* | [**policyresults_get**](docs/PoliciesApi.md#policyresults_get) | **GET** /policyresults/{id} | Get a specific Policy Result. *JCAPIv2::PoliciesApi* | [**policyresults_list**](docs/PoliciesApi.md#policyresults_list) | **GET** /policies/{policy_id}/policyresults | Lists all the policy results of a policy. *JCAPIv2::PoliciesApi* | [**policyresults_list_0**](docs/PoliciesApi.md#policyresults_list_0) | **GET** /policyresults | Lists all the policy results for an organization. -*JCAPIv2::PoliciesApi* | [**policystatuses_list**](docs/PoliciesApi.md#policystatuses_list) | **GET** /systems/{system_id}/policystatuses | List the policy statuses for a system -*JCAPIv2::PoliciesApi* | [**policystatuses_list_0**](docs/PoliciesApi.md#policystatuses_list_0) | **GET** /policies/{policy_id}/policystatuses | Lists the latest policy results of a policy. +*JCAPIv2::PoliciesApi* | [**policystatuses_list**](docs/PoliciesApi.md#policystatuses_list) | **GET** /policies/{policy_id}/policystatuses | Lists the latest policy results of a policy. +*JCAPIv2::PoliciesApi* | [**policystatuses_list_0**](docs/PoliciesApi.md#policystatuses_list_0) | **GET** /systems/{system_id}/policystatuses | List the policy statuses for a system *JCAPIv2::PoliciesApi* | [**policytemplates_get**](docs/PoliciesApi.md#policytemplates_get) | **GET** /policytemplates/{id} | Get a specific Policy Template *JCAPIv2::PoliciesApi* | [**policytemplates_list**](docs/PoliciesApi.md#policytemplates_list) | **GET** /policytemplates | Lists all of the Policy Templates *JCAPIv2::PolicytemplatesApi* | [**policytemplates_get**](docs/PolicytemplatesApi.md#policytemplates_get) | **GET** /policytemplates/{id} | Get a specific Policy Template @@ -307,7 +316,7 @@ Class | Method | HTTP request | Description *JCAPIv2::UsersApi* | [**graph_user_traverse_radius_server**](docs/UsersApi.md#graph_user_traverse_radius_server) | **GET** /users/{user_id}/radiusservers | List the RADIUS Servers bound to a User *JCAPIv2::UsersApi* | [**graph_user_traverse_system**](docs/UsersApi.md#graph_user_traverse_system) | **GET** /users/{user_id}/systems | List the Systems bound to a User *JCAPIv2::UsersApi* | [**graph_user_traverse_system_group**](docs/UsersApi.md#graph_user_traverse_system_group) | **GET** /users/{user_id}/systemgroups | List the System Groups bound to a User -*JCAPIv2::UsersApi* | [**user_send_emails**](docs/UsersApi.md#user_send_emails) | **POST** /users/{user_id}/emails | Send User Emails +*JCAPIv2::UsersApi* | [**users_send_emails**](docs/UsersApi.md#users_send_emails) | **POST** /users/{user_id}/emails | Send User Emails *JCAPIv2::WorkdayImportApi* | [**workdays_authorize**](docs/WorkdayImportApi.md#workdays_authorize) | **POST** /workdays/{workday_id}/auth | Authorize Workday *JCAPIv2::WorkdayImportApi* | [**workdays_deauthorize**](docs/WorkdayImportApi.md#workdays_deauthorize) | **DELETE** /workdays/{workday_id}/auth | Deauthorize Workday *JCAPIv2::WorkdayImportApi* | [**workdays_delete**](docs/WorkdayImportApi.md#workdays_delete) | **DELETE** /workdays/{id} | Delete Workday @@ -330,10 +339,14 @@ Class | Method | HTTP request | Description - [JCAPIv2::AuthinputBasic](docs/AuthinputBasic.md) - [JCAPIv2::AuthinputOauth](docs/AuthinputOauth.md) - [JCAPIv2::BulkUserCreate](docs/BulkUserCreate.md) + - [JCAPIv2::BulkUserUpdate](docs/BulkUserUpdate.md) - [JCAPIv2::Directory](docs/Directory.md) - [JCAPIv2::Emailrequest](docs/Emailrequest.md) - [JCAPIv2::Error](docs/Error.md) - [JCAPIv2::Errorresponse](docs/Errorresponse.md) + - [JCAPIv2::GSuiteBuiltinTranslation](docs/GSuiteBuiltinTranslation.md) + - [JCAPIv2::GSuiteTranslationRule](docs/GSuiteTranslationRule.md) + - [JCAPIv2::GSuiteTranslationRuleRequest](docs/GSuiteTranslationRuleRequest.md) - [JCAPIv2::GraphConnection](docs/GraphConnection.md) - [JCAPIv2::GraphManagementReq](docs/GraphManagementReq.md) - [JCAPIv2::GraphObject](docs/GraphObject.md) @@ -341,11 +354,16 @@ Class | Method | HTTP request | Description - [JCAPIv2::GraphType](docs/GraphType.md) - [JCAPIv2::Group](docs/Group.md) - [JCAPIv2::GroupType](docs/GroupType.md) + - [JCAPIv2::InlineResponse201](docs/InlineResponse201.md) + - [JCAPIv2::InlineResponse2011](docs/InlineResponse2011.md) - [JCAPIv2::JobDetails](docs/JobDetails.md) - [JCAPIv2::JobId](docs/JobId.md) - [JCAPIv2::JobWorkresult](docs/JobWorkresult.md) - [JCAPIv2::LdapServerInput](docs/LdapServerInput.md) - [JCAPIv2::OauthCodeInput](docs/OauthCodeInput.md) + - [JCAPIv2::Office365BuiltinTranslation](docs/Office365BuiltinTranslation.md) + - [JCAPIv2::Office365TranslationRule](docs/Office365TranslationRule.md) + - [JCAPIv2::Office365TranslationRuleRequest](docs/Office365TranslationRuleRequest.md) - [JCAPIv2::Policy](docs/Policy.md) - [JCAPIv2::PolicyRequest](docs/PolicyRequest.md) - [JCAPIv2::PolicyRequestTemplate](docs/PolicyRequestTemplate.md) diff --git a/jcapiv2/docs/ApplicationsApi.md b/jcapiv2/docs/ApplicationsApi.md index 61e1c2a..d89c967 100644 --- a/jcapiv2/docs/ApplicationsApi.md +++ b/jcapiv2/docs/ApplicationsApi.md @@ -151,7 +151,7 @@ nil (empty response body) List the Users bound to an Application -This endpoint will return all Users bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all Users bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby diff --git a/jcapiv2/docs/BulkJobRequestsApi.md b/jcapiv2/docs/BulkJobRequestsApi.md index 4e19601..8091c84 100644 --- a/jcapiv2/docs/BulkJobRequestsApi.md +++ b/jcapiv2/docs/BulkJobRequestsApi.md @@ -5,7 +5,8 @@ All URIs are relative to *https://console.jumpcloud.com/api/v2* Method | HTTP request | Description ------------- | ------------- | ------------- [**bulk_users_create**](BulkJobRequestsApi.md#bulk_users_create) | **POST** /bulk/users | Bulk Users Create -[**bulk_users_create_results**](BulkJobRequestsApi.md#bulk_users_create_results) | **GET** /bulk/users/{job_id}/results | List Bulk Users Create Results +[**bulk_users_create_results**](BulkJobRequestsApi.md#bulk_users_create_results) | **GET** /bulk/users/{job_id}/results | List Bulk Users Results +[**bulk_users_update**](BulkJobRequestsApi.md#bulk_users_update) | **PATCH** /bulk/users | Bulk Users Update [**jobs_get**](BulkJobRequestsApi.md#jobs_get) | **GET** /jobs/{id} | Get Job (incomplete) [**jobs_results**](BulkJobRequestsApi.md#jobs_results) | **GET** /jobs/{id}/results | List Job Results @@ -76,9 +77,9 @@ Name | Type | Description | Notes # **bulk_users_create_results** > Array<JobWorkresult> bulk_users_create_results(job_id, content_type, accept, opts) -List Bulk Users Create Results +List Bulk Users Results -This endpoint will return the results of particular import job request. ###Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return the results of particular user import or update job request. ###Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -107,7 +108,7 @@ opts = { } begin - #List Bulk Users Create Results + #List Bulk Users Results result = api_instance.bulk_users_create_results(job_id, content_type, accept, opts) p result rescue JCAPIv2::ApiError => e @@ -141,6 +142,69 @@ Name | Type | Description | Notes +# **bulk_users_update** +> JobId bulk_users_update(content_type, accept, opts) + +Bulk Users Update + +The endpoint allows you to create a bulk job to asynchronously update users. #### Sample Request ``` curl -X PATCH https://console.jumpcloud.com/api/v2/bulk/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '[ { \"id\":\"5be9fb4ddb01290001e85109\", \"firstname\":\"{UPDATED_FIRSTNAME}\", \"department\":\"{UPDATED_DEPARTMENT}\", \"attributes\":[ {\"name\":\"Custom\",\"value\":\"{ATTRIBUTE_VALUE}\"} ] }, { \"id\":\"5be9fb4ddb01290001e85109\", \"firstname\":\"{UPDATED_FIRSTNAME}\", \"costCenter\":\"{UPDATED_COST_CENTER}\", \"phoneNumbers\":[ {\"type\":\"home\",\"number\":\"{HOME_PHONE_NUMBER}\"}, {\"type\":\"work\",\"number\":\"{WORK_PHONE_NUMBER}\"} ] } ] ``` + +### Example +```ruby +# load the gem +require 'jcapiv2' +# setup authorization +JCAPIv2.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 = JCAPIv2::BulkJobRequestsApi.new + +content_type = "application/json" # String | + +accept = "application/json" # String | + +opts = { + body: [JCAPIv2::BulkUserUpdate.new], # Array | + x_org_id: "" # String | +} + +begin + #Bulk Users Update + result = api_instance.bulk_users_update(content_type, accept, opts) + p result +rescue JCAPIv2::ApiError => e + puts "Exception when calling BulkJobRequestsApi->bulk_users_update: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **content_type** | **String**| | [default to application/json] + **accept** | **String**| | [default to application/json] + **body** | [**Array<BulkUserUpdate>**](BulkUserUpdate.md)| | [optional] + **x_org_id** | **String**| | [optional] [default to ] + +### Return type + +[**JobId**](JobId.md) + +### Authorization + +[x-api-key](../README.md#x-api-key) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + # **jobs_get** > JobDetails jobs_get(id, content_type, accept, opts) @@ -210,7 +274,7 @@ Name | Type | Description | Notes List Job Results -This endpoint will return the results of particular import job request. ###Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/jobs/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return the results of particular import job request. ###Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/jobs/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby diff --git a/jcapiv2/docs/BulkUserCreate.md b/jcapiv2/docs/BulkUserCreate.md index dae2765..92cf1f2 100644 --- a/jcapiv2/docs/BulkUserCreate.md +++ b/jcapiv2/docs/BulkUserCreate.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes **firstname** | **String** | | [optional] **lastname** | **String** | | [optional] **email** | **String** | | [optional] -**attributes** | **Array<Object>** | | [optional] +**attributes** | **Array<Object>** | Map of additional attributes. | [optional] diff --git a/jcapiv2/docs/BulkUserUpdate.md b/jcapiv2/docs/BulkUserUpdate.md new file mode 100644 index 0000000..5ef3166 --- /dev/null +++ b/jcapiv2/docs/BulkUserUpdate.md @@ -0,0 +1,9 @@ +# JCAPIv2::BulkUserUpdate + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | Object ID of the systemuser being updated | [optional] +**attributes** | **Array<Object>** | Map of additional attributes. | [optional] + + diff --git a/jcapiv2/docs/GSuiteApi.md b/jcapiv2/docs/GSuiteApi.md index 3445f2e..a164858 100644 --- a/jcapiv2/docs/GSuiteApi.md +++ b/jcapiv2/docs/GSuiteApi.md @@ -8,6 +8,10 @@ Method | HTTP request | Description [**graph_g_suite_associations_post**](GSuiteApi.md#graph_g_suite_associations_post) | **POST** /gsuites/{gsuite_id}/associations | Manage the associations of a G Suite instance [**graph_g_suite_traverse_user**](GSuiteApi.md#graph_g_suite_traverse_user) | **GET** /gsuites/{gsuite_id}/users | List the Users bound to a G Suite instance [**graph_g_suite_traverse_user_group**](GSuiteApi.md#graph_g_suite_traverse_user_group) | **GET** /gsuites/{gsuite_id}/usergroups | List the User Groups bound to a G Suite instance +[**translation_rules_g_suite_delete**](GSuiteApi.md#translation_rules_g_suite_delete) | **DELETE** /gsuites/{gsuite_id}/translationrules/{id} | Deletes a G Suite translation rule +[**translation_rules_g_suite_get**](GSuiteApi.md#translation_rules_g_suite_get) | **GET** /gsuites/{gsuite_id}/translationrules/{id} | Gets a specific g suite translation rule +[**translation_rules_g_suite_list**](GSuiteApi.md#translation_rules_g_suite_list) | **GET** /gsuites/{gsuite_id}/translationrules | List all the G Suite Translation Rules +[**translation_rules_g_suite_post**](GSuiteApi.md#translation_rules_g_suite_post) | **POST** /gsuites/{gsuite_id}/translationrules | Create a new G Suite Translation Rule # **graph_g_suite_associations_list** @@ -276,3 +280,264 @@ Name | Type | Description | Notes +# **translation_rules_g_suite_delete** +> translation_rules_g_suite_delete(gsuite_id, id, content_type, accept) + +Deletes a G Suite translation rule + +This endpoint allows you to delete a translation rule for a specific G Suite instance. These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. #### Sample Request ``` curl -X DELETE https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + +### Example +```ruby +# load the gem +require 'jcapiv2' +# setup authorization +JCAPIv2.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 = JCAPIv2::GSuiteApi.new + +gsuite_id = "gsuite_id_example" # String | + +id = "id_example" # String | + +content_type = "application/json" # String | + +accept = "application/json" # String | + + +begin + #Deletes a G Suite translation rule + api_instance.translation_rules_g_suite_delete(gsuite_id, id, content_type, accept) +rescue JCAPIv2::ApiError => e + puts "Exception when calling GSuiteApi->translation_rules_g_suite_delete: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **gsuite_id** | **String**| | + **id** | **String**| | + **content_type** | **String**| | [default to application/json] + **accept** | **String**| | [default to application/json] + +### Return type + +nil (empty response body) + +### Authorization + +[x-api-key](../README.md#x-api-key) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **translation_rules_g_suite_get** +> GSuiteTranslationRule translation_rules_g_suite_get(gsuite_id, id, content_type, accept) + +Gets a specific g suite translation rule + +This endpoint returns a specific translation rule for a specific G Suite instance. These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. ###### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + +### Example +```ruby +# load the gem +require 'jcapiv2' +# setup authorization +JCAPIv2.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 = JCAPIv2::GSuiteApi.new + +gsuite_id = "gsuite_id_example" # String | + +id = "id_example" # String | + +content_type = "application/json" # String | + +accept = "application/json" # String | + + +begin + #Gets a specific g suite translation rule + result = api_instance.translation_rules_g_suite_get(gsuite_id, id, content_type, accept) + p result +rescue JCAPIv2::ApiError => e + puts "Exception when calling GSuiteApi->translation_rules_g_suite_get: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **gsuite_id** | **String**| | + **id** | **String**| | + **content_type** | **String**| | [default to application/json] + **accept** | **String**| | [default to application/json] + +### Return type + +[**GSuiteTranslationRule**](GSuiteTranslationRule.md) + +### Authorization + +[x-api-key](../README.md#x-api-key) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **translation_rules_g_suite_list** +> Array<GSuiteTranslationRule> translation_rules_g_suite_list(gsuite_id, content_type, accept, opts) + +List all the G Suite Translation Rules + +This endpoint returns all graph translation rules for a specific G Suite instance. These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + +### Example +```ruby +# load the gem +require 'jcapiv2' +# setup authorization +JCAPIv2.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 = JCAPIv2::GSuiteApi.new + +gsuite_id = "gsuite_id_example" # String | + +content_type = "application/json" # String | + +accept = "application/json" # String | + +opts = { + fields: ["fields_example"], # Array | The comma separated fields included in the returned records. If omitted the default list of fields will be returned. + filter: ["filter_example"], # Array | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in + 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: ["sort_example"], # Array | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. +} + +begin + #List all the G Suite Translation Rules + result = api_instance.translation_rules_g_suite_list(gsuite_id, content_type, accept, opts) + p result +rescue JCAPIv2::ApiError => e + puts "Exception when calling GSuiteApi->translation_rules_g_suite_list: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **gsuite_id** | **String**| | + **content_type** | **String**| | [default to application/json] + **accept** | **String**| | [default to application/json] + **fields** | [**Array<String>**](String.md)| The comma separated fields included in the returned records. If omitted the default list of fields will be returned. | [optional] + **filter** | [**Array<String>**](String.md)| Supported operators are: eq, ne, gt, ge, lt, le, between, search, in | [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** | [**Array<String>**](String.md)| The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. | [optional] + +### Return type + +[**Array<GSuiteTranslationRule>**](GSuiteTranslationRule.md) + +### Authorization + +[x-api-key](../README.md#x-api-key) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **translation_rules_g_suite_post** +> InlineResponse201 translation_rules_g_suite_post(gsuite_id, content_type, accept, opts) + +Create a new G Suite Translation Rule + +This endpoint allows you to create a translation rule for a specific G Suite instance. These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. ##### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ {Translation Rule Parameters} }' ``` + +### Example +```ruby +# load the gem +require 'jcapiv2' +# setup authorization +JCAPIv2.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 = JCAPIv2::GSuiteApi.new + +gsuite_id = "gsuite_id_example" # String | + +content_type = "application/json" # String | + +accept = "application/json" # String | + +opts = { + body: JCAPIv2::GSuiteTranslationRuleRequest.new # GSuiteTranslationRuleRequest | +} + +begin + #Create a new G Suite Translation Rule + result = api_instance.translation_rules_g_suite_post(gsuite_id, content_type, accept, opts) + p result +rescue JCAPIv2::ApiError => e + puts "Exception when calling GSuiteApi->translation_rules_g_suite_post: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **gsuite_id** | **String**| | + **content_type** | **String**| | [default to application/json] + **accept** | **String**| | [default to application/json] + **body** | [**GSuiteTranslationRuleRequest**](GSuiteTranslationRuleRequest.md)| | [optional] + +### Return type + +[**InlineResponse201**](InlineResponse201.md) + +### Authorization + +[x-api-key](../README.md#x-api-key) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + diff --git a/jcapiv2/docs/GSuiteBuiltinTranslation.md b/jcapiv2/docs/GSuiteBuiltinTranslation.md new file mode 100644 index 0000000..ce0d47f --- /dev/null +++ b/jcapiv2/docs/GSuiteBuiltinTranslation.md @@ -0,0 +1,7 @@ +# JCAPIv2::GSuiteBuiltinTranslation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/jcapiv2/docs/GSuiteTranslationRule.md b/jcapiv2/docs/GSuiteTranslationRule.md new file mode 100644 index 0000000..38fa8cf --- /dev/null +++ b/jcapiv2/docs/GSuiteTranslationRule.md @@ -0,0 +1,9 @@ +# JCAPIv2::GSuiteTranslationRule + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**built_in** | [**GSuiteBuiltinTranslation**](GSuiteBuiltinTranslation.md) | | [optional] +**id** | **String** | ObjectId uniquely identifying a Translation Rule. | [optional] + + diff --git a/jcapiv2/docs/GSuiteTranslationRuleRequest.md b/jcapiv2/docs/GSuiteTranslationRuleRequest.md new file mode 100644 index 0000000..1b4f5d9 --- /dev/null +++ b/jcapiv2/docs/GSuiteTranslationRuleRequest.md @@ -0,0 +1,8 @@ +# JCAPIv2::GSuiteTranslationRuleRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**built_in** | [**GSuiteBuiltinTranslation**](GSuiteBuiltinTranslation.md) | | [optional] + + diff --git a/jcapiv2/docs/GraphApi.md b/jcapiv2/docs/GraphApi.md index adcdc77..d50ed3a 100644 --- a/jcapiv2/docs/GraphApi.md +++ b/jcapiv2/docs/GraphApi.md @@ -426,7 +426,7 @@ nil (empty response body) List the Users bound to an Application -This endpoint will return all Users bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all Users bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -1780,7 +1780,7 @@ nil (empty response body) List the Systems bound to a Policy -This endpoint will return all Systems bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Policy to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all Systems bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Policy to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -2052,7 +2052,7 @@ nil (empty response body) List the Users bound to a RADIUS Server -This endpoint will return all Users bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all Users bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -2120,7 +2120,7 @@ Name | Type | Description | Notes List the User Groups bound to a RADIUS Server -This endpoint will return all Users Groups bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all Users Groups bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -2263,7 +2263,7 @@ Name | Type | Description | Notes Manage associations of a System -This endpoint allows you to manage the _direct_ associations of a System. A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"user\", \"id\": \"UserID\" }' ``` +This endpoint allows you to manage the _direct_ associations of a System. A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"user\", \"id\": \"UserID\" }' ``` ### Example ```ruby @@ -3165,7 +3165,7 @@ Name | Type | Description | Notes List the Policies bound to a System -This endpoint will return all Policies bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System. See `/members` and `/associations` endpoints to manage those collections. This endpoint is not yet public as we have finish the code. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/{System_ID}/policies \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all Policies bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System. See `/members` and `/associations` endpoints to manage those collections. This endpoint is not yet public as we have finish the code. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/{System_ID}/policies \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -3233,7 +3233,7 @@ Name | Type | Description | Notes List the Users bound to a System -This endpoint will return all Users bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all Users bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -3257,10 +3257,11 @@ accept = "application/json" # String | opts = { limit: 10, # Integer | The number of records to return at once. Limited to 100. + x_org_id: "" # String | skip: 0, # Integer | The offset into the records to return. date: "date_example", # String | Current date header for the System Context API authorization: "authorization_example", # String | Authorization header for the System Context API - x_org_id: "" # String | + filter: ["filter_example"], # Array | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in } begin @@ -3280,10 +3281,11 @@ Name | Type | Description | Notes **content_type** | **String**| | [default to application/json] **accept** | **String**| | [default to application/json] **limit** | **Integer**| The number of records to return at once. Limited to 100. | [optional] [default to 10] + **x_org_id** | **String**| | [optional] [default to ] **skip** | **Integer**| The offset into the records to return. | [optional] [default to 0] **date** | **String**| Current date header for the System Context API | [optional] **authorization** | **String**| Authorization header for the System Context API | [optional] - **x_org_id** | **String**| | [optional] [default to ] + **filter** | [**Array<String>**](String.md)| Supported operators are: eq, ne, gt, ge, lt, le, between, search, in | [optional] ### Return type @@ -3305,7 +3307,7 @@ Name | Type | Description | Notes List the User Groups bound to a System -This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -3448,7 +3450,7 @@ Name | Type | Description | Notes Manage the associations of a User -This endpoint allows you to manage the _direct_ associations of a User. A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"system_group\", \"id\": \"{GroupID}\" }' +This endpoint allows you to manage the _direct_ associations of a User. A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"system_group\", \"id\": \"{GroupID}\" }' ### Example ```ruby @@ -3926,7 +3928,7 @@ Name | Type | Description | Notes List the Active Directories bound to a User Group -This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -4334,7 +4336,7 @@ Name | Type | Description | Notes List the RADIUS Servers bound to a User Group -This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -4402,7 +4404,7 @@ Name | Type | Description | Notes List the Systems bound to a User Group -This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -4470,7 +4472,7 @@ Name | Type | Description | Notes List the System Groups bound to User Groups -This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -4610,7 +4612,7 @@ Name | Type | Description | Notes List the Applications bound to a User -This endpoint will return all Applications bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/applications \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all Applications bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/applications \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -4678,7 +4680,7 @@ Name | Type | Description | Notes List the Directories bound to a User -This endpoint will return all Directories bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/directories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all Directories bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/directories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -4746,7 +4748,7 @@ Name | Type | Description | Notes List the G Suite instances bound to a User -This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -4814,7 +4816,7 @@ Name | Type | Description | Notes List the LDAP servers bound to a User -This endpoint will return all LDAP Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/ldapservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all LDAP Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/ldapservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -4882,7 +4884,7 @@ Name | Type | Description | Notes List the Office 365 instances bound to a User -This endpoint will return all Office 365 Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/office365s \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all Office 365 Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/office365s \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -4950,7 +4952,7 @@ Name | Type | Description | Notes List the RADIUS Servers bound to a User -This endpoint will return all RADIUS Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all RADIUS Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -5018,7 +5020,7 @@ Name | Type | Description | Notes List the Systems bound to a User -This endpoint will return all Systems bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systems\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all Systems bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systems\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -5042,8 +5044,9 @@ accept = "application/json" # String | opts = { limit: 10, # Integer | The number of records to return at once. Limited to 100. - skip: 0, # Integer | The offset into the records to return. x_org_id: "" # String | + skip: 0, # Integer | The offset into the records to return. + filter: ["filter_example"], # Array | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in } begin @@ -5063,8 +5066,9 @@ Name | Type | Description | Notes **content_type** | **String**| | [default to application/json] **accept** | **String**| | [default to application/json] **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] **x_org_id** | **String**| | [optional] [default to ] + **skip** | **Integer**| The offset into the records to return. | [optional] [default to 0] + **filter** | [**Array<String>**](String.md)| Supported operators are: eq, ne, gt, ge, lt, le, between, search, in | [optional] ### Return type @@ -5086,7 +5090,7 @@ Name | Type | Description | Notes List the System Groups bound to a User -This endpoint will return all System Groups bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systemgroups\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all System Groups bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systemgroups\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby diff --git a/jcapiv2/docs/InlineResponse201.md b/jcapiv2/docs/InlineResponse201.md new file mode 100644 index 0000000..da4958b --- /dev/null +++ b/jcapiv2/docs/InlineResponse201.md @@ -0,0 +1,8 @@ +# JCAPIv2::InlineResponse201 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**rule** | [**GSuiteTranslationRule**](GSuiteTranslationRule.md) | | [optional] + + diff --git a/jcapiv2/docs/InlineResponse2011.md b/jcapiv2/docs/InlineResponse2011.md new file mode 100644 index 0000000..f5c6522 --- /dev/null +++ b/jcapiv2/docs/InlineResponse2011.md @@ -0,0 +1,8 @@ +# JCAPIv2::InlineResponse2011 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**rule** | [**Office365TranslationRule**](Office365TranslationRule.md) | | [optional] + + diff --git a/jcapiv2/docs/Office365Api.md b/jcapiv2/docs/Office365Api.md index de2b1ee..0988ca7 100644 --- a/jcapiv2/docs/Office365Api.md +++ b/jcapiv2/docs/Office365Api.md @@ -8,6 +8,10 @@ Method | HTTP request | Description [**graph_office365_associations_post**](Office365Api.md#graph_office365_associations_post) | **POST** /office365s/{office365_id}/associations | Manage the associations of an Office 365 instance [**graph_office365_traverse_user**](Office365Api.md#graph_office365_traverse_user) | **GET** /office365s/{office365_id}/users | List the Users bound to an Office 365 instance [**graph_office365_traverse_user_group**](Office365Api.md#graph_office365_traverse_user_group) | **GET** /office365s/{office365_id}/usergroups | List the User Groups bound to an Office 365 instance +[**translation_rules_office365_delete**](Office365Api.md#translation_rules_office365_delete) | **DELETE** /office365s/{office365_id}/translationrules/{id} | Deletes a Office 365 translation rule +[**translation_rules_office365_get**](Office365Api.md#translation_rules_office365_get) | **GET** /office365s/{office365_id}/translationrules/{id} | Gets a specific Office 365 translation rule +[**translation_rules_office365_list**](Office365Api.md#translation_rules_office365_list) | **GET** /office365s/{office365_id}/translationrules | List all the Office 365 Translation Rules +[**translation_rules_office365_post**](Office365Api.md#translation_rules_office365_post) | **POST** /office365s/{office365_id}/translationrules | Create a new Office 365 Translation Rule # **graph_office365_associations_list** @@ -282,3 +286,264 @@ Name | Type | Description | Notes +# **translation_rules_office365_delete** +> translation_rules_office365_delete(office365_id, id, content_type, accept) + +Deletes a Office 365 translation rule + +This endpoint allows you to delete a translation rule for a specific Office 365 instance. These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. #### Sample Request ``` curl -X DELETE https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + +### Example +```ruby +# load the gem +require 'jcapiv2' +# setup authorization +JCAPIv2.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 = JCAPIv2::Office365Api.new + +office365_id = "office365_id_example" # String | + +id = "id_example" # String | + +content_type = "application/json" # String | + +accept = "application/json" # String | + + +begin + #Deletes a Office 365 translation rule + api_instance.translation_rules_office365_delete(office365_id, id, content_type, accept) +rescue JCAPIv2::ApiError => e + puts "Exception when calling Office365Api->translation_rules_office365_delete: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **office365_id** | **String**| | + **id** | **String**| | + **content_type** | **String**| | [default to application/json] + **accept** | **String**| | [default to application/json] + +### Return type + +nil (empty response body) + +### Authorization + +[x-api-key](../README.md#x-api-key) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **translation_rules_office365_get** +> Office365TranslationRule translation_rules_office365_get(office365_id, id, content_type, accept) + +Gets a specific Office 365 translation rule + +This endpoint returns a specific translation rule for a specific Office 365 instance. These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. ###### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + +### Example +```ruby +# load the gem +require 'jcapiv2' +# setup authorization +JCAPIv2.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 = JCAPIv2::Office365Api.new + +office365_id = "office365_id_example" # String | + +id = "id_example" # String | + +content_type = "application/json" # String | + +accept = "application/json" # String | + + +begin + #Gets a specific Office 365 translation rule + result = api_instance.translation_rules_office365_get(office365_id, id, content_type, accept) + p result +rescue JCAPIv2::ApiError => e + puts "Exception when calling Office365Api->translation_rules_office365_get: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **office365_id** | **String**| | + **id** | **String**| | + **content_type** | **String**| | [default to application/json] + **accept** | **String**| | [default to application/json] + +### Return type + +[**Office365TranslationRule**](Office365TranslationRule.md) + +### Authorization + +[x-api-key](../README.md#x-api-key) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **translation_rules_office365_list** +> Array<Office365TranslationRule> translation_rules_office365_list(office365_id, content_type, accept, opts) + +List all the Office 365 Translation Rules + +This endpoint returns all translation rules for a specific Office 365 instance. These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + +### Example +```ruby +# load the gem +require 'jcapiv2' +# setup authorization +JCAPIv2.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 = JCAPIv2::Office365Api.new + +office365_id = "office365_id_example" # String | + +content_type = "application/json" # String | + +accept = "application/json" # String | + +opts = { + fields: ["fields_example"], # Array | The comma separated fields included in the returned records. If omitted the default list of fields will be returned. + filter: ["filter_example"], # Array | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in + 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: ["sort_example"], # Array | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. +} + +begin + #List all the Office 365 Translation Rules + result = api_instance.translation_rules_office365_list(office365_id, content_type, accept, opts) + p result +rescue JCAPIv2::ApiError => e + puts "Exception when calling Office365Api->translation_rules_office365_list: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **office365_id** | **String**| | + **content_type** | **String**| | [default to application/json] + **accept** | **String**| | [default to application/json] + **fields** | [**Array<String>**](String.md)| The comma separated fields included in the returned records. If omitted the default list of fields will be returned. | [optional] + **filter** | [**Array<String>**](String.md)| Supported operators are: eq, ne, gt, ge, lt, le, between, search, in | [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** | [**Array<String>**](String.md)| The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. | [optional] + +### Return type + +[**Array<Office365TranslationRule>**](Office365TranslationRule.md) + +### Authorization + +[x-api-key](../README.md#x-api-key) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **translation_rules_office365_post** +> InlineResponse2011 translation_rules_office365_post(office365_id, content_type, accept, opts) + +Create a new Office 365 Translation Rule + +This endpoint allows you to create a translation rule for a specific Office 365 instance. These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. ##### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ {Translation Rule Parameters} }' ``` + +### Example +```ruby +# load the gem +require 'jcapiv2' +# setup authorization +JCAPIv2.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 = JCAPIv2::Office365Api.new + +office365_id = "office365_id_example" # String | + +content_type = "application/json" # String | + +accept = "application/json" # String | + +opts = { + body: JCAPIv2::Office365TranslationRuleRequest.new # Office365TranslationRuleRequest | +} + +begin + #Create a new Office 365 Translation Rule + result = api_instance.translation_rules_office365_post(office365_id, content_type, accept, opts) + p result +rescue JCAPIv2::ApiError => e + puts "Exception when calling Office365Api->translation_rules_office365_post: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **office365_id** | **String**| | + **content_type** | **String**| | [default to application/json] + **accept** | **String**| | [default to application/json] + **body** | [**Office365TranslationRuleRequest**](Office365TranslationRuleRequest.md)| | [optional] + +### Return type + +[**InlineResponse2011**](InlineResponse2011.md) + +### Authorization + +[x-api-key](../README.md#x-api-key) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + diff --git a/jcapiv2/docs/Office365BuiltinTranslation.md b/jcapiv2/docs/Office365BuiltinTranslation.md new file mode 100644 index 0000000..ad58824 --- /dev/null +++ b/jcapiv2/docs/Office365BuiltinTranslation.md @@ -0,0 +1,7 @@ +# JCAPIv2::Office365BuiltinTranslation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/jcapiv2/docs/Office365TranslationRule.md b/jcapiv2/docs/Office365TranslationRule.md new file mode 100644 index 0000000..e9abd30 --- /dev/null +++ b/jcapiv2/docs/Office365TranslationRule.md @@ -0,0 +1,9 @@ +# JCAPIv2::Office365TranslationRule + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**built_in** | [**Office365BuiltinTranslation**](Office365BuiltinTranslation.md) | | [optional] +**id** | **String** | ObjectId uniquely identifying a Translation Rule. | [optional] + + diff --git a/jcapiv2/docs/Office365TranslationRuleRequest.md b/jcapiv2/docs/Office365TranslationRuleRequest.md new file mode 100644 index 0000000..6a62853 --- /dev/null +++ b/jcapiv2/docs/Office365TranslationRuleRequest.md @@ -0,0 +1,8 @@ +# JCAPIv2::Office365TranslationRuleRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**built_in** | [**Office365BuiltinTranslation**](Office365BuiltinTranslation.md) | | [optional] + + diff --git a/jcapiv2/docs/PoliciesApi.md b/jcapiv2/docs/PoliciesApi.md index 1b840a9..7252a56 100644 --- a/jcapiv2/docs/PoliciesApi.md +++ b/jcapiv2/docs/PoliciesApi.md @@ -16,8 +16,8 @@ Method | HTTP request | Description [**policyresults_get**](PoliciesApi.md#policyresults_get) | **GET** /policyresults/{id} | Get a specific Policy Result. [**policyresults_list**](PoliciesApi.md#policyresults_list) | **GET** /policies/{policy_id}/policyresults | Lists all the policy results of a policy. [**policyresults_list_0**](PoliciesApi.md#policyresults_list_0) | **GET** /policyresults | Lists all the policy results for an organization. -[**policystatuses_list**](PoliciesApi.md#policystatuses_list) | **GET** /systems/{system_id}/policystatuses | List the policy statuses for a system -[**policystatuses_list_0**](PoliciesApi.md#policystatuses_list_0) | **GET** /policies/{policy_id}/policystatuses | Lists the latest policy results of a policy. +[**policystatuses_list**](PoliciesApi.md#policystatuses_list) | **GET** /policies/{policy_id}/policystatuses | Lists the latest policy results of a policy. +[**policystatuses_list_0**](PoliciesApi.md#policystatuses_list_0) | **GET** /systems/{system_id}/policystatuses | List the policy statuses for a system [**policytemplates_get**](PoliciesApi.md#policytemplates_get) | **GET** /policytemplates/{id} | Get a specific Policy Template [**policytemplates_list**](PoliciesApi.md#policytemplates_list) | **GET** /policytemplates | Lists all of the Policy Templates @@ -163,7 +163,7 @@ nil (empty response body) List the Systems bound to a Policy -This endpoint will return all Systems bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Policy to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all Systems bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Policy to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -497,7 +497,7 @@ Name | Type | Description | Notes Create a new Policy -This endpoint allows you to create a policy. Given the amount of configurable parameters required to create a Policy, we suggest you use the JumpCloud Admin Console to create new policies. ##### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/policies \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ {Policy_Parameters} }' ``` +This endpoint allows you to create a policy. Given the amount of configurable parameters required to create a Policy, we suggest you use the JumpCloud Admin Console to create new policies. ##### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/policies \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ {Policy_Parameters} }' ``` ### Example ```ruby @@ -684,7 +684,7 @@ Name | Type | Description | Notes Lists all the policy results of a policy. -This endpoint returns all policies results for a specific policy. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policyresults \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint returns all policies results for a specific policy. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policyresults \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -760,7 +760,7 @@ Name | Type | Description | Notes Lists all the policy results for an organization. -This endpoint returns all policies results for an Organization. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policyresults \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint returns all policies results for an Organization. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policyresults \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -829,11 +829,11 @@ Name | Type | Description | Notes # **policystatuses_list** -> Array<PolicyResult> policystatuses_list(system_id, content_type, accept, opts) +> Array<PolicyResult> policystatuses_list(policy_id, content_type, accept, opts) -List the policy statuses for a system +Lists the latest policy results of a policy. -This endpoint returns the policy results for a particular system. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policystatuses \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint returns the latest policies results for a specific policy. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policystatuses \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -849,7 +849,7 @@ end api_instance = JCAPIv2::PoliciesApi.new -system_id = "system_id_example" # String | ObjectID of the System. +policy_id = "policy_id_example" # String | content_type = "application/json" # String | @@ -865,8 +865,8 @@ opts = { } begin - #List the policy statuses for a system - result = api_instance.policystatuses_list(system_id, content_type, accept, opts) + #Lists the latest policy results of a policy. + result = api_instance.policystatuses_list(policy_id, content_type, accept, opts) p result rescue JCAPIv2::ApiError => e puts "Exception when calling PoliciesApi->policystatuses_list: #{e}" @@ -877,7 +877,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **system_id** | **String**| ObjectID of the System. | + **policy_id** | **String**| | **content_type** | **String**| | [default to application/json] **accept** | **String**| | [default to application/json] **fields** | [**Array<String>**](String.md)| The comma separated fields included in the returned records. If omitted the default list of fields will be returned. | [optional] @@ -903,11 +903,11 @@ Name | Type | Description | Notes # **policystatuses_list_0** -> Array<PolicyResult> policystatuses_list_0(policy_id, content_type, accept, opts) +> Array<PolicyResult> policystatuses_list_0(system_id, content_type, accept, opts) -Lists the latest policy results of a policy. +List the policy statuses for a system -This endpoint returns the latest policies results for a specific policy. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policystatuses \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint returns the policy results for a particular system. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policystatuses \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -923,7 +923,7 @@ end api_instance = JCAPIv2::PoliciesApi.new -policy_id = "policy_id_example" # String | +system_id = "system_id_example" # String | ObjectID of the System. content_type = "application/json" # String | @@ -939,8 +939,8 @@ opts = { } begin - #Lists the latest policy results of a policy. - result = api_instance.policystatuses_list_0(policy_id, content_type, accept, opts) + #List the policy statuses for a system + result = api_instance.policystatuses_list_0(system_id, content_type, accept, opts) p result rescue JCAPIv2::ApiError => e puts "Exception when calling PoliciesApi->policystatuses_list_0: #{e}" @@ -951,7 +951,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **policy_id** | **String**| | + **system_id** | **String**| ObjectID of the System. | **content_type** | **String**| | [default to application/json] **accept** | **String**| | [default to application/json] **fields** | [**Array<String>**](String.md)| The comma separated fields included in the returned records. If omitted the default list of fields will be returned. | [optional] diff --git a/jcapiv2/docs/PolicyResult.md b/jcapiv2/docs/PolicyResult.md index 11eb5ab..cfc8c51 100644 --- a/jcapiv2/docs/PolicyResult.md +++ b/jcapiv2/docs/PolicyResult.md @@ -12,5 +12,7 @@ Name | Type | Description | Notes **exit_status** | **Integer** | The 32-bit unsigned exit status from the applying the policy. | [optional] **std_err** | **String** | The STDERR output from applying the policy. | [optional] **std_out** | **String** | The STDOUT output from applying the policy. | [optional] +**state** | **String** | Enumeration describing the state of the policy. Success, failed, or pending. | [optional] +**detail** | **String** | Details pertaining to the policy result. | [optional] diff --git a/jcapiv2/docs/RADIUSServersApi.md b/jcapiv2/docs/RADIUSServersApi.md index 0b5b601..4a6ed69 100644 --- a/jcapiv2/docs/RADIUSServersApi.md +++ b/jcapiv2/docs/RADIUSServersApi.md @@ -151,7 +151,7 @@ nil (empty response body) List the Users bound to a RADIUS Server -This endpoint will return all Users bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all Users bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -219,7 +219,7 @@ Name | Type | Description | Notes List the User Groups bound to a RADIUS Server -This endpoint will return all Users Groups bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all Users Groups bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby diff --git a/jcapiv2/docs/SambaDomainsApi.md b/jcapiv2/docs/SambaDomainsApi.md index 256f62b..4e75280 100644 --- a/jcapiv2/docs/SambaDomainsApi.md +++ b/jcapiv2/docs/SambaDomainsApi.md @@ -218,7 +218,7 @@ Name | Type | Description | Notes Create Samba Domain -This endpoint allows you to create a samba domain for an LDAP server. ##### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"sid\":\"{SID_ID}\", \"name\":\"{WORKGROUP_NAME}\" }' ``` +This endpoint allows you to create a samba domain for an LDAP server. ##### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"sid\":\"{SID_ID}\", \"name\":\"{WORKGROUP_NAME}\" }' ``` ### Example ```ruby @@ -282,7 +282,7 @@ Name | Type | Description | Notes Update Samba Domain -This endpoint allows you to update the samba domain information for an LDAP server. ##### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"sid\":\"{SID_ID}\", \"name\":\"{WORKGROUP_NAME}\" }' ``` +This endpoint allows you to update the samba domain information for an LDAP server. ##### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"sid\":\"{SID_ID}\", \"name\":\"{WORKGROUP_NAME}\" }' ``` ### Example ```ruby diff --git a/jcapiv2/docs/SystemsApi.md b/jcapiv2/docs/SystemsApi.md index af444b9..3cd3a02 100644 --- a/jcapiv2/docs/SystemsApi.md +++ b/jcapiv2/docs/SystemsApi.md @@ -94,7 +94,7 @@ Name | Type | Description | Notes Manage associations of a System -This endpoint allows you to manage the _direct_ associations of a System. A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"user\", \"id\": \"UserID\" }' ``` +This endpoint allows you to manage the _direct_ associations of a System. A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"user\", \"id\": \"UserID\" }' ``` ### Example ```ruby @@ -307,7 +307,7 @@ Name | Type | Description | Notes List the Policies bound to a System -This endpoint will return all Policies bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System. See `/members` and `/associations` endpoints to manage those collections. This endpoint is not yet public as we have finish the code. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/{System_ID}/policies \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all Policies bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System. See `/members` and `/associations` endpoints to manage those collections. This endpoint is not yet public as we have finish the code. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/{System_ID}/policies \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -375,7 +375,7 @@ Name | Type | Description | Notes List the Users bound to a System -This endpoint will return all Users bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all Users bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -399,10 +399,11 @@ accept = "application/json" # String | opts = { limit: 10, # Integer | The number of records to return at once. Limited to 100. + x_org_id: "" # String | skip: 0, # Integer | The offset into the records to return. date: "date_example", # String | Current date header for the System Context API authorization: "authorization_example", # String | Authorization header for the System Context API - x_org_id: "" # String | + filter: ["filter_example"], # Array | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in } begin @@ -422,10 +423,11 @@ Name | Type | Description | Notes **content_type** | **String**| | [default to application/json] **accept** | **String**| | [default to application/json] **limit** | **Integer**| The number of records to return at once. Limited to 100. | [optional] [default to 10] + **x_org_id** | **String**| | [optional] [default to ] **skip** | **Integer**| The offset into the records to return. | [optional] [default to 0] **date** | **String**| Current date header for the System Context API | [optional] **authorization** | **String**| Authorization header for the System Context API | [optional] - **x_org_id** | **String**| | [optional] [default to ] + **filter** | [**Array<String>**](String.md)| Supported operators are: eq, ne, gt, ge, lt, le, between, search, in | [optional] ### Return type @@ -447,7 +449,7 @@ Name | Type | Description | Notes List the User Groups bound to a System -This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby diff --git a/jcapiv2/docs/UserGroupAssociationsApi.md b/jcapiv2/docs/UserGroupAssociationsApi.md index da11ca8..f3f0083 100644 --- a/jcapiv2/docs/UserGroupAssociationsApi.md +++ b/jcapiv2/docs/UserGroupAssociationsApi.md @@ -158,7 +158,7 @@ nil (empty response body) List the Active Directories bound to a User Group -This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -566,7 +566,7 @@ Name | Type | Description | Notes List the RADIUS Servers bound to a User Group -This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -634,7 +634,7 @@ Name | Type | Description | Notes List the Systems bound to a User Group -This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -702,7 +702,7 @@ Name | Type | Description | Notes List the System Groups bound to User Groups -This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby diff --git a/jcapiv2/docs/UserGroupsApi.md b/jcapiv2/docs/UserGroupsApi.md index ce8a436..e225a9e 100644 --- a/jcapiv2/docs/UserGroupsApi.md +++ b/jcapiv2/docs/UserGroupsApi.md @@ -445,7 +445,7 @@ Name | Type | Description | Notes List the Active Directories bound to a User Group -This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -853,7 +853,7 @@ Name | Type | Description | Notes List the RADIUS Servers bound to a User Group -This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -921,7 +921,7 @@ Name | Type | Description | Notes List the Systems bound to a User Group -This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -989,7 +989,7 @@ Name | Type | Description | Notes List the System Groups bound to User Groups -This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -1384,7 +1384,7 @@ Name | Type | Description | Notes Update a User Group -This endpoint allows you to do a full update of the User Group. #### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/v2/usergroups/{Group_ID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY' \\ -d '{ \"name\": \"group_update\" }' ``` +This endpoint allows you to do a full update of the User Group. #### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/v2/usergroups/{Group_ID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY' \\ -d '{ \"name\": \"group_update\" }' ``` ### Example ```ruby diff --git a/jcapiv2/docs/UsersApi.md b/jcapiv2/docs/UsersApi.md index a4eb638..efe24b0 100644 --- a/jcapiv2/docs/UsersApi.md +++ b/jcapiv2/docs/UsersApi.md @@ -15,7 +15,7 @@ Method | HTTP request | Description [**graph_user_traverse_radius_server**](UsersApi.md#graph_user_traverse_radius_server) | **GET** /users/{user_id}/radiusservers | List the RADIUS Servers bound to a User [**graph_user_traverse_system**](UsersApi.md#graph_user_traverse_system) | **GET** /users/{user_id}/systems | List the Systems bound to a User [**graph_user_traverse_system_group**](UsersApi.md#graph_user_traverse_system_group) | **GET** /users/{user_id}/systemgroups | List the System Groups bound to a User -[**user_send_emails**](UsersApi.md#user_send_emails) | **POST** /users/{user_id}/emails | Send User Emails +[**users_send_emails**](UsersApi.md#users_send_emails) | **POST** /users/{user_id}/emails | Send User Emails # **graph_user_associations_list** @@ -94,7 +94,7 @@ Name | Type | Description | Notes Manage the associations of a User -This endpoint allows you to manage the _direct_ associations of a User. A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"system_group\", \"id\": \"{GroupID}\" }' +This endpoint allows you to manage the _direct_ associations of a User. A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"system_group\", \"id\": \"{GroupID}\" }' ### Example ```ruby @@ -231,7 +231,7 @@ Name | Type | Description | Notes List the Applications bound to a User -This endpoint will return all Applications bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/applications \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all Applications bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/applications \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -299,7 +299,7 @@ Name | Type | Description | Notes List the Directories bound to a User -This endpoint will return all Directories bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/directories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all Directories bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/directories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -367,7 +367,7 @@ Name | Type | Description | Notes List the G Suite instances bound to a User -This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -435,7 +435,7 @@ Name | Type | Description | Notes List the LDAP servers bound to a User -This endpoint will return all LDAP Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/ldapservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all LDAP Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/ldapservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -503,7 +503,7 @@ Name | Type | Description | Notes List the Office 365 instances bound to a User -This endpoint will return all Office 365 Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/office365s \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all Office 365 Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/office365s \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -571,7 +571,7 @@ Name | Type | Description | Notes List the RADIUS Servers bound to a User -This endpoint will return all RADIUS Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all RADIUS Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -639,7 +639,7 @@ Name | Type | Description | Notes List the Systems bound to a User -This endpoint will return all Systems bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systems\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all Systems bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systems\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -663,8 +663,9 @@ accept = "application/json" # String | opts = { limit: 10, # Integer | The number of records to return at once. Limited to 100. - skip: 0, # Integer | The offset into the records to return. x_org_id: "" # String | + skip: 0, # Integer | The offset into the records to return. + filter: ["filter_example"], # Array | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in } begin @@ -684,8 +685,9 @@ Name | Type | Description | Notes **content_type** | **String**| | [default to application/json] **accept** | **String**| | [default to application/json] **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] **x_org_id** | **String**| | [optional] [default to ] + **skip** | **Integer**| The offset into the records to return. | [optional] [default to 0] + **filter** | [**Array<String>**](String.md)| Supported operators are: eq, ne, gt, ge, lt, le, between, search, in | [optional] ### Return type @@ -707,7 +709,7 @@ Name | Type | Description | Notes List the System Groups bound to a User -This endpoint will return all System Groups bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systemgroups\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all System Groups bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systemgroups\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -770,8 +772,8 @@ Name | Type | Description | Notes -# **user_send_emails** -> user_send_emails(user_id, content_type, accept, opts) +# **users_send_emails** +> users_send_emails(user_id, content_type, accept, opts) Send User Emails @@ -804,9 +806,9 @@ opts = { begin #Send User Emails - api_instance.user_send_emails(user_id, content_type, accept, opts) + api_instance.users_send_emails(user_id, content_type, accept, opts) rescue JCAPIv2::ApiError => e - puts "Exception when calling UsersApi->user_send_emails: #{e}" + puts "Exception when calling UsersApi->users_send_emails: #{e}" end ``` diff --git a/jcapiv2/docs/WorkdayImportApi.md b/jcapiv2/docs/WorkdayImportApi.md index 6da46d5..fcc049c 100644 --- a/jcapiv2/docs/WorkdayImportApi.md +++ b/jcapiv2/docs/WorkdayImportApi.md @@ -150,7 +150,7 @@ nil (empty response body) Delete Workday -This endpoint allows you to delete an instance of Workday. **This functionality is currently not enable for users.** +This endpoint allows you to delete an instance of Workday. **This functionality is currently not enable for users.** ### Example ```ruby @@ -486,7 +486,7 @@ Name | Type | Description | Notes Create new Workday -This endpoint allows you to create a new workday instance. You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. Failure to provide these credentials will result in the request being rejected. Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. Currently, only one instance is allowed and it must be `Workday Import`. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/workdays/ \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"name\": \"Workday2\", \"reportUrl\":\"https://workday.com/ccx/service/customreport2/gms/user/reportname?format=json\", \"auth\": { \"basic\": { \"username\": \"someDeveloper\", \"password\": \"notTheRealPassword\" } } }' ``` +This endpoint allows you to create a new workday instance. You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. Failure to provide these credentials will result in the request being rejected. Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. Currently, only one instance is allowed and it must be `Workday Import`. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/workdays/ \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"name\": \"Workday2\", \"reportUrl\":\"https://workday.com/ccx/service/customreport2/gms/user/reportname?format=json\", \"auth\": { \"basic\": { \"username\": \"someDeveloper\", \"password\": \"notTheRealPassword\" } } }' ``` ### Example ```ruby @@ -614,7 +614,7 @@ Name | Type | Description | Notes Get Workday Settings (incomplete) -This endpoint allows you to obtain all settings needed for creating a workday instance, specifically the URL to initiate Basic Authentication with WorkDay. **This functionality is currently not enable for users.** +This endpoint allows you to obtain all settings needed for creating a workday instance, specifically the URL to initiate Basic Authentication with WorkDay. **This functionality is currently not enable for users.** ### Example ```ruby @@ -676,7 +676,7 @@ nil (empty response body) List Workday Workers -This endpoint will return all of the data in your WorkDay Custom Report that has been associated with your WorkDay Instance in JumpCloud. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/workers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return all of the data in your WorkDay Custom Report that has been associated with your WorkDay Instance in JumpCloud. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/workers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby diff --git a/jcapiv2/lib/jcapiv2.rb b/jcapiv2/lib/jcapiv2.rb index 4a378e6..8379eb5 100644 --- a/jcapiv2/lib/jcapiv2.rb +++ b/jcapiv2/lib/jcapiv2.rb @@ -24,10 +24,14 @@ require 'jcapiv2/models/authinput_basic' require 'jcapiv2/models/authinput_oauth' require 'jcapiv2/models/bulk_user_create' +require 'jcapiv2/models/bulk_user_update' require 'jcapiv2/models/directory' require 'jcapiv2/models/emailrequest' require 'jcapiv2/models/error' require 'jcapiv2/models/errorresponse' +require 'jcapiv2/models/g_suite_builtin_translation' +require 'jcapiv2/models/g_suite_translation_rule' +require 'jcapiv2/models/g_suite_translation_rule_request' require 'jcapiv2/models/graph_connection' require 'jcapiv2/models/graph_management_req' require 'jcapiv2/models/graph_object' @@ -35,11 +39,16 @@ require 'jcapiv2/models/graph_type' require 'jcapiv2/models/group' require 'jcapiv2/models/group_type' +require 'jcapiv2/models/inline_response_201' +require 'jcapiv2/models/inline_response_201_1' require 'jcapiv2/models/job_details' require 'jcapiv2/models/job_id' require 'jcapiv2/models/job_workresult' require 'jcapiv2/models/ldap_server_input' require 'jcapiv2/models/oauth_code_input' +require 'jcapiv2/models/office365_builtin_translation' +require 'jcapiv2/models/office365_translation_rule' +require 'jcapiv2/models/office365_translation_rule_request' require 'jcapiv2/models/policy' require 'jcapiv2/models/policy_request' require 'jcapiv2/models/policy_request_template' diff --git a/jcapiv2/lib/jcapiv2/api/applications_api.rb b/jcapiv2/lib/jcapiv2/api/applications_api.rb index ae5604e..75ef44f 100644 --- a/jcapiv2/lib/jcapiv2/api/applications_api.rb +++ b/jcapiv2/lib/jcapiv2/api/applications_api.rb @@ -179,7 +179,7 @@ def graph_application_associations_post_with_http_info(application_id, content_t end # List the Users bound to an Application - # This endpoint will return all Users bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Users bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param application_id ObjectID of the Application. # @param content_type # @param accept @@ -194,7 +194,7 @@ def graph_application_traverse_user(application_id, content_type, accept, opts = end # List the Users bound to an Application - # This endpoint will return all Users bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Users bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param application_id ObjectID of the Application. # @param content_type # @param accept diff --git a/jcapiv2/lib/jcapiv2/api/bulk_job_requests_api.rb b/jcapiv2/lib/jcapiv2/api/bulk_job_requests_api.rb index 94b6cb8..110e8b2 100644 --- a/jcapiv2/lib/jcapiv2/api/bulk_job_requests_api.rb +++ b/jcapiv2/lib/jcapiv2/api/bulk_job_requests_api.rb @@ -88,8 +88,8 @@ def bulk_users_create_with_http_info(content_type, accept, opts = {}) return data, status_code, headers end - # List Bulk Users Create Results - # This endpoint will return the results of particular import job request. ###Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # List Bulk Users Results + # This endpoint will return the results of particular user import or update job request. ###Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param job_id # @param content_type # @param accept @@ -103,8 +103,8 @@ def bulk_users_create_results(job_id, content_type, accept, opts = {}) return data end - # List Bulk Users Create Results - # This endpoint will return the results of particular import job request. ###Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # List Bulk Users Results + # This endpoint will return the results of particular user import or update job request. ###Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param job_id # @param content_type # @param accept @@ -166,6 +166,74 @@ def bulk_users_create_results_with_http_info(job_id, content_type, accept, opts return data, status_code, headers end + # Bulk Users Update + # The endpoint allows you to create a bulk job to asynchronously update users. #### Sample Request ``` curl -X PATCH https://console.jumpcloud.com/api/v2/bulk/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '[ { \"id\":\"5be9fb4ddb01290001e85109\", \"firstname\":\"{UPDATED_FIRSTNAME}\", \"department\":\"{UPDATED_DEPARTMENT}\", \"attributes\":[ {\"name\":\"Custom\",\"value\":\"{ATTRIBUTE_VALUE}\"} ] }, { \"id\":\"5be9fb4ddb01290001e85109\", \"firstname\":\"{UPDATED_FIRSTNAME}\", \"costCenter\":\"{UPDATED_COST_CENTER}\", \"phoneNumbers\":[ {\"type\":\"home\",\"number\":\"{HOME_PHONE_NUMBER}\"}, {\"type\":\"work\",\"number\":\"{WORK_PHONE_NUMBER}\"} ] } ] ``` + # @param content_type + # @param accept + # @param [Hash] opts the optional parameters + # @option opts [Array] :body + # @option opts [String] :x_org_id (default to ) + # @return [JobId] + def bulk_users_update(content_type, accept, opts = {}) + data, _status_code, _headers = bulk_users_update_with_http_info(content_type, accept, opts) + return data + end + + # Bulk Users Update + # The endpoint allows you to create a bulk job to asynchronously update users. #### Sample Request ``` curl -X PATCH https://console.jumpcloud.com/api/v2/bulk/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '[ { \"id\":\"5be9fb4ddb01290001e85109\", \"firstname\":\"{UPDATED_FIRSTNAME}\", \"department\":\"{UPDATED_DEPARTMENT}\", \"attributes\":[ {\"name\":\"Custom\",\"value\":\"{ATTRIBUTE_VALUE}\"} ] }, { \"id\":\"5be9fb4ddb01290001e85109\", \"firstname\":\"{UPDATED_FIRSTNAME}\", \"costCenter\":\"{UPDATED_COST_CENTER}\", \"phoneNumbers\":[ {\"type\":\"home\",\"number\":\"{HOME_PHONE_NUMBER}\"}, {\"type\":\"work\",\"number\":\"{WORK_PHONE_NUMBER}\"} ] } ] ``` + # @param content_type + # @param accept + # @param [Hash] opts the optional parameters + # @option opts [Array] :body + # @option opts [String] :x_org_id + # @return [Array<(JobId, Fixnum, Hash)>] JobId data, response status code and response headers + def bulk_users_update_with_http_info(content_type, accept, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug "Calling API: BulkJobRequestsApi.bulk_users_update ..." + end + # verify the required parameter 'content_type' is set + if @api_client.config.client_side_validation && content_type.nil? + fail ArgumentError, "Missing the required parameter 'content_type' when calling BulkJobRequestsApi.bulk_users_update" + end + # verify the required parameter 'accept' is set + if @api_client.config.client_side_validation && accept.nil? + fail ArgumentError, "Missing the required parameter 'accept' when calling BulkJobRequestsApi.bulk_users_update" + end + # resource path + local_var_path = "/bulk/users" + + # query parameters + query_params = {} + + # header parameters + header_params = {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + header_params[:'Content-Type'] = content_type + header_params[:'Accept'] = accept + header_params[:'x-org-id'] = opts[:'x_org_id'] if !opts[:'x_org_id'].nil? + + # form parameters + form_params = {} + + # http body (model) + post_body = @api_client.object_to_http_body(opts[:'body']) + auth_names = ['x-api-key'] + data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => 'JobId') + if @api_client.config.debugging + @api_client.config.logger.debug "API called: BulkJobRequestsApi#bulk_users_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + # Get Job (incomplete) # **This endpoint is not complete and should remain hidden as it's not functional yet.** # @param id @@ -239,7 +307,7 @@ def jobs_get_with_http_info(id, content_type, accept, opts = {}) end # List Job Results - # This endpoint will return the results of particular import job request. ###Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/jobs/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return the results of particular import job request. ###Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/jobs/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param id # @param content_type # @param accept @@ -254,7 +322,7 @@ def jobs_results(id, content_type, accept, opts = {}) end # List Job Results - # This endpoint will return the results of particular import job request. ###Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/jobs/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return the results of particular import job request. ###Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/jobs/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param id # @param content_type # @param accept diff --git a/jcapiv2/lib/jcapiv2/api/g_suite_api.rb b/jcapiv2/lib/jcapiv2/api/g_suite_api.rb index 60b26a1..256567d 100644 --- a/jcapiv2/lib/jcapiv2/api/g_suite_api.rb +++ b/jcapiv2/lib/jcapiv2/api/g_suite_api.rb @@ -319,5 +319,309 @@ def graph_g_suite_traverse_user_group_with_http_info(gsuite_id, content_type, ac end return data, status_code, headers end + + # Deletes a G Suite translation rule + # This endpoint allows you to delete a translation rule for a specific G Suite instance. These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. #### Sample Request ``` curl -X DELETE https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # @param gsuite_id + # @param id + # @param content_type + # @param accept + # @param [Hash] opts the optional parameters + # @return [nil] + def translation_rules_g_suite_delete(gsuite_id, id, content_type, accept, opts = {}) + translation_rules_g_suite_delete_with_http_info(gsuite_id, id, content_type, accept, opts) + return nil + end + + # Deletes a G Suite translation rule + # This endpoint allows you to delete a translation rule for a specific G Suite instance. These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. #### Sample Request ``` curl -X DELETE https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # @param gsuite_id + # @param id + # @param content_type + # @param accept + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers + def translation_rules_g_suite_delete_with_http_info(gsuite_id, id, content_type, accept, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug "Calling API: GSuiteApi.translation_rules_g_suite_delete ..." + end + # verify the required parameter 'gsuite_id' is set + if @api_client.config.client_side_validation && gsuite_id.nil? + fail ArgumentError, "Missing the required parameter 'gsuite_id' when calling GSuiteApi.translation_rules_g_suite_delete" + end + # verify the required parameter 'id' is set + if @api_client.config.client_side_validation && id.nil? + fail ArgumentError, "Missing the required parameter 'id' when calling GSuiteApi.translation_rules_g_suite_delete" + end + # verify the required parameter 'content_type' is set + if @api_client.config.client_side_validation && content_type.nil? + fail ArgumentError, "Missing the required parameter 'content_type' when calling GSuiteApi.translation_rules_g_suite_delete" + end + # verify the required parameter 'accept' is set + if @api_client.config.client_side_validation && accept.nil? + fail ArgumentError, "Missing the required parameter 'accept' when calling GSuiteApi.translation_rules_g_suite_delete" + end + # resource path + local_var_path = "/gsuites/{gsuite_id}/translationrules/{id}".sub('{' + 'gsuite_id' + '}', gsuite_id.to_s).sub('{' + 'id' + '}', id.to_s) + + # query parameters + query_params = {} + + # header parameters + header_params = {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + header_params[:'Content-Type'] = content_type + header_params[:'Accept'] = accept + + # form parameters + form_params = {} + + # http body (model) + post_body = nil + auth_names = ['x-api-key'] + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: GSuiteApi#translation_rules_g_suite_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Gets a specific g suite translation rule + # This endpoint returns a specific translation rule for a specific G Suite instance. These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. ###### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # @param gsuite_id + # @param id + # @param content_type + # @param accept + # @param [Hash] opts the optional parameters + # @return [GSuiteTranslationRule] + def translation_rules_g_suite_get(gsuite_id, id, content_type, accept, opts = {}) + data, _status_code, _headers = translation_rules_g_suite_get_with_http_info(gsuite_id, id, content_type, accept, opts) + return data + end + + # Gets a specific g suite translation rule + # This endpoint returns a specific translation rule for a specific G Suite instance. These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. ###### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # @param gsuite_id + # @param id + # @param content_type + # @param accept + # @param [Hash] opts the optional parameters + # @return [Array<(GSuiteTranslationRule, Fixnum, Hash)>] GSuiteTranslationRule data, response status code and response headers + def translation_rules_g_suite_get_with_http_info(gsuite_id, id, content_type, accept, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug "Calling API: GSuiteApi.translation_rules_g_suite_get ..." + end + # verify the required parameter 'gsuite_id' is set + if @api_client.config.client_side_validation && gsuite_id.nil? + fail ArgumentError, "Missing the required parameter 'gsuite_id' when calling GSuiteApi.translation_rules_g_suite_get" + end + # verify the required parameter 'id' is set + if @api_client.config.client_side_validation && id.nil? + fail ArgumentError, "Missing the required parameter 'id' when calling GSuiteApi.translation_rules_g_suite_get" + end + # verify the required parameter 'content_type' is set + if @api_client.config.client_side_validation && content_type.nil? + fail ArgumentError, "Missing the required parameter 'content_type' when calling GSuiteApi.translation_rules_g_suite_get" + end + # verify the required parameter 'accept' is set + if @api_client.config.client_side_validation && accept.nil? + fail ArgumentError, "Missing the required parameter 'accept' when calling GSuiteApi.translation_rules_g_suite_get" + end + # resource path + local_var_path = "/gsuites/{gsuite_id}/translationrules/{id}".sub('{' + 'gsuite_id' + '}', gsuite_id.to_s).sub('{' + 'id' + '}', id.to_s) + + # query parameters + query_params = {} + + # header parameters + header_params = {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + header_params[:'Content-Type'] = content_type + header_params[:'Accept'] = accept + + # form parameters + form_params = {} + + # http body (model) + post_body = nil + auth_names = ['x-api-key'] + data, status_code, headers = @api_client.call_api(:GET, local_var_path, + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => 'GSuiteTranslationRule') + if @api_client.config.debugging + @api_client.config.logger.debug "API called: GSuiteApi#translation_rules_g_suite_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # List all the G Suite Translation Rules + # This endpoint returns all graph translation rules for a specific G Suite instance. These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # @param gsuite_id + # @param content_type + # @param accept + # @param [Hash] opts the optional parameters + # @option opts [Array] :fields The comma separated fields included in the returned records. If omitted the default list of fields will be returned. + # @option opts [Array] :filter Supported operators are: eq, ne, gt, ge, lt, le, between, search, in + # @option opts [Integer] :limit The number of records to return at once. Limited to 100. (default to 10) + # @option opts [Integer] :skip The offset into the records to return. (default to 0) + # @option opts [Array] :sort The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. + # @return [Array] + def translation_rules_g_suite_list(gsuite_id, content_type, accept, opts = {}) + data, _status_code, _headers = translation_rules_g_suite_list_with_http_info(gsuite_id, content_type, accept, opts) + return data + end + + # List all the G Suite Translation Rules + # This endpoint returns all graph translation rules for a specific G Suite instance. These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # @param gsuite_id + # @param content_type + # @param accept + # @param [Hash] opts the optional parameters + # @option opts [Array] :fields The comma separated fields included in the returned records. If omitted the default list of fields will be returned. + # @option opts [Array] :filter Supported operators are: eq, ne, gt, ge, lt, le, between, search, in + # @option opts [Integer] :limit The number of records to return at once. Limited to 100. + # @option opts [Integer] :skip The offset into the records to return. + # @option opts [Array] :sort The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. + # @return [Array<(Array, Fixnum, Hash)>] Array data, response status code and response headers + def translation_rules_g_suite_list_with_http_info(gsuite_id, content_type, accept, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug "Calling API: GSuiteApi.translation_rules_g_suite_list ..." + end + # verify the required parameter 'gsuite_id' is set + if @api_client.config.client_side_validation && gsuite_id.nil? + fail ArgumentError, "Missing the required parameter 'gsuite_id' when calling GSuiteApi.translation_rules_g_suite_list" + end + # verify the required parameter 'content_type' is set + if @api_client.config.client_side_validation && content_type.nil? + fail ArgumentError, "Missing the required parameter 'content_type' when calling GSuiteApi.translation_rules_g_suite_list" + end + # verify the required parameter 'accept' is set + if @api_client.config.client_side_validation && accept.nil? + fail ArgumentError, "Missing the required parameter 'accept' when calling GSuiteApi.translation_rules_g_suite_list" + end + # resource path + local_var_path = "/gsuites/{gsuite_id}/translationrules".sub('{' + 'gsuite_id' + '}', gsuite_id.to_s) + + # query parameters + query_params = {} + query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil? + query_params[:'filter'] = @api_client.build_collection_param(opts[:'filter'], :csv) if !opts[:'filter'].nil? + query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? + query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? + query_params[:'sort'] = @api_client.build_collection_param(opts[:'sort'], :csv) if !opts[:'sort'].nil? + + # header parameters + header_params = {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + header_params[:'Content-Type'] = content_type + header_params[:'Accept'] = accept + + # form parameters + form_params = {} + + # http body (model) + post_body = nil + auth_names = ['x-api-key'] + data, status_code, headers = @api_client.call_api(:GET, local_var_path, + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => 'Array') + if @api_client.config.debugging + @api_client.config.logger.debug "API called: GSuiteApi#translation_rules_g_suite_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Create a new G Suite Translation Rule + # This endpoint allows you to create a translation rule for a specific G Suite instance. These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. ##### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ {Translation Rule Parameters} }' ``` + # @param gsuite_id + # @param content_type + # @param accept + # @param [Hash] opts the optional parameters + # @option opts [GSuiteTranslationRuleRequest] :body + # @return [InlineResponse201] + def translation_rules_g_suite_post(gsuite_id, content_type, accept, opts = {}) + data, _status_code, _headers = translation_rules_g_suite_post_with_http_info(gsuite_id, content_type, accept, opts) + return data + end + + # Create a new G Suite Translation Rule + # This endpoint allows you to create a translation rule for a specific G Suite instance. These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. ##### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ {Translation Rule Parameters} }' ``` + # @param gsuite_id + # @param content_type + # @param accept + # @param [Hash] opts the optional parameters + # @option opts [GSuiteTranslationRuleRequest] :body + # @return [Array<(InlineResponse201, Fixnum, Hash)>] InlineResponse201 data, response status code and response headers + def translation_rules_g_suite_post_with_http_info(gsuite_id, content_type, accept, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug "Calling API: GSuiteApi.translation_rules_g_suite_post ..." + end + # verify the required parameter 'gsuite_id' is set + if @api_client.config.client_side_validation && gsuite_id.nil? + fail ArgumentError, "Missing the required parameter 'gsuite_id' when calling GSuiteApi.translation_rules_g_suite_post" + end + # verify the required parameter 'content_type' is set + if @api_client.config.client_side_validation && content_type.nil? + fail ArgumentError, "Missing the required parameter 'content_type' when calling GSuiteApi.translation_rules_g_suite_post" + end + # verify the required parameter 'accept' is set + if @api_client.config.client_side_validation && accept.nil? + fail ArgumentError, "Missing the required parameter 'accept' when calling GSuiteApi.translation_rules_g_suite_post" + end + # resource path + local_var_path = "/gsuites/{gsuite_id}/translationrules".sub('{' + 'gsuite_id' + '}', gsuite_id.to_s) + + # query parameters + query_params = {} + + # header parameters + header_params = {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + header_params[:'Content-Type'] = content_type + header_params[:'Accept'] = accept + + # form parameters + form_params = {} + + # http body (model) + post_body = @api_client.object_to_http_body(opts[:'body']) + auth_names = ['x-api-key'] + data, status_code, headers = @api_client.call_api(:POST, local_var_path, + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => 'InlineResponse201') + if @api_client.config.debugging + @api_client.config.logger.debug "API called: GSuiteApi#translation_rules_g_suite_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end end end diff --git a/jcapiv2/lib/jcapiv2/api/graph_api.rb b/jcapiv2/lib/jcapiv2/api/graph_api.rb index fa1b0f5..5c2010e 100644 --- a/jcapiv2/lib/jcapiv2/api/graph_api.rb +++ b/jcapiv2/lib/jcapiv2/api/graph_api.rb @@ -415,7 +415,7 @@ def graph_application_associations_post_with_http_info(application_id, content_t end # List the Users bound to an Application - # This endpoint will return all Users bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Users bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param application_id ObjectID of the Application. # @param content_type # @param accept @@ -430,7 +430,7 @@ def graph_application_traverse_user(application_id, content_type, accept, opts = end # List the Users bound to an Application - # This endpoint will return all Users bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Users bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param application_id ObjectID of the Application. # @param content_type # @param accept @@ -1971,7 +1971,7 @@ def graph_policy_associations_post_with_http_info(policy_id, content_type, accep end # List the Systems bound to a Policy - # This endpoint will return all Systems bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Policy to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Systems bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Policy to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param policy_id ObjectID of the Command. # @param content_type # @param accept @@ -1986,7 +1986,7 @@ def graph_policy_traverse_system(policy_id, content_type, accept, opts = {}) end # List the Systems bound to a Policy - # This endpoint will return all Systems bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Policy to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Systems bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Policy to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param policy_id ObjectID of the Command. # @param content_type # @param accept @@ -2285,7 +2285,7 @@ def graph_radius_server_associations_post_with_http_info(radiusserver_id, conten end # List the Users bound to a RADIUS Server - # This endpoint will return all Users bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Users bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param radiusserver_id ObjectID of the Radius Server. # @param content_type # @param accept @@ -2300,7 +2300,7 @@ def graph_radius_server_traverse_user(radiusserver_id, content_type, accept, opt end # List the Users bound to a RADIUS Server - # This endpoint will return all Users bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Users bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param radiusserver_id ObjectID of the Radius Server. # @param content_type # @param accept @@ -2363,7 +2363,7 @@ def graph_radius_server_traverse_user_with_http_info(radiusserver_id, content_ty end # List the User Groups bound to a RADIUS Server - # This endpoint will return all Users Groups bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Users Groups bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param radiusserver_id ObjectID of the Radius Server. # @param content_type # @param accept @@ -2378,7 +2378,7 @@ def graph_radius_server_traverse_user_group(radiusserver_id, content_type, accep end # List the User Groups bound to a RADIUS Server - # This endpoint will return all Users Groups bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Users Groups bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param radiusserver_id ObjectID of the Radius Server. # @param content_type # @param accept @@ -2532,7 +2532,7 @@ def graph_system_associations_list_with_http_info(system_id, content_type, accep end # Manage associations of a System - # This endpoint allows you to manage the _direct_ associations of a System. A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"user\", \"id\": \"UserID\" }' ``` + # This endpoint allows you to manage the _direct_ associations of a System. A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"user\", \"id\": \"UserID\" }' ``` # @param system_id ObjectID of the System. # @param content_type # @param accept @@ -2548,7 +2548,7 @@ def graph_system_associations_post(system_id, content_type, accept, opts = {}) end # Manage associations of a System - # This endpoint allows you to manage the _direct_ associations of a System. A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"user\", \"id\": \"UserID\" }' ``` + # This endpoint allows you to manage the _direct_ associations of a System. A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"user\", \"id\": \"UserID\" }' ``` # @param system_id ObjectID of the System. # @param content_type # @param accept @@ -3574,7 +3574,7 @@ def graph_system_traverse_command_with_http_info(system_id, content_type, accept end # List the Policies bound to a System - # This endpoint will return all Policies bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System. See `/members` and `/associations` endpoints to manage those collections. This endpoint is not yet public as we have finish the code. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/{System_ID}/policies \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Policies bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System. See `/members` and `/associations` endpoints to manage those collections. This endpoint is not yet public as we have finish the code. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/{System_ID}/policies \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param system_id ObjectID of the System. # @param content_type # @param accept @@ -3589,7 +3589,7 @@ def graph_system_traverse_policy(system_id, content_type, accept, opts = {}) end # List the Policies bound to a System - # This endpoint will return all Policies bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System. See `/members` and `/associations` endpoints to manage those collections. This endpoint is not yet public as we have finish the code. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/{System_ID}/policies \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Policies bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System. See `/members` and `/associations` endpoints to manage those collections. This endpoint is not yet public as we have finish the code. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/{System_ID}/policies \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param system_id ObjectID of the System. # @param content_type # @param accept @@ -3652,16 +3652,17 @@ def graph_system_traverse_policy_with_http_info(system_id, content_type, accept, end # List the Users bound to a System - # This endpoint will return all Users bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Users bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param system_id ObjectID of the System. # @param content_type # @param accept # @param [Hash] opts the optional parameters # @option opts [Integer] :limit The number of records to return at once. Limited to 100. (default to 10) + # @option opts [String] :x_org_id (default to ) # @option opts [Integer] :skip The offset into the records to return. (default to 0) # @option opts [String] :date Current date header for the System Context API # @option opts [String] :authorization Authorization header for the System Context API - # @option opts [String] :x_org_id (default to ) + # @option opts [Array] :filter Supported operators are: eq, ne, gt, ge, lt, le, between, search, in # @return [Array] def graph_system_traverse_user(system_id, content_type, accept, opts = {}) data, _status_code, _headers = graph_system_traverse_user_with_http_info(system_id, content_type, accept, opts) @@ -3669,16 +3670,17 @@ def graph_system_traverse_user(system_id, content_type, accept, opts = {}) end # List the Users bound to a System - # This endpoint will return all Users bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Users bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param system_id ObjectID of the System. # @param content_type # @param accept # @param [Hash] opts the optional parameters # @option opts [Integer] :limit The number of records to return at once. Limited to 100. + # @option opts [String] :x_org_id # @option opts [Integer] :skip The offset into the records to return. # @option opts [String] :date Current date header for the System Context API # @option opts [String] :authorization Authorization header for the System Context API - # @option opts [String] :x_org_id + # @option opts [Array] :filter Supported operators are: eq, ne, gt, ge, lt, le, between, search, in # @return [Array<(Array, Fixnum, Hash)>] Array data, response status code and response headers def graph_system_traverse_user_with_http_info(system_id, content_type, accept, opts = {}) if @api_client.config.debugging @@ -3703,6 +3705,7 @@ def graph_system_traverse_user_with_http_info(system_id, content_type, accept, o query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? + query_params[:'filter'] = @api_client.build_collection_param(opts[:'filter'], :csv) if !opts[:'filter'].nil? # header parameters header_params = {} @@ -3712,9 +3715,9 @@ def graph_system_traverse_user_with_http_info(system_id, content_type, accept, o header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Content-Type'] = content_type header_params[:'Accept'] = accept + header_params[:'x-org-id'] = opts[:'x_org_id'] if !opts[:'x_org_id'].nil? header_params[:'Date'] = opts[:'date'] if !opts[:'date'].nil? header_params[:'Authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil? - header_params[:'x-org-id'] = opts[:'x_org_id'] if !opts[:'x_org_id'].nil? # form parameters form_params = {} @@ -3736,7 +3739,7 @@ def graph_system_traverse_user_with_http_info(system_id, content_type, accept, o end # List the User Groups bound to a System - # This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param system_id ObjectID of the System. # @param content_type # @param accept @@ -3753,7 +3756,7 @@ def graph_system_traverse_user_group(system_id, content_type, accept, opts = {}) end # List the User Groups bound to a System - # This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param system_id ObjectID of the System. # @param content_type # @param accept @@ -3905,7 +3908,7 @@ def graph_user_associations_list_with_http_info(user_id, content_type, accept, t end # Manage the associations of a User - # This endpoint allows you to manage the _direct_ associations of a User. A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"system_group\", \"id\": \"{GroupID}\" }' + # This endpoint allows you to manage the _direct_ associations of a User. A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"system_group\", \"id\": \"{GroupID}\" }' # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -3919,7 +3922,7 @@ def graph_user_associations_post(user_id, content_type, accept, opts = {}) end # Manage the associations of a User - # This endpoint allows you to manage the _direct_ associations of a User. A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"system_group\", \"id\": \"{GroupID}\" }' + # This endpoint allows you to manage the _direct_ associations of a User. A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"system_group\", \"id\": \"{GroupID}\" }' # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -4455,7 +4458,7 @@ def graph_user_group_membership_with_http_info(group_id, content_type, accept, o end # List the Active Directories bound to a User Group - # This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -4470,7 +4473,7 @@ def graph_user_group_traverse_active_directory(group_id, content_type, accept, o end # List the Active Directories bound to a User Group - # This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -4923,7 +4926,7 @@ def graph_user_group_traverse_office365_with_http_info(group_id, content_type, a end # List the RADIUS Servers bound to a User Group - # This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -4938,7 +4941,7 @@ def graph_user_group_traverse_radius_server(group_id, content_type, accept, opts end # List the RADIUS Servers bound to a User Group - # This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -5001,7 +5004,7 @@ def graph_user_group_traverse_radius_server_with_http_info(group_id, content_typ end # List the Systems bound to a User Group - # This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -5016,7 +5019,7 @@ def graph_user_group_traverse_system(group_id, content_type, accept, opts = {}) end # List the Systems bound to a User Group - # This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -5079,7 +5082,7 @@ def graph_user_group_traverse_system_with_http_info(group_id, content_type, acce end # List the System Groups bound to User Groups - # This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -5094,7 +5097,7 @@ def graph_user_group_traverse_system_group(group_id, content_type, accept, opts end # List the System Groups bound to User Groups - # This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -5241,7 +5244,7 @@ def graph_user_member_of_with_http_info(user_id, content_type, accept, opts = {} end # List the Applications bound to a User - # This endpoint will return all Applications bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/applications \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Applications bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/applications \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -5256,7 +5259,7 @@ def graph_user_traverse_application(user_id, content_type, accept, opts = {}) end # List the Applications bound to a User - # This endpoint will return all Applications bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/applications \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Applications bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/applications \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -5319,7 +5322,7 @@ def graph_user_traverse_application_with_http_info(user_id, content_type, accept end # List the Directories bound to a User - # This endpoint will return all Directories bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/directories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Directories bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/directories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -5334,7 +5337,7 @@ def graph_user_traverse_directory(user_id, content_type, accept, opts = {}) end # List the Directories bound to a User - # This endpoint will return all Directories bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/directories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Directories bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/directories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -5397,7 +5400,7 @@ def graph_user_traverse_directory_with_http_info(user_id, content_type, accept, end # List the G Suite instances bound to a User - # This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -5412,7 +5415,7 @@ def graph_user_traverse_g_suite(user_id, content_type, accept, opts = {}) end # List the G Suite instances bound to a User - # This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -5475,7 +5478,7 @@ def graph_user_traverse_g_suite_with_http_info(user_id, content_type, accept, op end # List the LDAP servers bound to a User - # This endpoint will return all LDAP Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/ldapservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all LDAP Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/ldapservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -5490,7 +5493,7 @@ def graph_user_traverse_ldap_server(user_id, content_type, accept, opts = {}) end # List the LDAP servers bound to a User - # This endpoint will return all LDAP Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/ldapservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all LDAP Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/ldapservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -5553,7 +5556,7 @@ def graph_user_traverse_ldap_server_with_http_info(user_id, content_type, accept end # List the Office 365 instances bound to a User - # This endpoint will return all Office 365 Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/office365s \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Office 365 Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/office365s \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -5568,7 +5571,7 @@ def graph_user_traverse_office365(user_id, content_type, accept, opts = {}) end # List the Office 365 instances bound to a User - # This endpoint will return all Office 365 Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/office365s \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Office 365 Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/office365s \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -5631,7 +5634,7 @@ def graph_user_traverse_office365_with_http_info(user_id, content_type, accept, end # List the RADIUS Servers bound to a User - # This endpoint will return all RADIUS Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all RADIUS Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -5646,7 +5649,7 @@ def graph_user_traverse_radius_server(user_id, content_type, accept, opts = {}) end # List the RADIUS Servers bound to a User - # This endpoint will return all RADIUS Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all RADIUS Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -5709,14 +5712,15 @@ def graph_user_traverse_radius_server_with_http_info(user_id, content_type, acce end # List the Systems bound to a User - # This endpoint will return all Systems bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systems\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Systems bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systems\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept # @param [Hash] opts the optional parameters # @option opts [Integer] :limit The number of records to return at once. Limited to 100. (default to 10) - # @option opts [Integer] :skip The offset into the records to return. (default to 0) # @option opts [String] :x_org_id (default to ) + # @option opts [Integer] :skip The offset into the records to return. (default to 0) + # @option opts [Array] :filter Supported operators are: eq, ne, gt, ge, lt, le, between, search, in # @return [Array] def graph_user_traverse_system(user_id, content_type, accept, opts = {}) data, _status_code, _headers = graph_user_traverse_system_with_http_info(user_id, content_type, accept, opts) @@ -5724,14 +5728,15 @@ def graph_user_traverse_system(user_id, content_type, accept, opts = {}) end # List the Systems bound to a User - # This endpoint will return all Systems bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systems\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Systems bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systems\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept # @param [Hash] opts the optional parameters # @option opts [Integer] :limit The number of records to return at once. Limited to 100. - # @option opts [Integer] :skip The offset into the records to return. # @option opts [String] :x_org_id + # @option opts [Integer] :skip The offset into the records to return. + # @option opts [Array] :filter Supported operators are: eq, ne, gt, ge, lt, le, between, search, in # @return [Array<(Array, Fixnum, Hash)>] Array data, response status code and response headers def graph_user_traverse_system_with_http_info(user_id, content_type, accept, opts = {}) if @api_client.config.debugging @@ -5756,6 +5761,7 @@ def graph_user_traverse_system_with_http_info(user_id, content_type, accept, opt query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? + query_params[:'filter'] = @api_client.build_collection_param(opts[:'filter'], :csv) if !opts[:'filter'].nil? # header parameters header_params = {} @@ -5787,7 +5793,7 @@ def graph_user_traverse_system_with_http_info(user_id, content_type, accept, opt end # List the System Groups bound to a User - # This endpoint will return all System Groups bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systemgroups\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all System Groups bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systemgroups\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -5802,7 +5808,7 @@ def graph_user_traverse_system_group(user_id, content_type, accept, opts = {}) end # List the System Groups bound to a User - # This endpoint will return all System Groups bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systemgroups\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all System Groups bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systemgroups\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept diff --git a/jcapiv2/lib/jcapiv2/api/office365_api.rb b/jcapiv2/lib/jcapiv2/api/office365_api.rb index d10cbed..a2519f8 100644 --- a/jcapiv2/lib/jcapiv2/api/office365_api.rb +++ b/jcapiv2/lib/jcapiv2/api/office365_api.rb @@ -333,5 +333,309 @@ def graph_office365_traverse_user_group_with_http_info(office365_id, content_typ end return data, status_code, headers end + + # Deletes a Office 365 translation rule + # This endpoint allows you to delete a translation rule for a specific Office 365 instance. These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. #### Sample Request ``` curl -X DELETE https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # @param office365_id + # @param id + # @param content_type + # @param accept + # @param [Hash] opts the optional parameters + # @return [nil] + def translation_rules_office365_delete(office365_id, id, content_type, accept, opts = {}) + translation_rules_office365_delete_with_http_info(office365_id, id, content_type, accept, opts) + return nil + end + + # Deletes a Office 365 translation rule + # This endpoint allows you to delete a translation rule for a specific Office 365 instance. These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. #### Sample Request ``` curl -X DELETE https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # @param office365_id + # @param id + # @param content_type + # @param accept + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers + def translation_rules_office365_delete_with_http_info(office365_id, id, content_type, accept, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug "Calling API: Office365Api.translation_rules_office365_delete ..." + end + # verify the required parameter 'office365_id' is set + if @api_client.config.client_side_validation && office365_id.nil? + fail ArgumentError, "Missing the required parameter 'office365_id' when calling Office365Api.translation_rules_office365_delete" + end + # verify the required parameter 'id' is set + if @api_client.config.client_side_validation && id.nil? + fail ArgumentError, "Missing the required parameter 'id' when calling Office365Api.translation_rules_office365_delete" + end + # verify the required parameter 'content_type' is set + if @api_client.config.client_side_validation && content_type.nil? + fail ArgumentError, "Missing the required parameter 'content_type' when calling Office365Api.translation_rules_office365_delete" + end + # verify the required parameter 'accept' is set + if @api_client.config.client_side_validation && accept.nil? + fail ArgumentError, "Missing the required parameter 'accept' when calling Office365Api.translation_rules_office365_delete" + end + # resource path + local_var_path = "/office365s/{office365_id}/translationrules/{id}".sub('{' + 'office365_id' + '}', office365_id.to_s).sub('{' + 'id' + '}', id.to_s) + + # query parameters + query_params = {} + + # header parameters + header_params = {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + header_params[:'Content-Type'] = content_type + header_params[:'Accept'] = accept + + # form parameters + form_params = {} + + # http body (model) + post_body = nil + auth_names = ['x-api-key'] + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: Office365Api#translation_rules_office365_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Gets a specific Office 365 translation rule + # This endpoint returns a specific translation rule for a specific Office 365 instance. These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. ###### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # @param office365_id + # @param id + # @param content_type + # @param accept + # @param [Hash] opts the optional parameters + # @return [Office365TranslationRule] + def translation_rules_office365_get(office365_id, id, content_type, accept, opts = {}) + data, _status_code, _headers = translation_rules_office365_get_with_http_info(office365_id, id, content_type, accept, opts) + return data + end + + # Gets a specific Office 365 translation rule + # This endpoint returns a specific translation rule for a specific Office 365 instance. These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. ###### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # @param office365_id + # @param id + # @param content_type + # @param accept + # @param [Hash] opts the optional parameters + # @return [Array<(Office365TranslationRule, Fixnum, Hash)>] Office365TranslationRule data, response status code and response headers + def translation_rules_office365_get_with_http_info(office365_id, id, content_type, accept, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug "Calling API: Office365Api.translation_rules_office365_get ..." + end + # verify the required parameter 'office365_id' is set + if @api_client.config.client_side_validation && office365_id.nil? + fail ArgumentError, "Missing the required parameter 'office365_id' when calling Office365Api.translation_rules_office365_get" + end + # verify the required parameter 'id' is set + if @api_client.config.client_side_validation && id.nil? + fail ArgumentError, "Missing the required parameter 'id' when calling Office365Api.translation_rules_office365_get" + end + # verify the required parameter 'content_type' is set + if @api_client.config.client_side_validation && content_type.nil? + fail ArgumentError, "Missing the required parameter 'content_type' when calling Office365Api.translation_rules_office365_get" + end + # verify the required parameter 'accept' is set + if @api_client.config.client_side_validation && accept.nil? + fail ArgumentError, "Missing the required parameter 'accept' when calling Office365Api.translation_rules_office365_get" + end + # resource path + local_var_path = "/office365s/{office365_id}/translationrules/{id}".sub('{' + 'office365_id' + '}', office365_id.to_s).sub('{' + 'id' + '}', id.to_s) + + # query parameters + query_params = {} + + # header parameters + header_params = {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + header_params[:'Content-Type'] = content_type + header_params[:'Accept'] = accept + + # form parameters + form_params = {} + + # http body (model) + post_body = nil + auth_names = ['x-api-key'] + data, status_code, headers = @api_client.call_api(:GET, local_var_path, + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => 'Office365TranslationRule') + if @api_client.config.debugging + @api_client.config.logger.debug "API called: Office365Api#translation_rules_office365_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # List all the Office 365 Translation Rules + # This endpoint returns all translation rules for a specific Office 365 instance. These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # @param office365_id + # @param content_type + # @param accept + # @param [Hash] opts the optional parameters + # @option opts [Array] :fields The comma separated fields included in the returned records. If omitted the default list of fields will be returned. + # @option opts [Array] :filter Supported operators are: eq, ne, gt, ge, lt, le, between, search, in + # @option opts [Integer] :limit The number of records to return at once. Limited to 100. (default to 10) + # @option opts [Integer] :skip The offset into the records to return. (default to 0) + # @option opts [Array] :sort The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. + # @return [Array] + def translation_rules_office365_list(office365_id, content_type, accept, opts = {}) + data, _status_code, _headers = translation_rules_office365_list_with_http_info(office365_id, content_type, accept, opts) + return data + end + + # List all the Office 365 Translation Rules + # This endpoint returns all translation rules for a specific Office 365 instance. These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # @param office365_id + # @param content_type + # @param accept + # @param [Hash] opts the optional parameters + # @option opts [Array] :fields The comma separated fields included in the returned records. If omitted the default list of fields will be returned. + # @option opts [Array] :filter Supported operators are: eq, ne, gt, ge, lt, le, between, search, in + # @option opts [Integer] :limit The number of records to return at once. Limited to 100. + # @option opts [Integer] :skip The offset into the records to return. + # @option opts [Array] :sort The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. + # @return [Array<(Array, Fixnum, Hash)>] Array data, response status code and response headers + def translation_rules_office365_list_with_http_info(office365_id, content_type, accept, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug "Calling API: Office365Api.translation_rules_office365_list ..." + end + # verify the required parameter 'office365_id' is set + if @api_client.config.client_side_validation && office365_id.nil? + fail ArgumentError, "Missing the required parameter 'office365_id' when calling Office365Api.translation_rules_office365_list" + end + # verify the required parameter 'content_type' is set + if @api_client.config.client_side_validation && content_type.nil? + fail ArgumentError, "Missing the required parameter 'content_type' when calling Office365Api.translation_rules_office365_list" + end + # verify the required parameter 'accept' is set + if @api_client.config.client_side_validation && accept.nil? + fail ArgumentError, "Missing the required parameter 'accept' when calling Office365Api.translation_rules_office365_list" + end + # resource path + local_var_path = "/office365s/{office365_id}/translationrules".sub('{' + 'office365_id' + '}', office365_id.to_s) + + # query parameters + query_params = {} + query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil? + query_params[:'filter'] = @api_client.build_collection_param(opts[:'filter'], :csv) if !opts[:'filter'].nil? + query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? + query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? + query_params[:'sort'] = @api_client.build_collection_param(opts[:'sort'], :csv) if !opts[:'sort'].nil? + + # header parameters + header_params = {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + header_params[:'Content-Type'] = content_type + header_params[:'Accept'] = accept + + # form parameters + form_params = {} + + # http body (model) + post_body = nil + auth_names = ['x-api-key'] + data, status_code, headers = @api_client.call_api(:GET, local_var_path, + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => 'Array') + if @api_client.config.debugging + @api_client.config.logger.debug "API called: Office365Api#translation_rules_office365_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Create a new Office 365 Translation Rule + # This endpoint allows you to create a translation rule for a specific Office 365 instance. These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. ##### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ {Translation Rule Parameters} }' ``` + # @param office365_id + # @param content_type + # @param accept + # @param [Hash] opts the optional parameters + # @option opts [Office365TranslationRuleRequest] :body + # @return [InlineResponse2011] + def translation_rules_office365_post(office365_id, content_type, accept, opts = {}) + data, _status_code, _headers = translation_rules_office365_post_with_http_info(office365_id, content_type, accept, opts) + return data + end + + # Create a new Office 365 Translation Rule + # This endpoint allows you to create a translation rule for a specific Office 365 instance. These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. ##### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ {Translation Rule Parameters} }' ``` + # @param office365_id + # @param content_type + # @param accept + # @param [Hash] opts the optional parameters + # @option opts [Office365TranslationRuleRequest] :body + # @return [Array<(InlineResponse2011, Fixnum, Hash)>] InlineResponse2011 data, response status code and response headers + def translation_rules_office365_post_with_http_info(office365_id, content_type, accept, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug "Calling API: Office365Api.translation_rules_office365_post ..." + end + # verify the required parameter 'office365_id' is set + if @api_client.config.client_side_validation && office365_id.nil? + fail ArgumentError, "Missing the required parameter 'office365_id' when calling Office365Api.translation_rules_office365_post" + end + # verify the required parameter 'content_type' is set + if @api_client.config.client_side_validation && content_type.nil? + fail ArgumentError, "Missing the required parameter 'content_type' when calling Office365Api.translation_rules_office365_post" + end + # verify the required parameter 'accept' is set + if @api_client.config.client_side_validation && accept.nil? + fail ArgumentError, "Missing the required parameter 'accept' when calling Office365Api.translation_rules_office365_post" + end + # resource path + local_var_path = "/office365s/{office365_id}/translationrules".sub('{' + 'office365_id' + '}', office365_id.to_s) + + # query parameters + query_params = {} + + # header parameters + header_params = {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + header_params[:'Content-Type'] = content_type + header_params[:'Accept'] = accept + + # form parameters + form_params = {} + + # http body (model) + post_body = @api_client.object_to_http_body(opts[:'body']) + auth_names = ['x-api-key'] + data, status_code, headers = @api_client.call_api(:POST, local_var_path, + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => 'InlineResponse2011') + if @api_client.config.debugging + @api_client.config.logger.debug "API called: Office365Api#translation_rules_office365_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end end end diff --git a/jcapiv2/lib/jcapiv2/api/policies_api.rb b/jcapiv2/lib/jcapiv2/api/policies_api.rb index bc9b340..be775a7 100644 --- a/jcapiv2/lib/jcapiv2/api/policies_api.rb +++ b/jcapiv2/lib/jcapiv2/api/policies_api.rb @@ -179,7 +179,7 @@ def graph_policy_associations_post_with_http_info(policy_id, content_type, accep end # List the Systems bound to a Policy - # This endpoint will return all Systems bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Policy to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Systems bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Policy to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param policy_id ObjectID of the Command. # @param content_type # @param accept @@ -194,7 +194,7 @@ def graph_policy_traverse_system(policy_id, content_type, accept, opts = {}) end # List the Systems bound to a Policy - # This endpoint will return all Systems bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Policy to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Systems bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Policy to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param policy_id ObjectID of the Command. # @param content_type # @param accept @@ -559,7 +559,7 @@ def policies_list_with_http_info(content_type, accept, opts = {}) end # Create a new Policy - # This endpoint allows you to create a policy. Given the amount of configurable parameters required to create a Policy, we suggest you use the JumpCloud Admin Console to create new policies. ##### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/policies \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ {Policy_Parameters} }' ``` + # This endpoint allows you to create a policy. Given the amount of configurable parameters required to create a Policy, we suggest you use the JumpCloud Admin Console to create new policies. ##### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/policies \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ {Policy_Parameters} }' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -572,7 +572,7 @@ def policies_post(content_type, accept, opts = {}) end # Create a new Policy - # This endpoint allows you to create a policy. Given the amount of configurable parameters required to create a Policy, we suggest you use the JumpCloud Admin Console to create new policies. ##### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/policies \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ {Policy_Parameters} }' ``` + # This endpoint allows you to create a policy. Given the amount of configurable parameters required to create a Policy, we suggest you use the JumpCloud Admin Console to create new policies. ##### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/policies \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ {Policy_Parameters} }' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -759,7 +759,7 @@ def policyresults_get_with_http_info(id, content_type, accept, opts = {}) end # Lists all the policy results of a policy. - # This endpoint returns all policies results for a specific policy. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policyresults \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint returns all policies results for a specific policy. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policyresults \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param policy_id # @param content_type # @param accept @@ -778,7 +778,7 @@ def policyresults_list(policy_id, content_type, accept, opts = {}) end # Lists all the policy results of a policy. - # This endpoint returns all policies results for a specific policy. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policyresults \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint returns all policies results for a specific policy. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policyresults \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param policy_id # @param content_type # @param accept @@ -849,7 +849,7 @@ def policyresults_list_with_http_info(policy_id, content_type, accept, opts = {} end # Lists all the policy results for an organization. - # This endpoint returns all policies results for an Organization. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policyresults \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint returns all policies results for an Organization. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policyresults \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -867,7 +867,7 @@ def policyresults_list_0(content_type, accept, opts = {}) end # Lists all the policy results for an organization. - # This endpoint returns all policies results for an Organization. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policyresults \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint returns all policies results for an Organization. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policyresults \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -932,9 +932,9 @@ def policyresults_list_0_with_http_info(content_type, accept, opts = {}) return data, status_code, headers end - # List the policy statuses for a system - # This endpoint returns the policy results for a particular system. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policystatuses \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` - # @param system_id ObjectID of the System. + # Lists the latest policy results of a policy. + # This endpoint returns the latest policies results for a specific policy. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policystatuses \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # @param policy_id # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -945,14 +945,14 @@ def policyresults_list_0_with_http_info(content_type, accept, opts = {}) # @option opts [Array] :sort The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. # @option opts [String] :x_org_id (default to ) # @return [Array] - def policystatuses_list(system_id, content_type, accept, opts = {}) - data, _status_code, _headers = policystatuses_list_with_http_info(system_id, content_type, accept, opts) + def policystatuses_list(policy_id, content_type, accept, opts = {}) + data, _status_code, _headers = policystatuses_list_with_http_info(policy_id, content_type, accept, opts) return data end - # List the policy statuses for a system - # This endpoint returns the policy results for a particular system. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policystatuses \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` - # @param system_id ObjectID of the System. + # Lists the latest policy results of a policy. + # This endpoint returns the latest policies results for a specific policy. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policystatuses \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # @param policy_id # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -963,13 +963,13 @@ def policystatuses_list(system_id, content_type, accept, opts = {}) # @option opts [Array] :sort The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. # @option opts [String] :x_org_id # @return [Array<(Array, Fixnum, Hash)>] Array data, response status code and response headers - def policystatuses_list_with_http_info(system_id, content_type, accept, opts = {}) + def policystatuses_list_with_http_info(policy_id, content_type, accept, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: PoliciesApi.policystatuses_list ..." end - # verify the required parameter 'system_id' is set - if @api_client.config.client_side_validation && system_id.nil? - fail ArgumentError, "Missing the required parameter 'system_id' when calling PoliciesApi.policystatuses_list" + # verify the required parameter 'policy_id' is set + if @api_client.config.client_side_validation && policy_id.nil? + fail ArgumentError, "Missing the required parameter 'policy_id' when calling PoliciesApi.policystatuses_list" end # verify the required parameter 'content_type' is set if @api_client.config.client_side_validation && content_type.nil? @@ -980,7 +980,7 @@ def policystatuses_list_with_http_info(system_id, content_type, accept, opts = { fail ArgumentError, "Missing the required parameter 'accept' when calling PoliciesApi.policystatuses_list" end # resource path - local_var_path = "/systems/{system_id}/policystatuses".sub('{' + 'system_id' + '}', system_id.to_s) + local_var_path = "/policies/{policy_id}/policystatuses".sub('{' + 'policy_id' + '}', policy_id.to_s) # query parameters query_params = {} @@ -1019,9 +1019,9 @@ def policystatuses_list_with_http_info(system_id, content_type, accept, opts = { return data, status_code, headers end - # Lists the latest policy results of a policy. - # This endpoint returns the latest policies results for a specific policy. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policystatuses \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` - # @param policy_id + # List the policy statuses for a system + # This endpoint returns the policy results for a particular system. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policystatuses \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # @param system_id ObjectID of the System. # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -1032,14 +1032,14 @@ def policystatuses_list_with_http_info(system_id, content_type, accept, opts = { # @option opts [Array] :sort The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. # @option opts [String] :x_org_id (default to ) # @return [Array] - def policystatuses_list_0(policy_id, content_type, accept, opts = {}) - data, _status_code, _headers = policystatuses_list_0_with_http_info(policy_id, content_type, accept, opts) + def policystatuses_list_0(system_id, content_type, accept, opts = {}) + data, _status_code, _headers = policystatuses_list_0_with_http_info(system_id, content_type, accept, opts) return data end - # Lists the latest policy results of a policy. - # This endpoint returns the latest policies results for a specific policy. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policystatuses \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` - # @param policy_id + # List the policy statuses for a system + # This endpoint returns the policy results for a particular system. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policystatuses \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # @param system_id ObjectID of the System. # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -1050,13 +1050,13 @@ def policystatuses_list_0(policy_id, content_type, accept, opts = {}) # @option opts [Array] :sort The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. # @option opts [String] :x_org_id # @return [Array<(Array, Fixnum, Hash)>] Array data, response status code and response headers - def policystatuses_list_0_with_http_info(policy_id, content_type, accept, opts = {}) + def policystatuses_list_0_with_http_info(system_id, content_type, accept, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: PoliciesApi.policystatuses_list_0 ..." end - # verify the required parameter 'policy_id' is set - if @api_client.config.client_side_validation && policy_id.nil? - fail ArgumentError, "Missing the required parameter 'policy_id' when calling PoliciesApi.policystatuses_list_0" + # verify the required parameter 'system_id' is set + if @api_client.config.client_side_validation && system_id.nil? + fail ArgumentError, "Missing the required parameter 'system_id' when calling PoliciesApi.policystatuses_list_0" end # verify the required parameter 'content_type' is set if @api_client.config.client_side_validation && content_type.nil? @@ -1067,7 +1067,7 @@ def policystatuses_list_0_with_http_info(policy_id, content_type, accept, opts = fail ArgumentError, "Missing the required parameter 'accept' when calling PoliciesApi.policystatuses_list_0" end # resource path - local_var_path = "/policies/{policy_id}/policystatuses".sub('{' + 'policy_id' + '}', policy_id.to_s) + local_var_path = "/systems/{system_id}/policystatuses".sub('{' + 'system_id' + '}', system_id.to_s) # query parameters query_params = {} diff --git a/jcapiv2/lib/jcapiv2/api/radius_servers_api.rb b/jcapiv2/lib/jcapiv2/api/radius_servers_api.rb index 6c01f46..bd48e49 100644 --- a/jcapiv2/lib/jcapiv2/api/radius_servers_api.rb +++ b/jcapiv2/lib/jcapiv2/api/radius_servers_api.rb @@ -179,7 +179,7 @@ def graph_radius_server_associations_post_with_http_info(radiusserver_id, conten end # List the Users bound to a RADIUS Server - # This endpoint will return all Users bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Users bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param radiusserver_id ObjectID of the Radius Server. # @param content_type # @param accept @@ -194,7 +194,7 @@ def graph_radius_server_traverse_user(radiusserver_id, content_type, accept, opt end # List the Users bound to a RADIUS Server - # This endpoint will return all Users bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Users bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param radiusserver_id ObjectID of the Radius Server. # @param content_type # @param accept @@ -257,7 +257,7 @@ def graph_radius_server_traverse_user_with_http_info(radiusserver_id, content_ty end # List the User Groups bound to a RADIUS Server - # This endpoint will return all Users Groups bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Users Groups bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param radiusserver_id ObjectID of the Radius Server. # @param content_type # @param accept @@ -272,7 +272,7 @@ def graph_radius_server_traverse_user_group(radiusserver_id, content_type, accep end # List the User Groups bound to a RADIUS Server - # This endpoint will return all Users Groups bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Users Groups bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param radiusserver_id ObjectID of the Radius Server. # @param content_type # @param accept diff --git a/jcapiv2/lib/jcapiv2/api/samba_domains_api.rb b/jcapiv2/lib/jcapiv2/api/samba_domains_api.rb index 730cf9a..f2c79be 100644 --- a/jcapiv2/lib/jcapiv2/api/samba_domains_api.rb +++ b/jcapiv2/lib/jcapiv2/api/samba_domains_api.rb @@ -240,7 +240,7 @@ def ldapservers_samba_domains_list_with_http_info(ldapserver_id, opts = {}) end # Create Samba Domain - # This endpoint allows you to create a samba domain for an LDAP server. ##### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"sid\":\"{SID_ID}\", \"name\":\"{WORKGROUP_NAME}\" }' ``` + # This endpoint allows you to create a samba domain for an LDAP server. ##### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"sid\":\"{SID_ID}\", \"name\":\"{WORKGROUP_NAME}\" }' ``` # @param ldapserver_id Unique identifier of the LDAP server. # @param [Hash] opts the optional parameters # @option opts [SambaDomainInput] :body @@ -254,7 +254,7 @@ def ldapservers_samba_domains_post(ldapserver_id, opts = {}) end # Create Samba Domain - # This endpoint allows you to create a samba domain for an LDAP server. ##### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"sid\":\"{SID_ID}\", \"name\":\"{WORKGROUP_NAME}\" }' ``` + # This endpoint allows you to create a samba domain for an LDAP server. ##### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"sid\":\"{SID_ID}\", \"name\":\"{WORKGROUP_NAME}\" }' ``` # @param ldapserver_id Unique identifier of the LDAP server. # @param [Hash] opts the optional parameters # @option opts [SambaDomainInput] :body @@ -306,7 +306,7 @@ def ldapservers_samba_domains_post_with_http_info(ldapserver_id, opts = {}) end # Update Samba Domain - # This endpoint allows you to update the samba domain information for an LDAP server. ##### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"sid\":\"{SID_ID}\", \"name\":\"{WORKGROUP_NAME}\" }' ``` + # This endpoint allows you to update the samba domain information for an LDAP server. ##### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"sid\":\"{SID_ID}\", \"name\":\"{WORKGROUP_NAME}\" }' ``` # @param ldapserver_id Unique identifier of the LDAP server. # @param id Unique identifier of the samba domain. # @param [Hash] opts the optional parameters @@ -321,7 +321,7 @@ def ldapservers_samba_domains_put(ldapserver_id, id, opts = {}) end # Update Samba Domain - # This endpoint allows you to update the samba domain information for an LDAP server. ##### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"sid\":\"{SID_ID}\", \"name\":\"{WORKGROUP_NAME}\" }' ``` + # This endpoint allows you to update the samba domain information for an LDAP server. ##### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"sid\":\"{SID_ID}\", \"name\":\"{WORKGROUP_NAME}\" }' ``` # @param ldapserver_id Unique identifier of the LDAP server. # @param id Unique identifier of the samba domain. # @param [Hash] opts the optional parameters diff --git a/jcapiv2/lib/jcapiv2/api/systems_api.rb b/jcapiv2/lib/jcapiv2/api/systems_api.rb index 737f607..a3c7de1 100644 --- a/jcapiv2/lib/jcapiv2/api/systems_api.rb +++ b/jcapiv2/lib/jcapiv2/api/systems_api.rb @@ -112,7 +112,7 @@ def graph_system_associations_list_with_http_info(system_id, content_type, accep end # Manage associations of a System - # This endpoint allows you to manage the _direct_ associations of a System. A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"user\", \"id\": \"UserID\" }' ``` + # This endpoint allows you to manage the _direct_ associations of a System. A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"user\", \"id\": \"UserID\" }' ``` # @param system_id ObjectID of the System. # @param content_type # @param accept @@ -128,7 +128,7 @@ def graph_system_associations_post(system_id, content_type, accept, opts = {}) end # Manage associations of a System - # This endpoint allows you to manage the _direct_ associations of a System. A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"user\", \"id\": \"UserID\" }' ``` + # This endpoint allows you to manage the _direct_ associations of a System. A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"user\", \"id\": \"UserID\" }' ``` # @param system_id ObjectID of the System. # @param content_type # @param accept @@ -359,7 +359,7 @@ def graph_system_traverse_command_with_http_info(system_id, content_type, accept end # List the Policies bound to a System - # This endpoint will return all Policies bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System. See `/members` and `/associations` endpoints to manage those collections. This endpoint is not yet public as we have finish the code. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/{System_ID}/policies \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Policies bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System. See `/members` and `/associations` endpoints to manage those collections. This endpoint is not yet public as we have finish the code. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/{System_ID}/policies \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param system_id ObjectID of the System. # @param content_type # @param accept @@ -374,7 +374,7 @@ def graph_system_traverse_policy(system_id, content_type, accept, opts = {}) end # List the Policies bound to a System - # This endpoint will return all Policies bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System. See `/members` and `/associations` endpoints to manage those collections. This endpoint is not yet public as we have finish the code. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/{System_ID}/policies \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Policies bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System. See `/members` and `/associations` endpoints to manage those collections. This endpoint is not yet public as we have finish the code. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/{System_ID}/policies \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param system_id ObjectID of the System. # @param content_type # @param accept @@ -437,16 +437,17 @@ def graph_system_traverse_policy_with_http_info(system_id, content_type, accept, end # List the Users bound to a System - # This endpoint will return all Users bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Users bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param system_id ObjectID of the System. # @param content_type # @param accept # @param [Hash] opts the optional parameters # @option opts [Integer] :limit The number of records to return at once. Limited to 100. (default to 10) + # @option opts [String] :x_org_id (default to ) # @option opts [Integer] :skip The offset into the records to return. (default to 0) # @option opts [String] :date Current date header for the System Context API # @option opts [String] :authorization Authorization header for the System Context API - # @option opts [String] :x_org_id (default to ) + # @option opts [Array] :filter Supported operators are: eq, ne, gt, ge, lt, le, between, search, in # @return [Array] def graph_system_traverse_user(system_id, content_type, accept, opts = {}) data, _status_code, _headers = graph_system_traverse_user_with_http_info(system_id, content_type, accept, opts) @@ -454,16 +455,17 @@ def graph_system_traverse_user(system_id, content_type, accept, opts = {}) end # List the Users bound to a System - # This endpoint will return all Users bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Users bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param system_id ObjectID of the System. # @param content_type # @param accept # @param [Hash] opts the optional parameters # @option opts [Integer] :limit The number of records to return at once. Limited to 100. + # @option opts [String] :x_org_id # @option opts [Integer] :skip The offset into the records to return. # @option opts [String] :date Current date header for the System Context API # @option opts [String] :authorization Authorization header for the System Context API - # @option opts [String] :x_org_id + # @option opts [Array] :filter Supported operators are: eq, ne, gt, ge, lt, le, between, search, in # @return [Array<(Array, Fixnum, Hash)>] Array data, response status code and response headers def graph_system_traverse_user_with_http_info(system_id, content_type, accept, opts = {}) if @api_client.config.debugging @@ -488,6 +490,7 @@ def graph_system_traverse_user_with_http_info(system_id, content_type, accept, o query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? + query_params[:'filter'] = @api_client.build_collection_param(opts[:'filter'], :csv) if !opts[:'filter'].nil? # header parameters header_params = {} @@ -497,9 +500,9 @@ def graph_system_traverse_user_with_http_info(system_id, content_type, accept, o header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'Content-Type'] = content_type header_params[:'Accept'] = accept + header_params[:'x-org-id'] = opts[:'x_org_id'] if !opts[:'x_org_id'].nil? header_params[:'Date'] = opts[:'date'] if !opts[:'date'].nil? header_params[:'Authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil? - header_params[:'x-org-id'] = opts[:'x_org_id'] if !opts[:'x_org_id'].nil? # form parameters form_params = {} @@ -521,7 +524,7 @@ def graph_system_traverse_user_with_http_info(system_id, content_type, accept, o end # List the User Groups bound to a System - # This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param system_id ObjectID of the System. # @param content_type # @param accept @@ -538,7 +541,7 @@ def graph_system_traverse_user_group(system_id, content_type, accept, opts = {}) end # List the User Groups bound to a System - # This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param system_id ObjectID of the System. # @param content_type # @param accept diff --git a/jcapiv2/lib/jcapiv2/api/user_group_associations_api.rb b/jcapiv2/lib/jcapiv2/api/user_group_associations_api.rb index 903657f..0852a2f 100644 --- a/jcapiv2/lib/jcapiv2/api/user_group_associations_api.rb +++ b/jcapiv2/lib/jcapiv2/api/user_group_associations_api.rb @@ -179,7 +179,7 @@ def graph_user_group_associations_post_with_http_info(group_id, content_type, ac end # List the Active Directories bound to a User Group - # This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -194,7 +194,7 @@ def graph_user_group_traverse_active_directory(group_id, content_type, accept, o end # List the Active Directories bound to a User Group - # This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -647,7 +647,7 @@ def graph_user_group_traverse_office365_with_http_info(group_id, content_type, a end # List the RADIUS Servers bound to a User Group - # This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -662,7 +662,7 @@ def graph_user_group_traverse_radius_server(group_id, content_type, accept, opts end # List the RADIUS Servers bound to a User Group - # This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -725,7 +725,7 @@ def graph_user_group_traverse_radius_server_with_http_info(group_id, content_typ end # List the Systems bound to a User Group - # This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -740,7 +740,7 @@ def graph_user_group_traverse_system(group_id, content_type, accept, opts = {}) end # List the Systems bound to a User Group - # This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -803,7 +803,7 @@ def graph_user_group_traverse_system_with_http_info(group_id, content_type, acce end # List the System Groups bound to User Groups - # This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -818,7 +818,7 @@ def graph_user_group_traverse_system_group(group_id, content_type, accept, opts end # List the System Groups bound to User Groups - # This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept diff --git a/jcapiv2/lib/jcapiv2/api/user_groups_api.rb b/jcapiv2/lib/jcapiv2/api/user_groups_api.rb index 8619b7b..1d9cf92 100644 --- a/jcapiv2/lib/jcapiv2/api/user_groups_api.rb +++ b/jcapiv2/lib/jcapiv2/api/user_groups_api.rb @@ -498,7 +498,7 @@ def graph_user_group_membership_with_http_info(group_id, content_type, accept, o end # List the Active Directories bound to a User Group - # This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -513,7 +513,7 @@ def graph_user_group_traverse_active_directory(group_id, content_type, accept, o end # List the Active Directories bound to a User Group - # This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -966,7 +966,7 @@ def graph_user_group_traverse_office365_with_http_info(group_id, content_type, a end # List the RADIUS Servers bound to a User Group - # This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -981,7 +981,7 @@ def graph_user_group_traverse_radius_server(group_id, content_type, accept, opts end # List the RADIUS Servers bound to a User Group - # This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -1044,7 +1044,7 @@ def graph_user_group_traverse_radius_server_with_http_info(group_id, content_typ end # List the Systems bound to a User Group - # This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -1059,7 +1059,7 @@ def graph_user_group_traverse_system(group_id, content_type, accept, opts = {}) end # List the Systems bound to a User Group - # This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -1122,7 +1122,7 @@ def graph_user_group_traverse_system_with_http_info(group_id, content_type, acce end # List the System Groups bound to User Groups - # This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -1137,7 +1137,7 @@ def graph_user_group_traverse_system_group(group_id, content_type, accept, opts end # List the System Groups bound to User Groups - # This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -1566,7 +1566,7 @@ def groups_user_post_with_http_info(content_type, accept, opts = {}) end # Update a User Group - # This endpoint allows you to do a full update of the User Group. #### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/v2/usergroups/{Group_ID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY' \\ -d '{ \"name\": \"group_update\" }' ``` + # This endpoint allows you to do a full update of the User Group. #### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/v2/usergroups/{Group_ID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY' \\ -d '{ \"name\": \"group_update\" }' ``` # @param id ObjectID of the User Group. # @param content_type # @param accept @@ -1580,7 +1580,7 @@ def groups_user_put(id, content_type, accept, opts = {}) end # Update a User Group - # This endpoint allows you to do a full update of the User Group. #### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/v2/usergroups/{Group_ID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY' \\ -d '{ \"name\": \"group_update\" }' ``` + # This endpoint allows you to do a full update of the User Group. #### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/v2/usergroups/{Group_ID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY' \\ -d '{ \"name\": \"group_update\" }' ``` # @param id ObjectID of the User Group. # @param content_type # @param accept diff --git a/jcapiv2/lib/jcapiv2/api/users_api.rb b/jcapiv2/lib/jcapiv2/api/users_api.rb index 693d1f3..d808caf 100644 --- a/jcapiv2/lib/jcapiv2/api/users_api.rb +++ b/jcapiv2/lib/jcapiv2/api/users_api.rb @@ -106,7 +106,7 @@ def graph_user_associations_list_with_http_info(user_id, content_type, accept, t end # Manage the associations of a User - # This endpoint allows you to manage the _direct_ associations of a User. A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"system_group\", \"id\": \"{GroupID}\" }' + # This endpoint allows you to manage the _direct_ associations of a User. A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"system_group\", \"id\": \"{GroupID}\" }' # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -120,7 +120,7 @@ def graph_user_associations_post(user_id, content_type, accept, opts = {}) end # Manage the associations of a User - # This endpoint allows you to manage the _direct_ associations of a User. A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"system_group\", \"id\": \"{GroupID}\" }' + # This endpoint allows you to manage the _direct_ associations of a User. A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"system_group\", \"id\": \"{GroupID}\" }' # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -263,7 +263,7 @@ def graph_user_member_of_with_http_info(user_id, content_type, accept, opts = {} end # List the Applications bound to a User - # This endpoint will return all Applications bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/applications \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Applications bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/applications \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -278,7 +278,7 @@ def graph_user_traverse_application(user_id, content_type, accept, opts = {}) end # List the Applications bound to a User - # This endpoint will return all Applications bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/applications \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Applications bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/applications \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -341,7 +341,7 @@ def graph_user_traverse_application_with_http_info(user_id, content_type, accept end # List the Directories bound to a User - # This endpoint will return all Directories bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/directories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Directories bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/directories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -356,7 +356,7 @@ def graph_user_traverse_directory(user_id, content_type, accept, opts = {}) end # List the Directories bound to a User - # This endpoint will return all Directories bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/directories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Directories bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/directories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -419,7 +419,7 @@ def graph_user_traverse_directory_with_http_info(user_id, content_type, accept, end # List the G Suite instances bound to a User - # This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -434,7 +434,7 @@ def graph_user_traverse_g_suite(user_id, content_type, accept, opts = {}) end # List the G Suite instances bound to a User - # This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -497,7 +497,7 @@ def graph_user_traverse_g_suite_with_http_info(user_id, content_type, accept, op end # List the LDAP servers bound to a User - # This endpoint will return all LDAP Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/ldapservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all LDAP Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/ldapservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -512,7 +512,7 @@ def graph_user_traverse_ldap_server(user_id, content_type, accept, opts = {}) end # List the LDAP servers bound to a User - # This endpoint will return all LDAP Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/ldapservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all LDAP Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/ldapservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -575,7 +575,7 @@ def graph_user_traverse_ldap_server_with_http_info(user_id, content_type, accept end # List the Office 365 instances bound to a User - # This endpoint will return all Office 365 Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/office365s \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Office 365 Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/office365s \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -590,7 +590,7 @@ def graph_user_traverse_office365(user_id, content_type, accept, opts = {}) end # List the Office 365 instances bound to a User - # This endpoint will return all Office 365 Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/office365s \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Office 365 Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/office365s \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -653,7 +653,7 @@ def graph_user_traverse_office365_with_http_info(user_id, content_type, accept, end # List the RADIUS Servers bound to a User - # This endpoint will return all RADIUS Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all RADIUS Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -668,7 +668,7 @@ def graph_user_traverse_radius_server(user_id, content_type, accept, opts = {}) end # List the RADIUS Servers bound to a User - # This endpoint will return all RADIUS Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all RADIUS Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -731,14 +731,15 @@ def graph_user_traverse_radius_server_with_http_info(user_id, content_type, acce end # List the Systems bound to a User - # This endpoint will return all Systems bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systems\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Systems bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systems\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept # @param [Hash] opts the optional parameters # @option opts [Integer] :limit The number of records to return at once. Limited to 100. (default to 10) - # @option opts [Integer] :skip The offset into the records to return. (default to 0) # @option opts [String] :x_org_id (default to ) + # @option opts [Integer] :skip The offset into the records to return. (default to 0) + # @option opts [Array] :filter Supported operators are: eq, ne, gt, ge, lt, le, between, search, in # @return [Array] def graph_user_traverse_system(user_id, content_type, accept, opts = {}) data, _status_code, _headers = graph_user_traverse_system_with_http_info(user_id, content_type, accept, opts) @@ -746,14 +747,15 @@ def graph_user_traverse_system(user_id, content_type, accept, opts = {}) end # List the Systems bound to a User - # This endpoint will return all Systems bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systems\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Systems bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systems\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept # @param [Hash] opts the optional parameters # @option opts [Integer] :limit The number of records to return at once. Limited to 100. - # @option opts [Integer] :skip The offset into the records to return. # @option opts [String] :x_org_id + # @option opts [Integer] :skip The offset into the records to return. + # @option opts [Array] :filter Supported operators are: eq, ne, gt, ge, lt, le, between, search, in # @return [Array<(Array, Fixnum, Hash)>] Array data, response status code and response headers def graph_user_traverse_system_with_http_info(user_id, content_type, accept, opts = {}) if @api_client.config.debugging @@ -778,6 +780,7 @@ def graph_user_traverse_system_with_http_info(user_id, content_type, accept, opt query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil? + query_params[:'filter'] = @api_client.build_collection_param(opts[:'filter'], :csv) if !opts[:'filter'].nil? # header parameters header_params = {} @@ -809,7 +812,7 @@ def graph_user_traverse_system_with_http_info(user_id, content_type, accept, opt end # List the System Groups bound to a User - # This endpoint will return all System Groups bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systemgroups\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all System Groups bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systemgroups\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -824,7 +827,7 @@ def graph_user_traverse_system_group(user_id, content_type, accept, opts = {}) end # List the System Groups bound to a User - # This endpoint will return all System Groups bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systemgroups\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all System Groups bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systemgroups\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -895,8 +898,8 @@ def graph_user_traverse_system_group_with_http_info(user_id, content_type, accep # @option opts [Emailrequest] :body # @option opts [String] :x_org_id (default to ) # @return [nil] - def user_send_emails(user_id, content_type, accept, opts = {}) - user_send_emails_with_http_info(user_id, content_type, accept, opts) + def users_send_emails(user_id, content_type, accept, opts = {}) + users_send_emails_with_http_info(user_id, content_type, accept, opts) return nil end @@ -909,21 +912,21 @@ def user_send_emails(user_id, content_type, accept, opts = {}) # @option opts [Emailrequest] :body # @option opts [String] :x_org_id # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers - def user_send_emails_with_http_info(user_id, content_type, accept, opts = {}) + def users_send_emails_with_http_info(user_id, content_type, accept, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug "Calling API: UsersApi.user_send_emails ..." + @api_client.config.logger.debug "Calling API: UsersApi.users_send_emails ..." end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? - fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.user_send_emails" + fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.users_send_emails" end # verify the required parameter 'content_type' is set if @api_client.config.client_side_validation && content_type.nil? - fail ArgumentError, "Missing the required parameter 'content_type' when calling UsersApi.user_send_emails" + fail ArgumentError, "Missing the required parameter 'content_type' when calling UsersApi.users_send_emails" end # verify the required parameter 'accept' is set if @api_client.config.client_side_validation && accept.nil? - fail ArgumentError, "Missing the required parameter 'accept' when calling UsersApi.user_send_emails" + fail ArgumentError, "Missing the required parameter 'accept' when calling UsersApi.users_send_emails" end # resource path local_var_path = "/users/{user_id}/emails".sub('{' + 'user_id' + '}', user_id.to_s) @@ -954,7 +957,7 @@ def user_send_emails_with_http_info(user_id, content_type, accept, opts = {}) :body => post_body, :auth_names => auth_names) if @api_client.config.debugging - @api_client.config.logger.debug "API called: UsersApi#user_send_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: UsersApi#users_send_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end diff --git a/jcapiv2/lib/jcapiv2/api/workday_import_api.rb b/jcapiv2/lib/jcapiv2/api/workday_import_api.rb index 4bb9c5a..9e65273 100644 --- a/jcapiv2/lib/jcapiv2/api/workday_import_api.rb +++ b/jcapiv2/lib/jcapiv2/api/workday_import_api.rb @@ -165,7 +165,7 @@ def workdays_deauthorize_with_http_info(workday_id, content_type, accept, opts = end # Delete Workday - # This endpoint allows you to delete an instance of Workday. **This functionality is currently not enable for users.** + # This endpoint allows you to delete an instance of Workday. **This functionality is currently not enable for users.** # @param id # @param content_type # @param accept @@ -178,7 +178,7 @@ def workdays_delete(id, content_type, accept, opts = {}) end # Delete Workday - # This endpoint allows you to delete an instance of Workday. **This functionality is currently not enable for users.** + # This endpoint allows you to delete an instance of Workday. **This functionality is currently not enable for users.** # @param id # @param content_type # @param accept @@ -548,7 +548,7 @@ def workdays_list_with_http_info(content_type, accept, opts = {}) end # Create new Workday - # This endpoint allows you to create a new workday instance. You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. Failure to provide these credentials will result in the request being rejected. Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. Currently, only one instance is allowed and it must be `Workday Import`. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/workdays/ \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"name\": \"Workday2\", \"reportUrl\":\"https://workday.com/ccx/service/customreport2/gms/user/reportname?format=json\", \"auth\": { \"basic\": { \"username\": \"someDeveloper\", \"password\": \"notTheRealPassword\" } } }' ``` + # This endpoint allows you to create a new workday instance. You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. Failure to provide these credentials will result in the request being rejected. Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. Currently, only one instance is allowed and it must be `Workday Import`. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/workdays/ \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"name\": \"Workday2\", \"reportUrl\":\"https://workday.com/ccx/service/customreport2/gms/user/reportname?format=json\", \"auth\": { \"basic\": { \"username\": \"someDeveloper\", \"password\": \"notTheRealPassword\" } } }' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -561,7 +561,7 @@ def workdays_post(content_type, accept, opts = {}) end # Create new Workday - # This endpoint allows you to create a new workday instance. You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. Failure to provide these credentials will result in the request being rejected. Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. Currently, only one instance is allowed and it must be `Workday Import`. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/workdays/ \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"name\": \"Workday2\", \"reportUrl\":\"https://workday.com/ccx/service/customreport2/gms/user/reportname?format=json\", \"auth\": { \"basic\": { \"username\": \"someDeveloper\", \"password\": \"notTheRealPassword\" } } }' ``` + # This endpoint allows you to create a new workday instance. You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. Failure to provide these credentials will result in the request being rejected. Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. Currently, only one instance is allowed and it must be `Workday Import`. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/workdays/ \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"name\": \"Workday2\", \"reportUrl\":\"https://workday.com/ccx/service/customreport2/gms/user/reportname?format=json\", \"auth\": { \"basic\": { \"username\": \"someDeveloper\", \"password\": \"notTheRealPassword\" } } }' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -689,7 +689,7 @@ def workdays_put_with_http_info(id, content_type, accept, opts = {}) end # Get Workday Settings (incomplete) - # This endpoint allows you to obtain all settings needed for creating a workday instance, specifically the URL to initiate Basic Authentication with WorkDay. **This functionality is currently not enable for users.** + # This endpoint allows you to obtain all settings needed for creating a workday instance, specifically the URL to initiate Basic Authentication with WorkDay. **This functionality is currently not enable for users.** # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -702,7 +702,7 @@ def workdays_settings(content_type, accept, opts = {}) end # Get Workday Settings (incomplete) - # This endpoint allows you to obtain all settings needed for creating a workday instance, specifically the URL to initiate Basic Authentication with WorkDay. **This functionality is currently not enable for users.** + # This endpoint allows you to obtain all settings needed for creating a workday instance, specifically the URL to initiate Basic Authentication with WorkDay. **This functionality is currently not enable for users.** # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -757,7 +757,7 @@ def workdays_settings_with_http_info(content_type, accept, opts = {}) end # List Workday Workers - # This endpoint will return all of the data in your WorkDay Custom Report that has been associated with your WorkDay Instance in JumpCloud. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/workers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all of the data in your WorkDay Custom Report that has been associated with your WorkDay Instance in JumpCloud. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/workers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param workday_id # @param content_type # @param accept @@ -773,7 +773,7 @@ def workdays_workers(workday_id, content_type, accept, opts = {}) end # List Workday Workers - # This endpoint will return all of the data in your WorkDay Custom Report that has been associated with your WorkDay Instance in JumpCloud. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/workers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all of the data in your WorkDay Custom Report that has been associated with your WorkDay Instance in JumpCloud. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/workers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param workday_id # @param content_type # @param accept diff --git a/jcapiv2/lib/jcapiv2/models/bulk_user_create.rb b/jcapiv2/lib/jcapiv2/models/bulk_user_create.rb index 640b1cd..96d5e23 100644 --- a/jcapiv2/lib/jcapiv2/models/bulk_user_create.rb +++ b/jcapiv2/lib/jcapiv2/models/bulk_user_create.rb @@ -13,7 +13,7 @@ require 'date' module JCAPIv2 - + # See [V1 system user creation](https://docs.jumpcloud.com/1.0/systemusers/create-a-system-user) for full list of attributes. class BulkUserCreate attr_accessor :username @@ -23,6 +23,7 @@ class BulkUserCreate attr_accessor :email + # Map of additional attributes. attr_accessor :attributes diff --git a/jcapiv2/lib/jcapiv2/models/bulk_user_update.rb b/jcapiv2/lib/jcapiv2/models/bulk_user_update.rb new file mode 100644 index 0000000..825afb8 --- /dev/null +++ b/jcapiv2/lib/jcapiv2/models/bulk_user_update.rb @@ -0,0 +1,201 @@ +=begin +#JumpCloud APIs + +# JumpCloud's V2 API. This set of endpoints allows JumpCloud customers to manage objects, groupings and mappings and interact with the JumpCloud Graph. + +OpenAPI spec version: 2.0 + +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.3.1 + +=end + +require 'date' + +module JCAPIv2 + # See [V1 system user update](https://docs.jumpcloud.com/1.0/systemusers/update-a-system-user) for full list of attributes. + class BulkUserUpdate + # Object ID of the systemuser being updated + attr_accessor :id + + # Map of additional attributes. + attr_accessor :attributes + + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'id' => :'id', + :'attributes' => :'attributes' + } + end + + # Attribute type mapping. + def self.swagger_types + { + :'id' => :'String', + :'attributes' => :'Array' + } + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + return unless attributes.is_a?(Hash) + + # convert string to symbol for hash key + attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} + + if attributes.has_key?(:'id') + self.id = attributes[:'id'] + end + + if attributes.has_key?(:'attributes') + if (value = attributes[:'attributes']).is_a?(Array) + self.attributes = value + end + end + + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + return invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + id == o.id && + attributes == o.attributes + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Fixnum] Hash code + def hash + [id, attributes].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.swagger_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :BOOLEAN + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + temp_model = JCAPIv2.const_get(type).new + temp_model.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + next if value.nil? + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map{ |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/jcapiv2/lib/jcapiv2/models/emailrequest.rb b/jcapiv2/lib/jcapiv2/models/emailrequest.rb index a399708..2097a24 100644 --- a/jcapiv2/lib/jcapiv2/models/emailrequest.rb +++ b/jcapiv2/lib/jcapiv2/models/emailrequest.rb @@ -17,6 +17,27 @@ module JCAPIv2 class Emailrequest attr_accessor :email_type + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map @@ -56,9 +77,21 @@ def list_invalid_properties # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? + email_type_validator = EnumAttributeValidator.new('String', ["activation"]) + return false unless email_type_validator.valid?(@email_type) return true end + # Custom attribute writer method checking allowed values (enum). + # @param [Object] email_type Object to be assigned + def email_type=(email_type) + validator = EnumAttributeValidator.new('String', ["activation"]) + unless validator.valid?(email_type) + fail ArgumentError, "invalid value for 'email_type', must be one of #{validator.allowable_values}." + end + @email_type = email_type + end + # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) diff --git a/jcapiv2/lib/jcapiv2/models/g_suite_builtin_translation.rb b/jcapiv2/lib/jcapiv2/models/g_suite_builtin_translation.rb new file mode 100644 index 0000000..5d4d46c --- /dev/null +++ b/jcapiv2/lib/jcapiv2/models/g_suite_builtin_translation.rb @@ -0,0 +1,43 @@ +=begin +#JumpCloud APIs + +# JumpCloud's V2 API. This set of endpoints allows JumpCloud customers to manage objects, groupings and mappings and interact with the JumpCloud Graph. + +OpenAPI spec version: 2.0 + +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.3.1 + +=end + +require 'date' + +module JCAPIv2 + class GSuiteBuiltinTranslation + + HOME_ADDRESSES = "user_home_addresses".freeze + WORK_ADDRESSES = "user_work_addresses".freeze + OTHER_ADDRESSES = "user_other_addresses".freeze + HOME_PHONE_NUMBERS = "user_home_phone_numbers".freeze + MOBILE_PHONE_NUMBERS = "user_mobile_phone_numbers".freeze + OTHER_PHONE_NUMBERS = "user_other_phone_numbers".freeze + WORK_PHONE_NUMBERS = "user_work_phone_numbers".freeze + WORK_FAX_PHONE_NUMBERS = "user_work_fax_phone_numbers".freeze + WORK_MOBILE_PHONE_NUMBERS = "user_work_mobile_phone_numbers".freeze + PRIMARY_ORGANIZATION_COST_CENTER = "user_primary_organization_cost_center".freeze + PRIMARY_ORGANIZATION_DEPARTMENT = "user_primary_organization_department".freeze + PRIMARY_ORGANIZATION_DESCRIPTION = "user_primary_organization_description".freeze + PRIMARY_ORGANIZATION_EMPLOYEE_ID = "user_primary_organization_employee_id".freeze + PRIMARY_ORGANIZATION_TITLE = "user_primary_organization_title".freeze + + # Builds the enum from string + # @param [String] The enum value in the form of the string + # @return [String] The enum value + def build_from_hash(value) + constantValues = GSuiteBuiltinTranslation.constants.select{|c| GSuiteBuiltinTranslation::const_get(c) == value} + raise "Invalid ENUM value #{value} for class #GSuiteBuiltinTranslation" if constantValues.empty? + value + end + end + +end diff --git a/jcapiv2/lib/jcapiv2/models/g_suite_translation_rule.rb b/jcapiv2/lib/jcapiv2/models/g_suite_translation_rule.rb new file mode 100644 index 0000000..edfb547 --- /dev/null +++ b/jcapiv2/lib/jcapiv2/models/g_suite_translation_rule.rb @@ -0,0 +1,198 @@ +=begin +#JumpCloud APIs + +# JumpCloud's V2 API. This set of endpoints allows JumpCloud customers to manage objects, groupings and mappings and interact with the JumpCloud Graph. + +OpenAPI spec version: 2.0 + +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.3.1 + +=end + +require 'date' + +module JCAPIv2 + + class GSuiteTranslationRule + attr_accessor :built_in + + # ObjectId uniquely identifying a Translation Rule. + attr_accessor :id + + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'built_in' => :'builtIn', + :'id' => :'id' + } + end + + # Attribute type mapping. + def self.swagger_types + { + :'built_in' => :'GSuiteBuiltinTranslation', + :'id' => :'String' + } + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + return unless attributes.is_a?(Hash) + + # convert string to symbol for hash key + attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} + + if attributes.has_key?(:'builtIn') + self.built_in = attributes[:'builtIn'] + end + + if attributes.has_key?(:'id') + self.id = attributes[:'id'] + end + + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + return invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + built_in == o.built_in && + id == o.id + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Fixnum] Hash code + def hash + [built_in, id].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.swagger_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :BOOLEAN + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + temp_model = JCAPIv2.const_get(type).new + temp_model.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + next if value.nil? + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map{ |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/jcapiv2/lib/jcapiv2/models/g_suite_translation_rule_request.rb b/jcapiv2/lib/jcapiv2/models/g_suite_translation_rule_request.rb new file mode 100644 index 0000000..0cb6c2d --- /dev/null +++ b/jcapiv2/lib/jcapiv2/models/g_suite_translation_rule_request.rb @@ -0,0 +1,188 @@ +=begin +#JumpCloud APIs + +# JumpCloud's V2 API. This set of endpoints allows JumpCloud customers to manage objects, groupings and mappings and interact with the JumpCloud Graph. + +OpenAPI spec version: 2.0 + +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.3.1 + +=end + +require 'date' + +module JCAPIv2 + + class GSuiteTranslationRuleRequest + attr_accessor :built_in + + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'built_in' => :'builtIn' + } + end + + # Attribute type mapping. + def self.swagger_types + { + :'built_in' => :'GSuiteBuiltinTranslation' + } + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + return unless attributes.is_a?(Hash) + + # convert string to symbol for hash key + attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} + + if attributes.has_key?(:'builtIn') + self.built_in = attributes[:'builtIn'] + end + + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + return invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + built_in == o.built_in + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Fixnum] Hash code + def hash + [built_in].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.swagger_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :BOOLEAN + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + temp_model = JCAPIv2.const_get(type).new + temp_model.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + next if value.nil? + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map{ |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/jcapiv2/lib/jcapiv2/models/inline_response_201.rb b/jcapiv2/lib/jcapiv2/models/inline_response_201.rb new file mode 100644 index 0000000..e20df7f --- /dev/null +++ b/jcapiv2/lib/jcapiv2/models/inline_response_201.rb @@ -0,0 +1,188 @@ +=begin +#JumpCloud APIs + +# JumpCloud's V2 API. This set of endpoints allows JumpCloud customers to manage objects, groupings and mappings and interact with the JumpCloud Graph. + +OpenAPI spec version: 2.0 + +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.3.1 + +=end + +require 'date' + +module JCAPIv2 + + class InlineResponse201 + attr_accessor :rule + + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'rule' => :'rule' + } + end + + # Attribute type mapping. + def self.swagger_types + { + :'rule' => :'GSuiteTranslationRule' + } + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + return unless attributes.is_a?(Hash) + + # convert string to symbol for hash key + attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} + + if attributes.has_key?(:'rule') + self.rule = attributes[:'rule'] + end + + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + return invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + rule == o.rule + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Fixnum] Hash code + def hash + [rule].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.swagger_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :BOOLEAN + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + temp_model = JCAPIv2.const_get(type).new + temp_model.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + next if value.nil? + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map{ |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/jcapiv2/lib/jcapiv2/models/inline_response_201_1.rb b/jcapiv2/lib/jcapiv2/models/inline_response_201_1.rb new file mode 100644 index 0000000..f0b9777 --- /dev/null +++ b/jcapiv2/lib/jcapiv2/models/inline_response_201_1.rb @@ -0,0 +1,188 @@ +=begin +#JumpCloud APIs + +# JumpCloud's V2 API. This set of endpoints allows JumpCloud customers to manage objects, groupings and mappings and interact with the JumpCloud Graph. + +OpenAPI spec version: 2.0 + +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.3.1 + +=end + +require 'date' + +module JCAPIv2 + + class InlineResponse2011 + attr_accessor :rule + + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'rule' => :'rule' + } + end + + # Attribute type mapping. + def self.swagger_types + { + :'rule' => :'Office365TranslationRule' + } + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + return unless attributes.is_a?(Hash) + + # convert string to symbol for hash key + attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} + + if attributes.has_key?(:'rule') + self.rule = attributes[:'rule'] + end + + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + return invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + rule == o.rule + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Fixnum] Hash code + def hash + [rule].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.swagger_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :BOOLEAN + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + temp_model = JCAPIv2.const_get(type).new + temp_model.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + next if value.nil? + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map{ |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/jcapiv2/lib/jcapiv2/models/office365_builtin_translation.rb b/jcapiv2/lib/jcapiv2/models/office365_builtin_translation.rb new file mode 100644 index 0000000..40306ef --- /dev/null +++ b/jcapiv2/lib/jcapiv2/models/office365_builtin_translation.rb @@ -0,0 +1,39 @@ +=begin +#JumpCloud APIs + +# JumpCloud's V2 API. This set of endpoints allows JumpCloud customers to manage objects, groupings and mappings and interact with the JumpCloud Graph. + +OpenAPI spec version: 2.0 + +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.3.1 + +=end + +require 'date' + +module JCAPIv2 + class Office365BuiltinTranslation + + STREET_ADDRESS = "user_street_address".freeze + CITY = "user_city".freeze + STATE = "user_state".freeze + COUNTRY = "user_country".freeze + POSTAL_CODE = "user_postal_code".freeze + BUSINESS_PHONES = "user_business_phones".freeze + MOBILE_PHONE = "user_mobile_phone".freeze + DEPARTMENT = "user_department".freeze + JOB_TITLE = "user_job_title".freeze + OFFICE_LOCATION = "user_office_location".freeze + + # Builds the enum from string + # @param [String] The enum value in the form of the string + # @return [String] The enum value + def build_from_hash(value) + constantValues = Office365BuiltinTranslation.constants.select{|c| Office365BuiltinTranslation::const_get(c) == value} + raise "Invalid ENUM value #{value} for class #Office365BuiltinTranslation" if constantValues.empty? + value + end + end + +end diff --git a/jcapiv2/lib/jcapiv2/models/office365_translation_rule.rb b/jcapiv2/lib/jcapiv2/models/office365_translation_rule.rb new file mode 100644 index 0000000..fdbe1d0 --- /dev/null +++ b/jcapiv2/lib/jcapiv2/models/office365_translation_rule.rb @@ -0,0 +1,198 @@ +=begin +#JumpCloud APIs + +# JumpCloud's V2 API. This set of endpoints allows JumpCloud customers to manage objects, groupings and mappings and interact with the JumpCloud Graph. + +OpenAPI spec version: 2.0 + +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.3.1 + +=end + +require 'date' + +module JCAPIv2 + + class Office365TranslationRule + attr_accessor :built_in + + # ObjectId uniquely identifying a Translation Rule. + attr_accessor :id + + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'built_in' => :'builtIn', + :'id' => :'id' + } + end + + # Attribute type mapping. + def self.swagger_types + { + :'built_in' => :'Office365BuiltinTranslation', + :'id' => :'String' + } + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + return unless attributes.is_a?(Hash) + + # convert string to symbol for hash key + attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} + + if attributes.has_key?(:'builtIn') + self.built_in = attributes[:'builtIn'] + end + + if attributes.has_key?(:'id') + self.id = attributes[:'id'] + end + + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + return invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + built_in == o.built_in && + id == o.id + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Fixnum] Hash code + def hash + [built_in, id].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.swagger_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :BOOLEAN + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + temp_model = JCAPIv2.const_get(type).new + temp_model.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + next if value.nil? + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map{ |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/jcapiv2/lib/jcapiv2/models/office365_translation_rule_request.rb b/jcapiv2/lib/jcapiv2/models/office365_translation_rule_request.rb new file mode 100644 index 0000000..de4be1f --- /dev/null +++ b/jcapiv2/lib/jcapiv2/models/office365_translation_rule_request.rb @@ -0,0 +1,188 @@ +=begin +#JumpCloud APIs + +# JumpCloud's V2 API. This set of endpoints allows JumpCloud customers to manage objects, groupings and mappings and interact with the JumpCloud Graph. + +OpenAPI spec version: 2.0 + +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.3.1 + +=end + +require 'date' + +module JCAPIv2 + + class Office365TranslationRuleRequest + attr_accessor :built_in + + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'built_in' => :'builtIn' + } + end + + # Attribute type mapping. + def self.swagger_types + { + :'built_in' => :'Office365BuiltinTranslation' + } + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + return unless attributes.is_a?(Hash) + + # convert string to symbol for hash key + attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} + + if attributes.has_key?(:'builtIn') + self.built_in = attributes[:'builtIn'] + end + + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + return invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + built_in == o.built_in + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Fixnum] Hash code + def hash + [built_in].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.swagger_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :BOOLEAN + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + temp_model = JCAPIv2.const_get(type).new + temp_model.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + next if value.nil? + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map{ |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/jcapiv2/lib/jcapiv2/models/policy_result.rb b/jcapiv2/lib/jcapiv2/models/policy_result.rb index af462ed..e881479 100644 --- a/jcapiv2/lib/jcapiv2/models/policy_result.rb +++ b/jcapiv2/lib/jcapiv2/models/policy_result.rb @@ -42,6 +42,12 @@ class PolicyResult # The STDOUT output from applying the policy. attr_accessor :std_out + # Enumeration describing the state of the policy. Success, failed, or pending. + attr_accessor :state + + # Details pertaining to the policy result. + attr_accessor :detail + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map @@ -54,7 +60,9 @@ def self.attribute_map :'success' => :'success', :'exit_status' => :'exitStatus', :'std_err' => :'stdErr', - :'std_out' => :'stdOut' + :'std_out' => :'stdOut', + :'state' => :'state', + :'detail' => :'detail' } end @@ -69,7 +77,9 @@ def self.swagger_types :'success' => :'BOOLEAN', :'exit_status' => :'Integer', :'std_err' => :'String', - :'std_out' => :'String' + :'std_out' => :'String', + :'state' => :'String', + :'detail' => :'String' } end @@ -117,6 +127,14 @@ def initialize(attributes = {}) self.std_out = attributes[:'stdOut'] end + if attributes.has_key?(:'state') + self.state = attributes[:'state'] + end + + if attributes.has_key?(:'detail') + self.detail = attributes[:'detail'] + end + end # Show invalid properties with the reasons. Usually used together with valid? @@ -145,7 +163,9 @@ def ==(o) success == o.success && exit_status == o.exit_status && std_err == o.std_err && - std_out == o.std_out + std_out == o.std_out && + state == o.state && + detail == o.detail end # @see the `==` method @@ -157,7 +177,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Fixnum] Hash code def hash - [policy_id, system_id, id, started_at, ended_at, success, exit_status, std_err, std_out].hash + [policy_id, system_id, id, started_at, ended_at, success, exit_status, std_err, std_out, state, detail].hash end # Builds the object from hash diff --git a/jcapiv2/lib/jcapiv2/models/systemuser.rb b/jcapiv2/lib/jcapiv2/models/systemuser.rb index 94a11c1..42af4a0 100644 --- a/jcapiv2/lib/jcapiv2/models/systemuser.rb +++ b/jcapiv2/lib/jcapiv2/models/systemuser.rb @@ -369,12 +369,12 @@ def list_invalid_properties invalid_properties.push("invalid value for 'username', the character length must be smaller than or equal to 1024.") end - if !@unix_uid.nil? && @unix_uid < 0 - invalid_properties.push("invalid value for 'unix_uid', must be greater than or equal to 0.") + if !@unix_uid.nil? && @unix_uid < 1 + invalid_properties.push("invalid value for 'unix_uid', must be greater than or equal to 1.") end - if !@unix_guid.nil? && @unix_guid < 0 - invalid_properties.push("invalid value for 'unix_guid', must be greater than or equal to 0.") + if !@unix_guid.nil? && @unix_guid < 1 + invalid_properties.push("invalid value for 'unix_guid', must be greater than or equal to 1.") end if !@firstname.nil? && @firstname.to_s.length > 1024 @@ -437,8 +437,8 @@ def list_invalid_properties def valid? return false if !@email.nil? && @email.to_s.length > 1024 return false if !@username.nil? && @username.to_s.length > 1024 - return false if !@unix_uid.nil? && @unix_uid < 0 - return false if !@unix_guid.nil? && @unix_guid < 0 + return false if !@unix_uid.nil? && @unix_uid < 1 + return false if !@unix_guid.nil? && @unix_guid < 1 return false if !@firstname.nil? && @firstname.to_s.length > 1024 return false if !@lastname.nil? && @lastname.to_s.length > 1024 return false if !@associated_tag_count.nil? && @associated_tag_count < 0 @@ -481,8 +481,8 @@ def username=(username) # @param [Object] unix_uid Value to be assigned def unix_uid=(unix_uid) - if !unix_uid.nil? && unix_uid < 0 - fail ArgumentError, "invalid value for 'unix_uid', must be greater than or equal to 0." + if !unix_uid.nil? && unix_uid < 1 + fail ArgumentError, "invalid value for 'unix_uid', must be greater than or equal to 1." end @unix_uid = unix_uid @@ -492,8 +492,8 @@ def unix_uid=(unix_uid) # @param [Object] unix_guid Value to be assigned def unix_guid=(unix_guid) - if !unix_guid.nil? && unix_guid < 0 - fail ArgumentError, "invalid value for 'unix_guid', must be greater than or equal to 0." + if !unix_guid.nil? && unix_guid < 1 + fail ArgumentError, "invalid value for 'unix_guid', must be greater than or equal to 1." end @unix_guid = unix_guid diff --git a/jcapiv2/lib/jcapiv2/models/systemuserputpost.rb b/jcapiv2/lib/jcapiv2/models/systemuserputpost.rb index 16810f2..060b45f 100644 --- a/jcapiv2/lib/jcapiv2/models/systemuserputpost.rb +++ b/jcapiv2/lib/jcapiv2/models/systemuserputpost.rb @@ -353,12 +353,12 @@ def list_invalid_properties invalid_properties.push("invalid value for 'username', username cannot be nil.") end - if !@unix_uid.nil? && @unix_uid < 0 - invalid_properties.push("invalid value for 'unix_uid', must be greater than or equal to 0.") + if !@unix_uid.nil? && @unix_uid < 1 + invalid_properties.push("invalid value for 'unix_uid', must be greater than or equal to 1.") end - if !@unix_guid.nil? && @unix_guid < 0 - invalid_properties.push("invalid value for 'unix_guid', must be greater than or equal to 0.") + if !@unix_guid.nil? && @unix_guid < 1 + invalid_properties.push("invalid value for 'unix_guid', must be greater than or equal to 1.") end if !@description.nil? && @description.to_s.length > 1024 @@ -378,8 +378,8 @@ def valid? return false if @email.nil? return false if @email.to_s.length > 1024 return false if @username.nil? - return false if !@unix_uid.nil? && @unix_uid < 0 - return false if !@unix_guid.nil? && @unix_guid < 0 + return false if !@unix_uid.nil? && @unix_uid < 1 + return false if !@unix_guid.nil? && @unix_guid < 1 return false if !@description.nil? && @description.to_s.length > 1024 return false if !@employee_identifier.nil? && @employee_identifier.to_s.length > 256 return true @@ -403,8 +403,8 @@ def email=(email) # @param [Object] unix_uid Value to be assigned def unix_uid=(unix_uid) - if !unix_uid.nil? && unix_uid < 0 - fail ArgumentError, "invalid value for 'unix_uid', must be greater than or equal to 0." + if !unix_uid.nil? && unix_uid < 1 + fail ArgumentError, "invalid value for 'unix_uid', must be greater than or equal to 1." end @unix_uid = unix_uid @@ -414,8 +414,8 @@ def unix_uid=(unix_uid) # @param [Object] unix_guid Value to be assigned def unix_guid=(unix_guid) - if !unix_guid.nil? && unix_guid < 0 - fail ArgumentError, "invalid value for 'unix_guid', must be greater than or equal to 0." + if !unix_guid.nil? && unix_guid < 1 + fail ArgumentError, "invalid value for 'unix_guid', must be greater than or equal to 1." end @unix_guid = unix_guid diff --git a/jcapiv2/lib/jcapiv2/version.rb b/jcapiv2/lib/jcapiv2/version.rb index f408a3d..f9a141f 100644 --- a/jcapiv2/lib/jcapiv2/version.rb +++ b/jcapiv2/lib/jcapiv2/version.rb @@ -11,5 +11,5 @@ =end module JCAPIv2 - VERSION = "1.2.0" + VERSION = "1.3.0" end diff --git a/jcapiv2/spec/api/applications_api_spec.rb b/jcapiv2/spec/api/applications_api_spec.rb index db12b1a..563f97b 100644 --- a/jcapiv2/spec/api/applications_api_spec.rb +++ b/jcapiv2/spec/api/applications_api_spec.rb @@ -68,7 +68,7 @@ # unit tests for graph_application_traverse_user # List the Users bound to an Application - # This endpoint will return all Users bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Users bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param application_id ObjectID of the Application. # @param content_type # @param accept diff --git a/jcapiv2/spec/api/bulk_job_requests_api_spec.rb b/jcapiv2/spec/api/bulk_job_requests_api_spec.rb index 2fb6319..a1f589a 100644 --- a/jcapiv2/spec/api/bulk_job_requests_api_spec.rb +++ b/jcapiv2/spec/api/bulk_job_requests_api_spec.rb @@ -48,8 +48,8 @@ end # unit tests for bulk_users_create_results - # List Bulk Users Create Results - # This endpoint will return the results of particular import job request. ###Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # List Bulk Users Results + # This endpoint will return the results of particular user import or update job request. ###Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param job_id # @param content_type # @param accept @@ -64,6 +64,21 @@ end end + # unit tests for bulk_users_update + # Bulk Users Update + # The endpoint allows you to create a bulk job to asynchronously update users. #### Sample Request ``` curl -X PATCH https://console.jumpcloud.com/api/v2/bulk/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '[ { \"id\":\"5be9fb4ddb01290001e85109\", \"firstname\":\"{UPDATED_FIRSTNAME}\", \"department\":\"{UPDATED_DEPARTMENT}\", \"attributes\":[ {\"name\":\"Custom\",\"value\":\"{ATTRIBUTE_VALUE}\"} ] }, { \"id\":\"5be9fb4ddb01290001e85109\", \"firstname\":\"{UPDATED_FIRSTNAME}\", \"costCenter\":\"{UPDATED_COST_CENTER}\", \"phoneNumbers\":[ {\"type\":\"home\",\"number\":\"{HOME_PHONE_NUMBER}\"}, {\"type\":\"work\",\"number\":\"{WORK_PHONE_NUMBER}\"} ] } ] ``` + # @param content_type + # @param accept + # @param [Hash] opts the optional parameters + # @option opts [Array] :body + # @option opts [String] :x_org_id + # @return [JobId] + describe 'bulk_users_update test' do + it "should work" do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + # unit tests for jobs_get # Get Job (incomplete) # **This endpoint is not complete and should remain hidden as it's not functional yet.** @@ -81,7 +96,7 @@ # unit tests for jobs_results # List Job Results - # This endpoint will return the results of particular import job request. ###Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/jobs/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return the results of particular import job request. ###Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/jobs/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param id # @param content_type # @param accept diff --git a/jcapiv2/spec/api/g_suite_api_spec.rb b/jcapiv2/spec/api/g_suite_api_spec.rb index fe675c0..e5c6dbc 100644 --- a/jcapiv2/spec/api/g_suite_api_spec.rb +++ b/jcapiv2/spec/api/g_suite_api_spec.rb @@ -98,4 +98,68 @@ end end + # unit tests for translation_rules_g_suite_delete + # Deletes a G Suite translation rule + # This endpoint allows you to delete a translation rule for a specific G Suite instance. These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. #### Sample Request ``` curl -X DELETE https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # @param gsuite_id + # @param id + # @param content_type + # @param accept + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'translation_rules_g_suite_delete test' do + it "should work" do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for translation_rules_g_suite_get + # Gets a specific g suite translation rule + # This endpoint returns a specific translation rule for a specific G Suite instance. These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. ###### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules/{id} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # @param gsuite_id + # @param id + # @param content_type + # @param accept + # @param [Hash] opts the optional parameters + # @return [GSuiteTranslationRule] + describe 'translation_rules_g_suite_get test' do + it "should work" do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for translation_rules_g_suite_list + # List all the G Suite Translation Rules + # This endpoint returns all graph translation rules for a specific G Suite instance. These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # @param gsuite_id + # @param content_type + # @param accept + # @param [Hash] opts the optional parameters + # @option opts [Array] :fields The comma separated fields included in the returned records. If omitted the default list of fields will be returned. + # @option opts [Array] :filter Supported operators are: eq, ne, gt, ge, lt, le, between, search, in + # @option opts [Integer] :limit The number of records to return at once. Limited to 100. + # @option opts [Integer] :skip The offset into the records to return. + # @option opts [Array] :sort The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. + # @return [Array] + describe 'translation_rules_g_suite_list test' do + it "should work" do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for translation_rules_g_suite_post + # Create a new G Suite Translation Rule + # This endpoint allows you to create a translation rule for a specific G Suite instance. These rules specify how JumpCloud attributes translate to [G Suite Admin SDK](https://developers.google.com/admin-sdk/directory/) attributes. ##### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/gsuites/{gsuite_id}/translationrules \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ {Translation Rule Parameters} }' ``` + # @param gsuite_id + # @param content_type + # @param accept + # @param [Hash] opts the optional parameters + # @option opts [GSuiteTranslationRuleRequest] :body + # @return [InlineResponse201] + describe 'translation_rules_g_suite_post test' do + it "should work" do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + end diff --git a/jcapiv2/spec/api/graph_api_spec.rb b/jcapiv2/spec/api/graph_api_spec.rb index f8cce61..9133f47 100644 --- a/jcapiv2/spec/api/graph_api_spec.rb +++ b/jcapiv2/spec/api/graph_api_spec.rb @@ -119,7 +119,7 @@ # unit tests for graph_application_traverse_user # List the Users bound to an Application - # This endpoint will return all Users bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Users bound to an Application, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Application to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this Application. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/applications/{Application_ID}/users \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param application_id ObjectID of the Application. # @param content_type # @param accept @@ -457,7 +457,7 @@ # unit tests for graph_policy_traverse_system # List the Systems bound to a Policy - # This endpoint will return all Systems bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Policy to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Systems bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Policy to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param policy_id ObjectID of the Command. # @param content_type # @param accept @@ -525,7 +525,7 @@ # unit tests for graph_radius_server_traverse_user # List the Users bound to a RADIUS Server - # This endpoint will return all Users bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Users bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param radiusserver_id ObjectID of the Radius Server. # @param content_type # @param accept @@ -542,7 +542,7 @@ # unit tests for graph_radius_server_traverse_user_group # List the User Groups bound to a RADIUS Server - # This endpoint will return all Users Groups bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Users Groups bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param radiusserver_id ObjectID of the Radius Server. # @param content_type # @param accept @@ -579,7 +579,7 @@ # unit tests for graph_system_associations_post # Manage associations of a System - # This endpoint allows you to manage the _direct_ associations of a System. A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"user\", \"id\": \"UserID\" }' ``` + # This endpoint allows you to manage the _direct_ associations of a System. A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"user\", \"id\": \"UserID\" }' ``` # @param system_id ObjectID of the System. # @param content_type # @param accept @@ -810,7 +810,7 @@ # unit tests for graph_system_traverse_policy # List the Policies bound to a System - # This endpoint will return all Policies bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System. See `/members` and `/associations` endpoints to manage those collections. This endpoint is not yet public as we have finish the code. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/{System_ID}/policies \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Policies bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System. See `/members` and `/associations` endpoints to manage those collections. This endpoint is not yet public as we have finish the code. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/{System_ID}/policies \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param system_id ObjectID of the System. # @param content_type # @param accept @@ -827,16 +827,17 @@ # unit tests for graph_system_traverse_user # List the Users bound to a System - # This endpoint will return all Users bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Users bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param system_id ObjectID of the System. # @param content_type # @param accept # @param [Hash] opts the optional parameters # @option opts [Integer] :limit The number of records to return at once. Limited to 100. + # @option opts [String] :x_org_id # @option opts [Integer] :skip The offset into the records to return. # @option opts [String] :date Current date header for the System Context API # @option opts [String] :authorization Authorization header for the System Context API - # @option opts [String] :x_org_id + # @option opts [Array] :filter Supported operators are: eq, ne, gt, ge, lt, le, between, search, in # @return [Array] describe 'graph_system_traverse_user test' do it "should work" do @@ -846,7 +847,7 @@ # unit tests for graph_system_traverse_user_group # List the User Groups bound to a System - # This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param system_id ObjectID of the System. # @param content_type # @param accept @@ -883,7 +884,7 @@ # unit tests for graph_user_associations_post # Manage the associations of a User - # This endpoint allows you to manage the _direct_ associations of a User. A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"system_group\", \"id\": \"{GroupID}\" }' + # This endpoint allows you to manage the _direct_ associations of a User. A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"system_group\", \"id\": \"{GroupID}\" }' # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -1004,7 +1005,7 @@ # unit tests for graph_user_group_traverse_active_directory # List the Active Directories bound to a User Group - # This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -1106,7 +1107,7 @@ # unit tests for graph_user_group_traverse_radius_server # List the RADIUS Servers bound to a User Group - # This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -1123,7 +1124,7 @@ # unit tests for graph_user_group_traverse_system # List the Systems bound to a User Group - # This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -1140,7 +1141,7 @@ # unit tests for graph_user_group_traverse_system_group # List the System Groups bound to User Groups - # This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -1176,7 +1177,7 @@ # unit tests for graph_user_traverse_application # List the Applications bound to a User - # This endpoint will return all Applications bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/applications \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Applications bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/applications \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -1193,7 +1194,7 @@ # unit tests for graph_user_traverse_directory # List the Directories bound to a User - # This endpoint will return all Directories bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/directories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Directories bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/directories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -1210,7 +1211,7 @@ # unit tests for graph_user_traverse_g_suite # List the G Suite instances bound to a User - # This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -1227,7 +1228,7 @@ # unit tests for graph_user_traverse_ldap_server # List the LDAP servers bound to a User - # This endpoint will return all LDAP Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/ldapservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all LDAP Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/ldapservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -1244,7 +1245,7 @@ # unit tests for graph_user_traverse_office365 # List the Office 365 instances bound to a User - # This endpoint will return all Office 365 Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/office365s \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Office 365 Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/office365s \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -1261,7 +1262,7 @@ # unit tests for graph_user_traverse_radius_server # List the RADIUS Servers bound to a User - # This endpoint will return all RADIUS Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all RADIUS Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -1278,14 +1279,15 @@ # unit tests for graph_user_traverse_system # List the Systems bound to a User - # This endpoint will return all Systems bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systems\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Systems bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systems\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept # @param [Hash] opts the optional parameters # @option opts [Integer] :limit The number of records to return at once. Limited to 100. - # @option opts [Integer] :skip The offset into the records to return. # @option opts [String] :x_org_id + # @option opts [Integer] :skip The offset into the records to return. + # @option opts [Array] :filter Supported operators are: eq, ne, gt, ge, lt, le, between, search, in # @return [Array] describe 'graph_user_traverse_system test' do it "should work" do @@ -1295,7 +1297,7 @@ # unit tests for graph_user_traverse_system_group # List the System Groups bound to a User - # This endpoint will return all System Groups bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systemgroups\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all System Groups bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systemgroups\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept diff --git a/jcapiv2/spec/api/office365_api_spec.rb b/jcapiv2/spec/api/office365_api_spec.rb index aa32047..bf082f9 100644 --- a/jcapiv2/spec/api/office365_api_spec.rb +++ b/jcapiv2/spec/api/office365_api_spec.rb @@ -100,4 +100,68 @@ end end + # unit tests for translation_rules_office365_delete + # Deletes a Office 365 translation rule + # This endpoint allows you to delete a translation rule for a specific Office 365 instance. These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. #### Sample Request ``` curl -X DELETE https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # @param office365_id + # @param id + # @param content_type + # @param accept + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'translation_rules_office365_delete test' do + it "should work" do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for translation_rules_office365_get + # Gets a specific Office 365 translation rule + # This endpoint returns a specific translation rule for a specific Office 365 instance. These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. ###### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # @param office365_id + # @param id + # @param content_type + # @param accept + # @param [Hash] opts the optional parameters + # @return [Office365TranslationRule] + describe 'translation_rules_office365_get test' do + it "should work" do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for translation_rules_office365_list + # List all the Office 365 Translation Rules + # This endpoint returns all translation rules for a specific Office 365 instance. These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # @param office365_id + # @param content_type + # @param accept + # @param [Hash] opts the optional parameters + # @option opts [Array] :fields The comma separated fields included in the returned records. If omitted the default list of fields will be returned. + # @option opts [Array] :filter Supported operators are: eq, ne, gt, ge, lt, le, between, search, in + # @option opts [Integer] :limit The number of records to return at once. Limited to 100. + # @option opts [Integer] :skip The offset into the records to return. + # @option opts [Array] :sort The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. + # @return [Array] + describe 'translation_rules_office365_list test' do + it "should work" do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for translation_rules_office365_post + # Create a new Office 365 Translation Rule + # This endpoint allows you to create a translation rule for a specific Office 365 instance. These rules specify how JumpCloud attributes translate to [Microsoft Graph](https://developer.microsoft.com/en-us/graph) attributes. ##### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ {Translation Rule Parameters} }' ``` + # @param office365_id + # @param content_type + # @param accept + # @param [Hash] opts the optional parameters + # @option opts [Office365TranslationRuleRequest] :body + # @return [InlineResponse2011] + describe 'translation_rules_office365_post test' do + it "should work" do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + end diff --git a/jcapiv2/spec/api/policies_api_spec.rb b/jcapiv2/spec/api/policies_api_spec.rb index 6b4295d..7ab40ef 100644 --- a/jcapiv2/spec/api/policies_api_spec.rb +++ b/jcapiv2/spec/api/policies_api_spec.rb @@ -68,7 +68,7 @@ # unit tests for graph_policy_traverse_system # List the Systems bound to a Policy - # This endpoint will return all Systems bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Policy to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Systems bound to a Policy, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this Policy to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this Policy. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param policy_id ObjectID of the Command. # @param content_type # @param accept @@ -151,7 +151,7 @@ # unit tests for policies_post # Create a new Policy - # This endpoint allows you to create a policy. Given the amount of configurable parameters required to create a Policy, we suggest you use the JumpCloud Admin Console to create new policies. ##### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/policies \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ {Policy_Parameters} }' ``` + # This endpoint allows you to create a policy. Given the amount of configurable parameters required to create a Policy, we suggest you use the JumpCloud Admin Console to create new policies. ##### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/policies \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ {Policy_Parameters} }' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -195,7 +195,7 @@ # unit tests for policyresults_list # Lists all the policy results of a policy. - # This endpoint returns all policies results for a specific policy. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policyresults \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint returns all policies results for a specific policy. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policyresults \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param policy_id # @param content_type # @param accept @@ -216,7 +216,7 @@ # unit tests for policyresults_list_0 # Lists all the policy results for an organization. - # This endpoint returns all policies results for an Organization. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policyresults \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint returns all policies results for an Organization. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policyresults \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -235,9 +235,9 @@ end # unit tests for policystatuses_list - # List the policy statuses for a system - # This endpoint returns the policy results for a particular system. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policystatuses \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` - # @param system_id ObjectID of the System. + # Lists the latest policy results of a policy. + # This endpoint returns the latest policies results for a specific policy. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policystatuses \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # @param policy_id # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -255,9 +255,9 @@ end # unit tests for policystatuses_list_0 - # Lists the latest policy results of a policy. - # This endpoint returns the latest policies results for a specific policy. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/policies/{Policy_ID}/policystatuses \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` - # @param policy_id + # List the policy statuses for a system + # This endpoint returns the policy results for a particular system. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/policystatuses \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # @param system_id ObjectID of the System. # @param content_type # @param accept # @param [Hash] opts the optional parameters diff --git a/jcapiv2/spec/api/radius_servers_api_spec.rb b/jcapiv2/spec/api/radius_servers_api_spec.rb index 5fffc57..48b4aae 100644 --- a/jcapiv2/spec/api/radius_servers_api_spec.rb +++ b/jcapiv2/spec/api/radius_servers_api_spec.rb @@ -68,7 +68,7 @@ # unit tests for graph_radius_server_traverse_user # List the Users bound to a RADIUS Server - # This endpoint will return all Users bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Users bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param radiusserver_id ObjectID of the Radius Server. # @param content_type # @param accept @@ -85,7 +85,7 @@ # unit tests for graph_radius_server_traverse_user_group # List the User Groups bound to a RADIUS Server - # This endpoint will return all Users Groups bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Users Groups bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this RADIUS server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this RADIUS server instance. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param radiusserver_id ObjectID of the Radius Server. # @param content_type # @param accept diff --git a/jcapiv2/spec/api/samba_domains_api_spec.rb b/jcapiv2/spec/api/samba_domains_api_spec.rb index f034b6a..8f224a7 100644 --- a/jcapiv2/spec/api/samba_domains_api_spec.rb +++ b/jcapiv2/spec/api/samba_domains_api_spec.rb @@ -86,7 +86,7 @@ # unit tests for ldapservers_samba_domains_post # Create Samba Domain - # This endpoint allows you to create a samba domain for an LDAP server. ##### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"sid\":\"{SID_ID}\", \"name\":\"{WORKGROUP_NAME}\" }' ``` + # This endpoint allows you to create a samba domain for an LDAP server. ##### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"sid\":\"{SID_ID}\", \"name\":\"{WORKGROUP_NAME}\" }' ``` # @param ldapserver_id Unique identifier of the LDAP server. # @param [Hash] opts the optional parameters # @option opts [SambaDomainInput] :body @@ -102,7 +102,7 @@ # unit tests for ldapservers_samba_domains_put # Update Samba Domain - # This endpoint allows you to update the samba domain information for an LDAP server. ##### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"sid\":\"{SID_ID}\", \"name\":\"{WORKGROUP_NAME}\" }' ``` + # This endpoint allows you to update the samba domain information for an LDAP server. ##### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/sambadomains/{SAMBA_ID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"sid\":\"{SID_ID}\", \"name\":\"{WORKGROUP_NAME}\" }' ``` # @param ldapserver_id Unique identifier of the LDAP server. # @param id Unique identifier of the samba domain. # @param [Hash] opts the optional parameters diff --git a/jcapiv2/spec/api/systems_api_spec.rb b/jcapiv2/spec/api/systems_api_spec.rb index 74d0909..fb58081 100644 --- a/jcapiv2/spec/api/systems_api_spec.rb +++ b/jcapiv2/spec/api/systems_api_spec.rb @@ -54,7 +54,7 @@ # unit tests for graph_system_associations_post # Manage associations of a System - # This endpoint allows you to manage the _direct_ associations of a System. A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"user\", \"id\": \"UserID\" }' ``` + # This endpoint allows you to manage the _direct_ associations of a System. A direct association can be a non-homogeneous relationship between 2 different objects, for example Systems and Users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/systems/{System_ID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"user\", \"id\": \"UserID\" }' ``` # @param system_id ObjectID of the System. # @param content_type # @param accept @@ -110,7 +110,7 @@ # unit tests for graph_system_traverse_policy # List the Policies bound to a System - # This endpoint will return all Policies bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System. See `/members` and `/associations` endpoints to manage those collections. This endpoint is not yet public as we have finish the code. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/{System_ID}/policies \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Policies bound to a System, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding Policy; this array represents all grouping and/or associations that would have to be removed to deprovision the Policy from this System. See `/members` and `/associations` endpoints to manage those collections. This endpoint is not yet public as we have finish the code. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/{System_ID}/policies \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param system_id ObjectID of the System. # @param content_type # @param accept @@ -127,16 +127,17 @@ # unit tests for graph_system_traverse_user # List the Users bound to a System - # This endpoint will return all Users bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Users bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param system_id ObjectID of the System. # @param content_type # @param accept # @param [Hash] opts the optional parameters # @option opts [Integer] :limit The number of records to return at once. Limited to 100. + # @option opts [String] :x_org_id # @option opts [Integer] :skip The offset into the records to return. # @option opts [String] :date Current date header for the System Context API # @option opts [String] :authorization Authorization header for the System Context API - # @option opts [String] :x_org_id + # @option opts [Array] :filter Supported operators are: eq, ne, gt, ge, lt, le, between, search, in # @return [Array] describe 'graph_system_traverse_user test' do it "should work" do @@ -146,7 +147,7 @@ # unit tests for graph_system_traverse_user_group # List the User Groups bound to a System - # This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all User Groups bound to a System, either directly or indirectly essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this System to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this System. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/systems/{System_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param system_id ObjectID of the System. # @param content_type # @param accept diff --git a/jcapiv2/spec/api/user_group_associations_api_spec.rb b/jcapiv2/spec/api/user_group_associations_api_spec.rb index e4b49f1..db85c9a 100644 --- a/jcapiv2/spec/api/user_group_associations_api_spec.rb +++ b/jcapiv2/spec/api/user_group_associations_api_spec.rb @@ -68,7 +68,7 @@ # unit tests for graph_user_group_traverse_active_directory # List the Active Directories bound to a User Group - # This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -170,7 +170,7 @@ # unit tests for graph_user_group_traverse_radius_server # List the RADIUS Servers bound to a User Group - # This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -187,7 +187,7 @@ # unit tests for graph_user_group_traverse_system # List the Systems bound to a User Group - # This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -204,7 +204,7 @@ # unit tests for graph_user_group_traverse_system_group # List the System Groups bound to User Groups - # This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept diff --git a/jcapiv2/spec/api/user_groups_api_spec.rb b/jcapiv2/spec/api/user_groups_api_spec.rb index fc88f13..ae0c4b2 100644 --- a/jcapiv2/spec/api/user_groups_api_spec.rb +++ b/jcapiv2/spec/api/user_groups_api_spec.rb @@ -139,7 +139,7 @@ # unit tests for graph_user_group_traverse_active_directory # List the Active Directories bound to a User Group - # This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -241,7 +241,7 @@ # unit tests for graph_user_group_traverse_radius_server # List the RADIUS Servers bound to a User Group - # This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all RADIUS servers bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -258,7 +258,7 @@ # unit tests for graph_user_group_traverse_system # List the Systems bound to a User Group - # This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Systems bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -275,7 +275,7 @@ # unit tests for graph_user_group_traverse_system_group # List the System Groups bound to User Groups - # This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all System Groups bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param group_id ObjectID of the User Group. # @param content_type # @param accept @@ -372,7 +372,7 @@ # unit tests for groups_user_put # Update a User Group - # This endpoint allows you to do a full update of the User Group. #### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/v2/usergroups/{Group_ID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY' \\ -d '{ \"name\": \"group_update\" }' ``` + # This endpoint allows you to do a full update of the User Group. #### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/v2/usergroups/{Group_ID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY' \\ -d '{ \"name\": \"group_update\" }' ``` # @param id ObjectID of the User Group. # @param content_type # @param accept diff --git a/jcapiv2/spec/api/users_api_spec.rb b/jcapiv2/spec/api/users_api_spec.rb index 2f62cc3..7f14edd 100644 --- a/jcapiv2/spec/api/users_api_spec.rb +++ b/jcapiv2/spec/api/users_api_spec.rb @@ -52,7 +52,7 @@ # unit tests for graph_user_associations_post # Manage the associations of a User - # This endpoint allows you to manage the _direct_ associations of a User. A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"system_group\", \"id\": \"{GroupID}\" }' + # This endpoint allows you to manage the _direct_ associations of a User. A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"attributes\": { \"sudo\": { \"enabled\": true, \"withoutPassword\": false } }, \"op\": \"add\", \"type\": \"system_group\", \"id\": \"{GroupID}\" }' # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -87,7 +87,7 @@ # unit tests for graph_user_traverse_application # List the Applications bound to a User - # This endpoint will return all Applications bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/applications \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Applications bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/applications \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -104,7 +104,7 @@ # unit tests for graph_user_traverse_directory # List the Directories bound to a User - # This endpoint will return all Directories bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/directories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Directories bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/directories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -121,7 +121,7 @@ # unit tests for graph_user_traverse_g_suite # List the G Suite instances bound to a User - # This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -138,7 +138,7 @@ # unit tests for graph_user_traverse_ldap_server # List the LDAP servers bound to a User - # This endpoint will return all LDAP Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/ldapservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all LDAP Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/ldapservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -155,7 +155,7 @@ # unit tests for graph_user_traverse_office365 # List the Office 365 instances bound to a User - # This endpoint will return all Office 365 Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/office365s \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Office 365 Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/office365s \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -172,7 +172,7 @@ # unit tests for graph_user_traverse_radius_server # List the RADIUS Servers bound to a User - # This endpoint will return all RADIUS Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all RADIUS Servers bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -189,14 +189,15 @@ # unit tests for graph_user_traverse_system # List the Systems bound to a User - # This endpoint will return all Systems bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systems\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all Systems bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systems\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept # @param [Hash] opts the optional parameters # @option opts [Integer] :limit The number of records to return at once. Limited to 100. - # @option opts [Integer] :skip The offset into the records to return. # @option opts [String] :x_org_id + # @option opts [Integer] :skip The offset into the records to return. + # @option opts [Array] :filter Supported operators are: eq, ne, gt, ge, lt, le, between, search, in # @return [Array] describe 'graph_user_traverse_system test' do it "should work" do @@ -206,7 +207,7 @@ # unit tests for graph_user_traverse_system_group # List the System Groups bound to a User - # This endpoint will return all System Groups bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systemgroups\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all System Groups bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The `attributes` object is a key/value hash of compiled graph attributes for all paths followed. The `paths` array enumerates each path from this User to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User. See `/members` and `/associations` endpoints to manage those collections. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/systemgroups\\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param user_id ObjectID of the User. # @param content_type # @param accept @@ -221,7 +222,7 @@ end end - # unit tests for user_send_emails + # unit tests for users_send_emails # Send User Emails # This endpoint allows you to send a specific email to a user without waiting for or triggering a workflow. # @param user_id ObjectID of the User. @@ -231,7 +232,7 @@ # @option opts [Emailrequest] :body # @option opts [String] :x_org_id # @return [nil] - describe 'user_send_emails test' do + describe 'users_send_emails test' do it "should work" do # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers end diff --git a/jcapiv2/spec/api/workday_import_api_spec.rb b/jcapiv2/spec/api/workday_import_api_spec.rb index e9c38ee..482524c 100644 --- a/jcapiv2/spec/api/workday_import_api_spec.rb +++ b/jcapiv2/spec/api/workday_import_api_spec.rb @@ -65,7 +65,7 @@ # unit tests for workdays_delete # Delete Workday - # This endpoint allows you to delete an instance of Workday. **This functionality is currently not enable for users.** + # This endpoint allows you to delete an instance of Workday. **This functionality is currently not enable for users.** # @param id # @param content_type # @param accept @@ -148,7 +148,7 @@ # unit tests for workdays_post # Create new Workday - # This endpoint allows you to create a new workday instance. You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. Failure to provide these credentials will result in the request being rejected. Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. Currently, only one instance is allowed and it must be `Workday Import`. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/workdays/ \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"name\": \"Workday2\", \"reportUrl\":\"https://workday.com/ccx/service/customreport2/gms/user/reportname?format=json\", \"auth\": { \"basic\": { \"username\": \"someDeveloper\", \"password\": \"notTheRealPassword\" } } }' ``` + # This endpoint allows you to create a new workday instance. You must supply a username and password for `Basic Authentication` that is the same as your WorkDay Integrator System User. Failure to provide these credentials will result in the request being rejected. Currently `O-Auth` isn't a supported authentication protocol for WorkDay, but will be in the future. Currently, only one instance is allowed and it must be `Workday Import`. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/workdays/ \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"name\": \"Workday2\", \"reportUrl\":\"https://workday.com/ccx/service/customreport2/gms/user/reportname?format=json\", \"auth\": { \"basic\": { \"username\": \"someDeveloper\", \"password\": \"notTheRealPassword\" } } }' ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -179,7 +179,7 @@ # unit tests for workdays_settings # Get Workday Settings (incomplete) - # This endpoint allows you to obtain all settings needed for creating a workday instance, specifically the URL to initiate Basic Authentication with WorkDay. **This functionality is currently not enable for users.** + # This endpoint allows you to obtain all settings needed for creating a workday instance, specifically the URL to initiate Basic Authentication with WorkDay. **This functionality is currently not enable for users.** # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -194,7 +194,7 @@ # unit tests for workdays_workers # List Workday Workers - # This endpoint will return all of the data in your WorkDay Custom Report that has been associated with your WorkDay Instance in JumpCloud. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/workers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return all of the data in your WorkDay Custom Report that has been associated with your WorkDay Instance in JumpCloud. ##### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/workers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param workday_id # @param content_type # @param accept diff --git a/jcapiv2/spec/models/bulk_user_update_spec.rb b/jcapiv2/spec/models/bulk_user_update_spec.rb new file mode 100644 index 0000000..0a7fed7 --- /dev/null +++ b/jcapiv2/spec/models/bulk_user_update_spec.rb @@ -0,0 +1,48 @@ +=begin +#JumpCloud APIs + +# JumpCloud's V2 API. This set of endpoints allows JumpCloud customers to manage objects, groupings and mappings and interact with the JumpCloud Graph. + +OpenAPI spec version: 2.0 + +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.3.1 + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for JCAPIv2::BulkUserUpdate +# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) +# Please update as you see appropriate +describe 'BulkUserUpdate' do + before do + # run before each test + @instance = JCAPIv2::BulkUserUpdate.new + end + + after do + # run after each test + end + + describe 'test an instance of BulkUserUpdate' do + it 'should create an instance of BulkUserUpdate' do + expect(@instance).to be_instance_of(JCAPIv2::BulkUserUpdate) + end + end + describe 'test attribute "id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "attributes"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end + diff --git a/jcapiv2/spec/models/emailrequest_spec.rb b/jcapiv2/spec/models/emailrequest_spec.rb index 6ea6875..c120321 100644 --- a/jcapiv2/spec/models/emailrequest_spec.rb +++ b/jcapiv2/spec/models/emailrequest_spec.rb @@ -35,6 +35,10 @@ describe 'test attribute "email_type"' do it 'should work' do # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + #validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["activation"]) + #validator.allowable_values.each do |value| + # expect { @instance.email_type = value }.not_to raise_error + #end end end diff --git a/jcapiv2/spec/models/g_suite_builtin_translation_spec.rb b/jcapiv2/spec/models/g_suite_builtin_translation_spec.rb new file mode 100644 index 0000000..76012e8 --- /dev/null +++ b/jcapiv2/spec/models/g_suite_builtin_translation_spec.rb @@ -0,0 +1,36 @@ +=begin +#JumpCloud APIs + +# JumpCloud's V2 API. This set of endpoints allows JumpCloud customers to manage objects, groupings and mappings and interact with the JumpCloud Graph. + +OpenAPI spec version: 2.0 + +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.3.1 + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for JCAPIv2::GSuiteBuiltinTranslation +# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) +# Please update as you see appropriate +describe 'GSuiteBuiltinTranslation' do + before do + # run before each test + @instance = JCAPIv2::GSuiteBuiltinTranslation.new + end + + after do + # run after each test + end + + describe 'test an instance of GSuiteBuiltinTranslation' do + it 'should create an instance of GSuiteBuiltinTranslation' do + expect(@instance).to be_instance_of(JCAPIv2::GSuiteBuiltinTranslation) + end + end +end + diff --git a/jcapiv2/spec/models/g_suite_translation_rule_request_spec.rb b/jcapiv2/spec/models/g_suite_translation_rule_request_spec.rb new file mode 100644 index 0000000..4203aba --- /dev/null +++ b/jcapiv2/spec/models/g_suite_translation_rule_request_spec.rb @@ -0,0 +1,42 @@ +=begin +#JumpCloud APIs + +# JumpCloud's V2 API. This set of endpoints allows JumpCloud customers to manage objects, groupings and mappings and interact with the JumpCloud Graph. + +OpenAPI spec version: 2.0 + +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.3.1 + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for JCAPIv2::GSuiteTranslationRuleRequest +# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) +# Please update as you see appropriate +describe 'GSuiteTranslationRuleRequest' do + before do + # run before each test + @instance = JCAPIv2::GSuiteTranslationRuleRequest.new + end + + after do + # run after each test + end + + describe 'test an instance of GSuiteTranslationRuleRequest' do + it 'should create an instance of GSuiteTranslationRuleRequest' do + expect(@instance).to be_instance_of(JCAPIv2::GSuiteTranslationRuleRequest) + end + end + describe 'test attribute "built_in"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end + diff --git a/jcapiv2/spec/models/g_suite_translation_rule_spec.rb b/jcapiv2/spec/models/g_suite_translation_rule_spec.rb new file mode 100644 index 0000000..da930ec --- /dev/null +++ b/jcapiv2/spec/models/g_suite_translation_rule_spec.rb @@ -0,0 +1,48 @@ +=begin +#JumpCloud APIs + +# JumpCloud's V2 API. This set of endpoints allows JumpCloud customers to manage objects, groupings and mappings and interact with the JumpCloud Graph. + +OpenAPI spec version: 2.0 + +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.3.1 + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for JCAPIv2::GSuiteTranslationRule +# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) +# Please update as you see appropriate +describe 'GSuiteTranslationRule' do + before do + # run before each test + @instance = JCAPIv2::GSuiteTranslationRule.new + end + + after do + # run after each test + end + + describe 'test an instance of GSuiteTranslationRule' do + it 'should create an instance of GSuiteTranslationRule' do + expect(@instance).to be_instance_of(JCAPIv2::GSuiteTranslationRule) + end + end + describe 'test attribute "built_in"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end + diff --git a/jcapiv2/spec/models/inline_response_201_1_spec.rb b/jcapiv2/spec/models/inline_response_201_1_spec.rb new file mode 100644 index 0000000..a5b93a7 --- /dev/null +++ b/jcapiv2/spec/models/inline_response_201_1_spec.rb @@ -0,0 +1,42 @@ +=begin +#JumpCloud APIs + +# JumpCloud's V2 API. This set of endpoints allows JumpCloud customers to manage objects, groupings and mappings and interact with the JumpCloud Graph. + +OpenAPI spec version: 2.0 + +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.3.1 + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for JCAPIv2::InlineResponse2011 +# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) +# Please update as you see appropriate +describe 'InlineResponse2011' do + before do + # run before each test + @instance = JCAPIv2::InlineResponse2011.new + end + + after do + # run after each test + end + + describe 'test an instance of InlineResponse2011' do + it 'should create an instance of InlineResponse2011' do + expect(@instance).to be_instance_of(JCAPIv2::InlineResponse2011) + end + end + describe 'test attribute "rule"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end + diff --git a/jcapiv2/spec/models/inline_response_201_spec.rb b/jcapiv2/spec/models/inline_response_201_spec.rb new file mode 100644 index 0000000..b42f414 --- /dev/null +++ b/jcapiv2/spec/models/inline_response_201_spec.rb @@ -0,0 +1,42 @@ +=begin +#JumpCloud APIs + +# JumpCloud's V2 API. This set of endpoints allows JumpCloud customers to manage objects, groupings and mappings and interact with the JumpCloud Graph. + +OpenAPI spec version: 2.0 + +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.3.1 + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for JCAPIv2::InlineResponse201 +# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) +# Please update as you see appropriate +describe 'InlineResponse201' do + before do + # run before each test + @instance = JCAPIv2::InlineResponse201.new + end + + after do + # run after each test + end + + describe 'test an instance of InlineResponse201' do + it 'should create an instance of InlineResponse201' do + expect(@instance).to be_instance_of(JCAPIv2::InlineResponse201) + end + end + describe 'test attribute "rule"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end + diff --git a/jcapiv2/spec/models/office365_builtin_translation_spec.rb b/jcapiv2/spec/models/office365_builtin_translation_spec.rb new file mode 100644 index 0000000..f242a84 --- /dev/null +++ b/jcapiv2/spec/models/office365_builtin_translation_spec.rb @@ -0,0 +1,36 @@ +=begin +#JumpCloud APIs + +# JumpCloud's V2 API. This set of endpoints allows JumpCloud customers to manage objects, groupings and mappings and interact with the JumpCloud Graph. + +OpenAPI spec version: 2.0 + +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.3.1 + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for JCAPIv2::Office365BuiltinTranslation +# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) +# Please update as you see appropriate +describe 'Office365BuiltinTranslation' do + before do + # run before each test + @instance = JCAPIv2::Office365BuiltinTranslation.new + end + + after do + # run after each test + end + + describe 'test an instance of Office365BuiltinTranslation' do + it 'should create an instance of Office365BuiltinTranslation' do + expect(@instance).to be_instance_of(JCAPIv2::Office365BuiltinTranslation) + end + end +end + diff --git a/jcapiv2/spec/models/office365_translation_rule_request_spec.rb b/jcapiv2/spec/models/office365_translation_rule_request_spec.rb new file mode 100644 index 0000000..75dad8b --- /dev/null +++ b/jcapiv2/spec/models/office365_translation_rule_request_spec.rb @@ -0,0 +1,42 @@ +=begin +#JumpCloud APIs + +# JumpCloud's V2 API. This set of endpoints allows JumpCloud customers to manage objects, groupings and mappings and interact with the JumpCloud Graph. + +OpenAPI spec version: 2.0 + +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.3.1 + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for JCAPIv2::Office365TranslationRuleRequest +# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) +# Please update as you see appropriate +describe 'Office365TranslationRuleRequest' do + before do + # run before each test + @instance = JCAPIv2::Office365TranslationRuleRequest.new + end + + after do + # run after each test + end + + describe 'test an instance of Office365TranslationRuleRequest' do + it 'should create an instance of Office365TranslationRuleRequest' do + expect(@instance).to be_instance_of(JCAPIv2::Office365TranslationRuleRequest) + end + end + describe 'test attribute "built_in"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end + diff --git a/jcapiv2/spec/models/office365_translation_rule_spec.rb b/jcapiv2/spec/models/office365_translation_rule_spec.rb new file mode 100644 index 0000000..3ff4f99 --- /dev/null +++ b/jcapiv2/spec/models/office365_translation_rule_spec.rb @@ -0,0 +1,48 @@ +=begin +#JumpCloud APIs + +# JumpCloud's V2 API. This set of endpoints allows JumpCloud customers to manage objects, groupings and mappings and interact with the JumpCloud Graph. + +OpenAPI spec version: 2.0 + +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.3.1 + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for JCAPIv2::Office365TranslationRule +# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) +# Please update as you see appropriate +describe 'Office365TranslationRule' do + before do + # run before each test + @instance = JCAPIv2::Office365TranslationRule.new + end + + after do + # run after each test + end + + describe 'test an instance of Office365TranslationRule' do + it 'should create an instance of Office365TranslationRule' do + expect(@instance).to be_instance_of(JCAPIv2::Office365TranslationRule) + end + end + describe 'test attribute "built_in"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end + diff --git a/jcapiv2/spec/models/policy_result_spec.rb b/jcapiv2/spec/models/policy_result_spec.rb index 5f828ce..c3dd2ce 100644 --- a/jcapiv2/spec/models/policy_result_spec.rb +++ b/jcapiv2/spec/models/policy_result_spec.rb @@ -86,5 +86,17 @@ end end + describe 'test attribute "state"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "detail"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + end From 3a3701256a6c62810b9913f4727423fde1dfb991 Mon Sep 17 00:00:00 2001 From: Bob Bawn Date: Wed, 16 Jan 2019 09:24:54 -0700 Subject: [PATCH 2/2] regen from latest v2 index.yaml --- jcapiv2/README.md | 2 - jcapiv2/docs/BulkJobRequestsApi.md | 8 +- jcapiv2/docs/BulkUserUpdate.md | 4 + jcapiv2/docs/GSuiteApi.md | 4 +- jcapiv2/docs/InlineResponse201.md | 8 - jcapiv2/docs/InlineResponse2011.md | 8 - jcapiv2/docs/Office365Api.md | 4 +- jcapiv2/lib/jcapiv2.rb | 2 - .../lib/jcapiv2/api/bulk_job_requests_api.rb | 16 +- jcapiv2/lib/jcapiv2/api/g_suite_api.rb | 6 +- jcapiv2/lib/jcapiv2/api/office365_api.rb | 6 +- .../lib/jcapiv2/models/bulk_user_update.rb | 38 +++- .../lib/jcapiv2/models/inline_response_201.rb | 188 ------------------ .../jcapiv2/models/inline_response_201_1.rb | 188 ------------------ .../spec/api/bulk_job_requests_api_spec.rb | 8 +- jcapiv2/spec/api/g_suite_api_spec.rb | 2 +- jcapiv2/spec/api/office365_api_spec.rb | 2 +- jcapiv2/spec/models/bulk_user_update_spec.rb | 24 +++ .../spec/models/inline_response_201_1_spec.rb | 42 ---- .../spec/models/inline_response_201_spec.rb | 42 ---- 20 files changed, 93 insertions(+), 509 deletions(-) delete mode 100644 jcapiv2/docs/InlineResponse201.md delete mode 100644 jcapiv2/docs/InlineResponse2011.md delete mode 100644 jcapiv2/lib/jcapiv2/models/inline_response_201.rb delete mode 100644 jcapiv2/lib/jcapiv2/models/inline_response_201_1.rb delete mode 100644 jcapiv2/spec/models/inline_response_201_1_spec.rb delete mode 100644 jcapiv2/spec/models/inline_response_201_spec.rb diff --git a/jcapiv2/README.md b/jcapiv2/README.md index f0cbcc2..db136bf 100644 --- a/jcapiv2/README.md +++ b/jcapiv2/README.md @@ -354,8 +354,6 @@ Class | Method | HTTP request | Description - [JCAPIv2::GraphType](docs/GraphType.md) - [JCAPIv2::Group](docs/Group.md) - [JCAPIv2::GroupType](docs/GroupType.md) - - [JCAPIv2::InlineResponse201](docs/InlineResponse201.md) - - [JCAPIv2::InlineResponse2011](docs/InlineResponse2011.md) - [JCAPIv2::JobDetails](docs/JobDetails.md) - [JCAPIv2::JobId](docs/JobId.md) - [JCAPIv2::JobWorkresult](docs/JobWorkresult.md) diff --git a/jcapiv2/docs/BulkJobRequestsApi.md b/jcapiv2/docs/BulkJobRequestsApi.md index 8091c84..f0265fd 100644 --- a/jcapiv2/docs/BulkJobRequestsApi.md +++ b/jcapiv2/docs/BulkJobRequestsApi.md @@ -16,7 +16,7 @@ Method | HTTP request | Description Bulk Users Create -The endpoint allows you to create a bulk job to asynchronously create users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/bulk/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '[ { \"email\":\"{email}\", \"firstname\":\"{firstname}\", \"lastname\":\"{firstname}\", \"username\":\"{username}\", \"attributes\":[ {\"name\":\"EmployeeID\",\"value\":\"0000\"}, {\"name\":\"Custom\",\"value\":\"attribute\"} ] } ] ``` +The endpoint allows you to create a bulk job to asynchronously create users. See [Create a System User](https://docs.jumpcloud.com/1.0/systemusers/create-a-system-user) for full list of attributes. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/bulk/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '[ { \"email\":\"{email}\", \"firstname\":\"{firstname}\", \"lastname\":\"{firstname}\", \"username\":\"{username}\", \"attributes\":[ {\"name\":\"EmployeeID\",\"value\":\"0000\"}, {\"name\":\"Custom\",\"value\":\"attribute\"} ] } ] ``` ### Example ```ruby @@ -79,7 +79,7 @@ Name | Type | Description | Notes List Bulk Users Results -This endpoint will return the results of particular user import or update job request. ###Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return the results of particular user import or update job request. #### Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby @@ -147,7 +147,7 @@ Name | Type | Description | Notes Bulk Users Update -The endpoint allows you to create a bulk job to asynchronously update users. #### Sample Request ``` curl -X PATCH https://console.jumpcloud.com/api/v2/bulk/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '[ { \"id\":\"5be9fb4ddb01290001e85109\", \"firstname\":\"{UPDATED_FIRSTNAME}\", \"department\":\"{UPDATED_DEPARTMENT}\", \"attributes\":[ {\"name\":\"Custom\",\"value\":\"{ATTRIBUTE_VALUE}\"} ] }, { \"id\":\"5be9fb4ddb01290001e85109\", \"firstname\":\"{UPDATED_FIRSTNAME}\", \"costCenter\":\"{UPDATED_COST_CENTER}\", \"phoneNumbers\":[ {\"type\":\"home\",\"number\":\"{HOME_PHONE_NUMBER}\"}, {\"type\":\"work\",\"number\":\"{WORK_PHONE_NUMBER}\"} ] } ] ``` +The endpoint allows you to create a bulk job to asynchronously update users. See [Update a System User](https://docs.jumpcloud.com/1.0/systemusers/update-a-system-user) for full list of attributes. #### Sample Request ``` curl -X PATCH https://console.jumpcloud.com/api/v2/bulk/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '[ { \"id\":\"5be9fb4ddb01290001e85109\", \"firstname\":\"{UPDATED_FIRSTNAME}\", \"department\":\"{UPDATED_DEPARTMENT}\", \"attributes\":[ {\"name\":\"Custom\",\"value\":\"{ATTRIBUTE_VALUE}\"} ] }, { \"id\":\"5be9fb4ddb01290001e85109\", \"firstname\":\"{UPDATED_FIRSTNAME}\", \"costCenter\":\"{UPDATED_COST_CENTER}\", \"phoneNumbers\":[ {\"type\":\"home\",\"number\":\"{HOME_PHONE_NUMBER}\"}, {\"type\":\"work\",\"number\":\"{WORK_PHONE_NUMBER}\"} ] } ] ``` ### Example ```ruby @@ -274,7 +274,7 @@ Name | Type | Description | Notes List Job Results -This endpoint will return the results of particular import job request. ###Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/jobs/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` +This endpoint will return the results of particular import job request. #### Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/jobs/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` ### Example ```ruby diff --git a/jcapiv2/docs/BulkUserUpdate.md b/jcapiv2/docs/BulkUserUpdate.md index 5ef3166..b9b85d1 100644 --- a/jcapiv2/docs/BulkUserUpdate.md +++ b/jcapiv2/docs/BulkUserUpdate.md @@ -4,6 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | Object ID of the systemuser being updated | [optional] +**username** | **String** | | [optional] +**firstname** | **String** | | [optional] +**lastname** | **String** | | [optional] +**email** | **String** | | [optional] **attributes** | **Array<Object>** | Map of additional attributes. | [optional] diff --git a/jcapiv2/docs/GSuiteApi.md b/jcapiv2/docs/GSuiteApi.md index a164858..e3b7032 100644 --- a/jcapiv2/docs/GSuiteApi.md +++ b/jcapiv2/docs/GSuiteApi.md @@ -478,7 +478,7 @@ Name | Type | Description | Notes # **translation_rules_g_suite_post** -> InlineResponse201 translation_rules_g_suite_post(gsuite_id, content_type, accept, opts) +> GSuiteTranslationRule translation_rules_g_suite_post(gsuite_id, content_type, accept, opts) Create a new G Suite Translation Rule @@ -528,7 +528,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse201**](InlineResponse201.md) +[**GSuiteTranslationRule**](GSuiteTranslationRule.md) ### Authorization diff --git a/jcapiv2/docs/InlineResponse201.md b/jcapiv2/docs/InlineResponse201.md deleted file mode 100644 index da4958b..0000000 --- a/jcapiv2/docs/InlineResponse201.md +++ /dev/null @@ -1,8 +0,0 @@ -# JCAPIv2::InlineResponse201 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**rule** | [**GSuiteTranslationRule**](GSuiteTranslationRule.md) | | [optional] - - diff --git a/jcapiv2/docs/InlineResponse2011.md b/jcapiv2/docs/InlineResponse2011.md deleted file mode 100644 index f5c6522..0000000 --- a/jcapiv2/docs/InlineResponse2011.md +++ /dev/null @@ -1,8 +0,0 @@ -# JCAPIv2::InlineResponse2011 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**rule** | [**Office365TranslationRule**](Office365TranslationRule.md) | | [optional] - - diff --git a/jcapiv2/docs/Office365Api.md b/jcapiv2/docs/Office365Api.md index 0988ca7..bdb616f 100644 --- a/jcapiv2/docs/Office365Api.md +++ b/jcapiv2/docs/Office365Api.md @@ -484,7 +484,7 @@ Name | Type | Description | Notes # **translation_rules_office365_post** -> InlineResponse2011 translation_rules_office365_post(office365_id, content_type, accept, opts) +> Office365TranslationRule translation_rules_office365_post(office365_id, content_type, accept, opts) Create a new Office 365 Translation Rule @@ -534,7 +534,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse2011**](InlineResponse2011.md) +[**Office365TranslationRule**](Office365TranslationRule.md) ### Authorization diff --git a/jcapiv2/lib/jcapiv2.rb b/jcapiv2/lib/jcapiv2.rb index 8379eb5..4840a86 100644 --- a/jcapiv2/lib/jcapiv2.rb +++ b/jcapiv2/lib/jcapiv2.rb @@ -39,8 +39,6 @@ require 'jcapiv2/models/graph_type' require 'jcapiv2/models/group' require 'jcapiv2/models/group_type' -require 'jcapiv2/models/inline_response_201' -require 'jcapiv2/models/inline_response_201_1' require 'jcapiv2/models/job_details' require 'jcapiv2/models/job_id' require 'jcapiv2/models/job_workresult' diff --git a/jcapiv2/lib/jcapiv2/api/bulk_job_requests_api.rb b/jcapiv2/lib/jcapiv2/api/bulk_job_requests_api.rb index 110e8b2..535f95a 100644 --- a/jcapiv2/lib/jcapiv2/api/bulk_job_requests_api.rb +++ b/jcapiv2/lib/jcapiv2/api/bulk_job_requests_api.rb @@ -21,7 +21,7 @@ def initialize(api_client = ApiClient.default) end # Bulk Users Create - # The endpoint allows you to create a bulk job to asynchronously create users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/bulk/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '[ { \"email\":\"{email}\", \"firstname\":\"{firstname}\", \"lastname\":\"{firstname}\", \"username\":\"{username}\", \"attributes\":[ {\"name\":\"EmployeeID\",\"value\":\"0000\"}, {\"name\":\"Custom\",\"value\":\"attribute\"} ] } ] ``` + # The endpoint allows you to create a bulk job to asynchronously create users. See [Create a System User](https://docs.jumpcloud.com/1.0/systemusers/create-a-system-user) for full list of attributes. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/bulk/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '[ { \"email\":\"{email}\", \"firstname\":\"{firstname}\", \"lastname\":\"{firstname}\", \"username\":\"{username}\", \"attributes\":[ {\"name\":\"EmployeeID\",\"value\":\"0000\"}, {\"name\":\"Custom\",\"value\":\"attribute\"} ] } ] ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -34,7 +34,7 @@ def bulk_users_create(content_type, accept, opts = {}) end # Bulk Users Create - # The endpoint allows you to create a bulk job to asynchronously create users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/bulk/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '[ { \"email\":\"{email}\", \"firstname\":\"{firstname}\", \"lastname\":\"{firstname}\", \"username\":\"{username}\", \"attributes\":[ {\"name\":\"EmployeeID\",\"value\":\"0000\"}, {\"name\":\"Custom\",\"value\":\"attribute\"} ] } ] ``` + # The endpoint allows you to create a bulk job to asynchronously create users. See [Create a System User](https://docs.jumpcloud.com/1.0/systemusers/create-a-system-user) for full list of attributes. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/bulk/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '[ { \"email\":\"{email}\", \"firstname\":\"{firstname}\", \"lastname\":\"{firstname}\", \"username\":\"{username}\", \"attributes\":[ {\"name\":\"EmployeeID\",\"value\":\"0000\"}, {\"name\":\"Custom\",\"value\":\"attribute\"} ] } ] ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -89,7 +89,7 @@ def bulk_users_create_with_http_info(content_type, accept, opts = {}) end # List Bulk Users Results - # This endpoint will return the results of particular user import or update job request. ###Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return the results of particular user import or update job request. #### Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param job_id # @param content_type # @param accept @@ -104,7 +104,7 @@ def bulk_users_create_results(job_id, content_type, accept, opts = {}) end # List Bulk Users Results - # This endpoint will return the results of particular user import or update job request. ###Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return the results of particular user import or update job request. #### Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param job_id # @param content_type # @param accept @@ -167,7 +167,7 @@ def bulk_users_create_results_with_http_info(job_id, content_type, accept, opts end # Bulk Users Update - # The endpoint allows you to create a bulk job to asynchronously update users. #### Sample Request ``` curl -X PATCH https://console.jumpcloud.com/api/v2/bulk/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '[ { \"id\":\"5be9fb4ddb01290001e85109\", \"firstname\":\"{UPDATED_FIRSTNAME}\", \"department\":\"{UPDATED_DEPARTMENT}\", \"attributes\":[ {\"name\":\"Custom\",\"value\":\"{ATTRIBUTE_VALUE}\"} ] }, { \"id\":\"5be9fb4ddb01290001e85109\", \"firstname\":\"{UPDATED_FIRSTNAME}\", \"costCenter\":\"{UPDATED_COST_CENTER}\", \"phoneNumbers\":[ {\"type\":\"home\",\"number\":\"{HOME_PHONE_NUMBER}\"}, {\"type\":\"work\",\"number\":\"{WORK_PHONE_NUMBER}\"} ] } ] ``` + # The endpoint allows you to create a bulk job to asynchronously update users. See [Update a System User](https://docs.jumpcloud.com/1.0/systemusers/update-a-system-user) for full list of attributes. #### Sample Request ``` curl -X PATCH https://console.jumpcloud.com/api/v2/bulk/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '[ { \"id\":\"5be9fb4ddb01290001e85109\", \"firstname\":\"{UPDATED_FIRSTNAME}\", \"department\":\"{UPDATED_DEPARTMENT}\", \"attributes\":[ {\"name\":\"Custom\",\"value\":\"{ATTRIBUTE_VALUE}\"} ] }, { \"id\":\"5be9fb4ddb01290001e85109\", \"firstname\":\"{UPDATED_FIRSTNAME}\", \"costCenter\":\"{UPDATED_COST_CENTER}\", \"phoneNumbers\":[ {\"type\":\"home\",\"number\":\"{HOME_PHONE_NUMBER}\"}, {\"type\":\"work\",\"number\":\"{WORK_PHONE_NUMBER}\"} ] } ] ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -180,7 +180,7 @@ def bulk_users_update(content_type, accept, opts = {}) end # Bulk Users Update - # The endpoint allows you to create a bulk job to asynchronously update users. #### Sample Request ``` curl -X PATCH https://console.jumpcloud.com/api/v2/bulk/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '[ { \"id\":\"5be9fb4ddb01290001e85109\", \"firstname\":\"{UPDATED_FIRSTNAME}\", \"department\":\"{UPDATED_DEPARTMENT}\", \"attributes\":[ {\"name\":\"Custom\",\"value\":\"{ATTRIBUTE_VALUE}\"} ] }, { \"id\":\"5be9fb4ddb01290001e85109\", \"firstname\":\"{UPDATED_FIRSTNAME}\", \"costCenter\":\"{UPDATED_COST_CENTER}\", \"phoneNumbers\":[ {\"type\":\"home\",\"number\":\"{HOME_PHONE_NUMBER}\"}, {\"type\":\"work\",\"number\":\"{WORK_PHONE_NUMBER}\"} ] } ] ``` + # The endpoint allows you to create a bulk job to asynchronously update users. See [Update a System User](https://docs.jumpcloud.com/1.0/systemusers/update-a-system-user) for full list of attributes. #### Sample Request ``` curl -X PATCH https://console.jumpcloud.com/api/v2/bulk/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '[ { \"id\":\"5be9fb4ddb01290001e85109\", \"firstname\":\"{UPDATED_FIRSTNAME}\", \"department\":\"{UPDATED_DEPARTMENT}\", \"attributes\":[ {\"name\":\"Custom\",\"value\":\"{ATTRIBUTE_VALUE}\"} ] }, { \"id\":\"5be9fb4ddb01290001e85109\", \"firstname\":\"{UPDATED_FIRSTNAME}\", \"costCenter\":\"{UPDATED_COST_CENTER}\", \"phoneNumbers\":[ {\"type\":\"home\",\"number\":\"{HOME_PHONE_NUMBER}\"}, {\"type\":\"work\",\"number\":\"{WORK_PHONE_NUMBER}\"} ] } ] ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -307,7 +307,7 @@ def jobs_get_with_http_info(id, content_type, accept, opts = {}) end # List Job Results - # This endpoint will return the results of particular import job request. ###Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/jobs/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return the results of particular import job request. #### Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/jobs/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param id # @param content_type # @param accept @@ -322,7 +322,7 @@ def jobs_results(id, content_type, accept, opts = {}) end # List Job Results - # This endpoint will return the results of particular import job request. ###Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/jobs/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return the results of particular import job request. #### Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/jobs/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param id # @param content_type # @param accept diff --git a/jcapiv2/lib/jcapiv2/api/g_suite_api.rb b/jcapiv2/lib/jcapiv2/api/g_suite_api.rb index 256567d..8a8b87e 100644 --- a/jcapiv2/lib/jcapiv2/api/g_suite_api.rb +++ b/jcapiv2/lib/jcapiv2/api/g_suite_api.rb @@ -560,7 +560,7 @@ def translation_rules_g_suite_list_with_http_info(gsuite_id, content_type, accep # @param accept # @param [Hash] opts the optional parameters # @option opts [GSuiteTranslationRuleRequest] :body - # @return [InlineResponse201] + # @return [GSuiteTranslationRule] def translation_rules_g_suite_post(gsuite_id, content_type, accept, opts = {}) data, _status_code, _headers = translation_rules_g_suite_post_with_http_info(gsuite_id, content_type, accept, opts) return data @@ -573,7 +573,7 @@ def translation_rules_g_suite_post(gsuite_id, content_type, accept, opts = {}) # @param accept # @param [Hash] opts the optional parameters # @option opts [GSuiteTranslationRuleRequest] :body - # @return [Array<(InlineResponse201, Fixnum, Hash)>] InlineResponse201 data, response status code and response headers + # @return [Array<(GSuiteTranslationRule, Fixnum, Hash)>] GSuiteTranslationRule data, response status code and response headers def translation_rules_g_suite_post_with_http_info(gsuite_id, content_type, accept, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: GSuiteApi.translation_rules_g_suite_post ..." @@ -617,7 +617,7 @@ def translation_rules_g_suite_post_with_http_info(gsuite_id, content_type, accep :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'InlineResponse201') + :return_type => 'GSuiteTranslationRule') if @api_client.config.debugging @api_client.config.logger.debug "API called: GSuiteApi#translation_rules_g_suite_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end diff --git a/jcapiv2/lib/jcapiv2/api/office365_api.rb b/jcapiv2/lib/jcapiv2/api/office365_api.rb index a2519f8..57d35ba 100644 --- a/jcapiv2/lib/jcapiv2/api/office365_api.rb +++ b/jcapiv2/lib/jcapiv2/api/office365_api.rb @@ -574,7 +574,7 @@ def translation_rules_office365_list_with_http_info(office365_id, content_type, # @param accept # @param [Hash] opts the optional parameters # @option opts [Office365TranslationRuleRequest] :body - # @return [InlineResponse2011] + # @return [Office365TranslationRule] def translation_rules_office365_post(office365_id, content_type, accept, opts = {}) data, _status_code, _headers = translation_rules_office365_post_with_http_info(office365_id, content_type, accept, opts) return data @@ -587,7 +587,7 @@ def translation_rules_office365_post(office365_id, content_type, accept, opts = # @param accept # @param [Hash] opts the optional parameters # @option opts [Office365TranslationRuleRequest] :body - # @return [Array<(InlineResponse2011, Fixnum, Hash)>] InlineResponse2011 data, response status code and response headers + # @return [Array<(Office365TranslationRule, Fixnum, Hash)>] Office365TranslationRule data, response status code and response headers def translation_rules_office365_post_with_http_info(office365_id, content_type, accept, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: Office365Api.translation_rules_office365_post ..." @@ -631,7 +631,7 @@ def translation_rules_office365_post_with_http_info(office365_id, content_type, :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'InlineResponse2011') + :return_type => 'Office365TranslationRule') if @api_client.config.debugging @api_client.config.logger.debug "API called: Office365Api#translation_rules_office365_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end diff --git a/jcapiv2/lib/jcapiv2/models/bulk_user_update.rb b/jcapiv2/lib/jcapiv2/models/bulk_user_update.rb index 825afb8..23e7f21 100644 --- a/jcapiv2/lib/jcapiv2/models/bulk_user_update.rb +++ b/jcapiv2/lib/jcapiv2/models/bulk_user_update.rb @@ -18,6 +18,14 @@ class BulkUserUpdate # Object ID of the systemuser being updated attr_accessor :id + attr_accessor :username + + attr_accessor :firstname + + attr_accessor :lastname + + attr_accessor :email + # Map of additional attributes. attr_accessor :attributes @@ -26,6 +34,10 @@ class BulkUserUpdate def self.attribute_map { :'id' => :'id', + :'username' => :'username', + :'firstname' => :'firstname', + :'lastname' => :'lastname', + :'email' => :'email', :'attributes' => :'attributes' } end @@ -34,6 +46,10 @@ def self.attribute_map def self.swagger_types { :'id' => :'String', + :'username' => :'String', + :'firstname' => :'String', + :'lastname' => :'String', + :'email' => :'String', :'attributes' => :'Array' } end @@ -50,6 +66,22 @@ def initialize(attributes = {}) self.id = attributes[:'id'] end + if attributes.has_key?(:'username') + self.username = attributes[:'username'] + end + + if attributes.has_key?(:'firstname') + self.firstname = attributes[:'firstname'] + end + + if attributes.has_key?(:'lastname') + self.lastname = attributes[:'lastname'] + end + + if attributes.has_key?(:'email') + self.email = attributes[:'email'] + end + if attributes.has_key?(:'attributes') if (value = attributes[:'attributes']).is_a?(Array) self.attributes = value @@ -77,6 +109,10 @@ def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && + username == o.username && + firstname == o.firstname && + lastname == o.lastname && + email == o.email && attributes == o.attributes end @@ -89,7 +125,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Fixnum] Hash code def hash - [id, attributes].hash + [id, username, firstname, lastname, email, attributes].hash end # Builds the object from hash diff --git a/jcapiv2/lib/jcapiv2/models/inline_response_201.rb b/jcapiv2/lib/jcapiv2/models/inline_response_201.rb deleted file mode 100644 index e20df7f..0000000 --- a/jcapiv2/lib/jcapiv2/models/inline_response_201.rb +++ /dev/null @@ -1,188 +0,0 @@ -=begin -#JumpCloud APIs - -# JumpCloud's V2 API. This set of endpoints allows JumpCloud customers to manage objects, groupings and mappings and interact with the JumpCloud Graph. - -OpenAPI spec version: 2.0 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.3.1 - -=end - -require 'date' - -module JCAPIv2 - - class InlineResponse201 - attr_accessor :rule - - - # Attribute mapping from ruby-style variable name to JSON key. - def self.attribute_map - { - :'rule' => :'rule' - } - end - - # Attribute type mapping. - def self.swagger_types - { - :'rule' => :'GSuiteTranslationRule' - } - end - - # Initializes the object - # @param [Hash] attributes Model attributes in the form of hash - def initialize(attributes = {}) - return unless attributes.is_a?(Hash) - - # convert string to symbol for hash key - attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} - - if attributes.has_key?(:'rule') - self.rule = attributes[:'rule'] - end - - end - - # Show invalid properties with the reasons. Usually used together with valid? - # @return Array for valid properties with the reasons - def list_invalid_properties - invalid_properties = Array.new - return invalid_properties - end - - # Check to see if the all the properties in the model are valid - # @return true if the model is valid - def valid? - return true - end - - # Checks equality by comparing each attribute. - # @param [Object] Object to be compared - def ==(o) - return true if self.equal?(o) - self.class == o.class && - rule == o.rule - end - - # @see the `==` method - # @param [Object] Object to be compared - def eql?(o) - self == o - end - - # Calculates hash code according to all attributes. - # @return [Fixnum] Hash code - def hash - [rule].hash - end - - # Builds the object from hash - # @param [Hash] attributes Model attributes in the form of hash - # @return [Object] Returns the model itself - def build_from_hash(attributes) - return nil unless attributes.is_a?(Hash) - self.class.swagger_types.each_pair do |key, type| - if type =~ /\AArray<(.*)>/i - # check to ensure the input is an array given that the the attribute - # is documented as an array but the input is not - if attributes[self.class.attribute_map[key]].is_a?(Array) - self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) - end - elsif !attributes[self.class.attribute_map[key]].nil? - self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) - end # or else data not found in attributes(hash), not an issue as the data can be optional - end - - self - end - - # Deserializes the data based on type - # @param string type Data type - # @param string value Value to be deserialized - # @return [Object] Deserialized data - def _deserialize(type, value) - case type.to_sym - when :DateTime - DateTime.parse(value) - when :Date - Date.parse(value) - when :String - value.to_s - when :Integer - value.to_i - when :Float - value.to_f - when :BOOLEAN - if value.to_s =~ /\A(true|t|yes|y|1)\z/i - true - else - false - end - when :Object - # generic object (usually a Hash), return directly - value - when /\AArray<(?.+)>\z/ - inner_type = Regexp.last_match[:inner_type] - value.map { |v| _deserialize(inner_type, v) } - when /\AHash<(?.+?), (?.+)>\z/ - k_type = Regexp.last_match[:k_type] - v_type = Regexp.last_match[:v_type] - {}.tap do |hash| - value.each do |k, v| - hash[_deserialize(k_type, k)] = _deserialize(v_type, v) - end - end - else # model - temp_model = JCAPIv2.const_get(type).new - temp_model.build_from_hash(value) - end - end - - # Returns the string representation of the object - # @return [String] String presentation of the object - def to_s - to_hash.to_s - end - - # to_body is an alias to to_hash (backward compatibility) - # @return [Hash] Returns the object in the form of hash - def to_body - to_hash - end - - # Returns the object in the form of hash - # @return [Hash] Returns the object in the form of hash - def to_hash - hash = {} - self.class.attribute_map.each_pair do |attr, param| - value = self.send(attr) - next if value.nil? - hash[param] = _to_hash(value) - end - hash - end - - # Outputs non-array value in the form of hash - # For object, use to_hash. Otherwise, just return the value - # @param [Object] value Any valid value - # @return [Hash] Returns the value in the form of hash - def _to_hash(value) - if value.is_a?(Array) - value.compact.map{ |v| _to_hash(v) } - elsif value.is_a?(Hash) - {}.tap do |hash| - value.each { |k, v| hash[k] = _to_hash(v) } - end - elsif value.respond_to? :to_hash - value.to_hash - else - value - end - end - - end - -end diff --git a/jcapiv2/lib/jcapiv2/models/inline_response_201_1.rb b/jcapiv2/lib/jcapiv2/models/inline_response_201_1.rb deleted file mode 100644 index f0b9777..0000000 --- a/jcapiv2/lib/jcapiv2/models/inline_response_201_1.rb +++ /dev/null @@ -1,188 +0,0 @@ -=begin -#JumpCloud APIs - -# JumpCloud's V2 API. This set of endpoints allows JumpCloud customers to manage objects, groupings and mappings and interact with the JumpCloud Graph. - -OpenAPI spec version: 2.0 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.3.1 - -=end - -require 'date' - -module JCAPIv2 - - class InlineResponse2011 - attr_accessor :rule - - - # Attribute mapping from ruby-style variable name to JSON key. - def self.attribute_map - { - :'rule' => :'rule' - } - end - - # Attribute type mapping. - def self.swagger_types - { - :'rule' => :'Office365TranslationRule' - } - end - - # Initializes the object - # @param [Hash] attributes Model attributes in the form of hash - def initialize(attributes = {}) - return unless attributes.is_a?(Hash) - - # convert string to symbol for hash key - attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} - - if attributes.has_key?(:'rule') - self.rule = attributes[:'rule'] - end - - end - - # Show invalid properties with the reasons. Usually used together with valid? - # @return Array for valid properties with the reasons - def list_invalid_properties - invalid_properties = Array.new - return invalid_properties - end - - # Check to see if the all the properties in the model are valid - # @return true if the model is valid - def valid? - return true - end - - # Checks equality by comparing each attribute. - # @param [Object] Object to be compared - def ==(o) - return true if self.equal?(o) - self.class == o.class && - rule == o.rule - end - - # @see the `==` method - # @param [Object] Object to be compared - def eql?(o) - self == o - end - - # Calculates hash code according to all attributes. - # @return [Fixnum] Hash code - def hash - [rule].hash - end - - # Builds the object from hash - # @param [Hash] attributes Model attributes in the form of hash - # @return [Object] Returns the model itself - def build_from_hash(attributes) - return nil unless attributes.is_a?(Hash) - self.class.swagger_types.each_pair do |key, type| - if type =~ /\AArray<(.*)>/i - # check to ensure the input is an array given that the the attribute - # is documented as an array but the input is not - if attributes[self.class.attribute_map[key]].is_a?(Array) - self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) - end - elsif !attributes[self.class.attribute_map[key]].nil? - self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) - end # or else data not found in attributes(hash), not an issue as the data can be optional - end - - self - end - - # Deserializes the data based on type - # @param string type Data type - # @param string value Value to be deserialized - # @return [Object] Deserialized data - def _deserialize(type, value) - case type.to_sym - when :DateTime - DateTime.parse(value) - when :Date - Date.parse(value) - when :String - value.to_s - when :Integer - value.to_i - when :Float - value.to_f - when :BOOLEAN - if value.to_s =~ /\A(true|t|yes|y|1)\z/i - true - else - false - end - when :Object - # generic object (usually a Hash), return directly - value - when /\AArray<(?.+)>\z/ - inner_type = Regexp.last_match[:inner_type] - value.map { |v| _deserialize(inner_type, v) } - when /\AHash<(?.+?), (?.+)>\z/ - k_type = Regexp.last_match[:k_type] - v_type = Regexp.last_match[:v_type] - {}.tap do |hash| - value.each do |k, v| - hash[_deserialize(k_type, k)] = _deserialize(v_type, v) - end - end - else # model - temp_model = JCAPIv2.const_get(type).new - temp_model.build_from_hash(value) - end - end - - # Returns the string representation of the object - # @return [String] String presentation of the object - def to_s - to_hash.to_s - end - - # to_body is an alias to to_hash (backward compatibility) - # @return [Hash] Returns the object in the form of hash - def to_body - to_hash - end - - # Returns the object in the form of hash - # @return [Hash] Returns the object in the form of hash - def to_hash - hash = {} - self.class.attribute_map.each_pair do |attr, param| - value = self.send(attr) - next if value.nil? - hash[param] = _to_hash(value) - end - hash - end - - # Outputs non-array value in the form of hash - # For object, use to_hash. Otherwise, just return the value - # @param [Object] value Any valid value - # @return [Hash] Returns the value in the form of hash - def _to_hash(value) - if value.is_a?(Array) - value.compact.map{ |v| _to_hash(v) } - elsif value.is_a?(Hash) - {}.tap do |hash| - value.each { |k, v| hash[k] = _to_hash(v) } - end - elsif value.respond_to? :to_hash - value.to_hash - else - value - end - end - - end - -end diff --git a/jcapiv2/spec/api/bulk_job_requests_api_spec.rb b/jcapiv2/spec/api/bulk_job_requests_api_spec.rb index a1f589a..2f4929c 100644 --- a/jcapiv2/spec/api/bulk_job_requests_api_spec.rb +++ b/jcapiv2/spec/api/bulk_job_requests_api_spec.rb @@ -34,7 +34,7 @@ # unit tests for bulk_users_create # Bulk Users Create - # The endpoint allows you to create a bulk job to asynchronously create users. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/bulk/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '[ { \"email\":\"{email}\", \"firstname\":\"{firstname}\", \"lastname\":\"{firstname}\", \"username\":\"{username}\", \"attributes\":[ {\"name\":\"EmployeeID\",\"value\":\"0000\"}, {\"name\":\"Custom\",\"value\":\"attribute\"} ] } ] ``` + # The endpoint allows you to create a bulk job to asynchronously create users. See [Create a System User](https://docs.jumpcloud.com/1.0/systemusers/create-a-system-user) for full list of attributes. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/bulk/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '[ { \"email\":\"{email}\", \"firstname\":\"{firstname}\", \"lastname\":\"{firstname}\", \"username\":\"{username}\", \"attributes\":[ {\"name\":\"EmployeeID\",\"value\":\"0000\"}, {\"name\":\"Custom\",\"value\":\"attribute\"} ] } ] ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -49,7 +49,7 @@ # unit tests for bulk_users_create_results # List Bulk Users Results - # This endpoint will return the results of particular user import or update job request. ###Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return the results of particular user import or update job request. #### Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/bulk/users/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param job_id # @param content_type # @param accept @@ -66,7 +66,7 @@ # unit tests for bulk_users_update # Bulk Users Update - # The endpoint allows you to create a bulk job to asynchronously update users. #### Sample Request ``` curl -X PATCH https://console.jumpcloud.com/api/v2/bulk/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '[ { \"id\":\"5be9fb4ddb01290001e85109\", \"firstname\":\"{UPDATED_FIRSTNAME}\", \"department\":\"{UPDATED_DEPARTMENT}\", \"attributes\":[ {\"name\":\"Custom\",\"value\":\"{ATTRIBUTE_VALUE}\"} ] }, { \"id\":\"5be9fb4ddb01290001e85109\", \"firstname\":\"{UPDATED_FIRSTNAME}\", \"costCenter\":\"{UPDATED_COST_CENTER}\", \"phoneNumbers\":[ {\"type\":\"home\",\"number\":\"{HOME_PHONE_NUMBER}\"}, {\"type\":\"work\",\"number\":\"{WORK_PHONE_NUMBER}\"} ] } ] ``` + # The endpoint allows you to create a bulk job to asynchronously update users. See [Update a System User](https://docs.jumpcloud.com/1.0/systemusers/update-a-system-user) for full list of attributes. #### Sample Request ``` curl -X PATCH https://console.jumpcloud.com/api/v2/bulk/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '[ { \"id\":\"5be9fb4ddb01290001e85109\", \"firstname\":\"{UPDATED_FIRSTNAME}\", \"department\":\"{UPDATED_DEPARTMENT}\", \"attributes\":[ {\"name\":\"Custom\",\"value\":\"{ATTRIBUTE_VALUE}\"} ] }, { \"id\":\"5be9fb4ddb01290001e85109\", \"firstname\":\"{UPDATED_FIRSTNAME}\", \"costCenter\":\"{UPDATED_COST_CENTER}\", \"phoneNumbers\":[ {\"type\":\"home\",\"number\":\"{HOME_PHONE_NUMBER}\"}, {\"type\":\"work\",\"number\":\"{WORK_PHONE_NUMBER}\"} ] } ] ``` # @param content_type # @param accept # @param [Hash] opts the optional parameters @@ -96,7 +96,7 @@ # unit tests for jobs_results # List Job Results - # This endpoint will return the results of particular import job request. ###Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/jobs/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` + # This endpoint will return the results of particular import job request. #### Sample Request ``` curl -X GET \\ https://console.jumpcloud.com/api/v2/jobs/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ``` # @param id # @param content_type # @param accept diff --git a/jcapiv2/spec/api/g_suite_api_spec.rb b/jcapiv2/spec/api/g_suite_api_spec.rb index e5c6dbc..7078e78 100644 --- a/jcapiv2/spec/api/g_suite_api_spec.rb +++ b/jcapiv2/spec/api/g_suite_api_spec.rb @@ -155,7 +155,7 @@ # @param accept # @param [Hash] opts the optional parameters # @option opts [GSuiteTranslationRuleRequest] :body - # @return [InlineResponse201] + # @return [GSuiteTranslationRule] describe 'translation_rules_g_suite_post test' do it "should work" do # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers diff --git a/jcapiv2/spec/api/office365_api_spec.rb b/jcapiv2/spec/api/office365_api_spec.rb index bf082f9..3a85ae9 100644 --- a/jcapiv2/spec/api/office365_api_spec.rb +++ b/jcapiv2/spec/api/office365_api_spec.rb @@ -157,7 +157,7 @@ # @param accept # @param [Hash] opts the optional parameters # @option opts [Office365TranslationRuleRequest] :body - # @return [InlineResponse2011] + # @return [Office365TranslationRule] describe 'translation_rules_office365_post test' do it "should work" do # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers diff --git a/jcapiv2/spec/models/bulk_user_update_spec.rb b/jcapiv2/spec/models/bulk_user_update_spec.rb index 0a7fed7..b0f3ecd 100644 --- a/jcapiv2/spec/models/bulk_user_update_spec.rb +++ b/jcapiv2/spec/models/bulk_user_update_spec.rb @@ -38,6 +38,30 @@ end end + describe 'test attribute "username"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "firstname"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "lastname"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "email"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + describe 'test attribute "attributes"' do it 'should work' do # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers diff --git a/jcapiv2/spec/models/inline_response_201_1_spec.rb b/jcapiv2/spec/models/inline_response_201_1_spec.rb deleted file mode 100644 index a5b93a7..0000000 --- a/jcapiv2/spec/models/inline_response_201_1_spec.rb +++ /dev/null @@ -1,42 +0,0 @@ -=begin -#JumpCloud APIs - -# JumpCloud's V2 API. This set of endpoints allows JumpCloud customers to manage objects, groupings and mappings and interact with the JumpCloud Graph. - -OpenAPI spec version: 2.0 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.3.1 - -=end - -require 'spec_helper' -require 'json' -require 'date' - -# Unit tests for JCAPIv2::InlineResponse2011 -# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) -# Please update as you see appropriate -describe 'InlineResponse2011' do - before do - # run before each test - @instance = JCAPIv2::InlineResponse2011.new - end - - after do - # run after each test - end - - describe 'test an instance of InlineResponse2011' do - it 'should create an instance of InlineResponse2011' do - expect(@instance).to be_instance_of(JCAPIv2::InlineResponse2011) - end - end - describe 'test attribute "rule"' do - it 'should work' do - # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers - end - end - -end - diff --git a/jcapiv2/spec/models/inline_response_201_spec.rb b/jcapiv2/spec/models/inline_response_201_spec.rb deleted file mode 100644 index b42f414..0000000 --- a/jcapiv2/spec/models/inline_response_201_spec.rb +++ /dev/null @@ -1,42 +0,0 @@ -=begin -#JumpCloud APIs - -# JumpCloud's V2 API. This set of endpoints allows JumpCloud customers to manage objects, groupings and mappings and interact with the JumpCloud Graph. - -OpenAPI spec version: 2.0 - -Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.3.1 - -=end - -require 'spec_helper' -require 'json' -require 'date' - -# Unit tests for JCAPIv2::InlineResponse201 -# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) -# Please update as you see appropriate -describe 'InlineResponse201' do - before do - # run before each test - @instance = JCAPIv2::InlineResponse201.new - end - - after do - # run after each test - end - - describe 'test an instance of InlineResponse201' do - it 'should create an instance of InlineResponse201' do - expect(@instance).to be_instance_of(JCAPIv2::InlineResponse201) - end - end - describe 'test attribute "rule"' do - it 'should work' do - # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers - end - end - -end -