hyperstack 0.1.23__py3-none-any.whl → 1.41.0a0__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 (225) hide show
  1. hyperstack/__init__.py +79 -131
  2. hyperstack/api/__init__.py +2 -0
  3. hyperstack/api/alive_api.py +240 -0
  4. hyperstack/api/api_key_api.py +16 -20
  5. hyperstack/api/assigning_member_role_api.py +15 -17
  6. hyperstack/api/auth_api.py +1050 -5
  7. hyperstack/api/beta_access_api.py +856 -0
  8. hyperstack/api/billing_api.py +6461 -673
  9. hyperstack/api/calculate_api.py +8 -9
  10. hyperstack/api/callbacks_api.py +120 -126
  11. hyperstack/api/cluster_events_api.py +1 -2
  12. hyperstack/api/clusters_api.py +2492 -146
  13. hyperstack/api/compliance_api.py +14 -18
  14. hyperstack/api/credit_api.py +17 -15
  15. hyperstack/api/customer_contract_api.py +30 -33
  16. hyperstack/api/dashboard_api.py +4 -5
  17. hyperstack/api/deployment_api.py +4 -8
  18. hyperstack/api/environment_api.py +285 -16
  19. hyperstack/api/firewall_attachment_api.py +11 -9
  20. hyperstack/api/firewalls_api.py +341 -347
  21. hyperstack/api/flavor_api.py +4 -5
  22. hyperstack/api/floating_ip_api.py +50 -49
  23. hyperstack/api/gpu_api.py +1 -2
  24. hyperstack/api/image_api.py +35 -39
  25. hyperstack/api/invite_api.py +288 -18
  26. hyperstack/api/keypair_api.py +22 -26
  27. hyperstack/api/organization_api.py +12 -15
  28. hyperstack/api/partner_config_api.py +564 -0
  29. hyperstack/api/payment_api.py +299 -18
  30. hyperstack/api/permission_api.py +4 -5
  31. hyperstack/api/policy_api.py +4 -5
  32. hyperstack/api/pricebook_api.py +14 -12
  33. hyperstack/api/profile_api.py +13 -17
  34. hyperstack/api/rbac_role_api.py +20 -25
  35. hyperstack/api/region_api.py +7 -8
  36. hyperstack/api/security_rules_api.py +1 -2
  37. hyperstack/api/snapshot_events_api.py +1 -2
  38. hyperstack/api/snapshots_api.py +166 -172
  39. hyperstack/api/stock_api.py +4 -5
  40. hyperstack/api/template_api.py +14 -19
  41. hyperstack/api/user_api.py +55 -49
  42. hyperstack/api/user_detail_choice_api.py +1 -2
  43. hyperstack/api/user_permission_api.py +8 -10
  44. hyperstack/api/virtual_machine_api.py +1529 -929
  45. hyperstack/api/virtual_machine_events_api.py +21 -22
  46. hyperstack/api/vnc_url_api.py +54 -50
  47. hyperstack/api/volume_api.py +340 -40
  48. hyperstack/api/volume_attachment_api.py +342 -42
  49. hyperstack/api_client.py +1 -1
  50. hyperstack/configuration.py +154 -47
  51. hyperstack/models/__init__.py +76 -130
  52. hyperstack/models/{environment_fieldsfor_volume.py → access_token_field.py} +7 -7
  53. hyperstack/models/attach_volume_fields.py +6 -2
  54. hyperstack/models/attach_volumes_payload.py +4 -2
  55. hyperstack/models/{virtual_machine_usage.py → attachments_fields_for_volume.py} +13 -11
  56. hyperstack/models/{flavor_vm_fields.py → attributes.py} +15 -18
  57. hyperstack/models/auth_get_token_response_model.py +4 -6
  58. hyperstack/models/{future_node_model.py → beta_access_request_fields.py} +27 -25
  59. hyperstack/models/{create_gpu.py → beta_access_request_payload.py} +9 -11
  60. hyperstack/models/{create_discount_response.py → beta_access_request_response_model.py} +11 -11
  61. hyperstack/models/{export_billing_data_request.py → beta_access_status_item.py} +20 -23
  62. hyperstack/models/{get_all_discount_for_all_organization_response.py → beta_access_status_response_model.py} +15 -15
  63. hyperstack/models/{exclude_billing_post_response.py → billing_history.py} +13 -11
  64. hyperstack/models/billing_history_data_synthesis_details.py +105 -0
  65. hyperstack/models/{vm_usage_response.py → billing_history_fine_tuning.py} +23 -19
  66. hyperstack/models/billing_history_model_evalutation_details.py +105 -0
  67. hyperstack/models/{get_all_discounts_fields.py → billing_history_serverless_inference.py} +23 -24
  68. hyperstack/models/billing_history_serverless_inference_details.py +105 -0
  69. hyperstack/models/{billingmetricesfields.py → billing_metrices_fields.py} +4 -4
  70. hyperstack/models/{billingmetricesresponse.py → billing_metrices_response.py} +7 -7
  71. hyperstack/models/cluster_fields.py +27 -9
  72. hyperstack/models/{add_update_flavor_organization_payload.py → cluster_flavor_fields.py} +28 -26
  73. hyperstack/models/{historical_instances_fields.py → cluster_node_fields.py} +24 -22
  74. hyperstack/models/{internal_instance_flavor_fields.py → cluster_node_group_fields.py} +17 -17
  75. hyperstack/models/{create_update_policy_response_model.py → cluster_node_groups_create_response.py} +21 -11
  76. hyperstack/models/{create_update_permission_response_model.py → cluster_node_groups_get_response.py} +11 -11
  77. hyperstack/models/{auth_request_login_response_model.py → cluster_node_groups_list_response.py} +15 -11
  78. hyperstack/models/{contract_eligible_instance_fields.py → cluster_node_instance_fields.py} +13 -11
  79. hyperstack/models/{image_logos.py → cluster_nodes_list_response.py} +14 -14
  80. hyperstack/models/{internal_environment_fields.py → cluster_version.py} +13 -9
  81. hyperstack/models/cluster_versions.py +10 -2
  82. hyperstack/models/{future_nodes_stock_model.py → colors.py} +17 -15
  83. hyperstack/models/contract_discount_plan_fields.py +3 -1
  84. hyperstack/models/contract_instance_fields.py +7 -1
  85. hyperstack/models/{future_node_response_model.py → create_cluster_node_fields.py} +23 -18
  86. hyperstack/models/{update_gpu.py → create_cluster_node_group_payload.py} +12 -11
  87. hyperstack/models/create_cluster_payload.py +31 -8
  88. hyperstack/models/create_environment.py +1 -1
  89. hyperstack/models/create_instances_payload.py +10 -8
  90. hyperstack/models/create_profile_payload.py +1 -1
  91. hyperstack/models/create_snapshot_payload.py +2 -4
  92. hyperstack/models/create_volume_payload.py +1 -1
  93. hyperstack/models/data_synthesis_billing_history_details_response_schema.py +95 -0
  94. hyperstack/models/{deployment_fieldsforstartdeployments.py → deployment_fields_for_start_deployments.py} +4 -4
  95. hyperstack/models/{editlabelofanexisting_vm_payload.py → edit_label_of_an_existing_vm_payload.py} +4 -4
  96. hyperstack/models/environment_features.py +14 -2
  97. hyperstack/models/{node_stocks_payload.py → environment_fields_for_volume.py} +10 -12
  98. hyperstack/models/flavor_fields.py +3 -1
  99. hyperstack/models/{customer_fields.py → flavor_label_fields.py} +7 -7
  100. hyperstack/models/{getcreditandthresholdinfo.py → get_credit_and_threshold_info.py} +4 -4
  101. hyperstack/models/{getcreditandthresholdinfoinresponse.py → get_credit_and_threshold_info_in_response.py} +7 -7
  102. hyperstack/models/{region_payload.py → get_instance_logs_response.py} +7 -9
  103. hyperstack/models/instance_fields.py +14 -4
  104. hyperstack/models/instance_flavor_fields.py +13 -1
  105. hyperstack/models/{flavor_response.py → keypair_environment_features.py} +20 -16
  106. hyperstack/models/{internal_instance_keypair_fields.py → keypair_environment_fields.py} +13 -11
  107. hyperstack/models/keypair_fields.py +6 -2
  108. hyperstack/models/{lastdaycostfields.py → last_day_cost_fields.py} +4 -4
  109. hyperstack/models/{lastdaycostresponse.py → last_day_cost_response.py} +7 -7
  110. hyperstack/models/{export_billing_data_response.py → logos.py} +13 -9
  111. hyperstack/models/{creditrequestresponse.py → master_flavors_response.py} +14 -14
  112. hyperstack/models/{customer_payload.py → mfa_status_fields.py} +8 -10
  113. hyperstack/models/{gpu.py → mfa_status_response.py} +11 -11
  114. hyperstack/models/model_evaluation_billing_history_details_response_schema.py +95 -0
  115. hyperstack/models/{organization_thresholdfields.py → organization_threshold_fields.py} +4 -4
  116. hyperstack/models/{organizationthresholdupdateresponse.py → organization_threshold_update_response.py} +7 -7
  117. hyperstack/models/{organizationthresholdsresponse.py → organization_thresholds_response.py} +7 -7
  118. hyperstack/models/{logo_get_response.py → pagination.py} +12 -12
  119. hyperstack/models/{billing_response.py → partner_config.py} +31 -20
  120. hyperstack/models/payment_details_fields.py +5 -1
  121. hyperstack/models/{logout_payload.py → primary_color.py} +10 -8
  122. hyperstack/models/region_fields.py +16 -2
  123. hyperstack/models/{vm_usage_request_payload.py → request_instance_logs_payload.py} +8 -8
  124. hyperstack/models/{stock_visibility_user_payload.py → request_instance_logs_response.py} +8 -8
  125. hyperstack/models/{contract_billing_history.py → resource_level_billing_bucket_details_resources.py} +10 -10
  126. hyperstack/models/{node_response_model.py → resource_level_billing_history_resources_cluster.py} +21 -11
  127. hyperstack/models/resource_level_billing_history_response_attributes.py +3 -1
  128. hyperstack/models/{get_all_contracts_response_model.py → resource_level_bucket_billing_details_response_model.py} +11 -15
  129. hyperstack/models/{contract_billing_history_response_model.py → resource_level_bucket_billing_history_response_model.py} +11 -11
  130. hyperstack/models/resource_level_cluster_billing_details_response_model.py +95 -0
  131. hyperstack/models/resource_level_cluster_billing_history_response_model.py +95 -0
  132. hyperstack/models/{get_discount_detail_response.py → resource_level_cluster_graph_billing_details_response_model.py} +11 -11
  133. hyperstack/models/{organization_object_response.py → resource_level_graph_billing_details_bucket.py} +18 -14
  134. hyperstack/models/{update_discounts_status_payload.py → secondary_color.py} +10 -8
  135. hyperstack/models/{security_rules_fieldsfor_instance.py → security_rules_fields_for_instance.py} +4 -4
  136. hyperstack/models/serverless_inferenced_billing_history_details_response_schema.py +95 -0
  137. hyperstack/models/snapshot_fields.py +6 -1
  138. hyperstack/models/snapshot_retrieve_fields.py +29 -2
  139. hyperstack/models/start_deployment.py +3 -3
  140. hyperstack/models/{subscribeorunsubscribeupdatepayload.py → subscribe_or_unsubscribe_update_payload.py} +4 -4
  141. hyperstack/models/token_based_billing_history_response.py +95 -0
  142. hyperstack/models/{update_keypairnameresponse.py → update_keypair_name_response.py} +4 -4
  143. hyperstack/models/update_volume_attachment_payload.py +87 -0
  144. hyperstack/models/{verify_api_key_payload.py → update_volume_payload.py} +7 -7
  145. hyperstack/models/{stock_visibility_user_list_response.py → update_volume_response.py} +14 -16
  146. hyperstack/models/{auth_request_login_fields.py → uris.py} +19 -9
  147. hyperstack/models/{userinfopostpayload.py → user_info_post_payload.py} +4 -4
  148. hyperstack/models/{node_stock_response_model.py → user_organizations_response.py} +14 -14
  149. hyperstack/models/users_info_fields.py +3 -1
  150. hyperstack/models/volume_attachment_fields.py +9 -5
  151. hyperstack/models/volume_fields.py +14 -4
  152. hyperstack/models/{volume_fieldsfor_instance.py → volume_fields_for_instance.py} +4 -4
  153. hyperstack/models/volumes.py +17 -11
  154. hyperstack/models/{instances_summary_fields.py → volumes_fields.py} +33 -29
  155. hyperstack/models/workload_billing_history_response.py +95 -0
  156. {hyperstack-0.1.23.dist-info → hyperstack-1.41.0a0.dist-info}/METADATA +9 -2
  157. hyperstack-1.41.0a0.dist-info/RECORD +349 -0
  158. {hyperstack-0.1.23.dist-info → hyperstack-1.41.0a0.dist-info}/WHEEL +1 -1
  159. hyperstack/models/api_key_verify_fields.py +0 -93
  160. hyperstack/models/billing_immune_resources_response.py +0 -95
  161. hyperstack/models/contract_billing_history_response_attributes.py +0 -99
  162. hyperstack/models/contract_change_payload.py +0 -101
  163. hyperstack/models/contract_eligible_instances_response.py +0 -101
  164. hyperstack/models/contract_event_create_model.py +0 -91
  165. hyperstack/models/contract_resource_payload.py +0 -95
  166. hyperstack/models/contractl_billing_history_response_metrics.py +0 -87
  167. hyperstack/models/create_contract_fields.py +0 -110
  168. hyperstack/models/create_contract_payload.py +0 -106
  169. hyperstack/models/create_discounts_payload.py +0 -112
  170. hyperstack/models/create_update_permission_payload.py +0 -93
  171. hyperstack/models/create_update_policy_payload.py +0 -93
  172. hyperstack/models/creditrechargelimitfield.py +0 -93
  173. hyperstack/models/creditrechargelimitresponse.py +0 -99
  174. hyperstack/models/creditrequests.py +0 -96
  175. hyperstack/models/data.py +0 -91
  176. hyperstack/models/discount_entity_model.py +0 -97
  177. hyperstack/models/discount_fields.py +0 -100
  178. hyperstack/models/discount_plan_fields.py +0 -108
  179. hyperstack/models/discount_resource_fields.py +0 -93
  180. hyperstack/models/discount_resource_payload.py +0 -93
  181. hyperstack/models/exclude_billing_post_payload.py +0 -91
  182. hyperstack/models/field_change.py +0 -91
  183. hyperstack/models/flavor_payload.py +0 -101
  184. hyperstack/models/flavor_vms_response.py +0 -99
  185. hyperstack/models/future_node_stock_model.py +0 -93
  186. hyperstack/models/future_node_update_model.py +0 -98
  187. hyperstack/models/get_all_contract_fields.py +0 -100
  188. hyperstack/models/get_discount_response.py +0 -99
  189. hyperstack/models/get_entity_discount_detail_response.py +0 -108
  190. hyperstack/models/get_token_payload.py +0 -89
  191. hyperstack/models/get_version_response.py +0 -91
  192. hyperstack/models/historical_instance.py +0 -101
  193. hyperstack/models/infrahub_resource_object_response.py +0 -119
  194. hyperstack/models/insert_discount_plan_fields.py +0 -112
  195. hyperstack/models/internal_instance_fields.py +0 -156
  196. hyperstack/models/internal_instance_image_fields.py +0 -95
  197. hyperstack/models/internal_instances_response.py +0 -99
  198. hyperstack/models/internal_security_rules_fields_for_instance.py +0 -104
  199. hyperstack/models/internal_volume_attachment_fields.py +0 -98
  200. hyperstack/models/internal_volume_fields.py +0 -95
  201. hyperstack/models/internal_volumes_response.py +0 -99
  202. hyperstack/models/new_stock_update_response_model.py +0 -89
  203. hyperstack/models/node_model.py +0 -114
  204. hyperstack/models/node_payload_model.py +0 -97
  205. hyperstack/models/node_power_usage_model.py +0 -120
  206. hyperstack/models/node_stock_payload_model.py +0 -95
  207. hyperstack/models/organizationcreditrechargelimitresponse.py +0 -95
  208. hyperstack/models/power_usage_model.py +0 -89
  209. hyperstack/models/pricebook_resource_object_response.py +0 -107
  210. hyperstack/models/refresh_token_payload.py +0 -89
  211. hyperstack/models/region_response.py +0 -95
  212. hyperstack/models/set_defaults_payload.py +0 -89
  213. hyperstack/models/single_visibility_user_response.py +0 -91
  214. hyperstack/models/success_response_model.py +0 -89
  215. hyperstack/models/token_fields.py +0 -91
  216. hyperstack/models/update_contract_payload.py +0 -104
  217. hyperstack/models/update_discounts_payload.py +0 -102
  218. hyperstack/models/user_transfer_payload.py +0 -89
  219. hyperstack/models/verify_api_key_response_model.py +0 -95
  220. hyperstack/models/volume_status_change_fields.py +0 -96
  221. hyperstack/models/volumes_last_status_change_response.py +0 -99
  222. hyperstack/models/warning_mail_log_fields.py +0 -99
  223. hyperstack/models/warning_mail_log_response.py +0 -101
  224. hyperstack-0.1.23.dist-info/RECORD +0 -401
  225. {hyperstack-0.1.23.dist-info → hyperstack-1.41.0a0.dist-info}/top_level.txt +0 -0
@@ -16,7 +16,12 @@ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
16
16
  from typing import Any, Dict, List, Optional, Tuple, Union
17
17
  from typing_extensions import Annotated
18
18
 
19
+ from pydantic import StrictInt
20
+ from ..models.auth_get_token_response_model import AuthGetTokenResponseModel
19
21
  from ..models.auth_user_info_response_model import AuthUserInfoResponseModel
22
+ from ..models.common_response_model import CommonResponseModel
23
+ from ..models.mfa_status_response import MFAStatusResponse
24
+ from ..models.user_organizations_response import UserOrganizationsResponse
20
25
 
21
26
  from ..api_client import ApiClient, RequestSerialized
22
27
  from ..api_response import ApiResponse
@@ -36,6 +41,1047 @@ class AuthApi:
36
41
  self.api_client = api_client
37
42
 
38
43
 
44
+ @validate_call
45
+ def change_organization_for_token(
46
+ self,
47
+ org_id: StrictInt,
48
+ _request_timeout: Union[
49
+ None,
50
+ Annotated[StrictFloat, Field(gt=0)],
51
+ Tuple[
52
+ Annotated[StrictFloat, Field(gt=0)],
53
+ Annotated[StrictFloat, Field(gt=0)]
54
+ ]
55
+ ] = None,
56
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
57
+ _content_type: Optional[StrictStr] = None,
58
+ _headers: Optional[Dict[StrictStr, Any]] = None,
59
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
60
+ ) -> AuthGetTokenResponseModel:
61
+ """change_organization_for_token
62
+
63
+ Change the organization associated with the current token. This is useful for users who have access to multiple organizations.
64
+
65
+ :param org_id: (required)
66
+ :type org_id: int
67
+ :param _request_timeout: timeout setting for this request. If one
68
+ number provided, it will be total request
69
+ timeout. It can also be a pair (tuple) of
70
+ (connection, read) timeouts.
71
+ :type _request_timeout: int, tuple(int, int), optional
72
+ :param _request_auth: set to override the auth_settings for an a single
73
+ request; this effectively ignores the
74
+ authentication in the spec for a single request.
75
+ :type _request_auth: dict, optional
76
+ :param _content_type: force content-type for the request.
77
+ :type _content_type: str, Optional
78
+ :param _headers: set to override the headers for a single
79
+ request; this effectively ignores the headers
80
+ in the spec for a single request.
81
+ :type _headers: dict, optional
82
+ :param _host_index: set to override the host_index for a single
83
+ request; this effectively ignores the host_index
84
+ in the spec for a single request.
85
+ :type _host_index: int, optional
86
+ :return: Returns the result object.
87
+ """ # noqa: E501
88
+
89
+ _param = self._change_organization_for_token_serialize(
90
+ org_id=org_id,
91
+ _request_auth=_request_auth,
92
+ _content_type=_content_type,
93
+ _headers=_headers,
94
+ _host_index=_host_index
95
+ )
96
+
97
+ _response_types_map: Dict[str, Optional[str]] = {
98
+ '200': "AuthGetTokenResponseModel",
99
+ '400': "ErrorResponseModel",
100
+ '401': "ErrorResponseModel",
101
+ '404': "ErrorResponseModel",
102
+ '500': None,
103
+ }
104
+ response_data = self.api_client.call_api(
105
+ *_param,
106
+ _request_timeout=_request_timeout
107
+ )
108
+ response_data.read()
109
+ return self.api_client.response_deserialize(
110
+ response_data=response_data,
111
+ response_types_map=_response_types_map,
112
+ ).data
113
+
114
+
115
+ @validate_call
116
+ def change_organization_for_token_with_http_info(
117
+ self,
118
+ org_id: StrictInt,
119
+ _request_timeout: Union[
120
+ None,
121
+ Annotated[StrictFloat, Field(gt=0)],
122
+ Tuple[
123
+ Annotated[StrictFloat, Field(gt=0)],
124
+ Annotated[StrictFloat, Field(gt=0)]
125
+ ]
126
+ ] = None,
127
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
128
+ _content_type: Optional[StrictStr] = None,
129
+ _headers: Optional[Dict[StrictStr, Any]] = None,
130
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
131
+ ) -> ApiResponse[AuthGetTokenResponseModel]:
132
+ """change_organization_for_token
133
+
134
+ Change the organization associated with the current token. This is useful for users who have access to multiple organizations.
135
+
136
+ :param org_id: (required)
137
+ :type org_id: int
138
+ :param _request_timeout: timeout setting for this request. If one
139
+ number provided, it will be total request
140
+ timeout. It can also be a pair (tuple) of
141
+ (connection, read) timeouts.
142
+ :type _request_timeout: int, tuple(int, int), optional
143
+ :param _request_auth: set to override the auth_settings for an a single
144
+ request; this effectively ignores the
145
+ authentication in the spec for a single request.
146
+ :type _request_auth: dict, optional
147
+ :param _content_type: force content-type for the request.
148
+ :type _content_type: str, Optional
149
+ :param _headers: set to override the headers for a single
150
+ request; this effectively ignores the headers
151
+ in the spec for a single request.
152
+ :type _headers: dict, optional
153
+ :param _host_index: set to override the host_index for a single
154
+ request; this effectively ignores the host_index
155
+ in the spec for a single request.
156
+ :type _host_index: int, optional
157
+ :return: Returns the result object.
158
+ """ # noqa: E501
159
+
160
+ _param = self._change_organization_for_token_serialize(
161
+ org_id=org_id,
162
+ _request_auth=_request_auth,
163
+ _content_type=_content_type,
164
+ _headers=_headers,
165
+ _host_index=_host_index
166
+ )
167
+
168
+ _response_types_map: Dict[str, Optional[str]] = {
169
+ '200': "AuthGetTokenResponseModel",
170
+ '400': "ErrorResponseModel",
171
+ '401': "ErrorResponseModel",
172
+ '404': "ErrorResponseModel",
173
+ '500': None,
174
+ }
175
+ response_data = self.api_client.call_api(
176
+ *_param,
177
+ _request_timeout=_request_timeout
178
+ )
179
+ response_data.read()
180
+ return self.api_client.response_deserialize(
181
+ response_data=response_data,
182
+ response_types_map=_response_types_map,
183
+ )
184
+
185
+
186
+ @validate_call
187
+ def change_organization_for_token_without_preload_content(
188
+ self,
189
+ org_id: StrictInt,
190
+ _request_timeout: Union[
191
+ None,
192
+ Annotated[StrictFloat, Field(gt=0)],
193
+ Tuple[
194
+ Annotated[StrictFloat, Field(gt=0)],
195
+ Annotated[StrictFloat, Field(gt=0)]
196
+ ]
197
+ ] = None,
198
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
199
+ _content_type: Optional[StrictStr] = None,
200
+ _headers: Optional[Dict[StrictStr, Any]] = None,
201
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
202
+ ) -> RESTResponseType:
203
+ """change_organization_for_token
204
+
205
+ Change the organization associated with the current token. This is useful for users who have access to multiple organizations.
206
+
207
+ :param org_id: (required)
208
+ :type org_id: int
209
+ :param _request_timeout: timeout setting for this request. If one
210
+ number provided, it will be total request
211
+ timeout. It can also be a pair (tuple) of
212
+ (connection, read) timeouts.
213
+ :type _request_timeout: int, tuple(int, int), optional
214
+ :param _request_auth: set to override the auth_settings for an a single
215
+ request; this effectively ignores the
216
+ authentication in the spec for a single request.
217
+ :type _request_auth: dict, optional
218
+ :param _content_type: force content-type for the request.
219
+ :type _content_type: str, Optional
220
+ :param _headers: set to override the headers for a single
221
+ request; this effectively ignores the headers
222
+ in the spec for a single request.
223
+ :type _headers: dict, optional
224
+ :param _host_index: set to override the host_index for a single
225
+ request; this effectively ignores the host_index
226
+ in the spec for a single request.
227
+ :type _host_index: int, optional
228
+ :return: Returns the result object.
229
+ """ # noqa: E501
230
+
231
+ _param = self._change_organization_for_token_serialize(
232
+ org_id=org_id,
233
+ _request_auth=_request_auth,
234
+ _content_type=_content_type,
235
+ _headers=_headers,
236
+ _host_index=_host_index
237
+ )
238
+
239
+ _response_types_map: Dict[str, Optional[str]] = {
240
+ '200': "AuthGetTokenResponseModel",
241
+ '400': "ErrorResponseModel",
242
+ '401': "ErrorResponseModel",
243
+ '404': "ErrorResponseModel",
244
+ '500': None,
245
+ }
246
+ response_data = self.api_client.call_api(
247
+ *_param,
248
+ _request_timeout=_request_timeout
249
+ )
250
+ return response_data.response
251
+
252
+
253
+ def _change_organization_for_token_serialize(
254
+ self,
255
+ org_id,
256
+ _request_auth,
257
+ _content_type,
258
+ _headers,
259
+ _host_index,
260
+ ) -> RequestSerialized:
261
+
262
+ _host = None
263
+
264
+ _collection_formats: Dict[str, str] = {
265
+ }
266
+
267
+ _path_params: Dict[str, str] = {}
268
+ _query_params: List[Tuple[str, str]] = []
269
+ _header_params: Dict[str, Optional[str]] = _headers or {}
270
+ _form_params: List[Tuple[str, str]] = []
271
+ _files: Dict[
272
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
273
+ ] = {}
274
+ _body_params: Optional[bytes] = None
275
+
276
+ # process the path parameters
277
+ if org_id is not None:
278
+ _path_params['org_id'] = org_id
279
+ # process the query parameters
280
+ # process the header parameters
281
+ # process the form parameters
282
+ # process the body parameter
283
+
284
+
285
+ # set the HTTP header `Accept`
286
+ if 'Accept' not in _header_params:
287
+ _header_params['Accept'] = self.api_client.select_header_accept(
288
+ [
289
+ 'application/json'
290
+ ]
291
+ )
292
+
293
+
294
+ # authentication setting
295
+ _auth_settings: List[str] = [
296
+ 'apiKey'
297
+ ]
298
+
299
+ return self.api_client.param_serialize(
300
+ method='GET',
301
+ resource_path='/auth/token/change-org/{org_id}',
302
+ path_params=_path_params,
303
+ query_params=_query_params,
304
+ header_params=_header_params,
305
+ body=_body_params,
306
+ post_params=_form_params,
307
+ files=_files,
308
+ auth_settings=_auth_settings,
309
+ collection_formats=_collection_formats,
310
+ _host=_host,
311
+ _request_auth=_request_auth
312
+ )
313
+
314
+
315
+
316
+
317
+ @validate_call
318
+ def disable_mfa(
319
+ self,
320
+ _request_timeout: Union[
321
+ None,
322
+ Annotated[StrictFloat, Field(gt=0)],
323
+ Tuple[
324
+ Annotated[StrictFloat, Field(gt=0)],
325
+ Annotated[StrictFloat, Field(gt=0)]
326
+ ]
327
+ ] = None,
328
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
329
+ _content_type: Optional[StrictStr] = None,
330
+ _headers: Optional[Dict[StrictStr, Any]] = None,
331
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
332
+ ) -> CommonResponseModel:
333
+ """disable_mfa
334
+
335
+ Disable Multi-Factor Authentication (MFA) for the currently authenticated user. This endpoint is used to turn off MFA.
336
+
337
+ :param _request_timeout: timeout setting for this request. If one
338
+ number provided, it will be total request
339
+ timeout. It can also be a pair (tuple) of
340
+ (connection, read) timeouts.
341
+ :type _request_timeout: int, tuple(int, int), optional
342
+ :param _request_auth: set to override the auth_settings for an a single
343
+ request; this effectively ignores the
344
+ authentication in the spec for a single request.
345
+ :type _request_auth: dict, optional
346
+ :param _content_type: force content-type for the request.
347
+ :type _content_type: str, Optional
348
+ :param _headers: set to override the headers for a single
349
+ request; this effectively ignores the headers
350
+ in the spec for a single request.
351
+ :type _headers: dict, optional
352
+ :param _host_index: set to override the host_index for a single
353
+ request; this effectively ignores the host_index
354
+ in the spec for a single request.
355
+ :type _host_index: int, optional
356
+ :return: Returns the result object.
357
+ """ # noqa: E501
358
+
359
+ _param = self._disable_mfa_serialize(
360
+ _request_auth=_request_auth,
361
+ _content_type=_content_type,
362
+ _headers=_headers,
363
+ _host_index=_host_index
364
+ )
365
+
366
+ _response_types_map: Dict[str, Optional[str]] = {
367
+ '200': "CommonResponseModel",
368
+ '401': "ErrorResponseModel",
369
+ '404': "ErrorResponseModel",
370
+ '500': "ErrorResponseModel",
371
+ }
372
+ response_data = self.api_client.call_api(
373
+ *_param,
374
+ _request_timeout=_request_timeout
375
+ )
376
+ response_data.read()
377
+ return self.api_client.response_deserialize(
378
+ response_data=response_data,
379
+ response_types_map=_response_types_map,
380
+ ).data
381
+
382
+
383
+ @validate_call
384
+ def disable_mfa_with_http_info(
385
+ self,
386
+ _request_timeout: Union[
387
+ None,
388
+ Annotated[StrictFloat, Field(gt=0)],
389
+ Tuple[
390
+ Annotated[StrictFloat, Field(gt=0)],
391
+ Annotated[StrictFloat, Field(gt=0)]
392
+ ]
393
+ ] = None,
394
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
395
+ _content_type: Optional[StrictStr] = None,
396
+ _headers: Optional[Dict[StrictStr, Any]] = None,
397
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
398
+ ) -> ApiResponse[CommonResponseModel]:
399
+ """disable_mfa
400
+
401
+ Disable Multi-Factor Authentication (MFA) for the currently authenticated user. This endpoint is used to turn off MFA.
402
+
403
+ :param _request_timeout: timeout setting for this request. If one
404
+ number provided, it will be total request
405
+ timeout. It can also be a pair (tuple) of
406
+ (connection, read) timeouts.
407
+ :type _request_timeout: int, tuple(int, int), optional
408
+ :param _request_auth: set to override the auth_settings for an a single
409
+ request; this effectively ignores the
410
+ authentication in the spec for a single request.
411
+ :type _request_auth: dict, optional
412
+ :param _content_type: force content-type for the request.
413
+ :type _content_type: str, Optional
414
+ :param _headers: set to override the headers for a single
415
+ request; this effectively ignores the headers
416
+ in the spec for a single request.
417
+ :type _headers: dict, optional
418
+ :param _host_index: set to override the host_index for a single
419
+ request; this effectively ignores the host_index
420
+ in the spec for a single request.
421
+ :type _host_index: int, optional
422
+ :return: Returns the result object.
423
+ """ # noqa: E501
424
+
425
+ _param = self._disable_mfa_serialize(
426
+ _request_auth=_request_auth,
427
+ _content_type=_content_type,
428
+ _headers=_headers,
429
+ _host_index=_host_index
430
+ )
431
+
432
+ _response_types_map: Dict[str, Optional[str]] = {
433
+ '200': "CommonResponseModel",
434
+ '401': "ErrorResponseModel",
435
+ '404': "ErrorResponseModel",
436
+ '500': "ErrorResponseModel",
437
+ }
438
+ response_data = self.api_client.call_api(
439
+ *_param,
440
+ _request_timeout=_request_timeout
441
+ )
442
+ response_data.read()
443
+ return self.api_client.response_deserialize(
444
+ response_data=response_data,
445
+ response_types_map=_response_types_map,
446
+ )
447
+
448
+
449
+ @validate_call
450
+ def disable_mfa_without_preload_content(
451
+ self,
452
+ _request_timeout: Union[
453
+ None,
454
+ Annotated[StrictFloat, Field(gt=0)],
455
+ Tuple[
456
+ Annotated[StrictFloat, Field(gt=0)],
457
+ Annotated[StrictFloat, Field(gt=0)]
458
+ ]
459
+ ] = None,
460
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
461
+ _content_type: Optional[StrictStr] = None,
462
+ _headers: Optional[Dict[StrictStr, Any]] = None,
463
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
464
+ ) -> RESTResponseType:
465
+ """disable_mfa
466
+
467
+ Disable Multi-Factor Authentication (MFA) for the currently authenticated user. This endpoint is used to turn off MFA.
468
+
469
+ :param _request_timeout: timeout setting for this request. If one
470
+ number provided, it will be total request
471
+ timeout. It can also be a pair (tuple) of
472
+ (connection, read) timeouts.
473
+ :type _request_timeout: int, tuple(int, int), optional
474
+ :param _request_auth: set to override the auth_settings for an a single
475
+ request; this effectively ignores the
476
+ authentication in the spec for a single request.
477
+ :type _request_auth: dict, optional
478
+ :param _content_type: force content-type for the request.
479
+ :type _content_type: str, Optional
480
+ :param _headers: set to override the headers for a single
481
+ request; this effectively ignores the headers
482
+ in the spec for a single request.
483
+ :type _headers: dict, optional
484
+ :param _host_index: set to override the host_index for a single
485
+ request; this effectively ignores the host_index
486
+ in the spec for a single request.
487
+ :type _host_index: int, optional
488
+ :return: Returns the result object.
489
+ """ # noqa: E501
490
+
491
+ _param = self._disable_mfa_serialize(
492
+ _request_auth=_request_auth,
493
+ _content_type=_content_type,
494
+ _headers=_headers,
495
+ _host_index=_host_index
496
+ )
497
+
498
+ _response_types_map: Dict[str, Optional[str]] = {
499
+ '200': "CommonResponseModel",
500
+ '401': "ErrorResponseModel",
501
+ '404': "ErrorResponseModel",
502
+ '500': "ErrorResponseModel",
503
+ }
504
+ response_data = self.api_client.call_api(
505
+ *_param,
506
+ _request_timeout=_request_timeout
507
+ )
508
+ return response_data.response
509
+
510
+
511
+ def _disable_mfa_serialize(
512
+ self,
513
+ _request_auth,
514
+ _content_type,
515
+ _headers,
516
+ _host_index,
517
+ ) -> RequestSerialized:
518
+
519
+ _host = None
520
+
521
+ _collection_formats: Dict[str, str] = {
522
+ }
523
+
524
+ _path_params: Dict[str, str] = {}
525
+ _query_params: List[Tuple[str, str]] = []
526
+ _header_params: Dict[str, Optional[str]] = _headers or {}
527
+ _form_params: List[Tuple[str, str]] = []
528
+ _files: Dict[
529
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
530
+ ] = {}
531
+ _body_params: Optional[bytes] = None
532
+
533
+ # process the path parameters
534
+ # process the query parameters
535
+ # process the header parameters
536
+ # process the form parameters
537
+ # process the body parameter
538
+
539
+
540
+ # set the HTTP header `Accept`
541
+ if 'Accept' not in _header_params:
542
+ _header_params['Accept'] = self.api_client.select_header_accept(
543
+ [
544
+ 'application/json'
545
+ ]
546
+ )
547
+
548
+
549
+ # authentication setting
550
+ _auth_settings: List[str] = [
551
+ 'apiKey'
552
+ ]
553
+
554
+ return self.api_client.param_serialize(
555
+ method='GET',
556
+ resource_path='/auth/me/mfa/disable',
557
+ path_params=_path_params,
558
+ query_params=_query_params,
559
+ header_params=_header_params,
560
+ body=_body_params,
561
+ post_params=_form_params,
562
+ files=_files,
563
+ auth_settings=_auth_settings,
564
+ collection_formats=_collection_formats,
565
+ _host=_host,
566
+ _request_auth=_request_auth
567
+ )
568
+
569
+
570
+
571
+
572
+ @validate_call
573
+ def get_user_mfa_status(
574
+ self,
575
+ _request_timeout: Union[
576
+ None,
577
+ Annotated[StrictFloat, Field(gt=0)],
578
+ Tuple[
579
+ Annotated[StrictFloat, Field(gt=0)],
580
+ Annotated[StrictFloat, Field(gt=0)]
581
+ ]
582
+ ] = None,
583
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
584
+ _content_type: Optional[StrictStr] = None,
585
+ _headers: Optional[Dict[StrictStr, Any]] = None,
586
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
587
+ ) -> MFAStatusResponse:
588
+ """Get MFA status for authenticated user
589
+
590
+ Retrieve the Multi-Factor Authentication (MFA) status for the currentlyauthenticated user. Includes whether MFA is enabled.
591
+
592
+ :param _request_timeout: timeout setting for this request. If one
593
+ number provided, it will be total request
594
+ timeout. It can also be a pair (tuple) of
595
+ (connection, read) timeouts.
596
+ :type _request_timeout: int, tuple(int, int), optional
597
+ :param _request_auth: set to override the auth_settings for an a single
598
+ request; this effectively ignores the
599
+ authentication in the spec for a single request.
600
+ :type _request_auth: dict, optional
601
+ :param _content_type: force content-type for the request.
602
+ :type _content_type: str, Optional
603
+ :param _headers: set to override the headers for a single
604
+ request; this effectively ignores the headers
605
+ in the spec for a single request.
606
+ :type _headers: dict, optional
607
+ :param _host_index: set to override the host_index for a single
608
+ request; this effectively ignores the host_index
609
+ in the spec for a single request.
610
+ :type _host_index: int, optional
611
+ :return: Returns the result object.
612
+ """ # noqa: E501
613
+
614
+ _param = self._get_user_mfa_status_serialize(
615
+ _request_auth=_request_auth,
616
+ _content_type=_content_type,
617
+ _headers=_headers,
618
+ _host_index=_host_index
619
+ )
620
+
621
+ _response_types_map: Dict[str, Optional[str]] = {
622
+ '200': "MFAStatusResponse",
623
+ '401': "ErrorResponseModel",
624
+ '404': "ErrorResponseModel",
625
+ '500': "ErrorResponseModel",
626
+ }
627
+ response_data = self.api_client.call_api(
628
+ *_param,
629
+ _request_timeout=_request_timeout
630
+ )
631
+ response_data.read()
632
+ return self.api_client.response_deserialize(
633
+ response_data=response_data,
634
+ response_types_map=_response_types_map,
635
+ ).data
636
+
637
+
638
+ @validate_call
639
+ def get_user_mfa_status_with_http_info(
640
+ self,
641
+ _request_timeout: Union[
642
+ None,
643
+ Annotated[StrictFloat, Field(gt=0)],
644
+ Tuple[
645
+ Annotated[StrictFloat, Field(gt=0)],
646
+ Annotated[StrictFloat, Field(gt=0)]
647
+ ]
648
+ ] = None,
649
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
650
+ _content_type: Optional[StrictStr] = None,
651
+ _headers: Optional[Dict[StrictStr, Any]] = None,
652
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
653
+ ) -> ApiResponse[MFAStatusResponse]:
654
+ """Get MFA status for authenticated user
655
+
656
+ Retrieve the Multi-Factor Authentication (MFA) status for the currentlyauthenticated user. Includes whether MFA is enabled.
657
+
658
+ :param _request_timeout: timeout setting for this request. If one
659
+ number provided, it will be total request
660
+ timeout. It can also be a pair (tuple) of
661
+ (connection, read) timeouts.
662
+ :type _request_timeout: int, tuple(int, int), optional
663
+ :param _request_auth: set to override the auth_settings for an a single
664
+ request; this effectively ignores the
665
+ authentication in the spec for a single request.
666
+ :type _request_auth: dict, optional
667
+ :param _content_type: force content-type for the request.
668
+ :type _content_type: str, Optional
669
+ :param _headers: set to override the headers for a single
670
+ request; this effectively ignores the headers
671
+ in the spec for a single request.
672
+ :type _headers: dict, optional
673
+ :param _host_index: set to override the host_index for a single
674
+ request; this effectively ignores the host_index
675
+ in the spec for a single request.
676
+ :type _host_index: int, optional
677
+ :return: Returns the result object.
678
+ """ # noqa: E501
679
+
680
+ _param = self._get_user_mfa_status_serialize(
681
+ _request_auth=_request_auth,
682
+ _content_type=_content_type,
683
+ _headers=_headers,
684
+ _host_index=_host_index
685
+ )
686
+
687
+ _response_types_map: Dict[str, Optional[str]] = {
688
+ '200': "MFAStatusResponse",
689
+ '401': "ErrorResponseModel",
690
+ '404': "ErrorResponseModel",
691
+ '500': "ErrorResponseModel",
692
+ }
693
+ response_data = self.api_client.call_api(
694
+ *_param,
695
+ _request_timeout=_request_timeout
696
+ )
697
+ response_data.read()
698
+ return self.api_client.response_deserialize(
699
+ response_data=response_data,
700
+ response_types_map=_response_types_map,
701
+ )
702
+
703
+
704
+ @validate_call
705
+ def get_user_mfa_status_without_preload_content(
706
+ self,
707
+ _request_timeout: Union[
708
+ None,
709
+ Annotated[StrictFloat, Field(gt=0)],
710
+ Tuple[
711
+ Annotated[StrictFloat, Field(gt=0)],
712
+ Annotated[StrictFloat, Field(gt=0)]
713
+ ]
714
+ ] = None,
715
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
716
+ _content_type: Optional[StrictStr] = None,
717
+ _headers: Optional[Dict[StrictStr, Any]] = None,
718
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
719
+ ) -> RESTResponseType:
720
+ """Get MFA status for authenticated user
721
+
722
+ Retrieve the Multi-Factor Authentication (MFA) status for the currentlyauthenticated user. Includes whether MFA is enabled.
723
+
724
+ :param _request_timeout: timeout setting for this request. If one
725
+ number provided, it will be total request
726
+ timeout. It can also be a pair (tuple) of
727
+ (connection, read) timeouts.
728
+ :type _request_timeout: int, tuple(int, int), optional
729
+ :param _request_auth: set to override the auth_settings for an a single
730
+ request; this effectively ignores the
731
+ authentication in the spec for a single request.
732
+ :type _request_auth: dict, optional
733
+ :param _content_type: force content-type for the request.
734
+ :type _content_type: str, Optional
735
+ :param _headers: set to override the headers for a single
736
+ request; this effectively ignores the headers
737
+ in the spec for a single request.
738
+ :type _headers: dict, optional
739
+ :param _host_index: set to override the host_index for a single
740
+ request; this effectively ignores the host_index
741
+ in the spec for a single request.
742
+ :type _host_index: int, optional
743
+ :return: Returns the result object.
744
+ """ # noqa: E501
745
+
746
+ _param = self._get_user_mfa_status_serialize(
747
+ _request_auth=_request_auth,
748
+ _content_type=_content_type,
749
+ _headers=_headers,
750
+ _host_index=_host_index
751
+ )
752
+
753
+ _response_types_map: Dict[str, Optional[str]] = {
754
+ '200': "MFAStatusResponse",
755
+ '401': "ErrorResponseModel",
756
+ '404': "ErrorResponseModel",
757
+ '500': "ErrorResponseModel",
758
+ }
759
+ response_data = self.api_client.call_api(
760
+ *_param,
761
+ _request_timeout=_request_timeout
762
+ )
763
+ return response_data.response
764
+
765
+
766
+ def _get_user_mfa_status_serialize(
767
+ self,
768
+ _request_auth,
769
+ _content_type,
770
+ _headers,
771
+ _host_index,
772
+ ) -> RequestSerialized:
773
+
774
+ _host = None
775
+
776
+ _collection_formats: Dict[str, str] = {
777
+ }
778
+
779
+ _path_params: Dict[str, str] = {}
780
+ _query_params: List[Tuple[str, str]] = []
781
+ _header_params: Dict[str, Optional[str]] = _headers or {}
782
+ _form_params: List[Tuple[str, str]] = []
783
+ _files: Dict[
784
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
785
+ ] = {}
786
+ _body_params: Optional[bytes] = None
787
+
788
+ # process the path parameters
789
+ # process the query parameters
790
+ # process the header parameters
791
+ # process the form parameters
792
+ # process the body parameter
793
+
794
+
795
+ # set the HTTP header `Accept`
796
+ if 'Accept' not in _header_params:
797
+ _header_params['Accept'] = self.api_client.select_header_accept(
798
+ [
799
+ 'application/json'
800
+ ]
801
+ )
802
+
803
+
804
+ # authentication setting
805
+ _auth_settings: List[str] = [
806
+ 'apiKey'
807
+ ]
808
+
809
+ return self.api_client.param_serialize(
810
+ method='GET',
811
+ resource_path='/auth/me/mfa',
812
+ path_params=_path_params,
813
+ query_params=_query_params,
814
+ header_params=_header_params,
815
+ body=_body_params,
816
+ post_params=_form_params,
817
+ files=_files,
818
+ auth_settings=_auth_settings,
819
+ collection_formats=_collection_formats,
820
+ _host=_host,
821
+ _request_auth=_request_auth
822
+ )
823
+
824
+
825
+
826
+
827
+ @validate_call
828
+ def get_user_organizations(
829
+ self,
830
+ _request_timeout: Union[
831
+ None,
832
+ Annotated[StrictFloat, Field(gt=0)],
833
+ Tuple[
834
+ Annotated[StrictFloat, Field(gt=0)],
835
+ Annotated[StrictFloat, Field(gt=0)]
836
+ ]
837
+ ] = None,
838
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
839
+ _content_type: Optional[StrictStr] = None,
840
+ _headers: Optional[Dict[StrictStr, Any]] = None,
841
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
842
+ ) -> UserOrganizationsResponse:
843
+ """Get User Organizations
844
+
845
+ Retrieve the organizations associated with a user by their user ID. This endpoint is useful for understanding the user's organizational affiliations.
846
+
847
+ :param _request_timeout: timeout setting for this request. If one
848
+ number provided, it will be total request
849
+ timeout. It can also be a pair (tuple) of
850
+ (connection, read) timeouts.
851
+ :type _request_timeout: int, tuple(int, int), optional
852
+ :param _request_auth: set to override the auth_settings for an a single
853
+ request; this effectively ignores the
854
+ authentication in the spec for a single request.
855
+ :type _request_auth: dict, optional
856
+ :param _content_type: force content-type for the request.
857
+ :type _content_type: str, Optional
858
+ :param _headers: set to override the headers for a single
859
+ request; this effectively ignores the headers
860
+ in the spec for a single request.
861
+ :type _headers: dict, optional
862
+ :param _host_index: set to override the host_index for a single
863
+ request; this effectively ignores the host_index
864
+ in the spec for a single request.
865
+ :type _host_index: int, optional
866
+ :return: Returns the result object.
867
+ """ # noqa: E501
868
+
869
+ _param = self._get_user_organizations_serialize(
870
+ _request_auth=_request_auth,
871
+ _content_type=_content_type,
872
+ _headers=_headers,
873
+ _host_index=_host_index
874
+ )
875
+
876
+ _response_types_map: Dict[str, Optional[str]] = {
877
+ '200': "UserOrganizationsResponse",
878
+ '400': "ErrorResponseModel",
879
+ '401': "ErrorResponseModel",
880
+ '404': "ErrorResponseModel",
881
+ '500': None,
882
+ }
883
+ response_data = self.api_client.call_api(
884
+ *_param,
885
+ _request_timeout=_request_timeout
886
+ )
887
+ response_data.read()
888
+ return self.api_client.response_deserialize(
889
+ response_data=response_data,
890
+ response_types_map=_response_types_map,
891
+ ).data
892
+
893
+
894
+ @validate_call
895
+ def get_user_organizations_with_http_info(
896
+ self,
897
+ _request_timeout: Union[
898
+ None,
899
+ Annotated[StrictFloat, Field(gt=0)],
900
+ Tuple[
901
+ Annotated[StrictFloat, Field(gt=0)],
902
+ Annotated[StrictFloat, Field(gt=0)]
903
+ ]
904
+ ] = None,
905
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
906
+ _content_type: Optional[StrictStr] = None,
907
+ _headers: Optional[Dict[StrictStr, Any]] = None,
908
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
909
+ ) -> ApiResponse[UserOrganizationsResponse]:
910
+ """Get User Organizations
911
+
912
+ Retrieve the organizations associated with a user by their user ID. This endpoint is useful for understanding the user's organizational affiliations.
913
+
914
+ :param _request_timeout: timeout setting for this request. If one
915
+ number provided, it will be total request
916
+ timeout. It can also be a pair (tuple) of
917
+ (connection, read) timeouts.
918
+ :type _request_timeout: int, tuple(int, int), optional
919
+ :param _request_auth: set to override the auth_settings for an a single
920
+ request; this effectively ignores the
921
+ authentication in the spec for a single request.
922
+ :type _request_auth: dict, optional
923
+ :param _content_type: force content-type for the request.
924
+ :type _content_type: str, Optional
925
+ :param _headers: set to override the headers for a single
926
+ request; this effectively ignores the headers
927
+ in the spec for a single request.
928
+ :type _headers: dict, optional
929
+ :param _host_index: set to override the host_index for a single
930
+ request; this effectively ignores the host_index
931
+ in the spec for a single request.
932
+ :type _host_index: int, optional
933
+ :return: Returns the result object.
934
+ """ # noqa: E501
935
+
936
+ _param = self._get_user_organizations_serialize(
937
+ _request_auth=_request_auth,
938
+ _content_type=_content_type,
939
+ _headers=_headers,
940
+ _host_index=_host_index
941
+ )
942
+
943
+ _response_types_map: Dict[str, Optional[str]] = {
944
+ '200': "UserOrganizationsResponse",
945
+ '400': "ErrorResponseModel",
946
+ '401': "ErrorResponseModel",
947
+ '404': "ErrorResponseModel",
948
+ '500': None,
949
+ }
950
+ response_data = self.api_client.call_api(
951
+ *_param,
952
+ _request_timeout=_request_timeout
953
+ )
954
+ response_data.read()
955
+ return self.api_client.response_deserialize(
956
+ response_data=response_data,
957
+ response_types_map=_response_types_map,
958
+ )
959
+
960
+
961
+ @validate_call
962
+ def get_user_organizations_without_preload_content(
963
+ self,
964
+ _request_timeout: Union[
965
+ None,
966
+ Annotated[StrictFloat, Field(gt=0)],
967
+ Tuple[
968
+ Annotated[StrictFloat, Field(gt=0)],
969
+ Annotated[StrictFloat, Field(gt=0)]
970
+ ]
971
+ ] = None,
972
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
973
+ _content_type: Optional[StrictStr] = None,
974
+ _headers: Optional[Dict[StrictStr, Any]] = None,
975
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
976
+ ) -> RESTResponseType:
977
+ """Get User Organizations
978
+
979
+ Retrieve the organizations associated with a user by their user ID. This endpoint is useful for understanding the user's organizational affiliations.
980
+
981
+ :param _request_timeout: timeout setting for this request. If one
982
+ number provided, it will be total request
983
+ timeout. It can also be a pair (tuple) of
984
+ (connection, read) timeouts.
985
+ :type _request_timeout: int, tuple(int, int), optional
986
+ :param _request_auth: set to override the auth_settings for an a single
987
+ request; this effectively ignores the
988
+ authentication in the spec for a single request.
989
+ :type _request_auth: dict, optional
990
+ :param _content_type: force content-type for the request.
991
+ :type _content_type: str, Optional
992
+ :param _headers: set to override the headers for a single
993
+ request; this effectively ignores the headers
994
+ in the spec for a single request.
995
+ :type _headers: dict, optional
996
+ :param _host_index: set to override the host_index for a single
997
+ request; this effectively ignores the host_index
998
+ in the spec for a single request.
999
+ :type _host_index: int, optional
1000
+ :return: Returns the result object.
1001
+ """ # noqa: E501
1002
+
1003
+ _param = self._get_user_organizations_serialize(
1004
+ _request_auth=_request_auth,
1005
+ _content_type=_content_type,
1006
+ _headers=_headers,
1007
+ _host_index=_host_index
1008
+ )
1009
+
1010
+ _response_types_map: Dict[str, Optional[str]] = {
1011
+ '200': "UserOrganizationsResponse",
1012
+ '400': "ErrorResponseModel",
1013
+ '401': "ErrorResponseModel",
1014
+ '404': "ErrorResponseModel",
1015
+ '500': None,
1016
+ }
1017
+ response_data = self.api_client.call_api(
1018
+ *_param,
1019
+ _request_timeout=_request_timeout
1020
+ )
1021
+ return response_data.response
1022
+
1023
+
1024
+ def _get_user_organizations_serialize(
1025
+ self,
1026
+ _request_auth,
1027
+ _content_type,
1028
+ _headers,
1029
+ _host_index,
1030
+ ) -> RequestSerialized:
1031
+
1032
+ _host = None
1033
+
1034
+ _collection_formats: Dict[str, str] = {
1035
+ }
1036
+
1037
+ _path_params: Dict[str, str] = {}
1038
+ _query_params: List[Tuple[str, str]] = []
1039
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1040
+ _form_params: List[Tuple[str, str]] = []
1041
+ _files: Dict[
1042
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1043
+ ] = {}
1044
+ _body_params: Optional[bytes] = None
1045
+
1046
+ # process the path parameters
1047
+ # process the query parameters
1048
+ # process the header parameters
1049
+ # process the form parameters
1050
+ # process the body parameter
1051
+
1052
+
1053
+ # set the HTTP header `Accept`
1054
+ if 'Accept' not in _header_params:
1055
+ _header_params['Accept'] = self.api_client.select_header_accept(
1056
+ [
1057
+ 'application/json'
1058
+ ]
1059
+ )
1060
+
1061
+
1062
+ # authentication setting
1063
+ _auth_settings: List[str] = [
1064
+ 'apiKey'
1065
+ ]
1066
+
1067
+ return self.api_client.param_serialize(
1068
+ method='GET',
1069
+ resource_path='/auth/me/organizations',
1070
+ path_params=_path_params,
1071
+ query_params=_query_params,
1072
+ header_params=_header_params,
1073
+ body=_body_params,
1074
+ post_params=_form_params,
1075
+ files=_files,
1076
+ auth_settings=_auth_settings,
1077
+ collection_formats=_collection_formats,
1078
+ _host=_host,
1079
+ _request_auth=_request_auth
1080
+ )
1081
+
1082
+
1083
+
1084
+
39
1085
  @validate_call
40
1086
  def retrieve_authenticated_user_details(
41
1087
  self,
@@ -54,7 +1100,7 @@ class AuthApi:
54
1100
  ) -> AuthUserInfoResponseModel:
55
1101
  """Retrieve Authenticated User Details
56
1102
 
57
- Retrieves detailed information about the currently authenticated user. For additional information, [**click here**](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/auth).
1103
+ Retrieves detailed information about the currently authenticated user. For additional information, [**click here**](https://docs...cloud/docs/api-reference/auth-resources/auth).
58
1104
 
59
1105
  :param _request_timeout: timeout setting for this request. If one
60
1106
  number provided, it will be total request
@@ -120,7 +1166,7 @@ class AuthApi:
120
1166
  ) -> ApiResponse[AuthUserInfoResponseModel]:
121
1167
  """Retrieve Authenticated User Details
122
1168
 
123
- Retrieves detailed information about the currently authenticated user. For additional information, [**click here**](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/auth).
1169
+ Retrieves detailed information about the currently authenticated user. For additional information, [**click here**](https://docs...cloud/docs/api-reference/auth-resources/auth).
124
1170
 
125
1171
  :param _request_timeout: timeout setting for this request. If one
126
1172
  number provided, it will be total request
@@ -186,7 +1232,7 @@ class AuthApi:
186
1232
  ) -> RESTResponseType:
187
1233
  """Retrieve Authenticated User Details
188
1234
 
189
- Retrieves detailed information about the currently authenticated user. For additional information, [**click here**](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/auth).
1235
+ Retrieves detailed information about the currently authenticated user. For additional information, [**click here**](https://docs...cloud/docs/api-reference/auth-resources/auth).
190
1236
 
191
1237
  :param _request_timeout: timeout setting for this request. If one
192
1238
  number provided, it will be total request
@@ -270,8 +1316,7 @@ class AuthApi:
270
1316
 
271
1317
  # authentication setting
272
1318
  _auth_settings: List[str] = [
273
- 'apiKey',
274
- 'accessToken'
1319
+ 'apiKey'
275
1320
  ]
276
1321
 
277
1322
  return self.api_client.param_serialize(