instana-client 1.0.0__py3-none-any.whl → 1.0.1__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 (586) hide show
  1. instana_client/__init__.py +1754 -514
  2. instana_client/api/__init__.py +85 -1
  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 +17 -17
  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 +21 -21
  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 +2 -2
  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 +1673 -0
  21. instana_client/api/end_user_monitoring_api.py +310 -0
  22. instana_client/api/event_settings_api.py +1251 -653
  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 +1121 -62
  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 +2 -2
  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 +44 -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 +1394 -0
  44. instana_client/api/service_levels_alert_configuration_api.py +2 -2
  45. instana_client/api/service_levels_objective_slo_configurations_api.py +160 -89
  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 +1528 -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 +1238 -369
  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 +302 -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 +11 -4
  66. instana_client/configuration.py +14 -7
  67. instana_client/exceptions.py +2 -2
  68. instana_client/models/__init__.py +585 -9
  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 +29 -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 +5 -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 +121 -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 +102 -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/built_in_event_specification.py +2 -2
  142. instana_client/models/built_in_event_specification_with_last_updated.py +2 -2
  143. instana_client/models/business_activity.py +5 -3
  144. instana_client/models/business_perspective_config.py +2 -2
  145. instana_client/models/call_groups_item.py +2 -2
  146. instana_client/models/call_groups_result.py +2 -2
  147. instana_client/models/call_relation.py +2 -2
  148. instana_client/models/change_summary.py +2 -2
  149. instana_client/models/cloudfoundry_physical_context.py +4 -4
  150. instana_client/models/condition.py +2 -2
  151. instana_client/models/config_version.py +2 -2
  152. instana_client/models/correction.py +105 -0
  153. instana_client/models/correction_configuration.py +109 -0
  154. instana_client/models/correction_scheduling.py +104 -0
  155. instana_client/models/correction_window.py +95 -0
  156. instana_client/models/crash_mobile_app_alert_rule.py +2 -2
  157. instana_client/models/create_website_request_inner.py +90 -0
  158. instana_client/models/cursor_paginated_business_activity_item.py +2 -2
  159. instana_client/models/cursor_pagination.py +2 -2
  160. instana_client/models/cursor_pagination_infra_explore_cursor.py +2 -2
  161. instana_client/models/custom_blueprint_indicator.py +8 -4
  162. instana_client/models/custom_dashboard.py +2 -2
  163. instana_client/models/custom_dashboard_preview.py +2 -2
  164. instana_client/models/custom_dashboard_with_user_specific_information.py +115 -0
  165. instana_client/models/custom_dependency.py +116 -0
  166. instana_client/models/custom_email_subject_prefix.py +2 -2
  167. instana_client/models/custom_entity_model.py +126 -0
  168. instana_client/models/custom_entity_with_metadata.py +98 -0
  169. instana_client/models/custom_event_mobile_app_alert_rule.py +2 -2
  170. instana_client/models/custom_event_specification.py +9 -3
  171. instana_client/models/custom_event_specification_with_last_updated.py +9 -3
  172. instana_client/models/custom_event_website_alert_rule.py +2 -2
  173. instana_client/models/custom_metric.py +134 -0
  174. instana_client/models/custom_payload_configuration.py +2 -2
  175. instana_client/models/custom_payload_field.py +2 -2
  176. instana_client/models/custom_payload_with_last_updated.py +2 -2
  177. instana_client/models/custom_payload_with_version.py +101 -0
  178. instana_client/models/dashboard_api_token.py +2 -2
  179. instana_client/models/database_integration.py +2 -2
  180. instana_client/models/deprecated_tag_filter.py +4 -4
  181. instana_client/models/division.py +97 -0
  182. instana_client/models/dns_configuration.py +146 -0
  183. instana_client/models/dns_filter_query_time.py +99 -0
  184. instana_client/models/dns_filter_target_value.py +106 -0
  185. instana_client/models/duration.py +2 -2
  186. instana_client/models/dynamic_field.py +2 -2
  187. instana_client/models/dynamic_field_value.py +2 -2
  188. instana_client/models/dynamic_parameter.py +2 -2
  189. instana_client/models/edit_user.py +2 -2
  190. instana_client/models/email_integration.py +2 -2
  191. instana_client/models/empty_configuration.py +2 -2
  192. instana_client/models/endpoint.py +4 -4
  193. instana_client/models/endpoint_config.py +2 -2
  194. instana_client/models/endpoint_event_result.py +7 -9
  195. instana_client/models/endpoint_item.py +2 -2
  196. instana_client/models/endpoint_metric_result.py +2 -2
  197. instana_client/models/endpoint_node.py +2 -2
  198. instana_client/models/endpoint_result.py +3 -3
  199. instana_client/models/endpoint_simple.py +3 -3
  200. instana_client/models/entity_count_rule.py +2 -2
  201. instana_client/models/entity_count_verification_rule.py +3 -3
  202. instana_client/models/entity_health_info.py +2 -2
  203. instana_client/models/entity_id.py +2 -2
  204. instana_client/models/entity_verification_rule.py +3 -3
  205. instana_client/models/error_budget_alert_rule.py +5 -5
  206. instana_client/models/errors_application_alert_rule.py +2 -2
  207. instana_client/models/event.py +7 -3
  208. instana_client/models/event_filtering_configuration.py +2 -2
  209. instana_client/models/event_result.py +2 -2
  210. instana_client/models/event_specification_info.py +2 -2
  211. instana_client/models/extended_service.py +2 -2
  212. instana_client/models/failure_synthetic_alert_rule.py +2 -2
  213. instana_client/models/fixed_http_path_segment_matching_rule.py +2 -2
  214. instana_client/models/fixed_time_window.py +4 -3
  215. instana_client/models/generic_infra_alert_rule.py +12 -4
  216. instana_client/models/geo_location_configuration.py +2 -2
  217. instana_client/models/geo_mapping_rule.py +2 -2
  218. instana_client/models/geo_subdivision.py +2 -2
  219. instana_client/models/get_activities.py +2 -2
  220. instana_client/models/get_application_metrics.py +2 -2
  221. instana_client/models/get_applications.py +2 -2
  222. instana_client/models/get_available_metrics_query.py +2 -2
  223. instana_client/models/get_available_plugins_query.py +2 -2
  224. instana_client/models/get_call_groups.py +2 -2
  225. instana_client/models/get_combined_metrics.py +2 -2
  226. instana_client/models/get_dynamic_parameter_values.py +2 -2
  227. instana_client/models/get_endpoints.py +2 -2
  228. instana_client/models/get_infrastructure_groups_query.py +2 -2
  229. instana_client/models/get_infrastructure_query.py +2 -2
  230. instana_client/models/get_metrics_result.py +2 -2
  231. instana_client/models/get_mobile_app_beacon_groups.py +2 -2
  232. instana_client/models/get_mobile_app_beacons.py +2 -2
  233. instana_client/models/get_mobile_app_metrics.py +2 -2
  234. instana_client/models/get_mobile_app_metrics_v2.py +2 -2
  235. instana_client/models/get_payload_keys_result.py +2 -2
  236. instana_client/models/get_services.py +2 -2
  237. instana_client/models/get_snapshots_query.py +2 -2
  238. instana_client/models/get_test_result.py +2 -2
  239. instana_client/models/get_test_result_analytic.py +126 -0
  240. instana_client/models/get_test_result_base.py +2 -2
  241. instana_client/models/get_test_result_list.py +2 -2
  242. instana_client/models/get_test_summary_result.py +2 -2
  243. instana_client/models/get_trace_download_result_item.py +3 -3
  244. instana_client/models/get_trace_groups.py +2 -2
  245. instana_client/models/get_traces.py +4 -4
  246. instana_client/models/get_website_beacon_groups.py +2 -2
  247. instana_client/models/get_website_beacons.py +2 -2
  248. instana_client/models/get_website_metrics.py +2 -2
  249. instana_client/models/get_website_metrics_v2.py +2 -2
  250. instana_client/models/global_application_alert_config_with_metadata.py +2 -2
  251. instana_client/models/global_applications_alert_config.py +2 -2
  252. instana_client/models/google_chat_integration.py +2 -2
  253. instana_client/models/graph_edge.py +2 -2
  254. instana_client/models/graph_node.py +2 -2
  255. instana_client/models/group.py +2 -2
  256. instana_client/models/group_by_tag.py +2 -2
  257. instana_client/models/group_mapping.py +5 -3
  258. instana_client/models/group_mapping_overview.py +96 -0
  259. instana_client/models/health_state.py +2 -2
  260. instana_client/models/historic_baseline.py +3 -3
  261. instana_client/models/host_availability_rule.py +2 -2
  262. instana_client/models/http_action_configuration.py +2 -2
  263. instana_client/models/http_endpoint_config.py +2 -2
  264. instana_client/models/http_endpoint_rule.py +2 -2
  265. instana_client/models/http_path_segment_matching_rule.py +2 -2
  266. instana_client/models/http_script_configuration.py +5 -3
  267. instana_client/models/hyper_param.py +2 -2
  268. instana_client/models/identity_provider_patch.py +2 -2
  269. instana_client/models/impacted_beacon_info.py +96 -0
  270. instana_client/models/infra_alert_config.py +8 -6
  271. instana_client/models/infra_alert_config_with_metadata.py +7 -5
  272. instana_client/models/infra_alert_rule.py +9 -3
  273. instana_client/models/infra_event_result.py +6 -8
  274. instana_client/models/infra_metric_configuration.py +103 -80
  275. instana_client/models/infra_slo_entity.py +95 -0
  276. instana_client/models/infra_time_threshold.py +2 -2
  277. instana_client/models/infrastructure_entities_result.py +2 -2
  278. instana_client/models/infrastructure_group.py +5 -3
  279. instana_client/models/infrastructure_groups_result.py +2 -2
  280. instana_client/models/infrastructure_item.py +2 -2
  281. instana_client/models/infrastructure_metric_result.py +2 -2
  282. instana_client/models/instana_version_info.py +2 -2
  283. instana_client/models/integration_overview.py +14 -4
  284. instana_client/models/invitation.py +2 -2
  285. instana_client/models/invitation_response.py +2 -2
  286. instana_client/models/invitation_result.py +2 -2
  287. instana_client/models/ip_masking_configuration.py +2 -2
  288. instana_client/models/js_stack_trace_line.py +2 -2
  289. instana_client/models/kubernetes_physical_context.py +3 -3
  290. instana_client/models/latency_blueprint_indicator.py +5 -16
  291. instana_client/models/llm_egress_gateway.py +125 -0
  292. instana_client/models/location_status.py +2 -2
  293. instana_client/models/log_alert_config.py +8 -6
  294. instana_client/models/log_alert_config_with_metadata.py +8 -6
  295. instana_client/models/log_alert_rule.py +2 -2
  296. instana_client/models/log_count_alert_rule.py +2 -2
  297. instana_client/models/log_entry_actor.py +2 -2
  298. instana_client/models/log_event_result.py +5 -7
  299. instana_client/models/log_time_threshold.py +2 -2
  300. instana_client/models/log_volume_group.py +91 -0
  301. instana_client/models/log_volume_usage_item.py +101 -0
  302. instana_client/models/log_volume_usage_result.py +96 -0
  303. instana_client/models/logs_application_alert_rule.py +4 -4
  304. instana_client/models/maintenance_config.py +2 -2
  305. instana_client/models/maintenance_config_scheduling.py +2 -2
  306. instana_client/models/maintenance_config_v2.py +2 -2
  307. instana_client/models/maintenance_config_v2_with_state_and_occurrence.py +2 -2
  308. instana_client/models/maintenance_config_with_last_updated.py +2 -2
  309. instana_client/models/maintenance_window.py +2 -2
  310. instana_client/models/manual_alerting_channel_configuration.py +2 -2
  311. instana_client/models/manual_close_info.py +2 -2
  312. instana_client/models/manual_service_config.py +2 -2
  313. instana_client/models/match_all_http_path_segment_matching_rule.py +2 -2
  314. instana_client/models/match_expression_dto.py +3 -3
  315. instana_client/models/meta_data.py +2 -2
  316. instana_client/models/metric_api_result.py +2 -2
  317. instana_client/models/metric_config.py +2 -2
  318. instana_client/models/metric_configuration.py +3 -3
  319. instana_client/models/metric_description.py +2 -2
  320. instana_client/models/metric_instance.py +2 -2
  321. instana_client/models/metric_item.py +2 -2
  322. instana_client/models/metric_metadata.py +4 -4
  323. instana_client/models/metric_pattern.py +2 -2
  324. instana_client/models/metric_query.py +128 -0
  325. instana_client/models/metrics_result.py +2 -2
  326. instana_client/models/metrics_result_item.py +5 -3
  327. instana_client/models/metrics_test_result_item.py +2 -2
  328. instana_client/models/mobile_app.py +2 -2
  329. instana_client/models/mobile_app_alert_config.py +2 -2
  330. instana_client/models/mobile_app_alert_rule.py +8 -5
  331. instana_client/models/mobile_app_beacon_groups_item.py +2 -2
  332. instana_client/models/mobile_app_beacon_groups_result.py +2 -2
  333. instana_client/models/mobile_app_beacon_result.py +2 -2
  334. instana_client/models/mobile_app_beacon_tag_group.py +2 -2
  335. instana_client/models/mobile_app_beacons_item.py +11 -5
  336. instana_client/models/mobile_app_event_result.py +5 -7
  337. instana_client/models/mobile_app_metric_result.py +2 -2
  338. instana_client/models/mobile_app_monitoring_beacon.py +22 -4
  339. instana_client/models/mobile_app_monitoring_metric_description.py +5 -3
  340. instana_client/models/mobile_app_monitoring_metrics_configuration.py +2 -2
  341. instana_client/models/mobile_app_time_threshold.py +2 -2
  342. instana_client/models/model_field.py +2 -2
  343. instana_client/models/monitored_entities_stats.py +92 -0
  344. instana_client/models/monitoring_state.py +11 -3
  345. instana_client/models/multiple_scripts_configuration.py +2 -2
  346. instana_client/models/multiplication.py +97 -0
  347. instana_client/models/nested_operation.py +128 -0
  348. instana_client/models/new_application_config.py +2 -2
  349. instana_client/models/new_business_perspective_config.py +2 -2
  350. instana_client/models/new_manual_service_config.py +2 -2
  351. instana_client/models/o_auth_config.py +107 -0
  352. instana_client/models/o_auth_integration.py +98 -0
  353. instana_client/models/o_auth_token.py +121 -0
  354. instana_client/models/occurrence.py +2 -2
  355. instana_client/models/office365_integration.py +2 -2
  356. instana_client/models/one_time_maintenance_window.py +2 -2
  357. instana_client/models/opsgenie_integration.py +2 -2
  358. instana_client/models/order.py +2 -2
  359. instana_client/models/pagerduty_integration.py +2 -2
  360. instana_client/models/paginated_result.py +2 -2
  361. instana_client/models/pagination.py +2 -2
  362. instana_client/models/parameter.py +2 -2
  363. instana_client/models/parameter_value.py +2 -2
  364. instana_client/models/path_parameter_http_path_segment_matching_rule.py +2 -2
  365. instana_client/models/physical_context.py +3 -3
  366. instana_client/models/plugin_result.py +2 -2
  367. instana_client/models/policy.py +2 -2
  368. instana_client/models/policy_runnable.py +2 -2
  369. instana_client/models/policy_scheduling.py +91 -0
  370. instana_client/models/post_mobile_app_source_map_config_request.py +88 -0
  371. instana_client/models/post_snapshots_result.py +2 -2
  372. instana_client/models/problem.py +2 -2
  373. instana_client/models/prometheus_webhook_integration.py +2 -2
  374. instana_client/models/recurrent_maintenance_window.py +2 -2
  375. instana_client/models/release.py +6 -6
  376. instana_client/models/release_scope.py +2 -2
  377. instana_client/models/release_with_metadata.py +8 -8
  378. instana_client/models/retention_period.py +101 -0
  379. instana_client/models/rolling_time_window.py +4 -3
  380. instana_client/models/rule_input.py +2 -2
  381. instana_client/models/rule_with_threshold_application_alert_rule.py +2 -2
  382. instana_client/models/rule_with_threshold_infra_alert_rule.py +2 -2
  383. instana_client/models/rule_with_threshold_log_alert_rule.py +2 -2
  384. instana_client/models/rule_with_threshold_mobile_app_alert_rule.py +2 -2
  385. instana_client/models/rule_with_threshold_website_alert_rule.py +2 -2
  386. instana_client/models/run_configuration.py +2 -2
  387. instana_client/models/salesforce_integration.py +2 -2
  388. instana_client/models/saturation_blueprint_indicator.py +97 -0
  389. instana_client/models/scope_binding.py +2 -2
  390. instana_client/models/search_field_result.py +2 -2
  391. instana_client/models/service.py +3 -3
  392. instana_client/models/service_config.py +2 -2
  393. instana_client/models/service_event_result.py +5 -7
  394. instana_client/models/service_item.py +2 -2
  395. instana_client/models/service_level_indicator.py +10 -7
  396. instana_client/models/service_level_objective_alert_rule.py +2 -2
  397. instana_client/models/service_level_objective_configuration.py +3 -3
  398. instana_client/models/service_levels_alert_config.py +15 -5
  399. instana_client/models/service_levels_alert_rule.py +2 -2
  400. instana_client/models/service_levels_burn_rate_config.py +115 -0
  401. instana_client/models/service_levels_burn_rate_time_windows.py +2 -2
  402. instana_client/models/service_levels_static_threshold_config.py +100 -0
  403. instana_client/models/service_levels_time_threshold.py +5 -5
  404. instana_client/models/service_levelse_alert_config_with_metadata.py +15 -5
  405. instana_client/models/service_map.py +2 -2
  406. instana_client/models/service_map_connection.py +2 -2
  407. instana_client/models/service_matching_rule.py +2 -2
  408. instana_client/models/service_metric_result.py +2 -2
  409. instana_client/models/service_node.py +2 -2
  410. instana_client/models/service_now_enhanced_integration.py +2 -2
  411. instana_client/models/service_now_integration.py +2 -2
  412. instana_client/models/service_result.py +3 -3
  413. instana_client/models/service_scope.py +4 -4
  414. instana_client/models/service_scope_with_metadata.py +5 -5
  415. instana_client/models/service_scoped_to.py +3 -3
  416. instana_client/models/service_scoped_to_with_metadata.py +4 -4
  417. instana_client/models/service_simple.py +2 -2
  418. instana_client/models/session_settings.py +4 -4
  419. instana_client/models/simple_metric_configuration.py +121 -0
  420. instana_client/models/single_value.py +128 -0
  421. instana_client/models/slack_integration.py +2 -2
  422. instana_client/models/sli_configuration.py +2 -2
  423. instana_client/models/sli_configuration_with_last_updated.py +2 -2
  424. instana_client/models/sli_entity.py +2 -2
  425. instana_client/models/sli_report.py +2 -2
  426. instana_client/models/slo_config_with_rbac_tag.py +128 -0
  427. instana_client/models/slo_entity.py +8 -5
  428. instana_client/models/slo_report.py +2 -2
  429. instana_client/models/slowness_application_alert_rule.py +2 -2
  430. instana_client/models/slowness_mobile_app_alert_rule.py +90 -0
  431. instana_client/models/slowness_website_alert_rule.py +2 -2
  432. instana_client/models/snapshot_item.py +2 -2
  433. instana_client/models/snapshot_preview.py +7 -7
  434. instana_client/models/snapshot_result.py +2 -2
  435. instana_client/models/software_user.py +2 -2
  436. instana_client/models/software_version.py +2 -2
  437. instana_client/models/source_map_file_blob.py +2 -2
  438. instana_client/models/source_map_file_meta.py +2 -2
  439. instana_client/models/source_map_upload_config.py +2 -2
  440. instana_client/models/source_map_upload_configs.py +106 -0
  441. instana_client/models/span_excerpt.py +12 -12
  442. instana_client/models/span_relation.py +3 -3
  443. instana_client/models/specific_js_errors_website_alert_rule.py +4 -4
  444. instana_client/models/splunk_integration.py +2 -2
  445. instana_client/models/ssl_certificate_configuration.py +17 -5
  446. instana_client/models/ssl_certificate_validation.py +99 -0
  447. instana_client/models/stack_trace_item.py +7 -7
  448. instana_client/models/stack_trace_line.py +2 -2
  449. instana_client/models/static_baseline_threshold_rule.py +3 -3
  450. instana_client/models/static_string_field.py +2 -2
  451. instana_client/models/static_threshold.py +2 -2
  452. instana_client/models/static_threshold_rule.py +2 -2
  453. instana_client/models/status_code_application_alert_rule.py +2 -2
  454. instana_client/models/status_code_mobile_app_alert_rule.py +4 -4
  455. instana_client/models/status_code_website_alert_rule.py +4 -4
  456. instana_client/models/subtraction.py +97 -0
  457. instana_client/models/synthetic_alert_config.py +2 -2
  458. instana_client/models/synthetic_alert_config_with_metadata.py +2 -2
  459. instana_client/models/synthetic_alert_rule.py +2 -2
  460. instana_client/models/synthetic_call_config.py +4 -4
  461. instana_client/models/synthetic_call_rule.py +6 -6
  462. instana_client/models/synthetic_call_with_defaults_config.py +4 -4
  463. instana_client/models/synthetic_configuration.py +93 -0
  464. instana_client/models/synthetic_credential.py +23 -3
  465. instana_client/models/synthetic_datacenter.py +2 -2
  466. instana_client/models/synthetic_datacenter_configuration.py +2 -2
  467. instana_client/models/synthetic_geo_point.py +2 -2
  468. instana_client/models/synthetic_location.py +2 -2
  469. instana_client/models/synthetic_location_configuration.py +2 -2
  470. instana_client/models/synthetic_metric_configuration.py +2 -2
  471. instana_client/models/synthetic_metric_tag_group.py +2 -2
  472. instana_client/models/synthetic_playback_capabilities.py +17 -4
  473. instana_client/models/synthetic_slo_entity.py +7 -5
  474. instana_client/models/synthetic_test.py +27 -3
  475. instana_client/models/synthetic_test_cicd.py +96 -0
  476. instana_client/models/synthetic_test_cicd_customization.py +96 -0
  477. instana_client/models/synthetic_test_cicd_item.py +114 -0
  478. instana_client/models/synthetic_test_cicd_response.py +92 -0
  479. instana_client/models/synthetic_time_threshold.py +2 -2
  480. instana_client/models/synthetic_type_configuration.py +11 -11
  481. instana_client/models/synthetics_event_result.py +5 -7
  482. instana_client/models/system_rule.py +2 -2
  483. instana_client/models/system_rule_label.py +2 -2
  484. instana_client/models/tag.py +6 -6
  485. instana_client/models/tag_catalog.py +2 -2
  486. instana_client/models/tag_filter.py +4 -4
  487. instana_client/models/tag_filter_expression.py +2 -2
  488. instana_client/models/tag_filter_expression_element.py +2 -2
  489. instana_client/models/tag_matcher_dto.py +2 -2
  490. instana_client/models/tag_tree_level.py +2 -2
  491. instana_client/models/tag_tree_node.py +2 -2
  492. instana_client/models/tag_tree_tag.py +2 -2
  493. instana_client/models/test_common_properties.py +2 -2
  494. instana_client/models/test_last_error.py +90 -0
  495. instana_client/models/test_result.py +2 -2
  496. instana_client/models/test_result_common_properties.py +24 -3
  497. instana_client/models/test_result_detail_data.py +2 -2
  498. instana_client/models/test_result_item.py +2 -2
  499. instana_client/models/test_result_list_item.py +2 -2
  500. instana_client/models/test_result_list_result.py +2 -2
  501. instana_client/models/test_result_metadata.py +2 -2
  502. instana_client/models/test_result_subtransaction.py +2 -2
  503. instana_client/models/threshold.py +2 -2
  504. instana_client/models/threshold_config_rule.py +2 -2
  505. instana_client/models/threshold_rule.py +2 -2
  506. instana_client/models/throughput_application_alert_rule.py +2 -2
  507. instana_client/models/throughput_mobile_app_alert_rule.py +2 -2
  508. instana_client/models/throughput_website_alert_rule.py +2 -2
  509. instana_client/models/time_frame.py +2 -2
  510. instana_client/models/time_window.py +5 -4
  511. instana_client/models/topology.py +2 -2
  512. instana_client/models/trace.py +8 -8
  513. instana_client/models/trace_activity_tree_node_details.py +13 -13
  514. instana_client/models/trace_download_result.py +2 -2
  515. instana_client/models/trace_groups_item.py +2 -2
  516. instana_client/models/trace_groups_result.py +2 -2
  517. instana_client/models/trace_impact_application_time_threshold.py +2 -2
  518. instana_client/models/trace_item.py +2 -2
  519. instana_client/models/trace_result.py +2 -2
  520. instana_client/models/traffic_blueprint_indicator.py +3 -3
  521. instana_client/models/trigger.py +15 -7
  522. instana_client/models/type_configuration.py +2 -2
  523. instana_client/models/unsupported_http_path_segment_matching_rule.py +2 -2
  524. instana_client/models/updated_business_perspective_config.py +2 -2
  525. instana_client/models/usage_result.py +2 -2
  526. instana_client/models/usage_result_items.py +2 -2
  527. instana_client/models/user_basic_result.py +2 -2
  528. instana_client/models/user_impact_mobile_app_time_threshold.py +3 -3
  529. instana_client/models/user_impact_website_time_threshold.py +3 -3
  530. instana_client/models/user_result.py +2 -2
  531. instana_client/models/users_result.py +2 -2
  532. instana_client/models/validated_alerting_channel_input_info.py +4 -4
  533. instana_client/models/validated_alerting_configuration.py +2 -2
  534. instana_client/models/validated_maintenance_config_v2_with_state_and_occurrence.py +2 -2
  535. instana_client/models/validated_maintenance_config_with_status.py +2 -2
  536. instana_client/models/victor_ops_integration.py +2 -2
  537. instana_client/models/violations_in_period_application_time_threshold.py +2 -2
  538. instana_client/models/violations_in_period_mobile_app_time_threshold.py +2 -2
  539. instana_client/models/violations_in_period_website_time_threshold.py +2 -2
  540. instana_client/models/violations_in_sequence_application_time_threshold.py +2 -2
  541. instana_client/models/violations_in_sequence_infra_time_threshold.py +2 -2
  542. instana_client/models/violations_in_sequence_log_time_threshold.py +2 -2
  543. instana_client/models/violations_in_sequence_mobile_app_time_threshold.py +2 -2
  544. instana_client/models/violations_in_sequence_synthetic_time_threshold.py +2 -2
  545. instana_client/models/violations_in_sequence_website_time_threshold.py +2 -2
  546. instana_client/models/watson_ai_ops_webhook_integration.py +2 -2
  547. instana_client/models/webex_teams_webhook_integration.py +2 -2
  548. instana_client/models/webhook_integration.py +14 -4
  549. instana_client/models/webpage_action_configuration.py +2 -2
  550. instana_client/models/webpage_script_configuration.py +5 -3
  551. instana_client/models/website.py +2 -2
  552. instana_client/models/website_alert_config.py +2 -2
  553. instana_client/models/website_alert_config_with_metadata.py +2 -2
  554. instana_client/models/website_alert_rule.py +2 -2
  555. instana_client/models/website_apdex_entity.py +2 -2
  556. instana_client/models/website_beacon_groups_item.py +2 -2
  557. instana_client/models/website_beacon_groups_result.py +2 -2
  558. instana_client/models/website_beacon_result.py +2 -2
  559. instana_client/models/website_beacon_tag_group.py +2 -2
  560. instana_client/models/website_beacons_item.py +11 -5
  561. instana_client/models/website_event_based_sli_entity.py +2 -2
  562. instana_client/models/website_event_result.py +4 -6
  563. instana_client/models/website_metric_result.py +2 -2
  564. instana_client/models/website_monitoring_beacon.py +7 -3
  565. instana_client/models/website_monitoring_metric_description.py +2 -2
  566. instana_client/models/website_monitoring_metrics_configuration.py +2 -2
  567. instana_client/models/website_slo_entity.py +2 -2
  568. instana_client/models/website_time_based_sli_entity.py +2 -2
  569. instana_client/models/website_time_threshold.py +2 -2
  570. instana_client/models/widget.py +2 -2
  571. instana_client/models/with_metadata.py +2 -2
  572. instana_client/models/with_resolved_name.py +2 -2
  573. instana_client/models/z_chat_ops_integration.py +2 -2
  574. instana_client/rest.py +3 -2
  575. instana_client-1.0.1.dist-info/METADATA +1068 -0
  576. instana_client-1.0.1.dist-info/RECORD +581 -0
  577. {instana_client-1.0.0.dist-info → instana_client-1.0.1.dist-info}/WHEEL +1 -1
  578. instana_client/models/dns_action_configuration.py +0 -134
  579. instana_client/models/dns_action_filter_query_time.py +0 -99
  580. instana_client/models/dns_action_filter_target_value.py +0 -106
  581. instana_client/models/full_trace.py +0 -97
  582. instana_client/models/span.py +0 -156
  583. instana_client-1.0.0.dist-info/METADATA +0 -25
  584. instana_client-1.0.0.dist-info/RECORD +0 -515
  585. {instana_client-1.0.0.dist-info → instana_client-1.0.1.dist-info}/licenses/LICENSE +0 -0
  586. {instana_client-1.0.0.dist-info → instana_client-1.0.1.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.306.1368
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
@@ -1256,7 +1257,7 @@ class GroupsApi:
1256
1257
  ) -> ApiResponse[None]:
1257
1258
  """Delete group
1258
1259
 
1259
- Delete the group data.
1260
+ 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
1261
 
1261
1262
  :param id: Id of the group to delete (required)
1262
1263
  :type id: str
@@ -1322,7 +1323,7 @@ class GroupsApi:
1322
1323
  ) -> RESTResponseType:
1323
1324
  """Delete group
1324
1325
 
1325
- Delete the group data.
1326
+ 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
1327
 
1327
1328
  :param id: Id of the group to delete (required)
1328
1329
  :type id: str
@@ -1448,6 +1449,7 @@ class GroupsApi:
1448
1449
  ) -> None:
1449
1450
  """Delete group mapping
1450
1451
 
1452
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
1451
1453
 
1452
1454
  :param id: Id of the group mapping to delete (required)
1453
1455
  :type id: str
@@ -1513,6 +1515,7 @@ class GroupsApi:
1513
1515
  ) -> ApiResponse[None]:
1514
1516
  """Delete group mapping
1515
1517
 
1518
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
1516
1519
 
1517
1520
  :param id: Id of the group mapping to delete (required)
1518
1521
  :type id: str
@@ -1578,6 +1581,7 @@ class GroupsApi:
1578
1581
  ) -> RESTResponseType:
1579
1582
  """Delete group mapping
1580
1583
 
1584
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
1581
1585
 
1582
1586
  :param id: Id of the group mapping to delete (required)
1583
1587
  :type id: str
@@ -1684,6 +1688,548 @@ class GroupsApi:
1684
1688
 
1685
1689
 
1686
1690
 
1691
+ @validate_call
1692
+ def delete_group_mappings(
1693
+ self,
1694
+ body: StrictStr,
1695
+ _request_timeout: Union[
1696
+ None,
1697
+ Annotated[StrictFloat, Field(gt=0)],
1698
+ Tuple[
1699
+ Annotated[StrictFloat, Field(gt=0)],
1700
+ Annotated[StrictFloat, Field(gt=0)]
1701
+ ]
1702
+ ] = None,
1703
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1704
+ _content_type: Optional[StrictStr] = None,
1705
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1706
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1707
+ ) -> None:
1708
+ """Delete multiple group mappings
1709
+
1710
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
1711
+
1712
+ :param body: (required)
1713
+ :type body: str
1714
+ :param _request_timeout: timeout setting for this request. If one
1715
+ number provided, it will be total request
1716
+ timeout. It can also be a pair (tuple) of
1717
+ (connection, read) timeouts.
1718
+ :type _request_timeout: int, tuple(int, int), optional
1719
+ :param _request_auth: set to override the auth_settings for an a single
1720
+ request; this effectively ignores the
1721
+ authentication in the spec for a single request.
1722
+ :type _request_auth: dict, optional
1723
+ :param _content_type: force content-type for the request.
1724
+ :type _content_type: str, Optional
1725
+ :param _headers: set to override the headers for a single
1726
+ request; this effectively ignores the headers
1727
+ in the spec for a single request.
1728
+ :type _headers: dict, optional
1729
+ :param _host_index: set to override the host_index for a single
1730
+ request; this effectively ignores the host_index
1731
+ in the spec for a single request.
1732
+ :type _host_index: int, optional
1733
+ :return: Returns the result object.
1734
+ """ # noqa: E501
1735
+
1736
+ _param = self._delete_group_mappings_serialize(
1737
+ body=body,
1738
+ _request_auth=_request_auth,
1739
+ _content_type=_content_type,
1740
+ _headers=_headers,
1741
+ _host_index=_host_index
1742
+ )
1743
+
1744
+ _response_types_map: Dict[str, Optional[str]] = {
1745
+ '204': None,
1746
+ '422': None,
1747
+ }
1748
+ response_data = self.api_client.call_api(
1749
+ *_param,
1750
+ _request_timeout=_request_timeout
1751
+ )
1752
+ response_data.read()
1753
+ return self.api_client.response_deserialize(
1754
+ response_data=response_data,
1755
+ response_types_map=_response_types_map,
1756
+ ).data
1757
+
1758
+
1759
+ @validate_call
1760
+ def delete_group_mappings_with_http_info(
1761
+ self,
1762
+ body: StrictStr,
1763
+ _request_timeout: Union[
1764
+ None,
1765
+ Annotated[StrictFloat, Field(gt=0)],
1766
+ Tuple[
1767
+ Annotated[StrictFloat, Field(gt=0)],
1768
+ Annotated[StrictFloat, Field(gt=0)]
1769
+ ]
1770
+ ] = None,
1771
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1772
+ _content_type: Optional[StrictStr] = None,
1773
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1774
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1775
+ ) -> ApiResponse[None]:
1776
+ """Delete multiple group mappings
1777
+
1778
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
1779
+
1780
+ :param body: (required)
1781
+ :type body: str
1782
+ :param _request_timeout: timeout setting for this request. If one
1783
+ number provided, it will be total request
1784
+ timeout. It can also be a pair (tuple) of
1785
+ (connection, read) timeouts.
1786
+ :type _request_timeout: int, tuple(int, int), optional
1787
+ :param _request_auth: set to override the auth_settings for an a single
1788
+ request; this effectively ignores the
1789
+ authentication in the spec for a single request.
1790
+ :type _request_auth: dict, optional
1791
+ :param _content_type: force content-type for the request.
1792
+ :type _content_type: str, Optional
1793
+ :param _headers: set to override the headers for a single
1794
+ request; this effectively ignores the headers
1795
+ in the spec for a single request.
1796
+ :type _headers: dict, optional
1797
+ :param _host_index: set to override the host_index for a single
1798
+ request; this effectively ignores the host_index
1799
+ in the spec for a single request.
1800
+ :type _host_index: int, optional
1801
+ :return: Returns the result object.
1802
+ """ # noqa: E501
1803
+
1804
+ _param = self._delete_group_mappings_serialize(
1805
+ body=body,
1806
+ _request_auth=_request_auth,
1807
+ _content_type=_content_type,
1808
+ _headers=_headers,
1809
+ _host_index=_host_index
1810
+ )
1811
+
1812
+ _response_types_map: Dict[str, Optional[str]] = {
1813
+ '204': None,
1814
+ '422': None,
1815
+ }
1816
+ response_data = self.api_client.call_api(
1817
+ *_param,
1818
+ _request_timeout=_request_timeout
1819
+ )
1820
+ response_data.read()
1821
+ return self.api_client.response_deserialize(
1822
+ response_data=response_data,
1823
+ response_types_map=_response_types_map,
1824
+ )
1825
+
1826
+
1827
+ @validate_call
1828
+ def delete_group_mappings_without_preload_content(
1829
+ self,
1830
+ body: StrictStr,
1831
+ _request_timeout: Union[
1832
+ None,
1833
+ Annotated[StrictFloat, Field(gt=0)],
1834
+ Tuple[
1835
+ Annotated[StrictFloat, Field(gt=0)],
1836
+ Annotated[StrictFloat, Field(gt=0)]
1837
+ ]
1838
+ ] = None,
1839
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1840
+ _content_type: Optional[StrictStr] = None,
1841
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1842
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1843
+ ) -> RESTResponseType:
1844
+ """Delete multiple group mappings
1845
+
1846
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
1847
+
1848
+ :param body: (required)
1849
+ :type body: str
1850
+ :param _request_timeout: timeout setting for this request. If one
1851
+ number provided, it will be total request
1852
+ timeout. It can also be a pair (tuple) of
1853
+ (connection, read) timeouts.
1854
+ :type _request_timeout: int, tuple(int, int), optional
1855
+ :param _request_auth: set to override the auth_settings for an a single
1856
+ request; this effectively ignores the
1857
+ authentication in the spec for a single request.
1858
+ :type _request_auth: dict, optional
1859
+ :param _content_type: force content-type for the request.
1860
+ :type _content_type: str, Optional
1861
+ :param _headers: set to override the headers for a single
1862
+ request; this effectively ignores the headers
1863
+ in the spec for a single request.
1864
+ :type _headers: dict, optional
1865
+ :param _host_index: set to override the host_index for a single
1866
+ request; this effectively ignores the host_index
1867
+ in the spec for a single request.
1868
+ :type _host_index: int, optional
1869
+ :return: Returns the result object.
1870
+ """ # noqa: E501
1871
+
1872
+ _param = self._delete_group_mappings_serialize(
1873
+ body=body,
1874
+ _request_auth=_request_auth,
1875
+ _content_type=_content_type,
1876
+ _headers=_headers,
1877
+ _host_index=_host_index
1878
+ )
1879
+
1880
+ _response_types_map: Dict[str, Optional[str]] = {
1881
+ '204': None,
1882
+ '422': None,
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_group_mappings_serialize(
1892
+ self,
1893
+ 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
+ }
1904
+
1905
+ _path_params: Dict[str, str] = {}
1906
+ _query_params: List[Tuple[str, str]] = []
1907
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1908
+ _form_params: List[Tuple[str, str]] = []
1909
+ _files: Dict[
1910
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1911
+ ] = {}
1912
+ _body_params: Optional[bytes] = None
1913
+
1914
+ # process the path parameters
1915
+ # process the query parameters
1916
+ # process the header parameters
1917
+ # process the form parameters
1918
+ # process the body parameter
1919
+ if body is not None:
1920
+ _body_params = body
1921
+
1922
+
1923
+
1924
+ # set the HTTP header `Content-Type`
1925
+ if _content_type:
1926
+ _header_params['Content-Type'] = _content_type
1927
+ else:
1928
+ _default_content_type = (
1929
+ self.api_client.select_header_content_type(
1930
+ [
1931
+ 'application/json'
1932
+ ]
1933
+ )
1934
+ )
1935
+ if _default_content_type is not None:
1936
+ _header_params['Content-Type'] = _default_content_type
1937
+
1938
+ # authentication setting
1939
+ _auth_settings: List[str] = [
1940
+ 'ApiKeyAuth'
1941
+ ]
1942
+
1943
+ return self.api_client.param_serialize(
1944
+ method='PUT',
1945
+ resource_path='/api/settings/rbac/mappings/delete',
1946
+ path_params=_path_params,
1947
+ query_params=_query_params,
1948
+ header_params=_header_params,
1949
+ body=_body_params,
1950
+ post_params=_form_params,
1951
+ files=_files,
1952
+ auth_settings=_auth_settings,
1953
+ collection_formats=_collection_formats,
1954
+ _host=_host,
1955
+ _request_auth=_request_auth
1956
+ )
1957
+
1958
+
1959
+
1960
+
1961
+ @validate_call
1962
+ def delete_groups(
1963
+ self,
1964
+ request_body: List[StrictStr],
1965
+ _request_timeout: Union[
1966
+ None,
1967
+ Annotated[StrictFloat, Field(gt=0)],
1968
+ Tuple[
1969
+ Annotated[StrictFloat, Field(gt=0)],
1970
+ Annotated[StrictFloat, Field(gt=0)]
1971
+ ]
1972
+ ] = None,
1973
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1974
+ _content_type: Optional[StrictStr] = None,
1975
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1976
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1977
+ ) -> None:
1978
+ """Delete groups
1979
+
1980
+ Delete multiple groups For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
1981
+
1982
+ :param request_body: (required)
1983
+ :type request_body: List[str]
1984
+ :param _request_timeout: timeout setting for this request. If one
1985
+ number provided, it will be total request
1986
+ timeout. It can also be a pair (tuple) of
1987
+ (connection, read) timeouts.
1988
+ :type _request_timeout: int, tuple(int, int), optional
1989
+ :param _request_auth: set to override the auth_settings for an a single
1990
+ request; this effectively ignores the
1991
+ authentication in the spec for a single request.
1992
+ :type _request_auth: dict, optional
1993
+ :param _content_type: force content-type for the request.
1994
+ :type _content_type: str, Optional
1995
+ :param _headers: set to override the headers for a single
1996
+ request; this effectively ignores the headers
1997
+ in the spec for a single request.
1998
+ :type _headers: dict, optional
1999
+ :param _host_index: set to override the host_index for a single
2000
+ request; this effectively ignores the host_index
2001
+ in the spec for a single request.
2002
+ :type _host_index: int, optional
2003
+ :return: Returns the result object.
2004
+ """ # noqa: E501
2005
+
2006
+ _param = self._delete_groups_serialize(
2007
+ request_body=request_body,
2008
+ _request_auth=_request_auth,
2009
+ _content_type=_content_type,
2010
+ _headers=_headers,
2011
+ _host_index=_host_index
2012
+ )
2013
+
2014
+ _response_types_map: Dict[str, Optional[str]] = {
2015
+ }
2016
+ response_data = self.api_client.call_api(
2017
+ *_param,
2018
+ _request_timeout=_request_timeout
2019
+ )
2020
+ response_data.read()
2021
+ return self.api_client.response_deserialize(
2022
+ response_data=response_data,
2023
+ response_types_map=_response_types_map,
2024
+ ).data
2025
+
2026
+
2027
+ @validate_call
2028
+ def delete_groups_with_http_info(
2029
+ self,
2030
+ request_body: List[StrictStr],
2031
+ _request_timeout: Union[
2032
+ None,
2033
+ Annotated[StrictFloat, Field(gt=0)],
2034
+ Tuple[
2035
+ Annotated[StrictFloat, Field(gt=0)],
2036
+ Annotated[StrictFloat, Field(gt=0)]
2037
+ ]
2038
+ ] = None,
2039
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2040
+ _content_type: Optional[StrictStr] = None,
2041
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2042
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2043
+ ) -> ApiResponse[None]:
2044
+ """Delete groups
2045
+
2046
+ Delete multiple groups For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2047
+
2048
+ :param request_body: (required)
2049
+ :type request_body: List[str]
2050
+ :param _request_timeout: timeout setting for this request. If one
2051
+ number provided, it will be total request
2052
+ timeout. It can also be a pair (tuple) of
2053
+ (connection, read) timeouts.
2054
+ :type _request_timeout: int, tuple(int, int), optional
2055
+ :param _request_auth: set to override the auth_settings for an a single
2056
+ request; this effectively ignores the
2057
+ authentication in the spec for a single request.
2058
+ :type _request_auth: dict, optional
2059
+ :param _content_type: force content-type for the request.
2060
+ :type _content_type: str, Optional
2061
+ :param _headers: set to override the headers for a single
2062
+ request; this effectively ignores the headers
2063
+ in the spec for a single request.
2064
+ :type _headers: dict, optional
2065
+ :param _host_index: set to override the host_index for a single
2066
+ request; this effectively ignores the host_index
2067
+ in the spec for a single request.
2068
+ :type _host_index: int, optional
2069
+ :return: Returns the result object.
2070
+ """ # noqa: E501
2071
+
2072
+ _param = self._delete_groups_serialize(
2073
+ request_body=request_body,
2074
+ _request_auth=_request_auth,
2075
+ _content_type=_content_type,
2076
+ _headers=_headers,
2077
+ _host_index=_host_index
2078
+ )
2079
+
2080
+ _response_types_map: Dict[str, Optional[str]] = {
2081
+ }
2082
+ response_data = self.api_client.call_api(
2083
+ *_param,
2084
+ _request_timeout=_request_timeout
2085
+ )
2086
+ response_data.read()
2087
+ return self.api_client.response_deserialize(
2088
+ response_data=response_data,
2089
+ response_types_map=_response_types_map,
2090
+ )
2091
+
2092
+
2093
+ @validate_call
2094
+ def delete_groups_without_preload_content(
2095
+ self,
2096
+ request_body: List[StrictStr],
2097
+ _request_timeout: Union[
2098
+ None,
2099
+ Annotated[StrictFloat, Field(gt=0)],
2100
+ Tuple[
2101
+ Annotated[StrictFloat, Field(gt=0)],
2102
+ Annotated[StrictFloat, Field(gt=0)]
2103
+ ]
2104
+ ] = None,
2105
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2106
+ _content_type: Optional[StrictStr] = None,
2107
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2108
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2109
+ ) -> RESTResponseType:
2110
+ """Delete groups
2111
+
2112
+ Delete multiple groups For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2113
+
2114
+ :param request_body: (required)
2115
+ :type request_body: List[str]
2116
+ :param _request_timeout: timeout setting for this request. If one
2117
+ number provided, it will be total request
2118
+ timeout. It can also be a pair (tuple) of
2119
+ (connection, read) timeouts.
2120
+ :type _request_timeout: int, tuple(int, int), optional
2121
+ :param _request_auth: set to override the auth_settings for an a single
2122
+ request; this effectively ignores the
2123
+ authentication in the spec for a single request.
2124
+ :type _request_auth: dict, optional
2125
+ :param _content_type: force content-type for the request.
2126
+ :type _content_type: str, Optional
2127
+ :param _headers: set to override the headers for a single
2128
+ request; this effectively ignores the headers
2129
+ in the spec for a single request.
2130
+ :type _headers: dict, optional
2131
+ :param _host_index: set to override the host_index for a single
2132
+ request; this effectively ignores the host_index
2133
+ in the spec for a single request.
2134
+ :type _host_index: int, optional
2135
+ :return: Returns the result object.
2136
+ """ # noqa: E501
2137
+
2138
+ _param = self._delete_groups_serialize(
2139
+ request_body=request_body,
2140
+ _request_auth=_request_auth,
2141
+ _content_type=_content_type,
2142
+ _headers=_headers,
2143
+ _host_index=_host_index
2144
+ )
2145
+
2146
+ _response_types_map: Dict[str, Optional[str]] = {
2147
+ }
2148
+ response_data = self.api_client.call_api(
2149
+ *_param,
2150
+ _request_timeout=_request_timeout
2151
+ )
2152
+ return response_data.response
2153
+
2154
+
2155
+ def _delete_groups_serialize(
2156
+ self,
2157
+ request_body,
2158
+ _request_auth,
2159
+ _content_type,
2160
+ _headers,
2161
+ _host_index,
2162
+ ) -> RequestSerialized:
2163
+
2164
+ _host = None
2165
+
2166
+ _collection_formats: Dict[str, str] = {
2167
+ 'request_body': '',
2168
+ }
2169
+
2170
+ _path_params: Dict[str, str] = {}
2171
+ _query_params: List[Tuple[str, str]] = []
2172
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2173
+ _form_params: List[Tuple[str, str]] = []
2174
+ _files: Dict[
2175
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2176
+ ] = {}
2177
+ _body_params: Optional[bytes] = None
2178
+
2179
+ # process the path parameters
2180
+ # process the query parameters
2181
+ # process the header parameters
2182
+ # process the form parameters
2183
+ # process the body parameter
2184
+ if request_body is not None:
2185
+ _body_params = request_body
2186
+
2187
+
2188
+ # set the HTTP header `Accept`
2189
+ if 'Accept' not in _header_params:
2190
+ _header_params['Accept'] = self.api_client.select_header_accept(
2191
+ [
2192
+ 'application/json'
2193
+ ]
2194
+ )
2195
+
2196
+ # set the HTTP header `Content-Type`
2197
+ if _content_type:
2198
+ _header_params['Content-Type'] = _content_type
2199
+ else:
2200
+ _default_content_type = (
2201
+ self.api_client.select_header_content_type(
2202
+ [
2203
+ 'application/json'
2204
+ ]
2205
+ )
2206
+ )
2207
+ if _default_content_type is not None:
2208
+ _header_params['Content-Type'] = _default_content_type
2209
+
2210
+ # authentication setting
2211
+ _auth_settings: List[str] = [
2212
+ 'ApiKeyAuth'
2213
+ ]
2214
+
2215
+ return self.api_client.param_serialize(
2216
+ method='PUT',
2217
+ resource_path='/api/settings/rbac/groups/delete',
2218
+ path_params=_path_params,
2219
+ query_params=_query_params,
2220
+ header_params=_header_params,
2221
+ body=_body_params,
2222
+ post_params=_form_params,
2223
+ files=_files,
2224
+ auth_settings=_auth_settings,
2225
+ collection_formats=_collection_formats,
2226
+ _host=_host,
2227
+ _request_auth=_request_auth
2228
+ )
2229
+
2230
+
2231
+
2232
+
1687
2233
  @validate_call
1688
2234
  def get_group(
1689
2235
  self,
@@ -1703,9 +2249,270 @@ class GroupsApi:
1703
2249
  ) -> ApiGroup:
1704
2250
  """Get group
1705
2251
 
1706
- Returns group data, including the `Permission set`. See [get groups](#operation/getGroups) for more details.
2252
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2253
+
2254
+ :param id: Id of the group for retrieval (required)
2255
+ :type id: str
2256
+ :param _request_timeout: timeout setting for this request. If one
2257
+ number provided, it will be total request
2258
+ timeout. It can also be a pair (tuple) of
2259
+ (connection, read) timeouts.
2260
+ :type _request_timeout: int, tuple(int, int), optional
2261
+ :param _request_auth: set to override the auth_settings for an a single
2262
+ request; this effectively ignores the
2263
+ authentication in the spec for a single request.
2264
+ :type _request_auth: dict, optional
2265
+ :param _content_type: force content-type for the request.
2266
+ :type _content_type: str, Optional
2267
+ :param _headers: set to override the headers for a single
2268
+ request; this effectively ignores the headers
2269
+ in the spec for a single request.
2270
+ :type _headers: dict, optional
2271
+ :param _host_index: set to override the host_index for a single
2272
+ request; this effectively ignores the host_index
2273
+ in the spec for a single request.
2274
+ :type _host_index: int, optional
2275
+ :return: Returns the result object.
2276
+ """ # noqa: E501
2277
+
2278
+ _param = self._get_group_serialize(
2279
+ id=id,
2280
+ _request_auth=_request_auth,
2281
+ _content_type=_content_type,
2282
+ _headers=_headers,
2283
+ _host_index=_host_index
2284
+ )
2285
+
2286
+ _response_types_map: Dict[str, Optional[str]] = {
2287
+ '200': "ApiGroup",
2288
+ }
2289
+ response_data = self.api_client.call_api(
2290
+ *_param,
2291
+ _request_timeout=_request_timeout
2292
+ )
2293
+ response_data.read()
2294
+ return self.api_client.response_deserialize(
2295
+ response_data=response_data,
2296
+ response_types_map=_response_types_map,
2297
+ ).data
2298
+
2299
+
2300
+ @validate_call
2301
+ def get_group_with_http_info(
2302
+ self,
2303
+ id: Annotated[StrictStr, Field(description="Id of the group for retrieval")],
2304
+ _request_timeout: Union[
2305
+ None,
2306
+ Annotated[StrictFloat, Field(gt=0)],
2307
+ Tuple[
2308
+ Annotated[StrictFloat, Field(gt=0)],
2309
+ Annotated[StrictFloat, Field(gt=0)]
2310
+ ]
2311
+ ] = None,
2312
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2313
+ _content_type: Optional[StrictStr] = None,
2314
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2315
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2316
+ ) -> ApiResponse[ApiGroup]:
2317
+ """Get group
2318
+
2319
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2320
+
2321
+ :param id: Id of the group for retrieval (required)
2322
+ :type id: str
2323
+ :param _request_timeout: timeout setting for this request. If one
2324
+ number provided, it will be total request
2325
+ timeout. It can also be a pair (tuple) of
2326
+ (connection, read) timeouts.
2327
+ :type _request_timeout: int, tuple(int, int), optional
2328
+ :param _request_auth: set to override the auth_settings for an a single
2329
+ request; this effectively ignores the
2330
+ authentication in the spec for a single request.
2331
+ :type _request_auth: dict, optional
2332
+ :param _content_type: force content-type for the request.
2333
+ :type _content_type: str, Optional
2334
+ :param _headers: set to override the headers for a single
2335
+ request; this effectively ignores the headers
2336
+ in the spec for a single request.
2337
+ :type _headers: dict, optional
2338
+ :param _host_index: set to override the host_index for a single
2339
+ request; this effectively ignores the host_index
2340
+ in the spec for a single request.
2341
+ :type _host_index: int, optional
2342
+ :return: Returns the result object.
2343
+ """ # noqa: E501
2344
+
2345
+ _param = self._get_group_serialize(
2346
+ id=id,
2347
+ _request_auth=_request_auth,
2348
+ _content_type=_content_type,
2349
+ _headers=_headers,
2350
+ _host_index=_host_index
2351
+ )
2352
+
2353
+ _response_types_map: Dict[str, Optional[str]] = {
2354
+ '200': "ApiGroup",
2355
+ }
2356
+ response_data = self.api_client.call_api(
2357
+ *_param,
2358
+ _request_timeout=_request_timeout
2359
+ )
2360
+ response_data.read()
2361
+ return self.api_client.response_deserialize(
2362
+ response_data=response_data,
2363
+ response_types_map=_response_types_map,
2364
+ )
2365
+
2366
+
2367
+ @validate_call
2368
+ def get_group_without_preload_content(
2369
+ self,
2370
+ id: Annotated[StrictStr, Field(description="Id of the group for retrieval")],
2371
+ _request_timeout: Union[
2372
+ None,
2373
+ Annotated[StrictFloat, Field(gt=0)],
2374
+ Tuple[
2375
+ Annotated[StrictFloat, Field(gt=0)],
2376
+ Annotated[StrictFloat, Field(gt=0)]
2377
+ ]
2378
+ ] = None,
2379
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2380
+ _content_type: Optional[StrictStr] = None,
2381
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2382
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2383
+ ) -> RESTResponseType:
2384
+ """Get group
2385
+
2386
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2387
+
2388
+ :param id: Id of the group for retrieval (required)
2389
+ :type id: str
2390
+ :param _request_timeout: timeout setting for this request. If one
2391
+ number provided, it will be total request
2392
+ timeout. It can also be a pair (tuple) of
2393
+ (connection, read) timeouts.
2394
+ :type _request_timeout: int, tuple(int, int), optional
2395
+ :param _request_auth: set to override the auth_settings for an a single
2396
+ request; this effectively ignores the
2397
+ authentication in the spec for a single request.
2398
+ :type _request_auth: dict, optional
2399
+ :param _content_type: force content-type for the request.
2400
+ :type _content_type: str, Optional
2401
+ :param _headers: set to override the headers for a single
2402
+ request; this effectively ignores the headers
2403
+ in the spec for a single request.
2404
+ :type _headers: dict, optional
2405
+ :param _host_index: set to override the host_index for a single
2406
+ request; this effectively ignores the host_index
2407
+ in the spec for a single request.
2408
+ :type _host_index: int, optional
2409
+ :return: Returns the result object.
2410
+ """ # noqa: E501
2411
+
2412
+ _param = self._get_group_serialize(
2413
+ id=id,
2414
+ _request_auth=_request_auth,
2415
+ _content_type=_content_type,
2416
+ _headers=_headers,
2417
+ _host_index=_host_index
2418
+ )
2419
+
2420
+ _response_types_map: Dict[str, Optional[str]] = {
2421
+ '200': "ApiGroup",
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_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/groups/{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_mapping(
2496
+ self,
2497
+ id: StrictStr,
2498
+ _request_timeout: Union[
2499
+ None,
2500
+ Annotated[StrictFloat, Field(gt=0)],
2501
+ Tuple[
2502
+ Annotated[StrictFloat, Field(gt=0)],
2503
+ Annotated[StrictFloat, Field(gt=0)]
2504
+ ]
2505
+ ] = None,
2506
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2507
+ _content_type: Optional[StrictStr] = None,
2508
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2509
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2510
+ ) -> GroupMapping:
2511
+ """Get group mapping
2512
+
2513
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
1707
2514
 
1708
- :param id: Id of the group for retrieval (required)
2515
+ :param id: (required)
1709
2516
  :type id: str
1710
2517
  :param _request_timeout: timeout setting for this request. If one
1711
2518
  number provided, it will be total request
@@ -1729,7 +2536,7 @@ class GroupsApi:
1729
2536
  :return: Returns the result object.
1730
2537
  """ # noqa: E501
1731
2538
 
1732
- _param = self._get_group_serialize(
2539
+ _param = self._get_group_mapping_serialize(
1733
2540
  id=id,
1734
2541
  _request_auth=_request_auth,
1735
2542
  _content_type=_content_type,
@@ -1738,7 +2545,8 @@ class GroupsApi:
1738
2545
  )
1739
2546
 
1740
2547
  _response_types_map: Dict[str, Optional[str]] = {
1741
- '200': "ApiGroup",
2548
+ '200': "GroupMapping",
2549
+ '404': None,
1742
2550
  }
1743
2551
  response_data = self.api_client.call_api(
1744
2552
  *_param,
@@ -1752,9 +2560,9 @@ class GroupsApi:
1752
2560
 
1753
2561
 
1754
2562
  @validate_call
1755
- def get_group_with_http_info(
2563
+ def get_group_mapping_with_http_info(
1756
2564
  self,
1757
- id: Annotated[StrictStr, Field(description="Id of the group for retrieval")],
2565
+ id: StrictStr,
1758
2566
  _request_timeout: Union[
1759
2567
  None,
1760
2568
  Annotated[StrictFloat, Field(gt=0)],
@@ -1767,12 +2575,12 @@ class GroupsApi:
1767
2575
  _content_type: Optional[StrictStr] = None,
1768
2576
  _headers: Optional[Dict[StrictStr, Any]] = None,
1769
2577
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1770
- ) -> ApiResponse[ApiGroup]:
1771
- """Get group
2578
+ ) -> ApiResponse[GroupMapping]:
2579
+ """Get group mapping
1772
2580
 
1773
- Returns group data, including the `Permission set`. See [get groups](#operation/getGroups) for more details.
2581
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
1774
2582
 
1775
- :param id: Id of the group for retrieval (required)
2583
+ :param id: (required)
1776
2584
  :type id: str
1777
2585
  :param _request_timeout: timeout setting for this request. If one
1778
2586
  number provided, it will be total request
@@ -1796,7 +2604,7 @@ class GroupsApi:
1796
2604
  :return: Returns the result object.
1797
2605
  """ # noqa: E501
1798
2606
 
1799
- _param = self._get_group_serialize(
2607
+ _param = self._get_group_mapping_serialize(
1800
2608
  id=id,
1801
2609
  _request_auth=_request_auth,
1802
2610
  _content_type=_content_type,
@@ -1805,7 +2613,8 @@ class GroupsApi:
1805
2613
  )
1806
2614
 
1807
2615
  _response_types_map: Dict[str, Optional[str]] = {
1808
- '200': "ApiGroup",
2616
+ '200': "GroupMapping",
2617
+ '404': None,
1809
2618
  }
1810
2619
  response_data = self.api_client.call_api(
1811
2620
  *_param,
@@ -1819,9 +2628,9 @@ class GroupsApi:
1819
2628
 
1820
2629
 
1821
2630
  @validate_call
1822
- def get_group_without_preload_content(
2631
+ def get_group_mapping_without_preload_content(
1823
2632
  self,
1824
- id: Annotated[StrictStr, Field(description="Id of the group for retrieval")],
2633
+ id: StrictStr,
1825
2634
  _request_timeout: Union[
1826
2635
  None,
1827
2636
  Annotated[StrictFloat, Field(gt=0)],
@@ -1835,11 +2644,11 @@ class GroupsApi:
1835
2644
  _headers: Optional[Dict[StrictStr, Any]] = None,
1836
2645
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1837
2646
  ) -> RESTResponseType:
1838
- """Get group
2647
+ """Get group mapping
1839
2648
 
1840
- Returns group data, including the `Permission set`. See [get groups](#operation/getGroups) for more details.
2649
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
1841
2650
 
1842
- :param id: Id of the group for retrieval (required)
2651
+ :param id: (required)
1843
2652
  :type id: str
1844
2653
  :param _request_timeout: timeout setting for this request. If one
1845
2654
  number provided, it will be total request
@@ -1863,7 +2672,7 @@ class GroupsApi:
1863
2672
  :return: Returns the result object.
1864
2673
  """ # noqa: E501
1865
2674
 
1866
- _param = self._get_group_serialize(
2675
+ _param = self._get_group_mapping_serialize(
1867
2676
  id=id,
1868
2677
  _request_auth=_request_auth,
1869
2678
  _content_type=_content_type,
@@ -1872,7 +2681,8 @@ class GroupsApi:
1872
2681
  )
1873
2682
 
1874
2683
  _response_types_map: Dict[str, Optional[str]] = {
1875
- '200': "ApiGroup",
2684
+ '200': "GroupMapping",
2685
+ '404': None,
1876
2686
  }
1877
2687
  response_data = self.api_client.call_api(
1878
2688
  *_param,
@@ -1881,7 +2691,7 @@ class GroupsApi:
1881
2691
  return response_data.response
1882
2692
 
1883
2693
 
1884
- def _get_group_serialize(
2694
+ def _get_group_mapping_serialize(
1885
2695
  self,
1886
2696
  id,
1887
2697
  _request_auth,
@@ -1929,7 +2739,7 @@ class GroupsApi:
1929
2739
 
1930
2740
  return self.api_client.param_serialize(
1931
2741
  method='GET',
1932
- resource_path='/api/settings/rbac/groups/{id}',
2742
+ resource_path='/api/settings/rbac/mappings/{id}',
1933
2743
  path_params=_path_params,
1934
2744
  query_params=_query_params,
1935
2745
  header_params=_header_params,
@@ -1963,7 +2773,7 @@ class GroupsApi:
1963
2773
  ) -> List[GroupMapping]:
1964
2774
  """Get all group mappings
1965
2775
 
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.
2776
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
1967
2777
 
1968
2778
  :param _request_timeout: timeout setting for this request. If one
1969
2779
  number provided, it will be total request
@@ -2027,7 +2837,7 @@ class GroupsApi:
2027
2837
  ) -> ApiResponse[List[GroupMapping]]:
2028
2838
  """Get all group mappings
2029
2839
 
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.
2840
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2031
2841
 
2032
2842
  :param _request_timeout: timeout setting for this request. If one
2033
2843
  number provided, it will be total request
@@ -2091,7 +2901,7 @@ class GroupsApi:
2091
2901
  ) -> RESTResponseType:
2092
2902
  """Get all group mappings
2093
2903
 
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.
2904
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2095
2905
 
2096
2906
  :param _request_timeout: timeout setting for this request. If one
2097
2907
  number provided, it will be total request
@@ -2194,6 +3004,255 @@ class GroupsApi:
2194
3004
 
2195
3005
 
2196
3006
 
3007
+ @validate_call
3008
+ def get_group_mappings_overview(
3009
+ self,
3010
+ _request_timeout: Union[
3011
+ None,
3012
+ Annotated[StrictFloat, Field(gt=0)],
3013
+ Tuple[
3014
+ Annotated[StrictFloat, Field(gt=0)],
3015
+ Annotated[StrictFloat, Field(gt=0)]
3016
+ ]
3017
+ ] = None,
3018
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3019
+ _content_type: Optional[StrictStr] = None,
3020
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3021
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3022
+ ) -> List[GroupMappingOverview]:
3023
+ """Get all group mappings overview
3024
+
3025
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
3026
+
3027
+ :param _request_timeout: timeout setting for this request. If one
3028
+ number provided, it will be total request
3029
+ timeout. It can also be a pair (tuple) of
3030
+ (connection, read) timeouts.
3031
+ :type _request_timeout: int, tuple(int, int), optional
3032
+ :param _request_auth: set to override the auth_settings for an a single
3033
+ request; this effectively ignores the
3034
+ authentication in the spec for a single request.
3035
+ :type _request_auth: dict, optional
3036
+ :param _content_type: force content-type for the request.
3037
+ :type _content_type: str, Optional
3038
+ :param _headers: set to override the headers for a single
3039
+ request; this effectively ignores the headers
3040
+ in the spec for a single request.
3041
+ :type _headers: dict, optional
3042
+ :param _host_index: set to override the host_index for a single
3043
+ request; this effectively ignores the host_index
3044
+ in the spec for a single request.
3045
+ :type _host_index: int, optional
3046
+ :return: Returns the result object.
3047
+ """ # noqa: E501
3048
+
3049
+ _param = self._get_group_mappings_overview_serialize(
3050
+ _request_auth=_request_auth,
3051
+ _content_type=_content_type,
3052
+ _headers=_headers,
3053
+ _host_index=_host_index
3054
+ )
3055
+
3056
+ _response_types_map: Dict[str, Optional[str]] = {
3057
+ '200': "List[GroupMappingOverview]",
3058
+ '404': None,
3059
+ }
3060
+ response_data = self.api_client.call_api(
3061
+ *_param,
3062
+ _request_timeout=_request_timeout
3063
+ )
3064
+ response_data.read()
3065
+ return self.api_client.response_deserialize(
3066
+ response_data=response_data,
3067
+ response_types_map=_response_types_map,
3068
+ ).data
3069
+
3070
+
3071
+ @validate_call
3072
+ def get_group_mappings_overview_with_http_info(
3073
+ self,
3074
+ _request_timeout: Union[
3075
+ None,
3076
+ Annotated[StrictFloat, Field(gt=0)],
3077
+ Tuple[
3078
+ Annotated[StrictFloat, Field(gt=0)],
3079
+ Annotated[StrictFloat, Field(gt=0)]
3080
+ ]
3081
+ ] = None,
3082
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3083
+ _content_type: Optional[StrictStr] = None,
3084
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3085
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3086
+ ) -> ApiResponse[List[GroupMappingOverview]]:
3087
+ """Get all group mappings overview
3088
+
3089
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
3090
+
3091
+ :param _request_timeout: timeout setting for this request. If one
3092
+ number provided, it will be total request
3093
+ timeout. It can also be a pair (tuple) of
3094
+ (connection, read) timeouts.
3095
+ :type _request_timeout: int, tuple(int, int), optional
3096
+ :param _request_auth: set to override the auth_settings for an a single
3097
+ request; this effectively ignores the
3098
+ authentication in the spec for a single request.
3099
+ :type _request_auth: dict, optional
3100
+ :param _content_type: force content-type for the request.
3101
+ :type _content_type: str, Optional
3102
+ :param _headers: set to override the headers for a single
3103
+ request; this effectively ignores the headers
3104
+ in the spec for a single request.
3105
+ :type _headers: dict, optional
3106
+ :param _host_index: set to override the host_index for a single
3107
+ request; this effectively ignores the host_index
3108
+ in the spec for a single request.
3109
+ :type _host_index: int, optional
3110
+ :return: Returns the result object.
3111
+ """ # noqa: E501
3112
+
3113
+ _param = self._get_group_mappings_overview_serialize(
3114
+ _request_auth=_request_auth,
3115
+ _content_type=_content_type,
3116
+ _headers=_headers,
3117
+ _host_index=_host_index
3118
+ )
3119
+
3120
+ _response_types_map: Dict[str, Optional[str]] = {
3121
+ '200': "List[GroupMappingOverview]",
3122
+ '404': None,
3123
+ }
3124
+ response_data = self.api_client.call_api(
3125
+ *_param,
3126
+ _request_timeout=_request_timeout
3127
+ )
3128
+ response_data.read()
3129
+ return self.api_client.response_deserialize(
3130
+ response_data=response_data,
3131
+ response_types_map=_response_types_map,
3132
+ )
3133
+
3134
+
3135
+ @validate_call
3136
+ def get_group_mappings_overview_without_preload_content(
3137
+ self,
3138
+ _request_timeout: Union[
3139
+ None,
3140
+ Annotated[StrictFloat, Field(gt=0)],
3141
+ Tuple[
3142
+ Annotated[StrictFloat, Field(gt=0)],
3143
+ Annotated[StrictFloat, Field(gt=0)]
3144
+ ]
3145
+ ] = None,
3146
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3147
+ _content_type: Optional[StrictStr] = None,
3148
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3149
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3150
+ ) -> RESTResponseType:
3151
+ """Get all group mappings overview
3152
+
3153
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
3154
+
3155
+ :param _request_timeout: timeout setting for this request. If one
3156
+ number provided, it will be total request
3157
+ timeout. It can also be a pair (tuple) of
3158
+ (connection, read) timeouts.
3159
+ :type _request_timeout: int, tuple(int, int), optional
3160
+ :param _request_auth: set to override the auth_settings for an a single
3161
+ request; this effectively ignores the
3162
+ authentication in the spec for a single request.
3163
+ :type _request_auth: dict, optional
3164
+ :param _content_type: force content-type for the request.
3165
+ :type _content_type: str, Optional
3166
+ :param _headers: set to override the headers for a single
3167
+ request; this effectively ignores the headers
3168
+ in the spec for a single request.
3169
+ :type _headers: dict, optional
3170
+ :param _host_index: set to override the host_index for a single
3171
+ request; this effectively ignores the host_index
3172
+ in the spec for a single request.
3173
+ :type _host_index: int, optional
3174
+ :return: Returns the result object.
3175
+ """ # noqa: E501
3176
+
3177
+ _param = self._get_group_mappings_overview_serialize(
3178
+ _request_auth=_request_auth,
3179
+ _content_type=_content_type,
3180
+ _headers=_headers,
3181
+ _host_index=_host_index
3182
+ )
3183
+
3184
+ _response_types_map: Dict[str, Optional[str]] = {
3185
+ '200': "List[GroupMappingOverview]",
3186
+ '404': None,
3187
+ }
3188
+ response_data = self.api_client.call_api(
3189
+ *_param,
3190
+ _request_timeout=_request_timeout
3191
+ )
3192
+ return response_data.response
3193
+
3194
+
3195
+ def _get_group_mappings_overview_serialize(
3196
+ self,
3197
+ _request_auth,
3198
+ _content_type,
3199
+ _headers,
3200
+ _host_index,
3201
+ ) -> RequestSerialized:
3202
+
3203
+ _host = None
3204
+
3205
+ _collection_formats: Dict[str, str] = {
3206
+ }
3207
+
3208
+ _path_params: Dict[str, str] = {}
3209
+ _query_params: List[Tuple[str, str]] = []
3210
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3211
+ _form_params: List[Tuple[str, str]] = []
3212
+ _files: Dict[
3213
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
3214
+ ] = {}
3215
+ _body_params: Optional[bytes] = None
3216
+
3217
+ # process the path parameters
3218
+ # process the query parameters
3219
+ # process the header parameters
3220
+ # process the form parameters
3221
+ # process the body parameter
3222
+
3223
+
3224
+ # set the HTTP header `Accept`
3225
+ if 'Accept' not in _header_params:
3226
+ _header_params['Accept'] = self.api_client.select_header_accept(
3227
+ [
3228
+ 'application/json'
3229
+ ]
3230
+ )
3231
+
3232
+
3233
+ # authentication setting
3234
+ _auth_settings: List[str] = [
3235
+ 'ApiKeyAuth'
3236
+ ]
3237
+
3238
+ return self.api_client.param_serialize(
3239
+ method='GET',
3240
+ resource_path='/api/settings/rbac/mappings/overview',
3241
+ path_params=_path_params,
3242
+ query_params=_query_params,
3243
+ header_params=_header_params,
3244
+ body=_body_params,
3245
+ post_params=_form_params,
3246
+ files=_files,
3247
+ auth_settings=_auth_settings,
3248
+ collection_formats=_collection_formats,
3249
+ _host=_host,
3250
+ _request_auth=_request_auth
3251
+ )
3252
+
3253
+
3254
+
3255
+
2197
3256
  @validate_call
2198
3257
  def get_groups(
2199
3258
  self,
@@ -2212,7 +3271,7 @@ class GroupsApi:
2212
3271
  ) -> List[ApiGroup]:
2213
3272
  """Get groups
2214
3273
 
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.
3274
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2216
3275
 
2217
3276
  :param _request_timeout: timeout setting for this request. If one
2218
3277
  number provided, it will be total request
@@ -2276,7 +3335,7 @@ class GroupsApi:
2276
3335
  ) -> ApiResponse[List[ApiGroup]]:
2277
3336
  """Get groups
2278
3337
 
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.
3338
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2280
3339
 
2281
3340
  :param _request_timeout: timeout setting for this request. If one
2282
3341
  number provided, it will be total request
@@ -2340,7 +3399,7 @@ class GroupsApi:
2340
3399
  ) -> RESTResponseType:
2341
3400
  """Get groups
2342
3401
 
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.
3402
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2344
3403
 
2345
3404
  :param _request_timeout: timeout setting for this request. If one
2346
3405
  number provided, it will be total request
@@ -2462,7 +3521,7 @@ class GroupsApi:
2462
3521
  ) -> List[ApiGroup]:
2463
3522
  """Get groups of a single user
2464
3523
 
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`.
3524
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2466
3525
 
2467
3526
  :param email: Email of the user for retrieval (required)
2468
3527
  :type email: str
@@ -2530,7 +3589,7 @@ class GroupsApi:
2530
3589
  ) -> ApiResponse[List[ApiGroup]]:
2531
3590
  """Get groups of a single user
2532
3591
 
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`.
3592
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2534
3593
 
2535
3594
  :param email: Email of the user for retrieval (required)
2536
3595
  :type email: str
@@ -2598,7 +3657,7 @@ class GroupsApi:
2598
3657
  ) -> RESTResponseType:
2599
3658
  """Get groups of a single user
2600
3659
 
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`.
3660
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2602
3661
 
2603
3662
  :param email: Email of the user for retrieval (required)
2604
3663
  :type email: str
@@ -2725,7 +3784,7 @@ class GroupsApi:
2725
3784
  ) -> IdentityProviderPatch:
2726
3785
  """Check user restrictions for empty Idp group mapping
2727
3786
 
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.
3787
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2729
3788
 
2730
3789
  :param _request_timeout: timeout setting for this request. If one
2731
3790
  number provided, it will be total request
@@ -2789,7 +3848,7 @@ class GroupsApi:
2789
3848
  ) -> ApiResponse[IdentityProviderPatch]:
2790
3849
  """Check user restrictions for empty Idp group mapping
2791
3850
 
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.
3851
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2793
3852
 
2794
3853
  :param _request_timeout: timeout setting for this request. If one
2795
3854
  number provided, it will be total request
@@ -2853,7 +3912,7 @@ class GroupsApi:
2853
3912
  ) -> RESTResponseType:
2854
3913
  """Check user restrictions for empty Idp group mapping
2855
3914
 
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.
3915
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
2857
3916
 
2858
3917
  :param _request_timeout: timeout setting for this request. If one
2859
3918
  number provided, it will be total request
@@ -2976,7 +4035,7 @@ class GroupsApi:
2976
4035
  ) -> None:
2977
4036
  """Remove user from group
2978
4037
 
2979
- Remove the user from a group.
4038
+ 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
4039
 
2981
4040
  :param id: Id of the group to remove user from (required)
2982
4041
  :type id: str
@@ -3046,7 +4105,7 @@ class GroupsApi:
3046
4105
  ) -> ApiResponse[None]:
3047
4106
  """Remove user from group
3048
4107
 
3049
- Remove the user from a group.
4108
+ 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
4109
 
3051
4110
  :param id: Id of the group to remove user from (required)
3052
4111
  :type id: str
@@ -3116,7 +4175,7 @@ class GroupsApi:
3116
4175
  ) -> RESTResponseType:
3117
4176
  """Remove user from group
3118
4177
 
3119
- Remove the user from a group.
4178
+ 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
4179
 
3121
4180
  :param id: Id of the group to remove user from (required)
3122
4181
  :type id: str
@@ -3249,7 +4308,7 @@ class GroupsApi:
3249
4308
  ) -> ApiGroup:
3250
4309
  """Update group
3251
4310
 
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`
4311
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
3253
4312
 
3254
4313
  :param id: Id of the group to update (required)
3255
4314
  :type id: str
@@ -3320,7 +4379,7 @@ class GroupsApi:
3320
4379
  ) -> ApiResponse[ApiGroup]:
3321
4380
  """Update group
3322
4381
 
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`
4382
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
3324
4383
 
3325
4384
  :param id: Id of the group to update (required)
3326
4385
  :type id: str
@@ -3391,7 +4450,7 @@ class GroupsApi:
3391
4450
  ) -> RESTResponseType:
3392
4451
  """Update group
3393
4452
 
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`
4453
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
3395
4454
 
3396
4455
  :param id: Id of the group to update (required)
3397
4456
  :type id: str
@@ -3538,7 +4597,7 @@ class GroupsApi:
3538
4597
  ) -> GroupMapping:
3539
4598
  """Update group mapping
3540
4599
 
3541
- See [creating group mapping](#operation/createGroupMapping)
4600
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
3542
4601
 
3543
4602
  :param id: Id of the group mapping to update (required)
3544
4603
  :type id: str
@@ -3609,7 +4668,7 @@ class GroupsApi:
3609
4668
  ) -> ApiResponse[GroupMapping]:
3610
4669
  """Update group mapping
3611
4670
 
3612
- See [creating group mapping](#operation/createGroupMapping)
4671
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
3613
4672
 
3614
4673
  :param id: Id of the group mapping to update (required)
3615
4674
  :type id: str
@@ -3680,7 +4739,7 @@ class GroupsApi:
3680
4739
  ) -> RESTResponseType:
3681
4740
  """Update group mapping
3682
4741
 
3683
- See [creating group mapping](#operation/createGroupMapping)
4742
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
3684
4743
 
3685
4744
  :param id: Id of the group mapping to update (required)
3686
4745
  :type id: str
@@ -3826,7 +4885,7 @@ class GroupsApi:
3826
4885
  ) -> None:
3827
4886
  """Allow/Restrict users with empty Idp group mapping
3828
4887
 
3829
- Set the RestrictEmptyIdpGroups value as true/false. See [Check user restrictions for empty Idp group mapping](#operation/getIdentityProviderPatch) for more details.
4888
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
3830
4889
 
3831
4890
  :param identity_provider_patch: (required)
3832
4891
  :type identity_provider_patch: IdentityProviderPatch
@@ -3892,7 +4951,7 @@ class GroupsApi:
3892
4951
  ) -> ApiResponse[None]:
3893
4952
  """Allow/Restrict users with empty Idp group mapping
3894
4953
 
3895
- Set the RestrictEmptyIdpGroups value as true/false. See [Check user restrictions for empty Idp group mapping](#operation/getIdentityProviderPatch) for more details.
4954
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
3896
4955
 
3897
4956
  :param identity_provider_patch: (required)
3898
4957
  :type identity_provider_patch: IdentityProviderPatch
@@ -3958,7 +5017,7 @@ class GroupsApi:
3958
5017
  ) -> RESTResponseType:
3959
5018
  """Allow/Restrict users with empty Idp group mapping
3960
5019
 
3961
- Set the RestrictEmptyIdpGroups value as true/false. See [Check user restrictions for empty Idp group mapping](#operation/getIdentityProviderPatch) for more details.
5020
+ For more information on groups please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Settings#groups.
3962
5021
 
3963
5022
  :param identity_provider_patch: (required)
3964
5023
  :type identity_provider_patch: IdentityProviderPatch