instana-client 1.0.0__py3-none-any.whl → 1.0.3__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (604) hide show
  1. instana_client/__init__.py +91 -9
  2. instana_client/api/__init__.py +8 -0
  3. instana_client/api/action_catalog_api.py +329 -6
  4. instana_client/api/action_history_api.py +54 -2
  5. instana_client/api/ai_management_api.py +1973 -0
  6. instana_client/api/apdex_report_api.py +2 -2
  7. instana_client/api/apdex_settings_api.py +8 -9
  8. instana_client/api/api_token_api.py +23 -24
  9. instana_client/api/application_alert_configuration_api.py +79 -66
  10. instana_client/api/application_analyze_api.py +20 -282
  11. instana_client/api/application_catalog_api.py +11 -11
  12. instana_client/api/application_metrics_api.py +14 -14
  13. instana_client/api/application_resources_api.py +171 -44
  14. instana_client/api/application_settings_api.py +134 -104
  15. instana_client/api/application_topology_api.py +11 -2
  16. instana_client/api/audit_log_api.py +2 -2
  17. instana_client/api/authentication_api.py +14 -30
  18. instana_client/api/business_monitoring_api.py +2 -2
  19. instana_client/api/custom_dashboards_api.py +29 -19
  20. instana_client/api/custom_entities_api.py +1398 -0
  21. instana_client/api/end_user_monitoring_api.py +310 -0
  22. instana_client/api/event_settings_api.py +1365 -658
  23. instana_client/api/events_api.py +11 -26
  24. instana_client/api/global_application_alert_configuration_api.py +53 -56
  25. instana_client/api/groups_api.py +888 -87
  26. instana_client/api/health_api.py +8 -5
  27. instana_client/api/host_agent_api.py +274 -8
  28. instana_client/api/infrastructure_alert_configuration_api.py +50 -30
  29. instana_client/api/infrastructure_analyze_api.py +14 -14
  30. instana_client/api/infrastructure_catalog_api.py +44 -13
  31. instana_client/api/infrastructure_metrics_api.py +5 -5
  32. instana_client/api/infrastructure_resources_api.py +11 -11
  33. instana_client/api/infrastructure_topology_api.py +2 -2
  34. instana_client/api/log_alert_configuration_api.py +50 -30
  35. instana_client/api/logging_analyze_api.py +343 -0
  36. instana_client/api/maintenance_configuration_api.py +32 -20
  37. instana_client/api/mobile_app_analyze_api.py +2 -2
  38. instana_client/api/mobile_app_catalog_api.py +8 -2
  39. instana_client/api/mobile_app_configuration_api.py +3058 -334
  40. instana_client/api/mobile_app_metrics_api.py +3 -6
  41. instana_client/api/policies_api.py +14 -11
  42. instana_client/api/releases_api.py +8 -11
  43. instana_client/api/roles_api.py +1410 -0
  44. instana_client/api/service_levels_alert_configuration_api.py +2 -2
  45. instana_client/api/service_levels_objective_slo_configurations_api.py +211 -87
  46. instana_client/api/service_levels_objective_slo_report_api.py +38 -2
  47. instana_client/api/session_settings_api.py +2 -2
  48. instana_client/api/sli_report_api.py +2 -2
  49. instana_client/api/sli_settings_api.py +5 -8
  50. instana_client/api/slo_correction_configurations_api.py +1537 -0
  51. instana_client/api/slo_correction_windows_api.py +392 -0
  52. instana_client/api/synthetic_alert_configuration_api.py +53 -56
  53. instana_client/api/synthetic_calls_api.py +20 -9
  54. instana_client/api/synthetic_catalog_api.py +20 -2
  55. instana_client/api/synthetic_metrics_api.py +5 -5
  56. instana_client/api/synthetic_settings_api.py +1915 -477
  57. instana_client/api/synthetic_test_playback_results_api.py +307 -20
  58. instana_client/api/teams_api.py +1380 -0
  59. instana_client/api/usage_api.py +2 -2
  60. instana_client/api/user_api.py +41 -28
  61. instana_client/api/website_analyze_api.py +8 -8
  62. instana_client/api/website_catalog_api.py +11 -8
  63. instana_client/api/website_configuration_api.py +1801 -336
  64. instana_client/api/website_metrics_api.py +3 -3
  65. instana_client/api_client.py +3 -3
  66. instana_client/configuration.py +14 -7
  67. instana_client/exceptions.py +2 -2
  68. instana_client/models/__init__.py +626 -11
  69. instana_client/models/abstract_integration.py +11 -5
  70. instana_client/models/abstract_rule.py +2 -2
  71. instana_client/models/access_log_entry.py +12 -7
  72. instana_client/models/access_log_response.py +2 -2
  73. instana_client/models/access_rule.py +2 -2
  74. instana_client/models/action.py +2 -2
  75. instana_client/models/action_configuration.py +2 -2
  76. instana_client/models/action_instance.py +2 -2
  77. instana_client/models/action_instance_metadata_entry.py +2 -2
  78. instana_client/models/action_instance_parameter.py +2 -2
  79. instana_client/models/action_instance_request.py +2 -2
  80. instana_client/models/action_instance_request_parameters.py +2 -2
  81. instana_client/models/action_match.py +19 -6
  82. instana_client/models/action_search_space.py +2 -2
  83. instana_client/models/adaptive_baseline.py +3 -3
  84. instana_client/models/adaptive_threshold_rule.py +3 -3
  85. instana_client/models/addition.py +97 -0
  86. instana_client/models/adjusted_timeframe.py +2 -2
  87. instana_client/models/agent_configuration_update.py +2 -2
  88. instana_client/models/alerting_configuration.py +2 -2
  89. instana_client/models/alerting_configuration_with_last_updated.py +2 -2
  90. instana_client/models/alerting_time_window.py +2 -2
  91. instana_client/models/apdex_configuration.py +2 -2
  92. instana_client/models/apdex_configuration_input.py +2 -2
  93. instana_client/models/apdex_entity.py +2 -2
  94. instana_client/models/apdex_report.py +2 -2
  95. instana_client/models/api_create_group.py +2 -2
  96. instana_client/models/api_create_role.py +101 -0
  97. instana_client/models/api_group.py +2 -2
  98. instana_client/models/api_member.py +5 -3
  99. instana_client/models/api_permission_set.py +12 -3
  100. instana_client/models/api_restricted_application_filter.py +2 -2
  101. instana_client/models/api_role.py +102 -0
  102. instana_client/models/api_tag.py +91 -0
  103. instana_client/models/api_team.py +113 -0
  104. instana_client/models/api_team_info.py +89 -0
  105. instana_client/models/api_team_member.py +102 -0
  106. instana_client/models/api_team_role.py +92 -0
  107. instana_client/models/api_team_scope.py +131 -0
  108. instana_client/models/api_token.py +35 -5
  109. instana_client/models/app_data_metric_configuration.py +2 -2
  110. instana_client/models/application.py +2 -2
  111. instana_client/models/application_alert_config.py +2 -2
  112. instana_client/models/application_alert_config_with_metadata.py +2 -2
  113. instana_client/models/application_alert_rule.py +2 -2
  114. instana_client/models/application_apdex_entity.py +2 -2
  115. instana_client/models/application_config.py +2 -2
  116. instana_client/models/application_event_result.py +6 -7
  117. instana_client/models/application_item.py +2 -2
  118. instana_client/models/application_metric_result.py +2 -2
  119. instana_client/models/application_node.py +2 -2
  120. instana_client/models/application_result.py +2 -2
  121. instana_client/models/application_scope.py +4 -4
  122. instana_client/models/application_scope_with_metadata.py +6 -6
  123. instana_client/models/application_sli_entity.py +2 -2
  124. instana_client/models/application_slo_entity.py +2 -2
  125. instana_client/models/application_time_threshold.py +2 -2
  126. instana_client/models/arithmetic_configuration.py +123 -0
  127. instana_client/models/arithmetic_operand.py +154 -0
  128. instana_client/models/arithmetic_operation.py +128 -0
  129. instana_client/models/audit_log_entry.py +2 -2
  130. instana_client/models/audit_log_ui_response.py +2 -2
  131. instana_client/models/author.py +2 -2
  132. instana_client/models/availability_blueprint_indicator.py +5 -16
  133. instana_client/models/availability_sli_entity.py +2 -2
  134. instana_client/models/available_metrics.py +2 -2
  135. instana_client/models/available_plugins.py +2 -2
  136. instana_client/models/backend_trace_reference.py +2 -2
  137. instana_client/models/bidirectional_ms_teams_app_integration.py +108 -0
  138. instana_client/models/bidirectional_slack_app_integration.py +104 -0
  139. instana_client/models/binary_operator_dto.py +2 -2
  140. instana_client/models/browser_script_configuration.py +5 -3
  141. instana_client/models/browser_script_configuration_update.py +129 -0
  142. instana_client/models/built_in_event_specification.py +2 -2
  143. instana_client/models/built_in_event_specification_with_last_updated.py +2 -2
  144. instana_client/models/business_activity.py +5 -3
  145. instana_client/models/business_perspective_config.py +2 -2
  146. instana_client/models/call_groups_item.py +2 -2
  147. instana_client/models/call_groups_result.py +2 -2
  148. instana_client/models/call_relation.py +2 -2
  149. instana_client/models/change_summary.py +2 -2
  150. instana_client/models/cloudfoundry_physical_context.py +4 -4
  151. instana_client/models/condition.py +2 -2
  152. instana_client/models/config_version.py +2 -2
  153. instana_client/models/correction.py +105 -0
  154. instana_client/models/correction_configuration.py +110 -0
  155. instana_client/models/correction_scheduling.py +105 -0
  156. instana_client/models/correction_window.py +95 -0
  157. instana_client/models/crash_mobile_app_alert_rule.py +2 -2
  158. instana_client/models/create_website_request_inner.py +90 -0
  159. instana_client/models/cursor_paginated_business_activity_item.py +2 -2
  160. instana_client/models/cursor_pagination.py +2 -2
  161. instana_client/models/cursor_pagination_infra_explore_cursor.py +2 -2
  162. instana_client/models/custom_blueprint_indicator.py +8 -4
  163. instana_client/models/custom_dashboard.py +2 -2
  164. instana_client/models/custom_dashboard_preview.py +2 -2
  165. instana_client/models/custom_dashboard_with_user_specific_information.py +115 -0
  166. instana_client/models/custom_dependency.py +119 -0
  167. instana_client/models/custom_email_subject_prefix.py +2 -2
  168. instana_client/models/custom_entity_model.py +126 -0
  169. instana_client/models/custom_entity_with_metadata.py +98 -0
  170. instana_client/models/custom_event_mobile_app_alert_rule.py +2 -2
  171. instana_client/models/custom_event_specification.py +9 -3
  172. instana_client/models/custom_event_specification_with_last_updated.py +9 -3
  173. instana_client/models/custom_event_website_alert_rule.py +2 -2
  174. instana_client/models/custom_metric.py +134 -0
  175. instana_client/models/custom_payload_configuration.py +2 -2
  176. instana_client/models/custom_payload_field.py +2 -2
  177. instana_client/models/custom_payload_with_last_updated.py +2 -2
  178. instana_client/models/custom_payload_with_version.py +101 -0
  179. instana_client/models/dashboard_api_token.py +2 -2
  180. instana_client/models/database_integration.py +2 -2
  181. instana_client/models/deprecated_tag_filter.py +4 -4
  182. instana_client/models/division.py +97 -0
  183. instana_client/models/dns_configuration.py +146 -0
  184. instana_client/models/dns_configuration_update.py +143 -0
  185. instana_client/models/dns_filter_query_time.py +99 -0
  186. instana_client/models/dns_filter_target_value.py +106 -0
  187. instana_client/models/duration.py +2 -2
  188. instana_client/models/dynamic_field.py +2 -2
  189. instana_client/models/dynamic_field_value.py +2 -2
  190. instana_client/models/dynamic_parameter.py +2 -2
  191. instana_client/models/edit_user.py +2 -2
  192. instana_client/models/email_integration.py +2 -2
  193. instana_client/models/empty_configuration.py +2 -2
  194. instana_client/models/endpoint.py +4 -4
  195. instana_client/models/endpoint_config.py +2 -2
  196. instana_client/models/endpoint_event_result.py +8 -9
  197. instana_client/models/endpoint_item.py +2 -2
  198. instana_client/models/endpoint_metric_result.py +2 -2
  199. instana_client/models/endpoint_node.py +2 -2
  200. instana_client/models/endpoint_result.py +3 -3
  201. instana_client/models/endpoint_simple.py +3 -3
  202. instana_client/models/entity_count_rule.py +2 -2
  203. instana_client/models/entity_count_verification_rule.py +3 -3
  204. instana_client/models/entity_health_info.py +2 -2
  205. instana_client/models/entity_id.py +2 -2
  206. instana_client/models/entity_verification_rule.py +3 -3
  207. instana_client/models/error_budget_alert_rule.py +5 -5
  208. instana_client/models/errors_application_alert_rule.py +2 -2
  209. instana_client/models/event.py +11 -3
  210. instana_client/models/event_filtering_configuration.py +2 -2
  211. instana_client/models/event_result.py +4 -3
  212. instana_client/models/event_specification_info.py +2 -2
  213. instana_client/models/extended_service.py +2 -2
  214. instana_client/models/failure_synthetic_alert_rule.py +2 -2
  215. instana_client/models/fixed_http_path_segment_matching_rule.py +2 -2
  216. instana_client/models/fixed_time_window.py +4 -3
  217. instana_client/models/generic_infra_alert_rule.py +12 -4
  218. instana_client/models/geo_location_configuration.py +2 -2
  219. instana_client/models/geo_mapping_rule.py +2 -2
  220. instana_client/models/geo_subdivision.py +2 -2
  221. instana_client/models/get_activities.py +2 -2
  222. instana_client/models/get_application_metrics.py +2 -2
  223. instana_client/models/get_applications.py +2 -2
  224. instana_client/models/get_available_metrics_query.py +2 -2
  225. instana_client/models/get_available_plugins_query.py +2 -2
  226. instana_client/models/get_call_groups.py +2 -2
  227. instana_client/models/get_combined_metrics.py +2 -2
  228. instana_client/models/get_dynamic_parameter_values.py +2 -2
  229. instana_client/models/get_endpoints.py +2 -2
  230. instana_client/models/get_infrastructure_groups_query.py +2 -2
  231. instana_client/models/get_infrastructure_query.py +2 -2
  232. instana_client/models/get_metrics_result.py +2 -2
  233. instana_client/models/get_mobile_app_beacon_groups.py +2 -2
  234. instana_client/models/get_mobile_app_beacons.py +2 -2
  235. instana_client/models/get_mobile_app_metrics.py +2 -2
  236. instana_client/models/get_mobile_app_metrics_v2.py +2 -2
  237. instana_client/models/get_payload_keys_result.py +2 -2
  238. instana_client/models/get_services.py +2 -2
  239. instana_client/models/get_snapshots_query.py +2 -2
  240. instana_client/models/get_test_result.py +2 -2
  241. instana_client/models/get_test_result_analytic.py +126 -0
  242. instana_client/models/get_test_result_base.py +2 -2
  243. instana_client/models/get_test_result_list.py +2 -2
  244. instana_client/models/get_test_summary_result.py +2 -2
  245. instana_client/models/get_trace_download_result_item.py +3 -3
  246. instana_client/models/get_trace_groups.py +2 -2
  247. instana_client/models/get_traces.py +4 -4
  248. instana_client/models/get_website_beacon_groups.py +2 -2
  249. instana_client/models/get_website_beacons.py +2 -2
  250. instana_client/models/get_website_metrics.py +2 -2
  251. instana_client/models/get_website_metrics_v2.py +2 -2
  252. instana_client/models/global_application_alert_config_with_metadata.py +2 -2
  253. instana_client/models/global_applications_alert_config.py +2 -2
  254. instana_client/models/google_chat_integration.py +2 -2
  255. instana_client/models/graph_edge.py +2 -2
  256. instana_client/models/graph_node.py +2 -2
  257. instana_client/models/group.py +2 -2
  258. instana_client/models/group_by_tag.py +2 -2
  259. instana_client/models/group_mapping.py +5 -3
  260. instana_client/models/group_mapping_overview.py +96 -0
  261. instana_client/models/health_state.py +2 -2
  262. instana_client/models/historic_baseline.py +3 -3
  263. instana_client/models/host_availability_rule.py +2 -2
  264. instana_client/models/http_action_configuration.py +2 -2
  265. instana_client/models/http_action_configuration_update.py +138 -0
  266. instana_client/models/http_endpoint_config.py +2 -2
  267. instana_client/models/http_endpoint_rule.py +2 -2
  268. instana_client/models/http_path_segment_matching_rule.py +2 -2
  269. instana_client/models/http_script_configuration.py +5 -3
  270. instana_client/models/http_script_configuration_update.py +115 -0
  271. instana_client/models/hyper_param.py +2 -2
  272. instana_client/models/identity_provider_patch.py +2 -2
  273. instana_client/models/impacted_beacon_info.py +96 -0
  274. instana_client/models/infra_alert_config.py +8 -6
  275. instana_client/models/infra_alert_config_with_metadata.py +7 -5
  276. instana_client/models/infra_alert_rule.py +9 -3
  277. instana_client/models/infra_event_result.py +7 -8
  278. instana_client/models/infra_metric_configuration.py +103 -80
  279. instana_client/models/infra_slo_entity.py +95 -0
  280. instana_client/models/infra_time_threshold.py +2 -2
  281. instana_client/models/infrastructure_entities_result.py +2 -2
  282. instana_client/models/infrastructure_group.py +5 -3
  283. instana_client/models/infrastructure_groups_result.py +2 -2
  284. instana_client/models/infrastructure_item.py +2 -2
  285. instana_client/models/infrastructure_metric_result.py +2 -2
  286. instana_client/models/instana_version_info.py +2 -2
  287. instana_client/models/integration_overview.py +14 -4
  288. instana_client/models/invitation.py +6 -4
  289. instana_client/models/invitation_response.py +2 -2
  290. instana_client/models/invitation_result.py +2 -2
  291. instana_client/models/ip_masking_configuration.py +2 -2
  292. instana_client/models/js_stack_trace_line.py +2 -2
  293. instana_client/models/kubernetes_physical_context.py +3 -3
  294. instana_client/models/latency_blueprint_indicator.py +5 -16
  295. instana_client/models/llm_egress_gateway.py +124 -0
  296. instana_client/models/location_status.py +2 -2
  297. instana_client/models/log_alert_config.py +8 -6
  298. instana_client/models/log_alert_config_with_metadata.py +8 -6
  299. instana_client/models/log_alert_rule.py +2 -2
  300. instana_client/models/log_count_alert_rule.py +2 -2
  301. instana_client/models/log_entry_actor.py +2 -2
  302. instana_client/models/log_event_result.py +6 -7
  303. instana_client/models/log_time_threshold.py +2 -2
  304. instana_client/models/log_volume_group.py +91 -0
  305. instana_client/models/log_volume_usage_item.py +101 -0
  306. instana_client/models/log_volume_usage_result.py +96 -0
  307. instana_client/models/logs_application_alert_rule.py +4 -4
  308. instana_client/models/maintenance_config.py +2 -2
  309. instana_client/models/maintenance_config_scheduling.py +2 -2
  310. instana_client/models/maintenance_config_v2.py +2 -2
  311. instana_client/models/maintenance_config_v2_with_state_and_occurrence.py +2 -2
  312. instana_client/models/maintenance_config_with_last_updated.py +2 -2
  313. instana_client/models/maintenance_window.py +2 -2
  314. instana_client/models/manual_alerting_channel_configuration.py +2 -2
  315. instana_client/models/manual_close_info.py +2 -2
  316. instana_client/models/manual_service_config.py +2 -2
  317. instana_client/models/match_all_http_path_segment_matching_rule.py +2 -2
  318. instana_client/models/match_expression_dto.py +3 -3
  319. instana_client/models/meta_data.py +2 -2
  320. instana_client/models/metric_api_result.py +2 -2
  321. instana_client/models/metric_config.py +2 -2
  322. instana_client/models/metric_configuration.py +3 -3
  323. instana_client/models/metric_description.py +2 -2
  324. instana_client/models/metric_instance.py +2 -2
  325. instana_client/models/metric_item.py +2 -2
  326. instana_client/models/metric_metadata.py +4 -4
  327. instana_client/models/metric_pattern.py +2 -2
  328. instana_client/models/metric_query.py +128 -0
  329. instana_client/models/metrics_result.py +2 -2
  330. instana_client/models/metrics_result_item.py +5 -3
  331. instana_client/models/metrics_test_result_item.py +2 -2
  332. instana_client/models/mobile_app.py +2 -2
  333. instana_client/models/mobile_app_alert_config.py +2 -2
  334. instana_client/models/mobile_app_alert_rule.py +8 -5
  335. instana_client/models/mobile_app_beacon_groups_item.py +2 -2
  336. instana_client/models/mobile_app_beacon_groups_result.py +2 -2
  337. instana_client/models/mobile_app_beacon_result.py +2 -2
  338. instana_client/models/mobile_app_beacon_tag_group.py +2 -2
  339. instana_client/models/mobile_app_beacons_item.py +11 -5
  340. instana_client/models/mobile_app_event_result.py +6 -7
  341. instana_client/models/mobile_app_metric_result.py +2 -2
  342. instana_client/models/mobile_app_monitoring_beacon.py +22 -4
  343. instana_client/models/mobile_app_monitoring_metric_description.py +5 -3
  344. instana_client/models/mobile_app_monitoring_metrics_configuration.py +2 -2
  345. instana_client/models/mobile_app_time_threshold.py +2 -2
  346. instana_client/models/model_field.py +2 -2
  347. instana_client/models/monitored_entities_stats.py +92 -0
  348. instana_client/models/monitoring_state.py +11 -3
  349. instana_client/models/multiple_scripts_configuration.py +2 -2
  350. instana_client/models/multiplication.py +97 -0
  351. instana_client/models/nested_operation.py +128 -0
  352. instana_client/models/new_application_config.py +2 -2
  353. instana_client/models/new_business_perspective_config.py +2 -2
  354. instana_client/models/new_manual_service_config.py +2 -2
  355. instana_client/models/o_auth_config.py +110 -0
  356. instana_client/models/o_auth_integration.py +98 -0
  357. instana_client/models/o_auth_token.py +111 -0
  358. instana_client/models/occurrence.py +2 -2
  359. instana_client/models/office365_integration.py +2 -2
  360. instana_client/models/one_time_maintenance_window.py +2 -2
  361. instana_client/models/opsgenie_integration.py +2 -2
  362. instana_client/models/order.py +2 -2
  363. instana_client/models/pagerduty_integration.py +2 -2
  364. instana_client/models/paginated_result.py +2 -2
  365. instana_client/models/pagination.py +2 -2
  366. instana_client/models/parameter.py +2 -2
  367. instana_client/models/parameter_value.py +2 -2
  368. instana_client/models/path_parameter_http_path_segment_matching_rule.py +2 -2
  369. instana_client/models/physical_context.py +3 -3
  370. instana_client/models/plugin_result.py +2 -2
  371. instana_client/models/policy.py +2 -2
  372. instana_client/models/policy_runnable.py +2 -2
  373. instana_client/models/policy_scheduling.py +91 -0
  374. instana_client/models/post_mobile_app_source_map_config_request.py +88 -0
  375. instana_client/models/post_snapshots_result.py +2 -2
  376. instana_client/models/problem.py +2 -2
  377. instana_client/models/prometheus_webhook_integration.py +2 -2
  378. instana_client/models/recurrent_maintenance_window.py +2 -2
  379. instana_client/models/release.py +6 -6
  380. instana_client/models/release_scope.py +2 -2
  381. instana_client/models/release_with_metadata.py +8 -8
  382. instana_client/models/retention_period.py +101 -0
  383. instana_client/models/rolling_time_window.py +4 -3
  384. instana_client/models/rule_input.py +2 -2
  385. instana_client/models/rule_with_threshold_application_alert_rule.py +2 -2
  386. instana_client/models/rule_with_threshold_infra_alert_rule.py +2 -2
  387. instana_client/models/rule_with_threshold_log_alert_rule.py +2 -2
  388. instana_client/models/rule_with_threshold_mobile_app_alert_rule.py +2 -2
  389. instana_client/models/rule_with_threshold_website_alert_rule.py +2 -2
  390. instana_client/models/run_configuration.py +2 -2
  391. instana_client/models/salesforce_integration.py +2 -2
  392. instana_client/models/saturation_blueprint_indicator.py +97 -0
  393. instana_client/models/scope_binding.py +2 -2
  394. instana_client/models/search_field_result.py +2 -2
  395. instana_client/models/service.py +3 -3
  396. instana_client/models/service_config.py +2 -2
  397. instana_client/models/service_event_result.py +6 -7
  398. instana_client/models/service_item.py +2 -2
  399. instana_client/models/service_level_indicator.py +10 -7
  400. instana_client/models/service_level_objective_alert_rule.py +2 -2
  401. instana_client/models/service_level_objective_configuration.py +3 -3
  402. instana_client/models/service_levels_alert_config.py +15 -5
  403. instana_client/models/service_levels_alert_rule.py +2 -2
  404. instana_client/models/service_levels_burn_rate_config.py +115 -0
  405. instana_client/models/service_levels_burn_rate_time_windows.py +2 -2
  406. instana_client/models/service_levels_static_threshold_config.py +100 -0
  407. instana_client/models/service_levels_time_threshold.py +5 -5
  408. instana_client/models/service_levelse_alert_config_with_metadata.py +15 -5
  409. instana_client/models/service_map.py +2 -2
  410. instana_client/models/service_map_connection.py +2 -2
  411. instana_client/models/service_matching_rule.py +2 -2
  412. instana_client/models/service_metric_result.py +2 -2
  413. instana_client/models/service_node.py +2 -2
  414. instana_client/models/service_now_enhanced_integration.py +2 -2
  415. instana_client/models/service_now_integration.py +2 -2
  416. instana_client/models/service_result.py +3 -3
  417. instana_client/models/service_scope.py +4 -4
  418. instana_client/models/service_scope_with_metadata.py +5 -5
  419. instana_client/models/service_scoped_to.py +3 -3
  420. instana_client/models/service_scoped_to_with_metadata.py +4 -4
  421. instana_client/models/service_simple.py +2 -2
  422. instana_client/models/session_settings.py +4 -4
  423. instana_client/models/simple_metric_configuration.py +123 -0
  424. instana_client/models/single_value.py +128 -0
  425. instana_client/models/slack_integration.py +2 -2
  426. instana_client/models/sli_configuration.py +2 -2
  427. instana_client/models/sli_configuration_with_last_updated.py +2 -2
  428. instana_client/models/sli_entity.py +2 -2
  429. instana_client/models/sli_report.py +2 -2
  430. instana_client/models/slo_config_with_rbac_tag.py +128 -0
  431. instana_client/models/slo_entity.py +8 -5
  432. instana_client/models/slo_report.py +2 -2
  433. instana_client/models/slowness_application_alert_rule.py +2 -2
  434. instana_client/models/slowness_mobile_app_alert_rule.py +90 -0
  435. instana_client/models/slowness_website_alert_rule.py +2 -2
  436. instana_client/models/snapshot_item.py +2 -2
  437. instana_client/models/snapshot_preview.py +7 -7
  438. instana_client/models/snapshot_result.py +2 -2
  439. instana_client/models/software_user.py +2 -2
  440. instana_client/models/software_version.py +2 -2
  441. instana_client/models/source_map_file_blob.py +2 -2
  442. instana_client/models/source_map_file_meta.py +2 -2
  443. instana_client/models/source_map_upload_config.py +2 -2
  444. instana_client/models/source_map_upload_configs.py +106 -0
  445. instana_client/models/span_excerpt.py +12 -12
  446. instana_client/models/span_relation.py +3 -3
  447. instana_client/models/specific_js_errors_website_alert_rule.py +4 -4
  448. instana_client/models/splunk_integration.py +2 -2
  449. instana_client/models/ssl_certificate_configuration.py +17 -5
  450. instana_client/models/ssl_certificate_configuration_update.py +107 -0
  451. instana_client/models/ssl_certificate_validation.py +99 -0
  452. instana_client/models/stack_trace_item.py +7 -7
  453. instana_client/models/stack_trace_line.py +2 -2
  454. instana_client/models/static_baseline_threshold_rule.py +3 -3
  455. instana_client/models/static_string_field.py +2 -2
  456. instana_client/models/static_threshold.py +2 -2
  457. instana_client/models/static_threshold_rule.py +2 -2
  458. instana_client/models/status_code_application_alert_rule.py +2 -2
  459. instana_client/models/status_code_mobile_app_alert_rule.py +4 -4
  460. instana_client/models/status_code_website_alert_rule.py +4 -4
  461. instana_client/models/subtraction.py +97 -0
  462. instana_client/models/synthetic_alert_config.py +2 -2
  463. instana_client/models/synthetic_alert_config_with_metadata.py +2 -2
  464. instana_client/models/synthetic_alert_rule.py +2 -2
  465. instana_client/models/synthetic_bulk_response.py +92 -0
  466. instana_client/models/synthetic_call_config.py +4 -4
  467. instana_client/models/synthetic_call_rule.py +6 -6
  468. instana_client/models/synthetic_call_with_defaults_config.py +4 -4
  469. instana_client/models/synthetic_configuration.py +93 -0
  470. instana_client/models/synthetic_configuration_update.py +95 -0
  471. instana_client/models/synthetic_credential.py +23 -3
  472. instana_client/models/synthetic_datacenter.py +2 -2
  473. instana_client/models/synthetic_datacenter_configuration.py +2 -2
  474. instana_client/models/synthetic_geo_point.py +2 -2
  475. instana_client/models/synthetic_location.py +2 -2
  476. instana_client/models/synthetic_location_configuration.py +2 -2
  477. instana_client/models/synthetic_metric_configuration.py +2 -2
  478. instana_client/models/synthetic_metric_tag_group.py +18 -5
  479. instana_client/models/synthetic_playback_capabilities.py +17 -4
  480. instana_client/models/synthetic_resource_update_list_dns_filter_target_value_list_dns_filter_target_value.py +105 -0
  481. instana_client/models/synthetic_resource_update_list_ssl_certificate_validation_list_ssl_certificate_validation.py +105 -0
  482. instana_client/models/synthetic_resource_update_list_string_list_string.py +90 -0
  483. instana_client/models/synthetic_resource_update_map_string_string_list_string.py +90 -0
  484. instana_client/models/synthetic_slo_entity.py +7 -5
  485. instana_client/models/synthetic_test.py +27 -3
  486. instana_client/models/synthetic_test_cicd.py +96 -0
  487. instana_client/models/synthetic_test_cicd_customization.py +96 -0
  488. instana_client/models/synthetic_test_cicd_item.py +114 -0
  489. instana_client/models/synthetic_test_cicd_response.py +92 -0
  490. instana_client/models/synthetic_test_deep_update.py +122 -0
  491. instana_client/models/synthetic_test_shallow_update.py +122 -0
  492. instana_client/models/synthetic_test_update.py +147 -0
  493. instana_client/models/synthetic_time_threshold.py +2 -2
  494. instana_client/models/synthetic_type_configuration.py +11 -11
  495. instana_client/models/synthetic_type_configuration_update.py +152 -0
  496. instana_client/models/synthetics_event_result.py +6 -7
  497. instana_client/models/system_rule.py +2 -2
  498. instana_client/models/system_rule_label.py +2 -2
  499. instana_client/models/tag.py +6 -6
  500. instana_client/models/tag_catalog.py +2 -2
  501. instana_client/models/tag_filter.py +22 -10
  502. instana_client/models/tag_filter_all_of_value.py +195 -0
  503. instana_client/models/tag_filter_expression.py +2 -2
  504. instana_client/models/tag_filter_expression_element.py +2 -2
  505. instana_client/models/tag_matcher_dto.py +2 -2
  506. instana_client/models/tag_tree_level.py +2 -2
  507. instana_client/models/tag_tree_node.py +2 -2
  508. instana_client/models/tag_tree_tag.py +2 -2
  509. instana_client/models/test_common_properties.py +2 -2
  510. instana_client/models/test_last_error.py +90 -0
  511. instana_client/models/test_result.py +2 -2
  512. instana_client/models/test_result_common_properties.py +24 -3
  513. instana_client/models/test_result_detail_data.py +2 -2
  514. instana_client/models/test_result_item.py +2 -2
  515. instana_client/models/test_result_list_item.py +2 -2
  516. instana_client/models/test_result_list_result.py +2 -2
  517. instana_client/models/test_result_metadata.py +2 -2
  518. instana_client/models/test_result_subtransaction.py +2 -2
  519. instana_client/models/threshold.py +2 -2
  520. instana_client/models/threshold_config_rule.py +2 -2
  521. instana_client/models/threshold_rule.py +2 -2
  522. instana_client/models/throughput_application_alert_rule.py +2 -2
  523. instana_client/models/throughput_mobile_app_alert_rule.py +2 -2
  524. instana_client/models/throughput_website_alert_rule.py +2 -2
  525. instana_client/models/time_frame.py +2 -2
  526. instana_client/models/time_window.py +5 -4
  527. instana_client/models/topology.py +2 -2
  528. instana_client/models/trace.py +8 -8
  529. instana_client/models/trace_activity_tree_node_details.py +27 -15
  530. instana_client/models/trace_download_result.py +2 -2
  531. instana_client/models/trace_groups_item.py +2 -2
  532. instana_client/models/trace_groups_result.py +2 -2
  533. instana_client/models/trace_impact_application_time_threshold.py +2 -2
  534. instana_client/models/trace_item.py +2 -2
  535. instana_client/models/trace_result.py +2 -2
  536. instana_client/models/traffic_blueprint_indicator.py +3 -3
  537. instana_client/models/trigger.py +15 -7
  538. instana_client/models/type_configuration.py +2 -2
  539. instana_client/models/unsupported_http_path_segment_matching_rule.py +2 -2
  540. instana_client/models/updated_business_perspective_config.py +2 -2
  541. instana_client/models/usage_result.py +2 -2
  542. instana_client/models/usage_result_items.py +2 -2
  543. instana_client/models/user_basic_result.py +2 -2
  544. instana_client/models/user_impact_mobile_app_time_threshold.py +3 -3
  545. instana_client/models/user_impact_website_time_threshold.py +3 -3
  546. instana_client/models/user_result.py +2 -2
  547. instana_client/models/users_result.py +2 -2
  548. instana_client/models/validated_alerting_channel_input_info.py +4 -4
  549. instana_client/models/validated_alerting_configuration.py +2 -2
  550. instana_client/models/validated_maintenance_config_v2_with_state_and_occurrence.py +2 -2
  551. instana_client/models/validated_maintenance_config_with_status.py +2 -2
  552. instana_client/models/victor_ops_integration.py +2 -2
  553. instana_client/models/violations_in_period_application_time_threshold.py +2 -2
  554. instana_client/models/violations_in_period_mobile_app_time_threshold.py +2 -2
  555. instana_client/models/violations_in_period_website_time_threshold.py +2 -2
  556. instana_client/models/violations_in_sequence_application_time_threshold.py +2 -2
  557. instana_client/models/violations_in_sequence_infra_time_threshold.py +2 -2
  558. instana_client/models/violations_in_sequence_log_time_threshold.py +2 -2
  559. instana_client/models/violations_in_sequence_mobile_app_time_threshold.py +2 -2
  560. instana_client/models/violations_in_sequence_synthetic_time_threshold.py +2 -2
  561. instana_client/models/violations_in_sequence_website_time_threshold.py +2 -2
  562. instana_client/models/watson_ai_ops_webhook_integration.py +2 -2
  563. instana_client/models/webex_teams_webhook_integration.py +2 -2
  564. instana_client/models/webhook_integration.py +14 -4
  565. instana_client/models/webpage_action_configuration.py +2 -2
  566. instana_client/models/webpage_action_configuration_update.py +109 -0
  567. instana_client/models/webpage_script_configuration.py +5 -3
  568. instana_client/models/webpage_script_configuration_update.py +111 -0
  569. instana_client/models/website.py +2 -2
  570. instana_client/models/website_alert_config.py +2 -2
  571. instana_client/models/website_alert_config_with_metadata.py +2 -2
  572. instana_client/models/website_alert_rule.py +2 -2
  573. instana_client/models/website_apdex_entity.py +2 -2
  574. instana_client/models/website_beacon_groups_item.py +2 -2
  575. instana_client/models/website_beacon_groups_result.py +2 -2
  576. instana_client/models/website_beacon_result.py +2 -2
  577. instana_client/models/website_beacon_tag_group.py +2 -2
  578. instana_client/models/website_beacons_item.py +11 -5
  579. instana_client/models/website_event_based_sli_entity.py +2 -2
  580. instana_client/models/website_event_result.py +5 -6
  581. instana_client/models/website_metric_result.py +2 -2
  582. instana_client/models/website_monitoring_beacon.py +7 -3
  583. instana_client/models/website_monitoring_metric_description.py +2 -2
  584. instana_client/models/website_monitoring_metrics_configuration.py +2 -2
  585. instana_client/models/website_slo_entity.py +2 -2
  586. instana_client/models/website_time_based_sli_entity.py +2 -2
  587. instana_client/models/website_time_threshold.py +2 -2
  588. instana_client/models/widget.py +2 -2
  589. instana_client/models/with_metadata.py +2 -2
  590. instana_client/models/with_resolved_name.py +2 -2
  591. instana_client/models/z_chat_ops_integration.py +2 -2
  592. instana_client/rest.py +3 -2
  593. instana_client-1.0.3.dist-info/METADATA +1097 -0
  594. instana_client-1.0.3.dist-info/RECORD +599 -0
  595. {instana_client-1.0.0.dist-info → instana_client-1.0.3.dist-info}/WHEEL +1 -1
  596. instana_client/models/dns_action_configuration.py +0 -134
  597. instana_client/models/dns_action_filter_query_time.py +0 -99
  598. instana_client/models/dns_action_filter_target_value.py +0 -106
  599. instana_client/models/full_trace.py +0 -97
  600. instana_client/models/span.py +0 -156
  601. instana_client-1.0.0.dist-info/METADATA +0 -25
  602. instana_client-1.0.0.dist-info/RECORD +0 -515
  603. {instana_client-1.0.0.dist-info → instana_client-1.0.3.dist-info}/licenses/LICENSE +0 -0
  604. {instana_client-1.0.0.dist-info → instana_client-1.0.3.dist-info}/top_level.txt +0 -0
@@ -3,9 +3,9 @@
3
3
  """
4
4
  Instana REST API documentation
5
5
 
6
- Searching for answers and best pratices? Check our [IBM Instana Community](https://community.ibm.com/community/user/aiops/communities/community-home?CommunityKey=58f324a3-3104-41be-9510-5b7c413cc48f). ## Overview The Instana REST API provides programmatic access to the Instana platform. It can be used to retrieve data available through the Instana UI Dashboard -- metrics, events, traces, etc -- and also to automate configuration tasks such as user management. ### Navigating the API documentation The API endpoints are grouped by product area and functionality. This generally maps to how our UI Dashboard is organized, hopefully making it easier to locate which endpoints you'd use to fetch the data you see visualized in our UI. The [UI sections](https://www.ibm.com/docs/en/instana-observability/current?topic=working-user-interface#navigation-menu) include: - Websites & Mobile Apps - Applications - Infrastructure - Synthetic Monitoring - Events - Automation - Service Levels - Settings - etc ### Rate Limiting A rate limit is applied to API usage. Up to 5,000 calls per hour can be made. How many remaining calls can be made and when this call limit resets, can inspected via three headers that are part of the responses of the API server. - **X-RateLimit-Limit:** Shows the maximum number of calls that may be executed per hour. - **X-RateLimit-Remaining:** How many calls may still be executed within the current hour. - **X-RateLimit-Reset:** Time when the remaining calls will be reset to the limit. For compatibility reasons with other rate limited APIs, this date is not the date in milliseconds, but instead in seconds since 1970-01-01T00:00:00+00:00. ### Further Reading We provide additional documentation for our REST API in our [product documentation](https://www.ibm.com/docs/en/instana-observability/current?topic=apis-web-rest-api). Here you'll also find some common queries for retrieving data and configuring Instana. ## Getting Started with the REST API ### API base URL The base URL for an specific instance of Instana can be determined using the tenant and unit information. - `base`: This is the base URL of a tenant unit, e.g. `https://test-example.instana.io`. This is the same URL that is used to access the Instana user interface. - `apiToken`: Requests against the Instana API require valid API tokens. An initial API token can be generated via the Instana user interface. Any additional API tokens can be generated via the API itself. ### Curl Example Here is an Example to use the REST API with Curl. First lets get all the available metrics with possible aggregations with a GET call. ```bash curl --request GET \\ --url https://test-instana.instana.io/api/application-monitoring/catalog/metrics \\ --header 'authorization: apiToken xxxxxxxxxxxxxxxx' ``` Next we can get every call grouped by the endpoint name that has an error count greater then zero. As a metric we could get the mean error rate for example. ```bash curl --request POST \\ --url https://test-instana.instana.io/api/application-monitoring/analyze/call-groups \\ --header 'authorization: apiToken xxxxxxxxxxxxxxxx' \\ --header 'content-type: application/json' \\ --data '{ \"group\":{ \"groupbyTag\":\"endpoint.name\" }, \"tagFilters\":[ { \"name\":\"call.error.count\", \"value\":\"0\", \"operator\":\"GREATER_THAN\" } ], \"metrics\":[ { \"metric\":\"errors\", \"aggregation\":\"MEAN\" } ] }' ``` ### Generating REST API clients The API is specified using the [OpenAPI v3](https://github.com/OAI/OpenAPI-Specification) (previously known as Swagger) format. You can download the current specification at our [GitHub API documentation](https://instana.github.io/openapi/openapi.yaml). OpenAPI tries to solve the issue of ever-evolving APIs and clients lagging behind. Please make sure that you always use the latest version of the generator, as a number of improvements are regularly made. To generate a client library for your language, you can use the [OpenAPI client generators](https://github.com/OpenAPITools/openapi-generator). #### Go For example, to generate a client library for Go to interact with our backend, you can use the following script; mind replacing the values of the `UNIT_NAME` and `TENANT_NAME` environment variables using those for your tenant unit: ```bash #!/bin/bash ### This script assumes you have the `java` and `wget` commands on the path export UNIT_NAME='myunit' # for example: prod export TENANT_NAME='mytenant' # for example: awesomecompany //Download the generator to your current working directory: wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.3.1/openapi-generator-cli-4.3.1.jar -O openapi-generator-cli.jar --server-variables \"tenant=${TENANT_NAME},unit=${UNIT_NAME}\" //generate a client library that you can vendor into your repository java -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g go \\ -o pkg/instana/openapi \\ --skip-validate-spec //(optional) format the Go code according to the Go code standard gofmt -s -w pkg/instana/openapi ``` The generated clients contain comprehensive READMEs, and you can start right away using the client from the example above: ```go import instana \"./pkg/instana/openapi\" // readTags will read all available application monitoring tags along with their type and category func readTags() { configuration := instana.NewConfiguration() configuration.Host = \"tenant-unit.instana.io\" configuration.BasePath = \"https://tenant-unit.instana.io\" client := instana.NewAPIClient(configuration) auth := context.WithValue(context.Background(), instana.ContextAPIKey, instana.APIKey{ Key: apiKey, Prefix: \"apiToken\", }) tags, _, err := client.ApplicationCatalogApi.GetApplicationTagCatalog(auth) if err != nil { fmt.Fatalf(\"Error calling the API, aborting.\") } for _, tag := range tags { fmt.Printf(\"%s (%s): %s\\n\", tag.Category, tag.Type, tag.Name) } } ``` #### Java Follow the instructions provided in the official documentation from [OpenAPI Tools](https://github.com/OpenAPITools) to download the [openapi-generator-cli.jar](https://github.com/OpenAPITools/openapi-generator?tab=readme-ov-file#13---download-jar). Depending on your environment, use one of the following java http client implementations which will create a valid client for our OpenAPI specification: ``` //Nativ Java HTTP Client java -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec -p dateLibrary=java8 --library native //Spring WebClient java -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec -p dateLibrary=java8,hideGenerationTimestamp=true --library webclient //Spring RestTemplate java -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec -p dateLibrary=java8,hideGenerationTimestamp=true --library resttemplate ```
6
+ Documentation for INSTANA REST API
7
7
 
8
- The version of the OpenAPI document: 1.291.1002
8
+ The version of the OpenAPI document: 1.309.1268
9
9
  Contact: support@instana.com
10
10
  Generated by OpenAPI Generator (https://openapi-generator.tech)
11
11
 
@@ -23,6 +23,7 @@ from typing_extensions import Annotated
23
23
  from instana_client.models.api_create_group import ApiCreateGroup
24
24
  from instana_client.models.api_group import ApiGroup
25
25
  from instana_client.models.group_mapping import GroupMapping
26
+ from instana_client.models.group_mapping_overview import GroupMappingOverview
26
27
  from instana_client.models.identity_provider_patch import IdentityProviderPatch
27
28
 
28
29
  from instana_client.api_client import ApiClient, RequestSerialized
@@ -63,7 +64,7 @@ class GroupsApi:
63
64
  ) -> ApiGroup:
64
65
  """Add permissions to group
65
66
 
66
- Add a permission to a group. Permissions are strings associated with the group that some resources requires to fulfill requests. Examples of `Permissions`: - `ACCESS_APPLICATIONS` - `ACCESS_INFRASTRUCTURE` - `ACCESS_KUBERNETES` - `ACCESS_MOBILE_APPS` - `ACCESS_WEBSITES` - `CAN_CONFIGURE_AGENT_RUN_MODE` - `CAN_CONFIGURE_AGENTS` - `CAN_CONFIGURE_API_TOKENS` - `CAN_CONFIGURE_APPLICATIONS` - `CAN_CONFIGURE_AUTHENTICATION_METHODS` - `CAN_CONFIGURE_CUSTOM_ALERTS` - `CAN_CONFIGURE_EUM_APPLICATIONS` - `CAN_CONFIGURE_GLOBAL_ALERT_CONFIGS` - `CAN_CONFIGURE_GLOBAL_ALERT_PAYLOAD` - `CAN_CONFIGURE_INTEGRATIONS` - `CAN_CONFIGURE_LOG_MANAGEMENT` - `CAN_CONFIGURE_MOBILE_APP_MONITORING` - `CAN_CONFIGURE_PERSONAL_API_TOKENS` - `CAN_CONFIGURE_RELEASES` - `CAN_CONFIGURE_SERVICE_LEVEL_INDICATORS` - `CAN_CONFIGURE_SERVICE_MAPPING` - `CAN_CONFIGURE_SESSION_SETTINGS` - `CAN_CONFIGURE_TEAMS` - `CAN_CONFIGURE_USERS` - `CAN_CREATE_PUBLIC_CUSTOM_DASHBOARDS` - `CAN_EDIT_ALL_ACCESSIBLE_CUSTOM_DASHBOARDS` - `CAN_INSTALL_NEW_AGENTS` - `CAN_VIEW_ACCOUNT_AND_BILLING_INFORMATION` - `CAN_VIEW_AUDIT_LOG` - `CAN_VIEW_LOGS` - `CAN_VIEW_TRACE_DETAILS` - `LIMITED_APPLICATIONS_SCOPE` - `LIMITED_INFRASTRUCTURE_SCOPE` - `LIMITED_KUBERNETES_SCOPE` - `LIMITED_MOBILE_APPS_SCOPE` - `LIMITED_WEBSITES_SCOPE`
67
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
67
68
 
68
69
  :param group_id: Id of the group to add permissions (required)
69
70
  :type group_id: str
@@ -134,7 +135,7 @@ class GroupsApi:
134
135
  ) -> ApiResponse[ApiGroup]:
135
136
  """Add permissions to group
136
137
 
137
- Add a permission to a group. Permissions are strings associated with the group that some resources requires to fulfill requests. Examples of `Permissions`: - `ACCESS_APPLICATIONS` - `ACCESS_INFRASTRUCTURE` - `ACCESS_KUBERNETES` - `ACCESS_MOBILE_APPS` - `ACCESS_WEBSITES` - `CAN_CONFIGURE_AGENT_RUN_MODE` - `CAN_CONFIGURE_AGENTS` - `CAN_CONFIGURE_API_TOKENS` - `CAN_CONFIGURE_APPLICATIONS` - `CAN_CONFIGURE_AUTHENTICATION_METHODS` - `CAN_CONFIGURE_CUSTOM_ALERTS` - `CAN_CONFIGURE_EUM_APPLICATIONS` - `CAN_CONFIGURE_GLOBAL_ALERT_CONFIGS` - `CAN_CONFIGURE_GLOBAL_ALERT_PAYLOAD` - `CAN_CONFIGURE_INTEGRATIONS` - `CAN_CONFIGURE_LOG_MANAGEMENT` - `CAN_CONFIGURE_MOBILE_APP_MONITORING` - `CAN_CONFIGURE_PERSONAL_API_TOKENS` - `CAN_CONFIGURE_RELEASES` - `CAN_CONFIGURE_SERVICE_LEVEL_INDICATORS` - `CAN_CONFIGURE_SERVICE_MAPPING` - `CAN_CONFIGURE_SESSION_SETTINGS` - `CAN_CONFIGURE_TEAMS` - `CAN_CONFIGURE_USERS` - `CAN_CREATE_PUBLIC_CUSTOM_DASHBOARDS` - `CAN_EDIT_ALL_ACCESSIBLE_CUSTOM_DASHBOARDS` - `CAN_INSTALL_NEW_AGENTS` - `CAN_VIEW_ACCOUNT_AND_BILLING_INFORMATION` - `CAN_VIEW_AUDIT_LOG` - `CAN_VIEW_LOGS` - `CAN_VIEW_TRACE_DETAILS` - `LIMITED_APPLICATIONS_SCOPE` - `LIMITED_INFRASTRUCTURE_SCOPE` - `LIMITED_KUBERNETES_SCOPE` - `LIMITED_MOBILE_APPS_SCOPE` - `LIMITED_WEBSITES_SCOPE`
138
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
138
139
 
139
140
  :param group_id: Id of the group to add permissions (required)
140
141
  :type group_id: str
@@ -205,7 +206,7 @@ class GroupsApi:
205
206
  ) -> RESTResponseType:
206
207
  """Add permissions to group
207
208
 
208
- Add a permission to a group. Permissions are strings associated with the group that some resources requires to fulfill requests. Examples of `Permissions`: - `ACCESS_APPLICATIONS` - `ACCESS_INFRASTRUCTURE` - `ACCESS_KUBERNETES` - `ACCESS_MOBILE_APPS` - `ACCESS_WEBSITES` - `CAN_CONFIGURE_AGENT_RUN_MODE` - `CAN_CONFIGURE_AGENTS` - `CAN_CONFIGURE_API_TOKENS` - `CAN_CONFIGURE_APPLICATIONS` - `CAN_CONFIGURE_AUTHENTICATION_METHODS` - `CAN_CONFIGURE_CUSTOM_ALERTS` - `CAN_CONFIGURE_EUM_APPLICATIONS` - `CAN_CONFIGURE_GLOBAL_ALERT_CONFIGS` - `CAN_CONFIGURE_GLOBAL_ALERT_PAYLOAD` - `CAN_CONFIGURE_INTEGRATIONS` - `CAN_CONFIGURE_LOG_MANAGEMENT` - `CAN_CONFIGURE_MOBILE_APP_MONITORING` - `CAN_CONFIGURE_PERSONAL_API_TOKENS` - `CAN_CONFIGURE_RELEASES` - `CAN_CONFIGURE_SERVICE_LEVEL_INDICATORS` - `CAN_CONFIGURE_SERVICE_MAPPING` - `CAN_CONFIGURE_SESSION_SETTINGS` - `CAN_CONFIGURE_TEAMS` - `CAN_CONFIGURE_USERS` - `CAN_CREATE_PUBLIC_CUSTOM_DASHBOARDS` - `CAN_EDIT_ALL_ACCESSIBLE_CUSTOM_DASHBOARDS` - `CAN_INSTALL_NEW_AGENTS` - `CAN_VIEW_ACCOUNT_AND_BILLING_INFORMATION` - `CAN_VIEW_AUDIT_LOG` - `CAN_VIEW_LOGS` - `CAN_VIEW_TRACE_DETAILS` - `LIMITED_APPLICATIONS_SCOPE` - `LIMITED_INFRASTRUCTURE_SCOPE` - `LIMITED_KUBERNETES_SCOPE` - `LIMITED_MOBILE_APPS_SCOPE` - `LIMITED_WEBSITES_SCOPE`
209
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
209
210
 
210
211
  :param group_id: Id of the group to add permissions (required)
211
212
  :type group_id: str
@@ -353,7 +354,7 @@ class GroupsApi:
353
354
  ) -> ApiGroup:
354
355
  """Add users to group
355
356
 
356
- Add one or more users to a group. The array contains the ids of the users to be added.
357
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
357
358
 
358
359
  :param group_id: Id of the group to add users (required)
359
360
  :type group_id: str
@@ -424,7 +425,7 @@ class GroupsApi:
424
425
  ) -> ApiResponse[ApiGroup]:
425
426
  """Add users to group
426
427
 
427
- Add one or more users to a group. The array contains the ids of the users to be added.
428
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
428
429
 
429
430
  :param group_id: Id of the group to add users (required)
430
431
  :type group_id: str
@@ -495,7 +496,7 @@ class GroupsApi:
495
496
  ) -> RESTResponseType:
496
497
  """Add users to group
497
498
 
498
- Add one or more users to a group. The array contains the ids of the users to be added.
499
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
499
500
 
500
501
  :param group_id: Id of the group to add users (required)
501
502
  :type group_id: str
@@ -642,7 +643,7 @@ class GroupsApi:
642
643
  ) -> ApiGroup:
643
644
  """Create group
644
645
 
645
- Creates a group on the tenant. Each group entry also needs a `Permission Set` per unit. The `Permission Set` object contains a set of permissions applied to the group. In case `permissions` include the entry e.g. `LIMITED_APPLICATIONS_SCOPE`, this group will have limited access to application area. Possible access permissions values are: - `ACCESS_APPLICATIONS` - `ACCESS_INFRASTRUCTURE` - `ACCESS_KUBERNETES` - `ACCESS_MOBILE_APPS` - `ACCESS_WEBSITES` - `LIMITED_APPLICATIONS_SCOPE` - `LIMITED_INFRASTRUCTURE_SCOPE` - `LIMITED_KUBERNETES_SCOPE` - `LIMITED_MOBILE_APPS_SCOPE` - `LIMITED_WEBSITES_SCOPE` The `id` value for the group is ignored, a new id is generated. The `scopeRoleId` is ignored, the id corresponding to the area is used. The `scopeId` is the id for the corresponding resource.
646
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
646
647
 
647
648
  :param api_create_group: (required)
648
649
  :type api_create_group: ApiCreateGroup
@@ -709,7 +710,7 @@ class GroupsApi:
709
710
  ) -> ApiResponse[ApiGroup]:
710
711
  """Create group
711
712
 
712
- Creates a group on the tenant. Each group entry also needs a `Permission Set` per unit. The `Permission Set` object contains a set of permissions applied to the group. In case `permissions` include the entry e.g. `LIMITED_APPLICATIONS_SCOPE`, this group will have limited access to application area. Possible access permissions values are: - `ACCESS_APPLICATIONS` - `ACCESS_INFRASTRUCTURE` - `ACCESS_KUBERNETES` - `ACCESS_MOBILE_APPS` - `ACCESS_WEBSITES` - `LIMITED_APPLICATIONS_SCOPE` - `LIMITED_INFRASTRUCTURE_SCOPE` - `LIMITED_KUBERNETES_SCOPE` - `LIMITED_MOBILE_APPS_SCOPE` - `LIMITED_WEBSITES_SCOPE` The `id` value for the group is ignored, a new id is generated. The `scopeRoleId` is ignored, the id corresponding to the area is used. The `scopeId` is the id for the corresponding resource.
713
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
713
714
 
714
715
  :param api_create_group: (required)
715
716
  :type api_create_group: ApiCreateGroup
@@ -776,7 +777,7 @@ class GroupsApi:
776
777
  ) -> RESTResponseType:
777
778
  """Create group
778
779
 
779
- Creates a group on the tenant. Each group entry also needs a `Permission Set` per unit. The `Permission Set` object contains a set of permissions applied to the group. In case `permissions` include the entry e.g. `LIMITED_APPLICATIONS_SCOPE`, this group will have limited access to application area. Possible access permissions values are: - `ACCESS_APPLICATIONS` - `ACCESS_INFRASTRUCTURE` - `ACCESS_KUBERNETES` - `ACCESS_MOBILE_APPS` - `ACCESS_WEBSITES` - `LIMITED_APPLICATIONS_SCOPE` - `LIMITED_INFRASTRUCTURE_SCOPE` - `LIMITED_KUBERNETES_SCOPE` - `LIMITED_MOBILE_APPS_SCOPE` - `LIMITED_WEBSITES_SCOPE` The `id` value for the group is ignored, a new id is generated. The `scopeRoleId` is ignored, the id corresponding to the area is used. The `scopeId` is the id for the corresponding resource.
780
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
780
781
 
781
782
  :param api_create_group: (required)
782
783
  :type api_create_group: ApiCreateGroup
@@ -916,7 +917,7 @@ class GroupsApi:
916
917
  ) -> GroupMapping:
917
918
  """Create group mapping
918
919
 
919
- Creates a mapping between a group from the IdP (LDAP, OIDC, SAML) and an Instana group. If the IdP is configured and mappings are enabled, the `key` `value` pairs a user sent by the idp will be evaluated every time this user logs in. If they match the mapping, the user will be assigned to the group corresponding to the `groupId`. Inside the payload, the `id` for the mapping is ignored, and instead, Instana generates a new id.
920
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
920
921
 
921
922
  :param group_mapping: (required)
922
923
  :type group_mapping: GroupMapping
@@ -983,7 +984,7 @@ class GroupsApi:
983
984
  ) -> ApiResponse[GroupMapping]:
984
985
  """Create group mapping
985
986
 
986
- Creates a mapping between a group from the IdP (LDAP, OIDC, SAML) and an Instana group. If the IdP is configured and mappings are enabled, the `key` `value` pairs a user sent by the idp will be evaluated every time this user logs in. If they match the mapping, the user will be assigned to the group corresponding to the `groupId`. Inside the payload, the `id` for the mapping is ignored, and instead, Instana generates a new id.
987
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
987
988
 
988
989
  :param group_mapping: (required)
989
990
  :type group_mapping: GroupMapping
@@ -1050,7 +1051,7 @@ class GroupsApi:
1050
1051
  ) -> RESTResponseType:
1051
1052
  """Create group mapping
1052
1053
 
1053
- Creates a mapping between a group from the IdP (LDAP, OIDC, SAML) and an Instana group. If the IdP is configured and mappings are enabled, the `key` `value` pairs a user sent by the idp will be evaluated every time this user logs in. If they match the mapping, the user will be assigned to the group corresponding to the `groupId`. Inside the payload, the `id` for the mapping is ignored, and instead, Instana generates a new id.
1054
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
1054
1055
 
1055
1056
  :param group_mapping: (required)
1056
1057
  :type group_mapping: GroupMapping
@@ -1190,7 +1191,7 @@ class GroupsApi:
1190
1191
  ) -> None:
1191
1192
  """Delete group
1192
1193
 
1193
- Delete the group data.
1194
+ Delete the group data. For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
1194
1195
 
1195
1196
  :param id: Id of the group to delete (required)
1196
1197
  :type id: str
@@ -1225,6 +1226,8 @@ class GroupsApi:
1225
1226
  )
1226
1227
 
1227
1228
  _response_types_map: Dict[str, Optional[str]] = {
1229
+ '204': None,
1230
+ '412': "str",
1228
1231
  }
1229
1232
  response_data = self.api_client.call_api(
1230
1233
  *_param,
@@ -1256,7 +1259,7 @@ class GroupsApi:
1256
1259
  ) -> ApiResponse[None]:
1257
1260
  """Delete group
1258
1261
 
1259
- Delete the group data.
1262
+ Delete the group data. For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
1260
1263
 
1261
1264
  :param id: Id of the group to delete (required)
1262
1265
  :type id: str
@@ -1291,6 +1294,8 @@ class GroupsApi:
1291
1294
  )
1292
1295
 
1293
1296
  _response_types_map: Dict[str, Optional[str]] = {
1297
+ '204': None,
1298
+ '412': "str",
1294
1299
  }
1295
1300
  response_data = self.api_client.call_api(
1296
1301
  *_param,
@@ -1322,7 +1327,7 @@ class GroupsApi:
1322
1327
  ) -> RESTResponseType:
1323
1328
  """Delete group
1324
1329
 
1325
- Delete the group data.
1330
+ Delete the group data. For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
1326
1331
 
1327
1332
  :param id: Id of the group to delete (required)
1328
1333
  :type id: str
@@ -1357,6 +1362,8 @@ class GroupsApi:
1357
1362
  )
1358
1363
 
1359
1364
  _response_types_map: Dict[str, Optional[str]] = {
1365
+ '204': None,
1366
+ '412': "str",
1360
1367
  }
1361
1368
  response_data = self.api_client.call_api(
1362
1369
  *_param,
@@ -1448,6 +1455,7 @@ class GroupsApi:
1448
1455
  ) -> None:
1449
1456
  """Delete group mapping
1450
1457
 
1458
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
1451
1459
 
1452
1460
  :param id: Id of the group mapping to delete (required)
1453
1461
  :type id: str
@@ -1513,6 +1521,7 @@ class GroupsApi:
1513
1521
  ) -> ApiResponse[None]:
1514
1522
  """Delete group mapping
1515
1523
 
1524
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
1516
1525
 
1517
1526
  :param id: Id of the group mapping to delete (required)
1518
1527
  :type id: str
@@ -1578,6 +1587,7 @@ class GroupsApi:
1578
1587
  ) -> RESTResponseType:
1579
1588
  """Delete group mapping
1580
1589
 
1590
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
1581
1591
 
1582
1592
  :param id: Id of the group mapping to delete (required)
1583
1593
  :type id: str
@@ -1684,10 +1694,611 @@ class GroupsApi:
1684
1694
 
1685
1695
 
1686
1696
 
1697
+ @validate_call
1698
+ def delete_groups(
1699
+ self,
1700
+ request_body: List[StrictStr],
1701
+ _request_timeout: Union[
1702
+ None,
1703
+ Annotated[StrictFloat, Field(gt=0)],
1704
+ Tuple[
1705
+ Annotated[StrictFloat, Field(gt=0)],
1706
+ Annotated[StrictFloat, Field(gt=0)]
1707
+ ]
1708
+ ] = None,
1709
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1710
+ _content_type: Optional[StrictStr] = None,
1711
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1712
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1713
+ ) -> None:
1714
+ """Delete groups
1715
+
1716
+ Delete multiple groups For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
1717
+
1718
+ :param request_body: (required)
1719
+ :type request_body: List[str]
1720
+ :param _request_timeout: timeout setting for this request. If one
1721
+ number provided, it will be total request
1722
+ timeout. It can also be a pair (tuple) of
1723
+ (connection, read) timeouts.
1724
+ :type _request_timeout: int, tuple(int, int), optional
1725
+ :param _request_auth: set to override the auth_settings for an a single
1726
+ request; this effectively ignores the
1727
+ authentication in the spec for a single request.
1728
+ :type _request_auth: dict, optional
1729
+ :param _content_type: force content-type for the request.
1730
+ :type _content_type: str, Optional
1731
+ :param _headers: set to override the headers for a single
1732
+ request; this effectively ignores the headers
1733
+ in the spec for a single request.
1734
+ :type _headers: dict, optional
1735
+ :param _host_index: set to override the host_index for a single
1736
+ request; this effectively ignores the host_index
1737
+ in the spec for a single request.
1738
+ :type _host_index: int, optional
1739
+ :return: Returns the result object.
1740
+ """ # noqa: E501
1741
+
1742
+ _param = self._delete_groups_serialize(
1743
+ request_body=request_body,
1744
+ _request_auth=_request_auth,
1745
+ _content_type=_content_type,
1746
+ _headers=_headers,
1747
+ _host_index=_host_index
1748
+ )
1749
+
1750
+ _response_types_map: Dict[str, Optional[str]] = {
1751
+ }
1752
+ response_data = self.api_client.call_api(
1753
+ *_param,
1754
+ _request_timeout=_request_timeout
1755
+ )
1756
+ response_data.read()
1757
+ return self.api_client.response_deserialize(
1758
+ response_data=response_data,
1759
+ response_types_map=_response_types_map,
1760
+ ).data
1761
+
1762
+
1763
+ @validate_call
1764
+ def delete_groups_with_http_info(
1765
+ self,
1766
+ request_body: List[StrictStr],
1767
+ _request_timeout: Union[
1768
+ None,
1769
+ Annotated[StrictFloat, Field(gt=0)],
1770
+ Tuple[
1771
+ Annotated[StrictFloat, Field(gt=0)],
1772
+ Annotated[StrictFloat, Field(gt=0)]
1773
+ ]
1774
+ ] = None,
1775
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1776
+ _content_type: Optional[StrictStr] = None,
1777
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1778
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1779
+ ) -> ApiResponse[None]:
1780
+ """Delete groups
1781
+
1782
+ Delete multiple groups For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
1783
+
1784
+ :param request_body: (required)
1785
+ :type request_body: List[str]
1786
+ :param _request_timeout: timeout setting for this request. If one
1787
+ number provided, it will be total request
1788
+ timeout. It can also be a pair (tuple) of
1789
+ (connection, read) timeouts.
1790
+ :type _request_timeout: int, tuple(int, int), optional
1791
+ :param _request_auth: set to override the auth_settings for an a single
1792
+ request; this effectively ignores the
1793
+ authentication in the spec for a single request.
1794
+ :type _request_auth: dict, optional
1795
+ :param _content_type: force content-type for the request.
1796
+ :type _content_type: str, Optional
1797
+ :param _headers: set to override the headers for a single
1798
+ request; this effectively ignores the headers
1799
+ in the spec for a single request.
1800
+ :type _headers: dict, optional
1801
+ :param _host_index: set to override the host_index for a single
1802
+ request; this effectively ignores the host_index
1803
+ in the spec for a single request.
1804
+ :type _host_index: int, optional
1805
+ :return: Returns the result object.
1806
+ """ # noqa: E501
1807
+
1808
+ _param = self._delete_groups_serialize(
1809
+ request_body=request_body,
1810
+ _request_auth=_request_auth,
1811
+ _content_type=_content_type,
1812
+ _headers=_headers,
1813
+ _host_index=_host_index
1814
+ )
1815
+
1816
+ _response_types_map: Dict[str, Optional[str]] = {
1817
+ }
1818
+ response_data = self.api_client.call_api(
1819
+ *_param,
1820
+ _request_timeout=_request_timeout
1821
+ )
1822
+ response_data.read()
1823
+ return self.api_client.response_deserialize(
1824
+ response_data=response_data,
1825
+ response_types_map=_response_types_map,
1826
+ )
1827
+
1828
+
1829
+ @validate_call
1830
+ def delete_groups_without_preload_content(
1831
+ self,
1832
+ request_body: List[StrictStr],
1833
+ _request_timeout: Union[
1834
+ None,
1835
+ Annotated[StrictFloat, Field(gt=0)],
1836
+ Tuple[
1837
+ Annotated[StrictFloat, Field(gt=0)],
1838
+ Annotated[StrictFloat, Field(gt=0)]
1839
+ ]
1840
+ ] = None,
1841
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1842
+ _content_type: Optional[StrictStr] = None,
1843
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1844
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1845
+ ) -> RESTResponseType:
1846
+ """Delete groups
1847
+
1848
+ Delete multiple groups For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
1849
+
1850
+ :param request_body: (required)
1851
+ :type request_body: List[str]
1852
+ :param _request_timeout: timeout setting for this request. If one
1853
+ number provided, it will be total request
1854
+ timeout. It can also be a pair (tuple) of
1855
+ (connection, read) timeouts.
1856
+ :type _request_timeout: int, tuple(int, int), optional
1857
+ :param _request_auth: set to override the auth_settings for an a single
1858
+ request; this effectively ignores the
1859
+ authentication in the spec for a single request.
1860
+ :type _request_auth: dict, optional
1861
+ :param _content_type: force content-type for the request.
1862
+ :type _content_type: str, Optional
1863
+ :param _headers: set to override the headers for a single
1864
+ request; this effectively ignores the headers
1865
+ in the spec for a single request.
1866
+ :type _headers: dict, optional
1867
+ :param _host_index: set to override the host_index for a single
1868
+ request; this effectively ignores the host_index
1869
+ in the spec for a single request.
1870
+ :type _host_index: int, optional
1871
+ :return: Returns the result object.
1872
+ """ # noqa: E501
1873
+
1874
+ _param = self._delete_groups_serialize(
1875
+ request_body=request_body,
1876
+ _request_auth=_request_auth,
1877
+ _content_type=_content_type,
1878
+ _headers=_headers,
1879
+ _host_index=_host_index
1880
+ )
1881
+
1882
+ _response_types_map: Dict[str, Optional[str]] = {
1883
+ }
1884
+ response_data = self.api_client.call_api(
1885
+ *_param,
1886
+ _request_timeout=_request_timeout
1887
+ )
1888
+ return response_data.response
1889
+
1890
+
1891
+ def _delete_groups_serialize(
1892
+ self,
1893
+ request_body,
1894
+ _request_auth,
1895
+ _content_type,
1896
+ _headers,
1897
+ _host_index,
1898
+ ) -> RequestSerialized:
1899
+
1900
+ _host = None
1901
+
1902
+ _collection_formats: Dict[str, str] = {
1903
+ 'request_body': '',
1904
+ }
1905
+
1906
+ _path_params: Dict[str, str] = {}
1907
+ _query_params: List[Tuple[str, str]] = []
1908
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1909
+ _form_params: List[Tuple[str, str]] = []
1910
+ _files: Dict[
1911
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1912
+ ] = {}
1913
+ _body_params: Optional[bytes] = None
1914
+
1915
+ # process the path parameters
1916
+ # process the query parameters
1917
+ # process the header parameters
1918
+ # process the form parameters
1919
+ # process the body parameter
1920
+ if request_body is not None:
1921
+ _body_params = request_body
1922
+
1923
+
1924
+ # set the HTTP header `Accept`
1925
+ if 'Accept' not in _header_params:
1926
+ _header_params['Accept'] = self.api_client.select_header_accept(
1927
+ [
1928
+ 'application/json'
1929
+ ]
1930
+ )
1931
+
1932
+ # set the HTTP header `Content-Type`
1933
+ if _content_type:
1934
+ _header_params['Content-Type'] = _content_type
1935
+ else:
1936
+ _default_content_type = (
1937
+ self.api_client.select_header_content_type(
1938
+ [
1939
+ 'application/json'
1940
+ ]
1941
+ )
1942
+ )
1943
+ if _default_content_type is not None:
1944
+ _header_params['Content-Type'] = _default_content_type
1945
+
1946
+ # authentication setting
1947
+ _auth_settings: List[str] = [
1948
+ 'ApiKeyAuth'
1949
+ ]
1950
+
1951
+ return self.api_client.param_serialize(
1952
+ method='PUT',
1953
+ resource_path='/api/settings/rbac/groups/delete',
1954
+ path_params=_path_params,
1955
+ query_params=_query_params,
1956
+ header_params=_header_params,
1957
+ body=_body_params,
1958
+ post_params=_form_params,
1959
+ files=_files,
1960
+ auth_settings=_auth_settings,
1961
+ collection_formats=_collection_formats,
1962
+ _host=_host,
1963
+ _request_auth=_request_auth
1964
+ )
1965
+
1966
+
1967
+
1968
+
1687
1969
  @validate_call
1688
1970
  def get_group(
1689
1971
  self,
1690
- id: Annotated[StrictStr, Field(description="Id of the group for retrieval")],
1972
+ id: Annotated[StrictStr, Field(description="Id of the group for retrieval")],
1973
+ _request_timeout: Union[
1974
+ None,
1975
+ Annotated[StrictFloat, Field(gt=0)],
1976
+ Tuple[
1977
+ Annotated[StrictFloat, Field(gt=0)],
1978
+ Annotated[StrictFloat, Field(gt=0)]
1979
+ ]
1980
+ ] = None,
1981
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1982
+ _content_type: Optional[StrictStr] = None,
1983
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1984
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1985
+ ) -> ApiGroup:
1986
+ """Get group
1987
+
1988
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
1989
+
1990
+ :param id: Id of the group for retrieval (required)
1991
+ :type id: str
1992
+ :param _request_timeout: timeout setting for this request. If one
1993
+ number provided, it will be total request
1994
+ timeout. It can also be a pair (tuple) of
1995
+ (connection, read) timeouts.
1996
+ :type _request_timeout: int, tuple(int, int), optional
1997
+ :param _request_auth: set to override the auth_settings for an a single
1998
+ request; this effectively ignores the
1999
+ authentication in the spec for a single request.
2000
+ :type _request_auth: dict, optional
2001
+ :param _content_type: force content-type for the request.
2002
+ :type _content_type: str, Optional
2003
+ :param _headers: set to override the headers for a single
2004
+ request; this effectively ignores the headers
2005
+ in the spec for a single request.
2006
+ :type _headers: dict, optional
2007
+ :param _host_index: set to override the host_index for a single
2008
+ request; this effectively ignores the host_index
2009
+ in the spec for a single request.
2010
+ :type _host_index: int, optional
2011
+ :return: Returns the result object.
2012
+ """ # noqa: E501
2013
+
2014
+ _param = self._get_group_serialize(
2015
+ id=id,
2016
+ _request_auth=_request_auth,
2017
+ _content_type=_content_type,
2018
+ _headers=_headers,
2019
+ _host_index=_host_index
2020
+ )
2021
+
2022
+ _response_types_map: Dict[str, Optional[str]] = {
2023
+ '200': "ApiGroup",
2024
+ }
2025
+ response_data = self.api_client.call_api(
2026
+ *_param,
2027
+ _request_timeout=_request_timeout
2028
+ )
2029
+ response_data.read()
2030
+ return self.api_client.response_deserialize(
2031
+ response_data=response_data,
2032
+ response_types_map=_response_types_map,
2033
+ ).data
2034
+
2035
+
2036
+ @validate_call
2037
+ def get_group_with_http_info(
2038
+ self,
2039
+ id: Annotated[StrictStr, Field(description="Id of the group for retrieval")],
2040
+ _request_timeout: Union[
2041
+ None,
2042
+ Annotated[StrictFloat, Field(gt=0)],
2043
+ Tuple[
2044
+ Annotated[StrictFloat, Field(gt=0)],
2045
+ Annotated[StrictFloat, Field(gt=0)]
2046
+ ]
2047
+ ] = None,
2048
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2049
+ _content_type: Optional[StrictStr] = None,
2050
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2051
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2052
+ ) -> ApiResponse[ApiGroup]:
2053
+ """Get group
2054
+
2055
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2056
+
2057
+ :param id: Id of the group for retrieval (required)
2058
+ :type id: str
2059
+ :param _request_timeout: timeout setting for this request. If one
2060
+ number provided, it will be total request
2061
+ timeout. It can also be a pair (tuple) of
2062
+ (connection, read) timeouts.
2063
+ :type _request_timeout: int, tuple(int, int), optional
2064
+ :param _request_auth: set to override the auth_settings for an a single
2065
+ request; this effectively ignores the
2066
+ authentication in the spec for a single request.
2067
+ :type _request_auth: dict, optional
2068
+ :param _content_type: force content-type for the request.
2069
+ :type _content_type: str, Optional
2070
+ :param _headers: set to override the headers for a single
2071
+ request; this effectively ignores the headers
2072
+ in the spec for a single request.
2073
+ :type _headers: dict, optional
2074
+ :param _host_index: set to override the host_index for a single
2075
+ request; this effectively ignores the host_index
2076
+ in the spec for a single request.
2077
+ :type _host_index: int, optional
2078
+ :return: Returns the result object.
2079
+ """ # noqa: E501
2080
+
2081
+ _param = self._get_group_serialize(
2082
+ id=id,
2083
+ _request_auth=_request_auth,
2084
+ _content_type=_content_type,
2085
+ _headers=_headers,
2086
+ _host_index=_host_index
2087
+ )
2088
+
2089
+ _response_types_map: Dict[str, Optional[str]] = {
2090
+ '200': "ApiGroup",
2091
+ }
2092
+ response_data = self.api_client.call_api(
2093
+ *_param,
2094
+ _request_timeout=_request_timeout
2095
+ )
2096
+ response_data.read()
2097
+ return self.api_client.response_deserialize(
2098
+ response_data=response_data,
2099
+ response_types_map=_response_types_map,
2100
+ )
2101
+
2102
+
2103
+ @validate_call
2104
+ def get_group_without_preload_content(
2105
+ self,
2106
+ id: Annotated[StrictStr, Field(description="Id of the group for retrieval")],
2107
+ _request_timeout: Union[
2108
+ None,
2109
+ Annotated[StrictFloat, Field(gt=0)],
2110
+ Tuple[
2111
+ Annotated[StrictFloat, Field(gt=0)],
2112
+ Annotated[StrictFloat, Field(gt=0)]
2113
+ ]
2114
+ ] = None,
2115
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2116
+ _content_type: Optional[StrictStr] = None,
2117
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2118
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2119
+ ) -> RESTResponseType:
2120
+ """Get group
2121
+
2122
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2123
+
2124
+ :param id: Id of the group for retrieval (required)
2125
+ :type id: str
2126
+ :param _request_timeout: timeout setting for this request. If one
2127
+ number provided, it will be total request
2128
+ timeout. It can also be a pair (tuple) of
2129
+ (connection, read) timeouts.
2130
+ :type _request_timeout: int, tuple(int, int), optional
2131
+ :param _request_auth: set to override the auth_settings for an a single
2132
+ request; this effectively ignores the
2133
+ authentication in the spec for a single request.
2134
+ :type _request_auth: dict, optional
2135
+ :param _content_type: force content-type for the request.
2136
+ :type _content_type: str, Optional
2137
+ :param _headers: set to override the headers for a single
2138
+ request; this effectively ignores the headers
2139
+ in the spec for a single request.
2140
+ :type _headers: dict, optional
2141
+ :param _host_index: set to override the host_index for a single
2142
+ request; this effectively ignores the host_index
2143
+ in the spec for a single request.
2144
+ :type _host_index: int, optional
2145
+ :return: Returns the result object.
2146
+ """ # noqa: E501
2147
+
2148
+ _param = self._get_group_serialize(
2149
+ id=id,
2150
+ _request_auth=_request_auth,
2151
+ _content_type=_content_type,
2152
+ _headers=_headers,
2153
+ _host_index=_host_index
2154
+ )
2155
+
2156
+ _response_types_map: Dict[str, Optional[str]] = {
2157
+ '200': "ApiGroup",
2158
+ }
2159
+ response_data = self.api_client.call_api(
2160
+ *_param,
2161
+ _request_timeout=_request_timeout
2162
+ )
2163
+ return response_data.response
2164
+
2165
+
2166
+ def _get_group_serialize(
2167
+ self,
2168
+ id,
2169
+ _request_auth,
2170
+ _content_type,
2171
+ _headers,
2172
+ _host_index,
2173
+ ) -> RequestSerialized:
2174
+
2175
+ _host = None
2176
+
2177
+ _collection_formats: Dict[str, str] = {
2178
+ }
2179
+
2180
+ _path_params: Dict[str, str] = {}
2181
+ _query_params: List[Tuple[str, str]] = []
2182
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2183
+ _form_params: List[Tuple[str, str]] = []
2184
+ _files: Dict[
2185
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2186
+ ] = {}
2187
+ _body_params: Optional[bytes] = None
2188
+
2189
+ # process the path parameters
2190
+ if id is not None:
2191
+ _path_params['id'] = id
2192
+ # process the query parameters
2193
+ # process the header parameters
2194
+ # process the form parameters
2195
+ # process the body parameter
2196
+
2197
+
2198
+ # set the HTTP header `Accept`
2199
+ if 'Accept' not in _header_params:
2200
+ _header_params['Accept'] = self.api_client.select_header_accept(
2201
+ [
2202
+ 'application/json'
2203
+ ]
2204
+ )
2205
+
2206
+
2207
+ # authentication setting
2208
+ _auth_settings: List[str] = [
2209
+ 'ApiKeyAuth'
2210
+ ]
2211
+
2212
+ return self.api_client.param_serialize(
2213
+ method='GET',
2214
+ resource_path='/api/settings/rbac/groups/{id}',
2215
+ path_params=_path_params,
2216
+ query_params=_query_params,
2217
+ header_params=_header_params,
2218
+ body=_body_params,
2219
+ post_params=_form_params,
2220
+ files=_files,
2221
+ auth_settings=_auth_settings,
2222
+ collection_formats=_collection_formats,
2223
+ _host=_host,
2224
+ _request_auth=_request_auth
2225
+ )
2226
+
2227
+
2228
+
2229
+
2230
+ @validate_call
2231
+ def get_group_mapping(
2232
+ self,
2233
+ id: StrictStr,
2234
+ _request_timeout: Union[
2235
+ None,
2236
+ Annotated[StrictFloat, Field(gt=0)],
2237
+ Tuple[
2238
+ Annotated[StrictFloat, Field(gt=0)],
2239
+ Annotated[StrictFloat, Field(gt=0)]
2240
+ ]
2241
+ ] = None,
2242
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2243
+ _content_type: Optional[StrictStr] = None,
2244
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2245
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2246
+ ) -> GroupMapping:
2247
+ """Get group mapping
2248
+
2249
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2250
+
2251
+ :param id: (required)
2252
+ :type id: str
2253
+ :param _request_timeout: timeout setting for this request. If one
2254
+ number provided, it will be total request
2255
+ timeout. It can also be a pair (tuple) of
2256
+ (connection, read) timeouts.
2257
+ :type _request_timeout: int, tuple(int, int), optional
2258
+ :param _request_auth: set to override the auth_settings for an a single
2259
+ request; this effectively ignores the
2260
+ authentication in the spec for a single request.
2261
+ :type _request_auth: dict, optional
2262
+ :param _content_type: force content-type for the request.
2263
+ :type _content_type: str, Optional
2264
+ :param _headers: set to override the headers for a single
2265
+ request; this effectively ignores the headers
2266
+ in the spec for a single request.
2267
+ :type _headers: dict, optional
2268
+ :param _host_index: set to override the host_index for a single
2269
+ request; this effectively ignores the host_index
2270
+ in the spec for a single request.
2271
+ :type _host_index: int, optional
2272
+ :return: Returns the result object.
2273
+ """ # noqa: E501
2274
+
2275
+ _param = self._get_group_mapping_serialize(
2276
+ id=id,
2277
+ _request_auth=_request_auth,
2278
+ _content_type=_content_type,
2279
+ _headers=_headers,
2280
+ _host_index=_host_index
2281
+ )
2282
+
2283
+ _response_types_map: Dict[str, Optional[str]] = {
2284
+ '200': "GroupMapping",
2285
+ '404': None,
2286
+ }
2287
+ response_data = self.api_client.call_api(
2288
+ *_param,
2289
+ _request_timeout=_request_timeout
2290
+ )
2291
+ response_data.read()
2292
+ return self.api_client.response_deserialize(
2293
+ response_data=response_data,
2294
+ response_types_map=_response_types_map,
2295
+ ).data
2296
+
2297
+
2298
+ @validate_call
2299
+ def get_group_mapping_with_http_info(
2300
+ self,
2301
+ id: StrictStr,
1691
2302
  _request_timeout: Union[
1692
2303
  None,
1693
2304
  Annotated[StrictFloat, Field(gt=0)],
@@ -1700,12 +2311,12 @@ class GroupsApi:
1700
2311
  _content_type: Optional[StrictStr] = None,
1701
2312
  _headers: Optional[Dict[StrictStr, Any]] = None,
1702
2313
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1703
- ) -> ApiGroup:
1704
- """Get group
2314
+ ) -> ApiResponse[GroupMapping]:
2315
+ """Get group mapping
1705
2316
 
1706
- Returns group data, including the `Permission set`. See [get groups](#operation/getGroups) for more details.
2317
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
1707
2318
 
1708
- :param id: Id of the group for retrieval (required)
2319
+ :param id: (required)
1709
2320
  :type id: str
1710
2321
  :param _request_timeout: timeout setting for this request. If one
1711
2322
  number provided, it will be total request
@@ -1729,7 +2340,7 @@ class GroupsApi:
1729
2340
  :return: Returns the result object.
1730
2341
  """ # noqa: E501
1731
2342
 
1732
- _param = self._get_group_serialize(
2343
+ _param = self._get_group_mapping_serialize(
1733
2344
  id=id,
1734
2345
  _request_auth=_request_auth,
1735
2346
  _content_type=_content_type,
@@ -1738,7 +2349,8 @@ class GroupsApi:
1738
2349
  )
1739
2350
 
1740
2351
  _response_types_map: Dict[str, Optional[str]] = {
1741
- '200': "ApiGroup",
2352
+ '200': "GroupMapping",
2353
+ '404': None,
1742
2354
  }
1743
2355
  response_data = self.api_client.call_api(
1744
2356
  *_param,
@@ -1748,13 +2360,13 @@ class GroupsApi:
1748
2360
  return self.api_client.response_deserialize(
1749
2361
  response_data=response_data,
1750
2362
  response_types_map=_response_types_map,
1751
- ).data
2363
+ )
1752
2364
 
1753
2365
 
1754
2366
  @validate_call
1755
- def get_group_with_http_info(
2367
+ def get_group_mapping_without_preload_content(
1756
2368
  self,
1757
- id: Annotated[StrictStr, Field(description="Id of the group for retrieval")],
2369
+ id: StrictStr,
1758
2370
  _request_timeout: Union[
1759
2371
  None,
1760
2372
  Annotated[StrictFloat, Field(gt=0)],
@@ -1767,12 +2379,12 @@ class GroupsApi:
1767
2379
  _content_type: Optional[StrictStr] = None,
1768
2380
  _headers: Optional[Dict[StrictStr, Any]] = None,
1769
2381
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1770
- ) -> ApiResponse[ApiGroup]:
1771
- """Get group
2382
+ ) -> RESTResponseType:
2383
+ """Get group mapping
1772
2384
 
1773
- Returns group data, including the `Permission set`. See [get groups](#operation/getGroups) for more details.
2385
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
1774
2386
 
1775
- :param id: Id of the group for retrieval (required)
2387
+ :param id: (required)
1776
2388
  :type id: str
1777
2389
  :param _request_timeout: timeout setting for this request. If one
1778
2390
  number provided, it will be total request
@@ -1796,7 +2408,7 @@ class GroupsApi:
1796
2408
  :return: Returns the result object.
1797
2409
  """ # noqa: E501
1798
2410
 
1799
- _param = self._get_group_serialize(
2411
+ _param = self._get_group_mapping_serialize(
1800
2412
  id=id,
1801
2413
  _request_auth=_request_auth,
1802
2414
  _content_type=_content_type,
@@ -1805,7 +2417,196 @@ class GroupsApi:
1805
2417
  )
1806
2418
 
1807
2419
  _response_types_map: Dict[str, Optional[str]] = {
1808
- '200': "ApiGroup",
2420
+ '200': "GroupMapping",
2421
+ '404': None,
2422
+ }
2423
+ response_data = self.api_client.call_api(
2424
+ *_param,
2425
+ _request_timeout=_request_timeout
2426
+ )
2427
+ return response_data.response
2428
+
2429
+
2430
+ def _get_group_mapping_serialize(
2431
+ self,
2432
+ id,
2433
+ _request_auth,
2434
+ _content_type,
2435
+ _headers,
2436
+ _host_index,
2437
+ ) -> RequestSerialized:
2438
+
2439
+ _host = None
2440
+
2441
+ _collection_formats: Dict[str, str] = {
2442
+ }
2443
+
2444
+ _path_params: Dict[str, str] = {}
2445
+ _query_params: List[Tuple[str, str]] = []
2446
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2447
+ _form_params: List[Tuple[str, str]] = []
2448
+ _files: Dict[
2449
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2450
+ ] = {}
2451
+ _body_params: Optional[bytes] = None
2452
+
2453
+ # process the path parameters
2454
+ if id is not None:
2455
+ _path_params['id'] = id
2456
+ # process the query parameters
2457
+ # process the header parameters
2458
+ # process the form parameters
2459
+ # process the body parameter
2460
+
2461
+
2462
+ # set the HTTP header `Accept`
2463
+ if 'Accept' not in _header_params:
2464
+ _header_params['Accept'] = self.api_client.select_header_accept(
2465
+ [
2466
+ 'application/json'
2467
+ ]
2468
+ )
2469
+
2470
+
2471
+ # authentication setting
2472
+ _auth_settings: List[str] = [
2473
+ 'ApiKeyAuth'
2474
+ ]
2475
+
2476
+ return self.api_client.param_serialize(
2477
+ method='GET',
2478
+ resource_path='/api/settings/rbac/mappings/{id}',
2479
+ path_params=_path_params,
2480
+ query_params=_query_params,
2481
+ header_params=_header_params,
2482
+ body=_body_params,
2483
+ post_params=_form_params,
2484
+ files=_files,
2485
+ auth_settings=_auth_settings,
2486
+ collection_formats=_collection_formats,
2487
+ _host=_host,
2488
+ _request_auth=_request_auth
2489
+ )
2490
+
2491
+
2492
+
2493
+
2494
+ @validate_call
2495
+ def get_group_mappings(
2496
+ self,
2497
+ _request_timeout: Union[
2498
+ None,
2499
+ Annotated[StrictFloat, Field(gt=0)],
2500
+ Tuple[
2501
+ Annotated[StrictFloat, Field(gt=0)],
2502
+ Annotated[StrictFloat, Field(gt=0)]
2503
+ ]
2504
+ ] = None,
2505
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2506
+ _content_type: Optional[StrictStr] = None,
2507
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2508
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2509
+ ) -> List[GroupMapping]:
2510
+ """Get all group mappings
2511
+
2512
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2513
+
2514
+ :param _request_timeout: timeout setting for this request. If one
2515
+ number provided, it will be total request
2516
+ timeout. It can also be a pair (tuple) of
2517
+ (connection, read) timeouts.
2518
+ :type _request_timeout: int, tuple(int, int), optional
2519
+ :param _request_auth: set to override the auth_settings for an a single
2520
+ request; this effectively ignores the
2521
+ authentication in the spec for a single request.
2522
+ :type _request_auth: dict, optional
2523
+ :param _content_type: force content-type for the request.
2524
+ :type _content_type: str, Optional
2525
+ :param _headers: set to override the headers for a single
2526
+ request; this effectively ignores the headers
2527
+ in the spec for a single request.
2528
+ :type _headers: dict, optional
2529
+ :param _host_index: set to override the host_index for a single
2530
+ request; this effectively ignores the host_index
2531
+ in the spec for a single request.
2532
+ :type _host_index: int, optional
2533
+ :return: Returns the result object.
2534
+ """ # noqa: E501
2535
+
2536
+ _param = self._get_group_mappings_serialize(
2537
+ _request_auth=_request_auth,
2538
+ _content_type=_content_type,
2539
+ _headers=_headers,
2540
+ _host_index=_host_index
2541
+ )
2542
+
2543
+ _response_types_map: Dict[str, Optional[str]] = {
2544
+ '200': "List[GroupMapping]",
2545
+ '404': None,
2546
+ }
2547
+ response_data = self.api_client.call_api(
2548
+ *_param,
2549
+ _request_timeout=_request_timeout
2550
+ )
2551
+ response_data.read()
2552
+ return self.api_client.response_deserialize(
2553
+ response_data=response_data,
2554
+ response_types_map=_response_types_map,
2555
+ ).data
2556
+
2557
+
2558
+ @validate_call
2559
+ def get_group_mappings_with_http_info(
2560
+ self,
2561
+ _request_timeout: Union[
2562
+ None,
2563
+ Annotated[StrictFloat, Field(gt=0)],
2564
+ Tuple[
2565
+ Annotated[StrictFloat, Field(gt=0)],
2566
+ Annotated[StrictFloat, Field(gt=0)]
2567
+ ]
2568
+ ] = None,
2569
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2570
+ _content_type: Optional[StrictStr] = None,
2571
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2572
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2573
+ ) -> ApiResponse[List[GroupMapping]]:
2574
+ """Get all group mappings
2575
+
2576
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2577
+
2578
+ :param _request_timeout: timeout setting for this request. If one
2579
+ number provided, it will be total request
2580
+ timeout. It can also be a pair (tuple) of
2581
+ (connection, read) timeouts.
2582
+ :type _request_timeout: int, tuple(int, int), optional
2583
+ :param _request_auth: set to override the auth_settings for an a single
2584
+ request; this effectively ignores the
2585
+ authentication in the spec for a single request.
2586
+ :type _request_auth: dict, optional
2587
+ :param _content_type: force content-type for the request.
2588
+ :type _content_type: str, Optional
2589
+ :param _headers: set to override the headers for a single
2590
+ request; this effectively ignores the headers
2591
+ in the spec for a single request.
2592
+ :type _headers: dict, optional
2593
+ :param _host_index: set to override the host_index for a single
2594
+ request; this effectively ignores the host_index
2595
+ in the spec for a single request.
2596
+ :type _host_index: int, optional
2597
+ :return: Returns the result object.
2598
+ """ # noqa: E501
2599
+
2600
+ _param = self._get_group_mappings_serialize(
2601
+ _request_auth=_request_auth,
2602
+ _content_type=_content_type,
2603
+ _headers=_headers,
2604
+ _host_index=_host_index
2605
+ )
2606
+
2607
+ _response_types_map: Dict[str, Optional[str]] = {
2608
+ '200': "List[GroupMapping]",
2609
+ '404': None,
1809
2610
  }
1810
2611
  response_data = self.api_client.call_api(
1811
2612
  *_param,
@@ -1819,9 +2620,8 @@ class GroupsApi:
1819
2620
 
1820
2621
 
1821
2622
  @validate_call
1822
- def get_group_without_preload_content(
2623
+ def get_group_mappings_without_preload_content(
1823
2624
  self,
1824
- id: Annotated[StrictStr, Field(description="Id of the group for retrieval")],
1825
2625
  _request_timeout: Union[
1826
2626
  None,
1827
2627
  Annotated[StrictFloat, Field(gt=0)],
@@ -1835,12 +2635,10 @@ class GroupsApi:
1835
2635
  _headers: Optional[Dict[StrictStr, Any]] = None,
1836
2636
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1837
2637
  ) -> RESTResponseType:
1838
- """Get group
2638
+ """Get all group mappings
1839
2639
 
1840
- Returns group data, including the `Permission set`. See [get groups](#operation/getGroups) for more details.
2640
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
1841
2641
 
1842
- :param id: Id of the group for retrieval (required)
1843
- :type id: str
1844
2642
  :param _request_timeout: timeout setting for this request. If one
1845
2643
  number provided, it will be total request
1846
2644
  timeout. It can also be a pair (tuple) of
@@ -1863,8 +2661,7 @@ class GroupsApi:
1863
2661
  :return: Returns the result object.
1864
2662
  """ # noqa: E501
1865
2663
 
1866
- _param = self._get_group_serialize(
1867
- id=id,
2664
+ _param = self._get_group_mappings_serialize(
1868
2665
  _request_auth=_request_auth,
1869
2666
  _content_type=_content_type,
1870
2667
  _headers=_headers,
@@ -1872,7 +2669,8 @@ class GroupsApi:
1872
2669
  )
1873
2670
 
1874
2671
  _response_types_map: Dict[str, Optional[str]] = {
1875
- '200': "ApiGroup",
2672
+ '200': "List[GroupMapping]",
2673
+ '404': None,
1876
2674
  }
1877
2675
  response_data = self.api_client.call_api(
1878
2676
  *_param,
@@ -1881,9 +2679,8 @@ class GroupsApi:
1881
2679
  return response_data.response
1882
2680
 
1883
2681
 
1884
- def _get_group_serialize(
2682
+ def _get_group_mappings_serialize(
1885
2683
  self,
1886
- id,
1887
2684
  _request_auth,
1888
2685
  _content_type,
1889
2686
  _headers,
@@ -1905,8 +2702,6 @@ class GroupsApi:
1905
2702
  _body_params: Optional[bytes] = None
1906
2703
 
1907
2704
  # process the path parameters
1908
- if id is not None:
1909
- _path_params['id'] = id
1910
2705
  # process the query parameters
1911
2706
  # process the header parameters
1912
2707
  # process the form parameters
@@ -1929,7 +2724,7 @@ class GroupsApi:
1929
2724
 
1930
2725
  return self.api_client.param_serialize(
1931
2726
  method='GET',
1932
- resource_path='/api/settings/rbac/groups/{id}',
2727
+ resource_path='/api/settings/rbac/mappings',
1933
2728
  path_params=_path_params,
1934
2729
  query_params=_query_params,
1935
2730
  header_params=_header_params,
@@ -1946,7 +2741,7 @@ class GroupsApi:
1946
2741
 
1947
2742
 
1948
2743
  @validate_call
1949
- def get_group_mappings(
2744
+ def get_group_mappings_overview(
1950
2745
  self,
1951
2746
  _request_timeout: Union[
1952
2747
  None,
@@ -1960,10 +2755,10 @@ class GroupsApi:
1960
2755
  _content_type: Optional[StrictStr] = None,
1961
2756
  _headers: Optional[Dict[StrictStr, Any]] = None,
1962
2757
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1963
- ) -> List[GroupMapping]:
1964
- """Get all group mappings
2758
+ ) -> List[GroupMappingOverview]:
2759
+ """Get all group mappings overview
1965
2760
 
1966
- If mappings between groups on the identity provider (LDAP, OIDC, SAML) and Instana groups where configured, this will return a list of those mappings. This can be configured through the [api](#operation/createGroupMapping) or on Instana graphical user interface at Settings > Authentication > IDENTITY PROVIDERS > Group Mapping.
2761
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
1967
2762
 
1968
2763
  :param _request_timeout: timeout setting for this request. If one
1969
2764
  number provided, it will be total request
@@ -1987,7 +2782,7 @@ class GroupsApi:
1987
2782
  :return: Returns the result object.
1988
2783
  """ # noqa: E501
1989
2784
 
1990
- _param = self._get_group_mappings_serialize(
2785
+ _param = self._get_group_mappings_overview_serialize(
1991
2786
  _request_auth=_request_auth,
1992
2787
  _content_type=_content_type,
1993
2788
  _headers=_headers,
@@ -1995,7 +2790,7 @@ class GroupsApi:
1995
2790
  )
1996
2791
 
1997
2792
  _response_types_map: Dict[str, Optional[str]] = {
1998
- '200': "List[GroupMapping]",
2793
+ '200': "List[GroupMappingOverview]",
1999
2794
  '404': None,
2000
2795
  }
2001
2796
  response_data = self.api_client.call_api(
@@ -2010,7 +2805,7 @@ class GroupsApi:
2010
2805
 
2011
2806
 
2012
2807
  @validate_call
2013
- def get_group_mappings_with_http_info(
2808
+ def get_group_mappings_overview_with_http_info(
2014
2809
  self,
2015
2810
  _request_timeout: Union[
2016
2811
  None,
@@ -2024,10 +2819,10 @@ class GroupsApi:
2024
2819
  _content_type: Optional[StrictStr] = None,
2025
2820
  _headers: Optional[Dict[StrictStr, Any]] = None,
2026
2821
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2027
- ) -> ApiResponse[List[GroupMapping]]:
2028
- """Get all group mappings
2822
+ ) -> ApiResponse[List[GroupMappingOverview]]:
2823
+ """Get all group mappings overview
2029
2824
 
2030
- If mappings between groups on the identity provider (LDAP, OIDC, SAML) and Instana groups where configured, this will return a list of those mappings. This can be configured through the [api](#operation/createGroupMapping) or on Instana graphical user interface at Settings > Authentication > IDENTITY PROVIDERS > Group Mapping.
2825
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2031
2826
 
2032
2827
  :param _request_timeout: timeout setting for this request. If one
2033
2828
  number provided, it will be total request
@@ -2051,7 +2846,7 @@ class GroupsApi:
2051
2846
  :return: Returns the result object.
2052
2847
  """ # noqa: E501
2053
2848
 
2054
- _param = self._get_group_mappings_serialize(
2849
+ _param = self._get_group_mappings_overview_serialize(
2055
2850
  _request_auth=_request_auth,
2056
2851
  _content_type=_content_type,
2057
2852
  _headers=_headers,
@@ -2059,7 +2854,7 @@ class GroupsApi:
2059
2854
  )
2060
2855
 
2061
2856
  _response_types_map: Dict[str, Optional[str]] = {
2062
- '200': "List[GroupMapping]",
2857
+ '200': "List[GroupMappingOverview]",
2063
2858
  '404': None,
2064
2859
  }
2065
2860
  response_data = self.api_client.call_api(
@@ -2074,7 +2869,7 @@ class GroupsApi:
2074
2869
 
2075
2870
 
2076
2871
  @validate_call
2077
- def get_group_mappings_without_preload_content(
2872
+ def get_group_mappings_overview_without_preload_content(
2078
2873
  self,
2079
2874
  _request_timeout: Union[
2080
2875
  None,
@@ -2089,9 +2884,9 @@ class GroupsApi:
2089
2884
  _headers: Optional[Dict[StrictStr, Any]] = None,
2090
2885
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2091
2886
  ) -> RESTResponseType:
2092
- """Get all group mappings
2887
+ """Get all group mappings overview
2093
2888
 
2094
- If mappings between groups on the identity provider (LDAP, OIDC, SAML) and Instana groups where configured, this will return a list of those mappings. This can be configured through the [api](#operation/createGroupMapping) or on Instana graphical user interface at Settings > Authentication > IDENTITY PROVIDERS > Group Mapping.
2889
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2095
2890
 
2096
2891
  :param _request_timeout: timeout setting for this request. If one
2097
2892
  number provided, it will be total request
@@ -2115,7 +2910,7 @@ class GroupsApi:
2115
2910
  :return: Returns the result object.
2116
2911
  """ # noqa: E501
2117
2912
 
2118
- _param = self._get_group_mappings_serialize(
2913
+ _param = self._get_group_mappings_overview_serialize(
2119
2914
  _request_auth=_request_auth,
2120
2915
  _content_type=_content_type,
2121
2916
  _headers=_headers,
@@ -2123,7 +2918,7 @@ class GroupsApi:
2123
2918
  )
2124
2919
 
2125
2920
  _response_types_map: Dict[str, Optional[str]] = {
2126
- '200': "List[GroupMapping]",
2921
+ '200': "List[GroupMappingOverview]",
2127
2922
  '404': None,
2128
2923
  }
2129
2924
  response_data = self.api_client.call_api(
@@ -2133,7 +2928,7 @@ class GroupsApi:
2133
2928
  return response_data.response
2134
2929
 
2135
2930
 
2136
- def _get_group_mappings_serialize(
2931
+ def _get_group_mappings_overview_serialize(
2137
2932
  self,
2138
2933
  _request_auth,
2139
2934
  _content_type,
@@ -2178,7 +2973,7 @@ class GroupsApi:
2178
2973
 
2179
2974
  return self.api_client.param_serialize(
2180
2975
  method='GET',
2181
- resource_path='/api/settings/rbac/mappings',
2976
+ resource_path='/api/settings/rbac/mappings/overview',
2182
2977
  path_params=_path_params,
2183
2978
  query_params=_query_params,
2184
2979
  header_params=_header_params,
@@ -2212,7 +3007,7 @@ class GroupsApi:
2212
3007
  ) -> List[ApiGroup]:
2213
3008
  """Get groups
2214
3009
 
2215
- Retrieve the list of all groups on the tenant together with the `Permission Set` for the tenant unit. The `Permission Set` object contains a set of permissions applied to the group. In case `permissions` include the entry e.g. `LIMITED_APPLICATIONS_SCOPE`, this group will have limited access to application area. The areas are included inside the `permissionSet`. The scopeRoleId is a fixed value for each area type: | Area | value | | ----------------------- | ------------- | | applicationIds | -100 | | kubernetesClusterUUIDs | -200 | | kubernetesNamespaceUIDs | -300 | | websiteIds | -400 | | mobileAppIds | -500 | | infraDfqFilter | -600 | For example: ``` [ { \"id\": \"7hwdhtt7TU2CJDgYXgwwww\", \"name\": \"Scoped Group\", \"members\": [ { \"userId\": \"61892cfdfcffab03016b2950\", \"email\": \"jhon@example.com\" } ], \"permissionSet\": { \"permissions\": [ \"CAN_VIEW_LOGS\", \"CAN_VIEW_TRACE_DETAILS\", \"CAN_EDIT_ALL_ACCESSIBLE_CUSTOM_DASHBOARDS\", \"ACCESS_APPLICATIONS\", \"LIMITED_APPLICATIONS_SCOPE\", \"ACCESS_KUBERNETES\", \"LIMITED_KUBERNETES_SCOPE\", \"ACCESS_INFRASTRUCTURE_APPS\", \"LIMITED_INFRASTRUCTURE_SCOPE\", \"LIMITED_WEBSITES_SCOPE\", ], \"applicationIds\": [ { \"scopeId\": \"1qvWgVfLTNqi9gGTcCaNUw\", \"scopeRoleId\": \"-100\" } ], \"kubernetesClusterUUIDs\": [ { \"scopeId\": \"induced\", \"scopeRoleId\": \"-200\" } ], \"kubernetesNamespaceUIDs\": [], \"websiteIds\": [], \"mobileAppIds\": [], \"infraDfqFilter\": { \"scopeId\": \"production\", \"scopeRoleId\": \"-600\" } } ] ``` In this case `Scoped Group` has no access to websites due to having `LIMITED_WEBSITES_SCOPE` but not `ACCESS_WEBSITES`. Also due to having `LIMITED_APPLICATIONS_SCOPE`, the only visible application is the one with this id: `1qvWgVfLTNqi9gGTcCaNUw`. Same applies to `kubernetesClusterUUIDs`, `kubernetesNamespaceUIDs` and `infraDfqFilter`, with the only difference is that `infraDfqFilter` uses a filter \"production\" instead of an id.
3010
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2216
3011
 
2217
3012
  :param _request_timeout: timeout setting for this request. If one
2218
3013
  number provided, it will be total request
@@ -2276,7 +3071,7 @@ class GroupsApi:
2276
3071
  ) -> ApiResponse[List[ApiGroup]]:
2277
3072
  """Get groups
2278
3073
 
2279
- Retrieve the list of all groups on the tenant together with the `Permission Set` for the tenant unit. The `Permission Set` object contains a set of permissions applied to the group. In case `permissions` include the entry e.g. `LIMITED_APPLICATIONS_SCOPE`, this group will have limited access to application area. The areas are included inside the `permissionSet`. The scopeRoleId is a fixed value for each area type: | Area | value | | ----------------------- | ------------- | | applicationIds | -100 | | kubernetesClusterUUIDs | -200 | | kubernetesNamespaceUIDs | -300 | | websiteIds | -400 | | mobileAppIds | -500 | | infraDfqFilter | -600 | For example: ``` [ { \"id\": \"7hwdhtt7TU2CJDgYXgwwww\", \"name\": \"Scoped Group\", \"members\": [ { \"userId\": \"61892cfdfcffab03016b2950\", \"email\": \"jhon@example.com\" } ], \"permissionSet\": { \"permissions\": [ \"CAN_VIEW_LOGS\", \"CAN_VIEW_TRACE_DETAILS\", \"CAN_EDIT_ALL_ACCESSIBLE_CUSTOM_DASHBOARDS\", \"ACCESS_APPLICATIONS\", \"LIMITED_APPLICATIONS_SCOPE\", \"ACCESS_KUBERNETES\", \"LIMITED_KUBERNETES_SCOPE\", \"ACCESS_INFRASTRUCTURE_APPS\", \"LIMITED_INFRASTRUCTURE_SCOPE\", \"LIMITED_WEBSITES_SCOPE\", ], \"applicationIds\": [ { \"scopeId\": \"1qvWgVfLTNqi9gGTcCaNUw\", \"scopeRoleId\": \"-100\" } ], \"kubernetesClusterUUIDs\": [ { \"scopeId\": \"induced\", \"scopeRoleId\": \"-200\" } ], \"kubernetesNamespaceUIDs\": [], \"websiteIds\": [], \"mobileAppIds\": [], \"infraDfqFilter\": { \"scopeId\": \"production\", \"scopeRoleId\": \"-600\" } } ] ``` In this case `Scoped Group` has no access to websites due to having `LIMITED_WEBSITES_SCOPE` but not `ACCESS_WEBSITES`. Also due to having `LIMITED_APPLICATIONS_SCOPE`, the only visible application is the one with this id: `1qvWgVfLTNqi9gGTcCaNUw`. Same applies to `kubernetesClusterUUIDs`, `kubernetesNamespaceUIDs` and `infraDfqFilter`, with the only difference is that `infraDfqFilter` uses a filter \"production\" instead of an id.
3074
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2280
3075
 
2281
3076
  :param _request_timeout: timeout setting for this request. If one
2282
3077
  number provided, it will be total request
@@ -2340,7 +3135,7 @@ class GroupsApi:
2340
3135
  ) -> RESTResponseType:
2341
3136
  """Get groups
2342
3137
 
2343
- Retrieve the list of all groups on the tenant together with the `Permission Set` for the tenant unit. The `Permission Set` object contains a set of permissions applied to the group. In case `permissions` include the entry e.g. `LIMITED_APPLICATIONS_SCOPE`, this group will have limited access to application area. The areas are included inside the `permissionSet`. The scopeRoleId is a fixed value for each area type: | Area | value | | ----------------------- | ------------- | | applicationIds | -100 | | kubernetesClusterUUIDs | -200 | | kubernetesNamespaceUIDs | -300 | | websiteIds | -400 | | mobileAppIds | -500 | | infraDfqFilter | -600 | For example: ``` [ { \"id\": \"7hwdhtt7TU2CJDgYXgwwww\", \"name\": \"Scoped Group\", \"members\": [ { \"userId\": \"61892cfdfcffab03016b2950\", \"email\": \"jhon@example.com\" } ], \"permissionSet\": { \"permissions\": [ \"CAN_VIEW_LOGS\", \"CAN_VIEW_TRACE_DETAILS\", \"CAN_EDIT_ALL_ACCESSIBLE_CUSTOM_DASHBOARDS\", \"ACCESS_APPLICATIONS\", \"LIMITED_APPLICATIONS_SCOPE\", \"ACCESS_KUBERNETES\", \"LIMITED_KUBERNETES_SCOPE\", \"ACCESS_INFRASTRUCTURE_APPS\", \"LIMITED_INFRASTRUCTURE_SCOPE\", \"LIMITED_WEBSITES_SCOPE\", ], \"applicationIds\": [ { \"scopeId\": \"1qvWgVfLTNqi9gGTcCaNUw\", \"scopeRoleId\": \"-100\" } ], \"kubernetesClusterUUIDs\": [ { \"scopeId\": \"induced\", \"scopeRoleId\": \"-200\" } ], \"kubernetesNamespaceUIDs\": [], \"websiteIds\": [], \"mobileAppIds\": [], \"infraDfqFilter\": { \"scopeId\": \"production\", \"scopeRoleId\": \"-600\" } } ] ``` In this case `Scoped Group` has no access to websites due to having `LIMITED_WEBSITES_SCOPE` but not `ACCESS_WEBSITES`. Also due to having `LIMITED_APPLICATIONS_SCOPE`, the only visible application is the one with this id: `1qvWgVfLTNqi9gGTcCaNUw`. Same applies to `kubernetesClusterUUIDs`, `kubernetesNamespaceUIDs` and `infraDfqFilter`, with the only difference is that `infraDfqFilter` uses a filter \"production\" instead of an id.
3138
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2344
3139
 
2345
3140
  :param _request_timeout: timeout setting for this request. If one
2346
3141
  number provided, it will be total request
@@ -2462,7 +3257,7 @@ class GroupsApi:
2462
3257
  ) -> List[ApiGroup]:
2463
3258
  """Get groups of a single user
2464
3259
 
2465
- Returns a list of all groups a user belongs to. This includes data from these groups, the `members`, the `name` and the `Permission set`.
3260
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2466
3261
 
2467
3262
  :param email: Email of the user for retrieval (required)
2468
3263
  :type email: str
@@ -2530,7 +3325,7 @@ class GroupsApi:
2530
3325
  ) -> ApiResponse[List[ApiGroup]]:
2531
3326
  """Get groups of a single user
2532
3327
 
2533
- Returns a list of all groups a user belongs to. This includes data from these groups, the `members`, the `name` and the `Permission set`.
3328
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2534
3329
 
2535
3330
  :param email: Email of the user for retrieval (required)
2536
3331
  :type email: str
@@ -2598,7 +3393,7 @@ class GroupsApi:
2598
3393
  ) -> RESTResponseType:
2599
3394
  """Get groups of a single user
2600
3395
 
2601
- Returns a list of all groups a user belongs to. This includes data from these groups, the `members`, the `name` and the `Permission set`.
3396
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2602
3397
 
2603
3398
  :param email: Email of the user for retrieval (required)
2604
3399
  :type email: str
@@ -2725,7 +3520,7 @@ class GroupsApi:
2725
3520
  ) -> IdentityProviderPatch:
2726
3521
  """Check user restrictions for empty Idp group mapping
2727
3522
 
2728
- Returns `RestrictEmptyIdpGroups` value indicating if access is denied for empty Idp group mapping. `RestrictEmptyIdpGroups = true` indicates that the tenant is locked and only those users are allowed access that have at least one working mapping rule applied to them during the login process.
3523
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2729
3524
 
2730
3525
  :param _request_timeout: timeout setting for this request. If one
2731
3526
  number provided, it will be total request
@@ -2789,7 +3584,7 @@ class GroupsApi:
2789
3584
  ) -> ApiResponse[IdentityProviderPatch]:
2790
3585
  """Check user restrictions for empty Idp group mapping
2791
3586
 
2792
- Returns `RestrictEmptyIdpGroups` value indicating if access is denied for empty Idp group mapping. `RestrictEmptyIdpGroups = true` indicates that the tenant is locked and only those users are allowed access that have at least one working mapping rule applied to them during the login process.
3587
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2793
3588
 
2794
3589
  :param _request_timeout: timeout setting for this request. If one
2795
3590
  number provided, it will be total request
@@ -2853,7 +3648,7 @@ class GroupsApi:
2853
3648
  ) -> RESTResponseType:
2854
3649
  """Check user restrictions for empty Idp group mapping
2855
3650
 
2856
- Returns `RestrictEmptyIdpGroups` value indicating if access is denied for empty Idp group mapping. `RestrictEmptyIdpGroups = true` indicates that the tenant is locked and only those users are allowed access that have at least one working mapping rule applied to them during the login process.
3651
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2857
3652
 
2858
3653
  :param _request_timeout: timeout setting for this request. If one
2859
3654
  number provided, it will be total request
@@ -2976,7 +3771,7 @@ class GroupsApi:
2976
3771
  ) -> None:
2977
3772
  """Remove user from group
2978
3773
 
2979
- Remove the user from a group.
3774
+ Remove the user from a group. For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2980
3775
 
2981
3776
  :param id: Id of the group to remove user from (required)
2982
3777
  :type id: str
@@ -3046,7 +3841,7 @@ class GroupsApi:
3046
3841
  ) -> ApiResponse[None]:
3047
3842
  """Remove user from group
3048
3843
 
3049
- Remove the user from a group.
3844
+ Remove the user from a group. For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
3050
3845
 
3051
3846
  :param id: Id of the group to remove user from (required)
3052
3847
  :type id: str
@@ -3116,7 +3911,7 @@ class GroupsApi:
3116
3911
  ) -> RESTResponseType:
3117
3912
  """Remove user from group
3118
3913
 
3119
- Remove the user from a group.
3914
+ Remove the user from a group. For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
3120
3915
 
3121
3916
  :param id: Id of the group to remove user from (required)
3122
3917
  :type id: str
@@ -3249,7 +4044,7 @@ class GroupsApi:
3249
4044
  ) -> ApiGroup:
3250
4045
  """Update group
3251
4046
 
3252
- Add a permission to a group. Permissions are strings associated with the group that some resources requires to fulfill requests. Examples of `Permissions`: - `ACCESS_APPLICATIONS` - `ACCESS_INFRASTRUCTURE` - `ACCESS_KUBERNETES` - `ACCESS_MOBILE_APPS` - `ACCESS_WEBSITES` - `CAN_CONFIGURE_AGENT_RUN_MODE` - `CAN_CONFIGURE_AGENTS` - `CAN_CONFIGURE_API_TOKENS` - `CAN_CONFIGURE_APPLICATIONS` - `CAN_CONFIGURE_AUTHENTICATION_METHODS` - `CAN_CONFIGURE_CUSTOM_ALERTS` - `CAN_CONFIGURE_EUM_APPLICATIONS` - `CAN_CONFIGURE_GLOBAL_ALERT_CONFIGS` - `CAN_CONFIGURE_GLOBAL_ALERT_PAYLOAD` - `CAN_CONFIGURE_INTEGRATIONS` - `CAN_CONFIGURE_LOG_MANAGEMENT` - `CAN_CONFIGURE_MOBILE_APP_MONITORING` - `CAN_CONFIGURE_PERSONAL_API_TOKENS` - `CAN_CONFIGURE_RELEASES` - `CAN_CONFIGURE_SERVICE_LEVEL_INDICATORS` - `CAN_CONFIGURE_SERVICE_MAPPING` - `CAN_CONFIGURE_SESSION_SETTINGS` - `CAN_CONFIGURE_TEAMS` - `CAN_CONFIGURE_USERS` - `CAN_CREATE_PUBLIC_CUSTOM_DASHBOARDS` - `CAN_EDIT_ALL_ACCESSIBLE_CUSTOM_DASHBOARDS` - `CAN_INSTALL_NEW_AGENTS` - `CAN_VIEW_ACCOUNT_AND_BILLING_INFORMATION` - `CAN_VIEW_AUDIT_LOG` - `CAN_VIEW_LOGS` - `CAN_VIEW_TRACE_DETAILS` - `LIMITED_APPLICATIONS_SCOPE` - `LIMITED_INFRASTRUCTURE_SCOPE` - `LIMITED_KUBERNETES_SCOPE` - `LIMITED_MOBILE_APPS_SCOPE` - `LIMITED_WEBSITES_SCOPE`
4047
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
3253
4048
 
3254
4049
  :param id: Id of the group to update (required)
3255
4050
  :type id: str
@@ -3288,6 +4083,8 @@ class GroupsApi:
3288
4083
 
3289
4084
  _response_types_map: Dict[str, Optional[str]] = {
3290
4085
  '200': "ApiGroup",
4086
+ '404': None,
4087
+ '412': "str",
3291
4088
  }
3292
4089
  response_data = self.api_client.call_api(
3293
4090
  *_param,
@@ -3320,7 +4117,7 @@ class GroupsApi:
3320
4117
  ) -> ApiResponse[ApiGroup]:
3321
4118
  """Update group
3322
4119
 
3323
- Add a permission to a group. Permissions are strings associated with the group that some resources requires to fulfill requests. Examples of `Permissions`: - `ACCESS_APPLICATIONS` - `ACCESS_INFRASTRUCTURE` - `ACCESS_KUBERNETES` - `ACCESS_MOBILE_APPS` - `ACCESS_WEBSITES` - `CAN_CONFIGURE_AGENT_RUN_MODE` - `CAN_CONFIGURE_AGENTS` - `CAN_CONFIGURE_API_TOKENS` - `CAN_CONFIGURE_APPLICATIONS` - `CAN_CONFIGURE_AUTHENTICATION_METHODS` - `CAN_CONFIGURE_CUSTOM_ALERTS` - `CAN_CONFIGURE_EUM_APPLICATIONS` - `CAN_CONFIGURE_GLOBAL_ALERT_CONFIGS` - `CAN_CONFIGURE_GLOBAL_ALERT_PAYLOAD` - `CAN_CONFIGURE_INTEGRATIONS` - `CAN_CONFIGURE_LOG_MANAGEMENT` - `CAN_CONFIGURE_MOBILE_APP_MONITORING` - `CAN_CONFIGURE_PERSONAL_API_TOKENS` - `CAN_CONFIGURE_RELEASES` - `CAN_CONFIGURE_SERVICE_LEVEL_INDICATORS` - `CAN_CONFIGURE_SERVICE_MAPPING` - `CAN_CONFIGURE_SESSION_SETTINGS` - `CAN_CONFIGURE_TEAMS` - `CAN_CONFIGURE_USERS` - `CAN_CREATE_PUBLIC_CUSTOM_DASHBOARDS` - `CAN_EDIT_ALL_ACCESSIBLE_CUSTOM_DASHBOARDS` - `CAN_INSTALL_NEW_AGENTS` - `CAN_VIEW_ACCOUNT_AND_BILLING_INFORMATION` - `CAN_VIEW_AUDIT_LOG` - `CAN_VIEW_LOGS` - `CAN_VIEW_TRACE_DETAILS` - `LIMITED_APPLICATIONS_SCOPE` - `LIMITED_INFRASTRUCTURE_SCOPE` - `LIMITED_KUBERNETES_SCOPE` - `LIMITED_MOBILE_APPS_SCOPE` - `LIMITED_WEBSITES_SCOPE`
4120
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
3324
4121
 
3325
4122
  :param id: Id of the group to update (required)
3326
4123
  :type id: str
@@ -3359,6 +4156,8 @@ class GroupsApi:
3359
4156
 
3360
4157
  _response_types_map: Dict[str, Optional[str]] = {
3361
4158
  '200': "ApiGroup",
4159
+ '404': None,
4160
+ '412': "str",
3362
4161
  }
3363
4162
  response_data = self.api_client.call_api(
3364
4163
  *_param,
@@ -3391,7 +4190,7 @@ class GroupsApi:
3391
4190
  ) -> RESTResponseType:
3392
4191
  """Update group
3393
4192
 
3394
- Add a permission to a group. Permissions are strings associated with the group that some resources requires to fulfill requests. Examples of `Permissions`: - `ACCESS_APPLICATIONS` - `ACCESS_INFRASTRUCTURE` - `ACCESS_KUBERNETES` - `ACCESS_MOBILE_APPS` - `ACCESS_WEBSITES` - `CAN_CONFIGURE_AGENT_RUN_MODE` - `CAN_CONFIGURE_AGENTS` - `CAN_CONFIGURE_API_TOKENS` - `CAN_CONFIGURE_APPLICATIONS` - `CAN_CONFIGURE_AUTHENTICATION_METHODS` - `CAN_CONFIGURE_CUSTOM_ALERTS` - `CAN_CONFIGURE_EUM_APPLICATIONS` - `CAN_CONFIGURE_GLOBAL_ALERT_CONFIGS` - `CAN_CONFIGURE_GLOBAL_ALERT_PAYLOAD` - `CAN_CONFIGURE_INTEGRATIONS` - `CAN_CONFIGURE_LOG_MANAGEMENT` - `CAN_CONFIGURE_MOBILE_APP_MONITORING` - `CAN_CONFIGURE_PERSONAL_API_TOKENS` - `CAN_CONFIGURE_RELEASES` - `CAN_CONFIGURE_SERVICE_LEVEL_INDICATORS` - `CAN_CONFIGURE_SERVICE_MAPPING` - `CAN_CONFIGURE_SESSION_SETTINGS` - `CAN_CONFIGURE_TEAMS` - `CAN_CONFIGURE_USERS` - `CAN_CREATE_PUBLIC_CUSTOM_DASHBOARDS` - `CAN_EDIT_ALL_ACCESSIBLE_CUSTOM_DASHBOARDS` - `CAN_INSTALL_NEW_AGENTS` - `CAN_VIEW_ACCOUNT_AND_BILLING_INFORMATION` - `CAN_VIEW_AUDIT_LOG` - `CAN_VIEW_LOGS` - `CAN_VIEW_TRACE_DETAILS` - `LIMITED_APPLICATIONS_SCOPE` - `LIMITED_INFRASTRUCTURE_SCOPE` - `LIMITED_KUBERNETES_SCOPE` - `LIMITED_MOBILE_APPS_SCOPE` - `LIMITED_WEBSITES_SCOPE`
4193
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
3395
4194
 
3396
4195
  :param id: Id of the group to update (required)
3397
4196
  :type id: str
@@ -3430,6 +4229,8 @@ class GroupsApi:
3430
4229
 
3431
4230
  _response_types_map: Dict[str, Optional[str]] = {
3432
4231
  '200': "ApiGroup",
4232
+ '404': None,
4233
+ '412': "str",
3433
4234
  }
3434
4235
  response_data = self.api_client.call_api(
3435
4236
  *_param,
@@ -3538,7 +4339,7 @@ class GroupsApi:
3538
4339
  ) -> GroupMapping:
3539
4340
  """Update group mapping
3540
4341
 
3541
- See [creating group mapping](#operation/createGroupMapping)
4342
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
3542
4343
 
3543
4344
  :param id: Id of the group mapping to update (required)
3544
4345
  :type id: str
@@ -3609,7 +4410,7 @@ class GroupsApi:
3609
4410
  ) -> ApiResponse[GroupMapping]:
3610
4411
  """Update group mapping
3611
4412
 
3612
- See [creating group mapping](#operation/createGroupMapping)
4413
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
3613
4414
 
3614
4415
  :param id: Id of the group mapping to update (required)
3615
4416
  :type id: str
@@ -3680,7 +4481,7 @@ class GroupsApi:
3680
4481
  ) -> RESTResponseType:
3681
4482
  """Update group mapping
3682
4483
 
3683
- See [creating group mapping](#operation/createGroupMapping)
4484
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
3684
4485
 
3685
4486
  :param id: Id of the group mapping to update (required)
3686
4487
  :type id: str
@@ -3826,7 +4627,7 @@ class GroupsApi:
3826
4627
  ) -> None:
3827
4628
  """Allow/Restrict users with empty Idp group mapping
3828
4629
 
3829
- Set the RestrictEmptyIdpGroups value as true/false. See [Check user restrictions for empty Idp group mapping](#operation/getIdentityProviderPatch) for more details.
4630
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
3830
4631
 
3831
4632
  :param identity_provider_patch: (required)
3832
4633
  :type identity_provider_patch: IdentityProviderPatch
@@ -3892,7 +4693,7 @@ class GroupsApi:
3892
4693
  ) -> ApiResponse[None]:
3893
4694
  """Allow/Restrict users with empty Idp group mapping
3894
4695
 
3895
- Set the RestrictEmptyIdpGroups value as true/false. See [Check user restrictions for empty Idp group mapping](#operation/getIdentityProviderPatch) for more details.
4696
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
3896
4697
 
3897
4698
  :param identity_provider_patch: (required)
3898
4699
  :type identity_provider_patch: IdentityProviderPatch
@@ -3958,7 +4759,7 @@ class GroupsApi:
3958
4759
  ) -> RESTResponseType:
3959
4760
  """Allow/Restrict users with empty Idp group mapping
3960
4761
 
3961
- Set the RestrictEmptyIdpGroups value as true/false. See [Check user restrictions for empty Idp group mapping](#operation/getIdentityProviderPatch) for more details.
4762
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
3962
4763
 
3963
4764
  :param identity_provider_patch: (required)
3964
4765
  :type identity_provider_patch: IdentityProviderPatch