zitadel-client 4.1.0.beta.7 → 4.1.0.beta.8

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 (238) hide show
  1. checksums.yaml +4 -4
  2. data/lib/zitadel/client/api/action_service_api.rb +22 -22
  3. data/lib/zitadel/client/api/beta_action_service_api.rb +22 -22
  4. data/lib/zitadel/client/api/beta_app_service_api.rb +28 -28
  5. data/lib/zitadel/client/api/beta_authorization_service_api.rb +12 -12
  6. data/lib/zitadel/client/api/beta_instance_service_api.rb +20 -20
  7. data/lib/zitadel/client/api/beta_internal_permission_service_api.rb +8 -8
  8. data/lib/zitadel/client/api/beta_o_i_d_c_service_api.rb +1 -1
  9. data/lib/zitadel/client/api/beta_organization_service_api.rb +28 -28
  10. data/lib/zitadel/client/api/beta_project_service_api.rb +34 -34
  11. data/lib/zitadel/client/api/beta_session_service_api.rb +5 -5
  12. data/lib/zitadel/client/api/beta_settings_service_api.rb +11 -11
  13. data/lib/zitadel/client/api/beta_telemetry_service_api.rb +2 -2
  14. data/lib/zitadel/client/api/beta_user_service_api.rb +77 -77
  15. data/lib/zitadel/client/api/beta_web_key_service_api.rb +8 -8
  16. data/lib/zitadel/client/api/feature_service_api.rb +24 -24
  17. data/lib/zitadel/client/api/identity_provider_service_api.rb +2 -2
  18. data/lib/zitadel/client/api/o_i_d_c_service_api.rb +6 -6
  19. data/lib/zitadel/client/api/organization_service_api.rb +4 -4
  20. data/lib/zitadel/client/api/s_a_m_l_service_api.rb +1 -1
  21. data/lib/zitadel/client/api/session_service_api.rb +5 -5
  22. data/lib/zitadel/client/api/settings_service_api.rb +17 -17
  23. data/lib/zitadel/client/api/user_service_api.rb +125 -125
  24. data/lib/zitadel/client/api/web_key_service_api.rb +8 -8
  25. data/lib/zitadel/client/models/action_service_any.rb +7 -5
  26. data/lib/zitadel/client/models/action_service_connect_error.rb +10 -7
  27. data/lib/zitadel/client/models/action_service_delete_target_request.rb +0 -12
  28. data/lib/zitadel/client/models/beta_action_service_any.rb +7 -5
  29. data/lib/zitadel/client/models/beta_action_service_connect_error.rb +10 -7
  30. data/lib/zitadel/client/models/beta_action_service_delete_target_request.rb +0 -12
  31. data/lib/zitadel/client/models/beta_app_service_any.rb +7 -5
  32. data/lib/zitadel/client/models/beta_app_service_connect_error.rb +10 -7
  33. data/lib/zitadel/client/models/beta_app_service_create_application_request.rb +0 -12
  34. data/lib/zitadel/client/models/beta_app_service_get_application_request.rb +0 -12
  35. data/lib/zitadel/client/models/beta_app_service_update_application_request.rb +0 -12
  36. data/lib/zitadel/client/models/beta_authorization_service_any.rb +7 -5
  37. data/lib/zitadel/client/models/beta_authorization_service_connect_error.rb +10 -7
  38. data/lib/zitadel/client/models/beta_feature_service_any.rb +7 -5
  39. data/lib/zitadel/client/models/beta_feature_service_connect_error.rb +10 -7
  40. data/lib/zitadel/client/models/beta_instance_service_add_trusted_domain_request.rb +0 -12
  41. data/lib/zitadel/client/models/beta_instance_service_any.rb +7 -5
  42. data/lib/zitadel/client/models/beta_instance_service_connect_error.rb +10 -7
  43. data/lib/zitadel/client/models/beta_instance_service_remove_trusted_domain_request.rb +0 -12
  44. data/lib/zitadel/client/models/beta_internal_permission_service_any.rb +7 -5
  45. data/lib/zitadel/client/models/beta_internal_permission_service_connect_error.rb +10 -7
  46. data/lib/zitadel/client/models/beta_o_i_d_c_service_any.rb +7 -5
  47. data/lib/zitadel/client/models/beta_o_i_d_c_service_connect_error.rb +10 -7
  48. data/lib/zitadel/client/models/beta_organization_service_add_human_user_request.rb +0 -24
  49. data/lib/zitadel/client/models/beta_organization_service_add_organization_domain_request.rb +0 -24
  50. data/lib/zitadel/client/models/beta_organization_service_any.rb +7 -5
  51. data/lib/zitadel/client/models/beta_organization_service_connect_error.rb +10 -7
  52. data/lib/zitadel/client/models/beta_organization_service_create_organization_request.rb +0 -12
  53. data/lib/zitadel/client/models/beta_organization_service_create_organization_response.rb +0 -12
  54. data/lib/zitadel/client/models/beta_organization_service_delete_organization_domain_request.rb +0 -24
  55. data/lib/zitadel/client/models/beta_organization_service_delete_organization_metadata_request.rb +0 -12
  56. data/lib/zitadel/client/models/beta_organization_service_delete_organization_request.rb +0 -12
  57. data/lib/zitadel/client/models/beta_organization_service_generate_organization_domain_validation_request.rb +0 -24
  58. data/lib/zitadel/client/models/beta_organization_service_hashed_password.rb +0 -12
  59. data/lib/zitadel/client/models/beta_organization_service_list_organization_domains_request.rb +0 -12
  60. data/lib/zitadel/client/models/beta_organization_service_list_organization_metadata_request.rb +0 -12
  61. data/lib/zitadel/client/models/beta_organization_service_password.rb +0 -12
  62. data/lib/zitadel/client/models/beta_organization_service_set_human_email.rb +0 -12
  63. data/lib/zitadel/client/models/beta_organization_service_set_human_profile.rb +0 -24
  64. data/lib/zitadel/client/models/beta_organization_service_set_metadata_entry.rb +0 -24
  65. data/lib/zitadel/client/models/beta_organization_service_set_organization_metadata_request.rb +0 -12
  66. data/lib/zitadel/client/models/beta_organization_service_update_organization_request.rb +0 -24
  67. data/lib/zitadel/client/models/beta_organization_service_verify_organization_domain_request.rb +0 -12
  68. data/lib/zitadel/client/models/beta_project_service_activate_project_grant_request.rb +0 -24
  69. data/lib/zitadel/client/models/beta_project_service_activate_project_request.rb +0 -12
  70. data/lib/zitadel/client/models/beta_project_service_add_project_role_request.rb +0 -36
  71. data/lib/zitadel/client/models/beta_project_service_admin.rb +227 -0
  72. data/lib/zitadel/client/models/beta_project_service_any.rb +7 -5
  73. data/lib/zitadel/client/models/beta_project_service_connect_error.rb +10 -7
  74. data/lib/zitadel/client/models/beta_project_service_create_project_grant_request.rb +0 -24
  75. data/lib/zitadel/client/models/beta_project_service_create_project_request.rb +14 -14
  76. data/lib/zitadel/client/models/beta_project_service_deactivate_project_grant_request.rb +0 -24
  77. data/lib/zitadel/client/models/beta_project_service_deactivate_project_request.rb +0 -12
  78. data/lib/zitadel/client/models/beta_project_service_delete_project_grant_request.rb +0 -24
  79. data/lib/zitadel/client/models/beta_project_service_delete_project_request.rb +0 -12
  80. data/lib/zitadel/client/models/beta_project_service_list_project_roles_request.rb +0 -12
  81. data/lib/zitadel/client/models/beta_project_service_remove_project_role_request.rb +0 -24
  82. data/lib/zitadel/client/models/beta_project_service_update_project_grant_request.rb +0 -24
  83. data/lib/zitadel/client/models/beta_project_service_update_project_request.rb +0 -12
  84. data/lib/zitadel/client/models/beta_project_service_update_project_role_request.rb +0 -26
  85. data/lib/zitadel/client/models/beta_session_service_any.rb +7 -5
  86. data/lib/zitadel/client/models/beta_session_service_check_web_auth_n.rb +0 -12
  87. data/lib/zitadel/client/models/beta_session_service_connect_error.rb +10 -7
  88. data/lib/zitadel/client/models/beta_session_service_web_auth_n.rb +0 -24
  89. data/lib/zitadel/client/models/beta_settings_service_any.rb +7 -5
  90. data/lib/zitadel/client/models/beta_settings_service_connect_error.rb +10 -7
  91. data/lib/zitadel/client/models/beta_telemetry_service_any.rb +7 -5
  92. data/lib/zitadel/client/models/beta_telemetry_service_connect_error.rb +10 -7
  93. data/lib/zitadel/client/models/beta_user_service_add_human_user_request.rb +0 -24
  94. data/lib/zitadel/client/models/beta_user_service_add_i_d_p_link_request.rb +0 -12
  95. data/lib/zitadel/client/models/beta_user_service_add_o_t_p_email_request.rb +0 -12
  96. data/lib/zitadel/client/models/beta_user_service_add_o_t_p_s_m_s_request.rb +0 -12
  97. data/lib/zitadel/client/models/beta_user_service_any.rb +7 -5
  98. data/lib/zitadel/client/models/beta_user_service_connect_error.rb +10 -7
  99. data/lib/zitadel/client/models/beta_user_service_create_passkey_registration_link_request.rb +0 -12
  100. data/lib/zitadel/client/models/beta_user_service_deactivate_user_request.rb +0 -12
  101. data/lib/zitadel/client/models/beta_user_service_delete_user_request.rb +0 -12
  102. data/lib/zitadel/client/models/beta_user_service_display_name_query.rb +0 -12
  103. data/lib/zitadel/client/models/beta_user_service_email_query.rb +0 -12
  104. data/lib/zitadel/client/models/beta_user_service_first_name_query.rb +0 -12
  105. data/lib/zitadel/client/models/beta_user_service_get_user_by_i_d_request.rb +0 -12
  106. data/lib/zitadel/client/models/beta_user_service_hashed_password.rb +0 -12
  107. data/lib/zitadel/client/models/beta_user_service_last_name_query.rb +0 -12
  108. data/lib/zitadel/client/models/beta_user_service_list_authentication_method_types_request.rb +0 -12
  109. data/lib/zitadel/client/models/beta_user_service_lock_user_request.rb +0 -12
  110. data/lib/zitadel/client/models/beta_user_service_login_name_query.rb +0 -12
  111. data/lib/zitadel/client/models/beta_user_service_nick_name_query.rb +0 -12
  112. data/lib/zitadel/client/models/beta_user_service_organization_id_query.rb +0 -12
  113. data/lib/zitadel/client/models/beta_user_service_passkey_registration_code.rb +0 -24
  114. data/lib/zitadel/client/models/beta_user_service_password.rb +0 -12
  115. data/lib/zitadel/client/models/beta_user_service_password_reset_request.rb +0 -12
  116. data/lib/zitadel/client/models/beta_user_service_phone_query.rb +0 -12
  117. data/lib/zitadel/client/models/beta_user_service_reactivate_user_request.rb +0 -12
  118. data/lib/zitadel/client/models/beta_user_service_register_passkey_request.rb +0 -12
  119. data/lib/zitadel/client/models/beta_user_service_register_t_o_t_p_request.rb +0 -12
  120. data/lib/zitadel/client/models/beta_user_service_register_u2_f_request.rb +0 -12
  121. data/lib/zitadel/client/models/beta_user_service_remove_o_t_p_email_request.rb +0 -12
  122. data/lib/zitadel/client/models/beta_user_service_remove_o_t_p_s_m_s_request.rb +0 -12
  123. data/lib/zitadel/client/models/beta_user_service_remove_phone_request.rb +0 -12
  124. data/lib/zitadel/client/models/beta_user_service_remove_t_o_t_p_request.rb +0 -12
  125. data/lib/zitadel/client/models/beta_user_service_resend_email_code_request.rb +0 -12
  126. data/lib/zitadel/client/models/beta_user_service_resend_phone_code_request.rb +0 -12
  127. data/lib/zitadel/client/models/beta_user_service_set_email_request.rb +0 -24
  128. data/lib/zitadel/client/models/beta_user_service_set_human_email.rb +0 -12
  129. data/lib/zitadel/client/models/beta_user_service_set_human_profile.rb +0 -24
  130. data/lib/zitadel/client/models/beta_user_service_set_metadata_entry.rb +0 -24
  131. data/lib/zitadel/client/models/beta_user_service_set_password_request.rb +0 -12
  132. data/lib/zitadel/client/models/beta_user_service_set_phone_request.rb +0 -24
  133. data/lib/zitadel/client/models/beta_user_service_state_query.rb +0 -12
  134. data/lib/zitadel/client/models/beta_user_service_type_query.rb +0 -12
  135. data/lib/zitadel/client/models/beta_user_service_unlock_user_request.rb +0 -12
  136. data/lib/zitadel/client/models/beta_user_service_user_name_query.rb +0 -12
  137. data/lib/zitadel/client/models/beta_user_service_verify_email_request.rb +0 -24
  138. data/lib/zitadel/client/models/beta_user_service_verify_passkey_registration_request.rb +0 -48
  139. data/lib/zitadel/client/models/beta_user_service_verify_phone_request.rb +0 -24
  140. data/lib/zitadel/client/models/beta_user_service_verify_t_o_t_p_registration_request.rb +0 -24
  141. data/lib/zitadel/client/models/beta_user_service_verify_u2_f_registration_request.rb +0 -48
  142. data/lib/zitadel/client/models/beta_web_key_service_activate_web_key_request.rb +0 -12
  143. data/lib/zitadel/client/models/beta_web_key_service_any.rb +7 -5
  144. data/lib/zitadel/client/models/beta_web_key_service_connect_error.rb +10 -7
  145. data/lib/zitadel/client/models/beta_web_key_service_delete_web_key_request.rb +0 -12
  146. data/lib/zitadel/client/models/feature_service_any.rb +7 -5
  147. data/lib/zitadel/client/models/feature_service_connect_error.rb +10 -7
  148. data/lib/zitadel/client/models/identity_provider_service_any.rb +7 -5
  149. data/lib/zitadel/client/models/identity_provider_service_connect_error.rb +10 -7
  150. data/lib/zitadel/client/models/o_i_d_c_service_any.rb +7 -5
  151. data/lib/zitadel/client/models/o_i_d_c_service_connect_error.rb +10 -7
  152. data/lib/zitadel/client/models/organization_service_add_human_user_request.rb +0 -24
  153. data/lib/zitadel/client/models/organization_service_add_organization_request.rb +0 -12
  154. data/lib/zitadel/client/models/organization_service_any.rb +7 -5
  155. data/lib/zitadel/client/models/organization_service_connect_error.rb +10 -7
  156. data/lib/zitadel/client/models/organization_service_hashed_password.rb +0 -12
  157. data/lib/zitadel/client/models/organization_service_organization_domain_query.rb +0 -12
  158. data/lib/zitadel/client/models/organization_service_organization_i_d_query.rb +0 -12
  159. data/lib/zitadel/client/models/organization_service_organization_name_query.rb +0 -12
  160. data/lib/zitadel/client/models/organization_service_password.rb +0 -12
  161. data/lib/zitadel/client/models/organization_service_set_human_email.rb +0 -12
  162. data/lib/zitadel/client/models/organization_service_set_human_profile.rb +0 -24
  163. data/lib/zitadel/client/models/organization_service_set_metadata_entry.rb +0 -24
  164. data/lib/zitadel/client/models/s_a_m_l_service_any.rb +7 -5
  165. data/lib/zitadel/client/models/s_a_m_l_service_connect_error.rb +10 -7
  166. data/lib/zitadel/client/models/session_service_any.rb +7 -5
  167. data/lib/zitadel/client/models/session_service_check_web_auth_n.rb +0 -12
  168. data/lib/zitadel/client/models/session_service_connect_error.rb +10 -7
  169. data/lib/zitadel/client/models/session_service_web_auth_n.rb +0 -24
  170. data/lib/zitadel/client/models/settings_service_any.rb +7 -5
  171. data/lib/zitadel/client/models/settings_service_connect_error.rb +10 -7
  172. data/lib/zitadel/client/models/user_service_add_human_user_request.rb +0 -24
  173. data/lib/zitadel/client/models/user_service_add_i_d_p_link_request.rb +0 -12
  174. data/lib/zitadel/client/models/user_service_add_o_t_p_email_request.rb +0 -12
  175. data/lib/zitadel/client/models/user_service_add_o_t_p_s_m_s_request.rb +0 -12
  176. data/lib/zitadel/client/models/user_service_any.rb +7 -5
  177. data/lib/zitadel/client/models/user_service_connect_error.rb +10 -7
  178. data/lib/zitadel/client/models/user_service_create_invite_code_request.rb +0 -12
  179. data/lib/zitadel/client/models/user_service_create_passkey_registration_link_request.rb +0 -12
  180. data/lib/zitadel/client/models/user_service_deactivate_user_request.rb +0 -12
  181. data/lib/zitadel/client/models/user_service_delete_user_request.rb +0 -12
  182. data/lib/zitadel/client/models/user_service_display_name_query.rb +0 -12
  183. data/lib/zitadel/client/models/user_service_email_query.rb +0 -12
  184. data/lib/zitadel/client/models/user_service_first_name_query.rb +0 -12
  185. data/lib/zitadel/client/models/user_service_get_user_by_i_d_request.rb +0 -12
  186. data/lib/zitadel/client/models/user_service_hashed_password.rb +0 -12
  187. data/lib/zitadel/client/models/user_service_human_m_f_a_init_skipped_request.rb +0 -12
  188. data/lib/zitadel/client/models/user_service_last_name_query.rb +0 -12
  189. data/lib/zitadel/client/models/user_service_list_authentication_factors_request.rb +0 -12
  190. data/lib/zitadel/client/models/user_service_list_authentication_method_types_request.rb +0 -12
  191. data/lib/zitadel/client/models/user_service_list_passkeys_request.rb +0 -12
  192. data/lib/zitadel/client/models/user_service_list_user_metadata_request.rb +0 -12
  193. data/lib/zitadel/client/models/user_service_lock_user_request.rb +0 -12
  194. data/lib/zitadel/client/models/user_service_login_name_query.rb +0 -12
  195. data/lib/zitadel/client/models/user_service_nick_name_query.rb +0 -12
  196. data/lib/zitadel/client/models/user_service_organization_id_query.rb +0 -12
  197. data/lib/zitadel/client/models/user_service_passkey_registration_code.rb +0 -24
  198. data/lib/zitadel/client/models/user_service_password.rb +0 -12
  199. data/lib/zitadel/client/models/user_service_password_reset_request.rb +0 -12
  200. data/lib/zitadel/client/models/user_service_phone_query.rb +0 -12
  201. data/lib/zitadel/client/models/user_service_reactivate_user_request.rb +0 -12
  202. data/lib/zitadel/client/models/user_service_register_passkey_request.rb +0 -12
  203. data/lib/zitadel/client/models/user_service_register_t_o_t_p_request.rb +0 -12
  204. data/lib/zitadel/client/models/user_service_register_u2_f_request.rb +0 -12
  205. data/lib/zitadel/client/models/user_service_remove_i_d_p_link_request.rb +0 -36
  206. data/lib/zitadel/client/models/user_service_remove_o_t_p_email_request.rb +0 -12
  207. data/lib/zitadel/client/models/user_service_remove_o_t_p_s_m_s_request.rb +0 -12
  208. data/lib/zitadel/client/models/user_service_remove_passkey_request.rb +0 -24
  209. data/lib/zitadel/client/models/user_service_remove_phone_request.rb +0 -12
  210. data/lib/zitadel/client/models/user_service_remove_t_o_t_p_request.rb +0 -12
  211. data/lib/zitadel/client/models/user_service_remove_u2_f_request.rb +0 -24
  212. data/lib/zitadel/client/models/user_service_resend_email_code_request.rb +0 -12
  213. data/lib/zitadel/client/models/user_service_resend_invite_code_request.rb +0 -12
  214. data/lib/zitadel/client/models/user_service_resend_phone_code_request.rb +0 -12
  215. data/lib/zitadel/client/models/user_service_send_email_code_request.rb +0 -12
  216. data/lib/zitadel/client/models/user_service_set_email_request.rb +0 -24
  217. data/lib/zitadel/client/models/user_service_set_human_email.rb +0 -12
  218. data/lib/zitadel/client/models/user_service_set_human_profile.rb +0 -24
  219. data/lib/zitadel/client/models/user_service_set_metadata_entry.rb +0 -24
  220. data/lib/zitadel/client/models/user_service_set_password_request.rb +0 -12
  221. data/lib/zitadel/client/models/user_service_set_phone_request.rb +0 -24
  222. data/lib/zitadel/client/models/user_service_set_user_metadata_request.rb +0 -12
  223. data/lib/zitadel/client/models/user_service_state_query.rb +0 -12
  224. data/lib/zitadel/client/models/user_service_type_query.rb +0 -12
  225. data/lib/zitadel/client/models/user_service_unlock_user_request.rb +0 -12
  226. data/lib/zitadel/client/models/user_service_user_name_query.rb +0 -12
  227. data/lib/zitadel/client/models/user_service_verify_email_request.rb +0 -24
  228. data/lib/zitadel/client/models/user_service_verify_invite_code_request.rb +0 -24
  229. data/lib/zitadel/client/models/user_service_verify_passkey_registration_request.rb +0 -48
  230. data/lib/zitadel/client/models/user_service_verify_phone_request.rb +0 -24
  231. data/lib/zitadel/client/models/user_service_verify_t_o_t_p_registration_request.rb +0 -24
  232. data/lib/zitadel/client/models/user_service_verify_u2_f_registration_request.rb +0 -48
  233. data/lib/zitadel/client/models/web_key_service_activate_web_key_request.rb +0 -12
  234. data/lib/zitadel/client/models/web_key_service_any.rb +7 -5
  235. data/lib/zitadel/client/models/web_key_service_connect_error.rb +10 -7
  236. data/lib/zitadel/client/models/web_key_service_delete_web_key_request.rb +0 -12
  237. data/lib/zitadel/client/version.rb +1 -1
  238. metadata +2 -1
@@ -19,12 +19,12 @@ module Zitadel::Client::Api
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # AddHumanUser
23
- # Create a new human user Deprecated: Use [CreateUser](apis/resources/user_service_v2/user-service-create-user.api.mdx) to create a new user of type human instead. Create/import a new user with the type human. The newly created user will get a verification email if either the email address is not marked as verified and you did not request the verification to be returned.
22
+ # Create a new human user
23
+ # Deprecated: Use [CreateUser](apis/resources/user_service_v2/user-service-create-user.api.mdx) to create a new user of type human instead. Create/import a new user with the type human. The newly created user will get a verification email if either the email address is not marked as verified and you did not request the verification to be returned.
24
24
  # @param user_service_add_human_user_request [UserServiceAddHumanUserRequest]
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @return [UserServiceAddHumanUserResponse]
27
- def add_human_user(user_service_add_human_user_request, opts = {})
27
+ def add_human_user(user_service_add_human_user_request = {}, opts = {})
28
28
  if @api_client.config.debugging
29
29
  @api_client.config.logger.debug 'Calling API: Api::UserServiceApi.add_human_user ...' # MODIFIED
30
30
  end
@@ -77,8 +77,8 @@ module Zitadel::Client::Api
77
77
  return data
78
78
  end
79
79
 
80
- # AddIDPLink
81
- # Add link to an identity provider to an user Add link to an identity provider to an user..
80
+ # Add link to an identity provider to an user
81
+ # Add link to an identity provider to an user..
82
82
  # @param user_service_add_idp_link_request [UserServiceAddIDPLinkRequest]
83
83
  # @param [Hash] opts the optional parameters
84
84
  # @return [UserServiceAddIDPLinkResponse]
@@ -135,8 +135,8 @@ module Zitadel::Client::Api
135
135
  return data
136
136
  end
137
137
 
138
- # AddKey
139
- # Add a Key Add a keys that can be used to securely authenticate at the Zitadel APIs using JWT profile authentication using short-lived tokens. Make sure you store the returned key safely, as you won't be able to read it from the Zitadel API anymore. Only users of type machine can have keys. Required permission: - user.write
138
+ # Add a Key
139
+ # Add a keys that can be used to securely authenticate at the Zitadel APIs using JWT profile authentication using short-lived tokens. Make sure you store the returned key safely, as you won't be able to read it from the Zitadel API anymore. Only users of type machine can have keys. Required permission: - user.write
140
140
  # @param user_service_add_key_request [UserServiceAddKeyRequest]
141
141
  # @param [Hash] opts the optional parameters
142
142
  # @return [UserServiceAddKeyResponse]
@@ -193,8 +193,8 @@ module Zitadel::Client::Api
193
193
  return data
194
194
  end
195
195
 
196
- # AddOTPEmail
197
- # Add OTP Email for a user Add a new One-Time Password (OTP) Email factor to the authenticated user. OTP Email will enable the user to verify a OTP with the latest verified email. The email has to be verified to add the second factor..
196
+ # Add OTP Email for a user
197
+ # Add a new One-Time Password (OTP) Email factor to the authenticated user. OTP Email will enable the user to verify a OTP with the latest verified email. The email has to be verified to add the second factor..
198
198
  # @param user_service_add_otp_email_request [UserServiceAddOTPEmailRequest]
199
199
  # @param [Hash] opts the optional parameters
200
200
  # @return [UserServiceAddOTPEmailResponse]
@@ -251,8 +251,8 @@ module Zitadel::Client::Api
251
251
  return data
252
252
  end
253
253
 
254
- # AddOTPSMS
255
- # Add OTP SMS for a user Add a new One-Time Password (OTP) SMS factor to the authenticated user. OTP SMS will enable the user to verify a OTP with the latest verified phone number. The phone number has to be verified to add the second factor..
254
+ # Add OTP SMS for a user
255
+ # Add a new One-Time Password (OTP) SMS factor to the authenticated user. OTP SMS will enable the user to verify a OTP with the latest verified phone number. The phone number has to be verified to add the second factor..
256
256
  # @param user_service_add_otpsms_request [UserServiceAddOTPSMSRequest]
257
257
  # @param [Hash] opts the optional parameters
258
258
  # @return [UserServiceAddOTPSMSResponse]
@@ -309,8 +309,8 @@ module Zitadel::Client::Api
309
309
  return data
310
310
  end
311
311
 
312
- # AddPersonalAccessToken
313
- # Add a Personal Access Token Personal access tokens (PAT) are the easiest way to authenticate to the Zitadel APIs. Make sure you store the returned PAT safely, as you won't be able to read it from the Zitadel API anymore. Only users of type machine can have personal access tokens. Required permission: - user.write
312
+ # Add a Personal Access Token
313
+ # Personal access tokens (PAT) are the easiest way to authenticate to the Zitadel APIs. Make sure you store the returned PAT safely, as you won't be able to read it from the Zitadel API anymore. Only users of type machine can have personal access tokens. Required permission: - user.write
314
314
  # @param user_service_add_personal_access_token_request [UserServiceAddPersonalAccessTokenRequest]
315
315
  # @param [Hash] opts the optional parameters
316
316
  # @return [UserServiceAddPersonalAccessTokenResponse]
@@ -367,8 +367,8 @@ module Zitadel::Client::Api
367
367
  return data
368
368
  end
369
369
 
370
- # AddSecret
371
- # Add a Users Secret Generates a client secret for the user. The client id is the users username. If the user already has a secret, it is overwritten. Only users of type machine can have a secret. Required permission: - user.write
370
+ # Add a Users Secret
371
+ # Generates a client secret for the user. The client id is the users username. If the user already has a secret, it is overwritten. Only users of type machine can have a secret. Required permission: - user.write
372
372
  # @param user_service_add_secret_request [UserServiceAddSecretRequest]
373
373
  # @param [Hash] opts the optional parameters
374
374
  # @return [UserServiceAddSecretResponse]
@@ -425,12 +425,12 @@ module Zitadel::Client::Api
425
425
  return data
426
426
  end
427
427
 
428
- # CreateInviteCode
429
- # Create an invite code for a user Create an invite code for a user to initialize their first authentication method (password, passkeys, IdP) depending on the organization's available methods. If an invite code has been created previously, it's url template and application name will be used as defaults for the new code. The new code will overwrite the previous one and make it invalid. Note: It is possible to reissue a new code only when the previous code has expired, or when the user provides a wrong code three or more times during verification.
428
+ # Create an invite code for a user
429
+ # Create an invite code for a user to initialize their first authentication method (password, passkeys, IdP) depending on the organization's available methods. If an invite code has been created previously, it's url template and application name will be used as defaults for the new code. The new code will overwrite the previous one and make it invalid. Note: It is possible to reissue a new code only when the previous code has expired, or when the user provides a wrong code three or more times during verification.
430
430
  # @param user_service_create_invite_code_request [UserServiceCreateInviteCodeRequest]
431
431
  # @param [Hash] opts the optional parameters
432
432
  # @return [UserServiceCreateInviteCodeResponse]
433
- def create_invite_code(user_service_create_invite_code_request, opts = {})
433
+ def create_invite_code(user_service_create_invite_code_request = {}, opts = {})
434
434
  if @api_client.config.debugging
435
435
  @api_client.config.logger.debug 'Calling API: Api::UserServiceApi.create_invite_code ...' # MODIFIED
436
436
  end
@@ -483,12 +483,12 @@ module Zitadel::Client::Api
483
483
  return data
484
484
  end
485
485
 
486
- # CreatePasskeyRegistrationLink
487
- # Create a passkey registration link for a user Create a passkey registration link which includes a code and either return it or send it to the user..
486
+ # Create a passkey registration link for a user
487
+ # Create a passkey registration link which includes a code and either return it or send it to the user..
488
488
  # @param user_service_create_passkey_registration_link_request [UserServiceCreatePasskeyRegistrationLinkRequest]
489
489
  # @param [Hash] opts the optional parameters
490
490
  # @return [UserServiceCreatePasskeyRegistrationLinkResponse]
491
- def create_passkey_registration_link(user_service_create_passkey_registration_link_request, opts = {})
491
+ def create_passkey_registration_link(user_service_create_passkey_registration_link_request = {}, opts = {})
492
492
  if @api_client.config.debugging
493
493
  @api_client.config.logger.debug 'Calling API: Api::UserServiceApi.create_passkey_registration_link ...' # MODIFIED
494
494
  end
@@ -541,12 +541,12 @@ module Zitadel::Client::Api
541
541
  return data
542
542
  end
543
543
 
544
- # CreateUser
545
- # Create a User Create a new human or machine user in the specified organization. Required permission: - user.write
544
+ # Create a User
545
+ # Create a new human or machine user in the specified organization. Required permission: - user.write
546
546
  # @param user_service_create_user_request [UserServiceCreateUserRequest]
547
547
  # @param [Hash] opts the optional parameters
548
548
  # @return [UserServiceCreateUserResponse]
549
- def create_user(user_service_create_user_request, opts = {})
549
+ def create_user(user_service_create_user_request = {}, opts = {})
550
550
  if @api_client.config.debugging
551
551
  @api_client.config.logger.debug 'Calling API: Api::UserServiceApi.create_user ...' # MODIFIED
552
552
  end
@@ -599,8 +599,8 @@ module Zitadel::Client::Api
599
599
  return data
600
600
  end
601
601
 
602
- # DeactivateUser
603
- # Deactivate user The state of the user will be changed to 'deactivated'. The user will not be able to log in anymore. The endpoint returns an error if the user is already in the state 'deactivated'. Use deactivate user when the user should not be able to use the account anymore, but you still need access to the user data..
602
+ # Deactivate user
603
+ # The state of the user will be changed to 'deactivated'. The user will not be able to log in anymore. The endpoint returns an error if the user is already in the state 'deactivated'. Use deactivate user when the user should not be able to use the account anymore, but you still need access to the user data..
604
604
  # @param user_service_deactivate_user_request [UserServiceDeactivateUserRequest]
605
605
  # @param [Hash] opts the optional parameters
606
606
  # @return [UserServiceDeactivateUserResponse]
@@ -657,8 +657,8 @@ module Zitadel::Client::Api
657
657
  return data
658
658
  end
659
659
 
660
- # DeleteUser
661
- # Delete user The state of the user will be changed to 'deleted'. The user will not be able to log in anymore. Endpoints requesting this user will return an error 'User not found..
660
+ # Delete user
661
+ # The state of the user will be changed to 'deleted'. The user will not be able to log in anymore. Endpoints requesting this user will return an error 'User not found..
662
662
  # @param user_service_delete_user_request [UserServiceDeleteUserRequest]
663
663
  # @param [Hash] opts the optional parameters
664
664
  # @return [UserServiceDeleteUserResponse]
@@ -715,8 +715,8 @@ module Zitadel::Client::Api
715
715
  return data
716
716
  end
717
717
 
718
- # DeleteUserMetadata
719
- # Delete User Metadata Delete metadata objects from an user with a specific key. Required permission: - `user.write`
718
+ # Delete User Metadata
719
+ # Delete metadata objects from an user with a specific key. Required permission: - `user.write`
720
720
  # @param user_service_delete_user_metadata_request [UserServiceDeleteUserMetadataRequest]
721
721
  # @param [Hash] opts the optional parameters
722
722
  # @return [UserServiceDeleteUserMetadataResponse]
@@ -773,8 +773,8 @@ module Zitadel::Client::Api
773
773
  return data
774
774
  end
775
775
 
776
- # GetUserByID
777
- # User by ID Returns the full user object (human or machine) including the profile, email, etc..
776
+ # User by ID
777
+ # Returns the full user object (human or machine) including the profile, email, etc..
778
778
  # @param user_service_get_user_by_id_request [UserServiceGetUserByIDRequest]
779
779
  # @param [Hash] opts the optional parameters
780
780
  # @return [UserServiceGetUserByIDResponse]
@@ -831,8 +831,8 @@ module Zitadel::Client::Api
831
831
  return data
832
832
  end
833
833
 
834
- # HumanMFAInitSkipped
835
- # MFA Init Skipped Update the last time the user has skipped MFA initialization. The server timestamp is used.
834
+ # MFA Init Skipped
835
+ # Update the last time the user has skipped MFA initialization. The server timestamp is used.
836
836
  # @param user_service_human_mfa_init_skipped_request [UserServiceHumanMFAInitSkippedRequest]
837
837
  # @param [Hash] opts the optional parameters
838
838
  # @return [UserServiceHumanMFAInitSkippedResponse]
@@ -946,8 +946,8 @@ module Zitadel::Client::Api
946
946
  return data
947
947
  end
948
948
 
949
- # ListAuthenticationMethodTypes
950
- # List all possible authentication methods of a user List all possible authentication methods of a user like password, passwordless, (T)OTP and more..
949
+ # List all possible authentication methods of a user
950
+ # List all possible authentication methods of a user like password, passwordless, (T)OTP and more..
951
951
  # @param user_service_list_authentication_method_types_request [UserServiceListAuthenticationMethodTypesRequest]
952
952
  # @param [Hash] opts the optional parameters
953
953
  # @return [UserServiceListAuthenticationMethodTypesResponse]
@@ -1004,8 +1004,8 @@ module Zitadel::Client::Api
1004
1004
  return data
1005
1005
  end
1006
1006
 
1007
- # ListIDPLinks
1008
- # List links to an identity provider of an user List links to an identity provider of an user.
1007
+ # List links to an identity provider of an user
1008
+ # List links to an identity provider of an user.
1009
1009
  # @param user_service_list_idp_links_request [UserServiceListIDPLinksRequest]
1010
1010
  # @param [Hash] opts the optional parameters
1011
1011
  # @return [UserServiceListIDPLinksResponse]
@@ -1062,8 +1062,8 @@ module Zitadel::Client::Api
1062
1062
  return data
1063
1063
  end
1064
1064
 
1065
- # ListKeys
1066
- # Search Keys List all matching keys. By default all keys of the instance on which the caller has permission to read the owning users are returned. Make sure to include a limit and sorting for pagination. Required permission: - user.read
1065
+ # Search Keys
1066
+ # List all matching keys. By default all keys of the instance on which the caller has permission to read the owning users are returned. Make sure to include a limit and sorting for pagination. Required permission: - user.read
1067
1067
  # @param user_service_list_keys_request [UserServiceListKeysRequest]
1068
1068
  # @param [Hash] opts the optional parameters
1069
1069
  # @return [UserServiceListKeysResponse]
@@ -1120,8 +1120,8 @@ module Zitadel::Client::Api
1120
1120
  return data
1121
1121
  end
1122
1122
 
1123
- # ListPasskeys
1124
- # List passkeys of an user List passkeys of an user
1123
+ # List passkeys of an user
1124
+ # List passkeys of an user
1125
1125
  # @param user_service_list_passkeys_request [UserServiceListPasskeysRequest]
1126
1126
  # @param [Hash] opts the optional parameters
1127
1127
  # @return [UserServiceListPasskeysResponse]
@@ -1178,8 +1178,8 @@ module Zitadel::Client::Api
1178
1178
  return data
1179
1179
  end
1180
1180
 
1181
- # ListPersonalAccessTokens
1182
- # Search Personal Access Tokens List all personal access tokens. By default all personal access tokens of the instance on which the caller has permission to read the owning users are returned. Make sure to include a limit and sorting for pagination. Required permission: - user.read
1181
+ # Search Personal Access Tokens
1182
+ # List all personal access tokens. By default all personal access tokens of the instance on which the caller has permission to read the owning users are returned. Make sure to include a limit and sorting for pagination. Required permission: - user.read
1183
1183
  # @param user_service_list_personal_access_tokens_request [UserServiceListPersonalAccessTokensRequest]
1184
1184
  # @param [Hash] opts the optional parameters
1185
1185
  # @return [UserServiceListPersonalAccessTokensResponse]
@@ -1236,8 +1236,8 @@ module Zitadel::Client::Api
1236
1236
  return data
1237
1237
  end
1238
1238
 
1239
- # ListUserMetadata
1240
- # List User Metadata List metadata of an user filtered by query. Required permission: - `user.read`
1239
+ # List User Metadata
1240
+ # List metadata of an user filtered by query. Required permission: - `user.read`
1241
1241
  # @param user_service_list_user_metadata_request [UserServiceListUserMetadataRequest]
1242
1242
  # @param [Hash] opts the optional parameters
1243
1243
  # @return [UserServiceListUserMetadataResponse]
@@ -1294,8 +1294,8 @@ module Zitadel::Client::Api
1294
1294
  return data
1295
1295
  end
1296
1296
 
1297
- # ListUsers
1298
- # Search Users Search for users. By default, we will return all users of your instance that you have permission to read. Make sure to include a limit and sorting for pagination.
1297
+ # Search Users
1298
+ # Search for users. By default, we will return all users of your instance that you have permission to read. Make sure to include a limit and sorting for pagination.
1299
1299
  # @param user_service_list_users_request [UserServiceListUsersRequest]
1300
1300
  # @param [Hash] opts the optional parameters
1301
1301
  # @return [UserServiceListUsersResponse]
@@ -1352,8 +1352,8 @@ module Zitadel::Client::Api
1352
1352
  return data
1353
1353
  end
1354
1354
 
1355
- # LockUser
1356
- # Lock user The state of the user will be changed to 'locked'. The user will not be able to log in anymore. The endpoint returns an error if the user is already in the state 'locked'. Use this endpoint if the user should not be able to log in temporarily because of an event that happened (wrong password, etc.)..
1355
+ # Lock user
1356
+ # The state of the user will be changed to 'locked'. The user will not be able to log in anymore. The endpoint returns an error if the user is already in the state 'locked'. Use this endpoint if the user should not be able to log in temporarily because of an event that happened (wrong password, etc.)..
1357
1357
  # @param user_service_lock_user_request [UserServiceLockUserRequest]
1358
1358
  # @param [Hash] opts the optional parameters
1359
1359
  # @return [UserServiceLockUserResponse]
@@ -1410,12 +1410,12 @@ module Zitadel::Client::Api
1410
1410
  return data
1411
1411
  end
1412
1412
 
1413
- # PasswordReset
1414
- # Request a code to reset a password Request a code to reset a password..
1413
+ # Request a code to reset a password
1414
+ # Request a code to reset a password..
1415
1415
  # @param user_service_password_reset_request [UserServicePasswordResetRequest]
1416
1416
  # @param [Hash] opts the optional parameters
1417
1417
  # @return [UserServicePasswordResetResponse]
1418
- def password_reset(user_service_password_reset_request, opts = {})
1418
+ def password_reset(user_service_password_reset_request = {}, opts = {})
1419
1419
  if @api_client.config.debugging
1420
1420
  @api_client.config.logger.debug 'Calling API: Api::UserServiceApi.password_reset ...' # MODIFIED
1421
1421
  end
@@ -1468,8 +1468,8 @@ module Zitadel::Client::Api
1468
1468
  return data
1469
1469
  end
1470
1470
 
1471
- # ReactivateUser
1472
- # Reactivate user Reactivate a user with the state 'deactivated'. The user will be able to log in again afterward. The endpoint returns an error if the user is not in the state 'deactivated'..
1471
+ # Reactivate user
1472
+ # Reactivate a user with the state 'deactivated'. The user will be able to log in again afterward. The endpoint returns an error if the user is not in the state 'deactivated'..
1473
1473
  # @param user_service_reactivate_user_request [UserServiceReactivateUserRequest]
1474
1474
  # @param [Hash] opts the optional parameters
1475
1475
  # @return [UserServiceReactivateUserResponse]
@@ -1526,8 +1526,8 @@ module Zitadel::Client::Api
1526
1526
  return data
1527
1527
  end
1528
1528
 
1529
- # RegisterPasskey
1530
- # Start the registration of passkey for a user Start the registration of a passkey for a user, as a response the public key credential creation options are returned, which are used to verify the passkey..
1529
+ # Start the registration of passkey for a user
1530
+ # Start the registration of a passkey for a user, as a response the public key credential creation options are returned, which are used to verify the passkey..
1531
1531
  # @param user_service_register_passkey_request [UserServiceRegisterPasskeyRequest]
1532
1532
  # @param [Hash] opts the optional parameters
1533
1533
  # @return [UserServiceRegisterPasskeyResponse]
@@ -1584,8 +1584,8 @@ module Zitadel::Client::Api
1584
1584
  return data
1585
1585
  end
1586
1586
 
1587
- # RegisterTOTP
1588
- # Start the registration of a TOTP generator for a user Start the registration of a TOTP generator for a user, as a response a secret returned, which is used to initialize a TOTP app or device..
1587
+ # Start the registration of a TOTP generator for a user
1588
+ # Start the registration of a TOTP generator for a user, as a response a secret returned, which is used to initialize a TOTP app or device..
1589
1589
  # @param user_service_register_totp_request [UserServiceRegisterTOTPRequest]
1590
1590
  # @param [Hash] opts the optional parameters
1591
1591
  # @return [UserServiceRegisterTOTPResponse]
@@ -1642,8 +1642,8 @@ module Zitadel::Client::Api
1642
1642
  return data
1643
1643
  end
1644
1644
 
1645
- # RegisterU2F
1646
- # Start the registration of a u2f token for a user Start the registration of a u2f token for a user, as a response the public key credential creation options are returned, which are used to verify the u2f token..
1645
+ # Start the registration of a u2f token for a user
1646
+ # Start the registration of a u2f token for a user, as a response the public key credential creation options are returned, which are used to verify the u2f token..
1647
1647
  # @param user_service_register_u2_f_request [UserServiceRegisterU2FRequest]
1648
1648
  # @param [Hash] opts the optional parameters
1649
1649
  # @return [UserServiceRegisterU2FResponse]
@@ -1700,8 +1700,8 @@ module Zitadel::Client::Api
1700
1700
  return data
1701
1701
  end
1702
1702
 
1703
- # RemoveIDPLink
1704
- # Remove link of an identity provider to an user Remove link of an identity provider to an user.
1703
+ # Remove link of an identity provider to an user
1704
+ # Remove link of an identity provider to an user.
1705
1705
  # @param user_service_remove_idp_link_request [UserServiceRemoveIDPLinkRequest]
1706
1706
  # @param [Hash] opts the optional parameters
1707
1707
  # @return [UserServiceRemoveIDPLinkResponse]
@@ -1758,8 +1758,8 @@ module Zitadel::Client::Api
1758
1758
  return data
1759
1759
  end
1760
1760
 
1761
- # RemoveKey
1762
- # Remove a Key Remove a machine users key by the given key ID and an optionally given user ID. Required permission: - user.write
1761
+ # Remove a Key
1762
+ # Remove a machine users key by the given key ID and an optionally given user ID. Required permission: - user.write
1763
1763
  # @param user_service_remove_key_request [UserServiceRemoveKeyRequest]
1764
1764
  # @param [Hash] opts the optional parameters
1765
1765
  # @return [UserServiceRemoveKeyResponse]
@@ -1816,8 +1816,8 @@ module Zitadel::Client::Api
1816
1816
  return data
1817
1817
  end
1818
1818
 
1819
- # RemoveOTPEmail
1820
- # Remove One-Time Password (OTP) Email from a user Remove the configured One-Time Password (OTP) Email factor of a user. As only one OTP Email per user is allowed, the user will not have OTP Email as a second factor afterward.
1819
+ # Remove One-Time Password (OTP) Email from a user
1820
+ # Remove the configured One-Time Password (OTP) Email factor of a user. As only one OTP Email per user is allowed, the user will not have OTP Email as a second factor afterward.
1821
1821
  # @param user_service_remove_otp_email_request [UserServiceRemoveOTPEmailRequest]
1822
1822
  # @param [Hash] opts the optional parameters
1823
1823
  # @return [UserServiceRemoveOTPEmailResponse]
@@ -1874,8 +1874,8 @@ module Zitadel::Client::Api
1874
1874
  return data
1875
1875
  end
1876
1876
 
1877
- # RemoveOTPSMS
1878
- # Remove One-Time Password (OTP) SMS from a user Remove the configured One-Time Password (OTP) SMS factor of a user. As only one OTP SMS per user is allowed, the user will not have OTP SMS as a second factor afterward.
1877
+ # Remove One-Time Password (OTP) SMS from a user
1878
+ # Remove the configured One-Time Password (OTP) SMS factor of a user. As only one OTP SMS per user is allowed, the user will not have OTP SMS as a second factor afterward.
1879
1879
  # @param user_service_remove_otpsms_request [UserServiceRemoveOTPSMSRequest]
1880
1880
  # @param [Hash] opts the optional parameters
1881
1881
  # @return [UserServiceRemoveOTPSMSResponse]
@@ -1932,8 +1932,8 @@ module Zitadel::Client::Api
1932
1932
  return data
1933
1933
  end
1934
1934
 
1935
- # RemovePasskey
1936
- # Remove passkey from a user Remove passkey from a user.
1935
+ # Remove passkey from a user
1936
+ # Remove passkey from a user.
1937
1937
  # @param user_service_remove_passkey_request [UserServiceRemovePasskeyRequest]
1938
1938
  # @param [Hash] opts the optional parameters
1939
1939
  # @return [UserServiceRemovePasskeyResponse]
@@ -1990,8 +1990,8 @@ module Zitadel::Client::Api
1990
1990
  return data
1991
1991
  end
1992
1992
 
1993
- # RemovePersonalAccessToken
1994
- # Remove a Personal Access Token Removes a machine users personal access token by the given token ID and an optionally given user ID. Required permission: - user.write
1993
+ # Remove a Personal Access Token
1994
+ # Removes a machine users personal access token by the given token ID and an optionally given user ID. Required permission: - user.write
1995
1995
  # @param user_service_remove_personal_access_token_request [UserServiceRemovePersonalAccessTokenRequest]
1996
1996
  # @param [Hash] opts the optional parameters
1997
1997
  # @return [UserServiceRemovePersonalAccessTokenResponse]
@@ -2048,8 +2048,8 @@ module Zitadel::Client::Api
2048
2048
  return data
2049
2049
  end
2050
2050
 
2051
- # RemovePhone
2052
- # Delete the user phone Deprecated: [Update the users phone field](apis/resources/user_service_v2/user-service-update-user.api.mdx) to remove the phone number. Delete the phone number of a user.
2051
+ # Delete the user phone
2052
+ # Deprecated: [Update the users phone field](apis/resources/user_service_v2/user-service-update-user.api.mdx) to remove the phone number. Delete the phone number of a user.
2053
2053
  # @param user_service_remove_phone_request [UserServiceRemovePhoneRequest]
2054
2054
  # @param [Hash] opts the optional parameters
2055
2055
  # @return [UserServiceRemovePhoneResponse]
@@ -2106,8 +2106,8 @@ module Zitadel::Client::Api
2106
2106
  return data
2107
2107
  end
2108
2108
 
2109
- # RemoveSecret
2110
- # Remove a Users Secret Remove the current client ID and client secret from a machine user. Required permission: - user.write
2109
+ # Remove a Users Secret
2110
+ # Remove the current client ID and client secret from a machine user. Required permission: - user.write
2111
2111
  # @param user_service_remove_secret_request [UserServiceRemoveSecretRequest]
2112
2112
  # @param [Hash] opts the optional parameters
2113
2113
  # @return [UserServiceRemoveSecretResponse]
@@ -2164,8 +2164,8 @@ module Zitadel::Client::Api
2164
2164
  return data
2165
2165
  end
2166
2166
 
2167
- # RemoveTOTP
2168
- # Remove TOTP generator from a user Remove the configured TOTP generator of a user. As only one TOTP generator per user is allowed, the user will not have TOTP as a second factor afterward.
2167
+ # Remove TOTP generator from a user
2168
+ # Remove the configured TOTP generator of a user. As only one TOTP generator per user is allowed, the user will not have TOTP as a second factor afterward.
2169
2169
  # @param user_service_remove_totp_request [UserServiceRemoveTOTPRequest]
2170
2170
  # @param [Hash] opts the optional parameters
2171
2171
  # @return [UserServiceRemoveTOTPResponse]
@@ -2222,8 +2222,8 @@ module Zitadel::Client::Api
2222
2222
  return data
2223
2223
  end
2224
2224
 
2225
- # RemoveU2F
2226
- # Remove u2f token from a user Remove u2f token from a user.
2225
+ # Remove u2f token from a user
2226
+ # Remove u2f token from a user.
2227
2227
  # @param user_service_remove_u2_f_request [UserServiceRemoveU2FRequest]
2228
2228
  # @param [Hash] opts the optional parameters
2229
2229
  # @return [UserServiceRemoveU2FResponse]
@@ -2280,12 +2280,12 @@ module Zitadel::Client::Api
2280
2280
  return data
2281
2281
  end
2282
2282
 
2283
- # ResendEmailCode
2283
+ # Resend code to verify user email
2284
2284
  # Resend code to verify user email
2285
2285
  # @param user_service_resend_email_code_request [UserServiceResendEmailCodeRequest]
2286
2286
  # @param [Hash] opts the optional parameters
2287
2287
  # @return [UserServiceResendEmailCodeResponse]
2288
- def resend_email_code(user_service_resend_email_code_request, opts = {})
2288
+ def resend_email_code(user_service_resend_email_code_request = {}, opts = {})
2289
2289
  if @api_client.config.debugging
2290
2290
  @api_client.config.logger.debug 'Calling API: Api::UserServiceApi.resend_email_code ...' # MODIFIED
2291
2291
  end
@@ -2338,8 +2338,8 @@ module Zitadel::Client::Api
2338
2338
  return data
2339
2339
  end
2340
2340
 
2341
- # ResendInviteCode
2342
- # Resend an invite code for a user Deprecated: Use [CreateInviteCode](apis/resources/user_service_v2/user-service-create-invite-code.api.mdx) instead. Resend an invite code for a user to initialize their first authentication method (password, passkeys, IdP) depending on the organization's available methods. A resend is only possible if a code has been created previously and sent to the user. If there is no code or it was directly returned, an error will be returned.
2341
+ # Resend an invite code for a user
2342
+ # Deprecated: Use [CreateInviteCode](apis/resources/user_service_v2/user-service-create-invite-code.api.mdx) instead. Resend an invite code for a user to initialize their first authentication method (password, passkeys, IdP) depending on the organization's available methods. A resend is only possible if a code has been created previously and sent to the user. If there is no code or it was directly returned, an error will be returned.
2343
2343
  # @param user_service_resend_invite_code_request [UserServiceResendInviteCodeRequest]
2344
2344
  # @param [Hash] opts the optional parameters
2345
2345
  # @return [UserServiceResendInviteCodeResponse]
@@ -2396,12 +2396,12 @@ module Zitadel::Client::Api
2396
2396
  return data
2397
2397
  end
2398
2398
 
2399
- # ResendPhoneCode
2400
- # Resend code to verify user phone number Resend code to verify user phone number.
2399
+ # Resend code to verify user phone number
2400
+ # Resend code to verify user phone number.
2401
2401
  # @param user_service_resend_phone_code_request [UserServiceResendPhoneCodeRequest]
2402
2402
  # @param [Hash] opts the optional parameters
2403
2403
  # @return [UserServiceResendPhoneCodeResponse]
2404
- def resend_phone_code(user_service_resend_phone_code_request, opts = {})
2404
+ def resend_phone_code(user_service_resend_phone_code_request = {}, opts = {})
2405
2405
  if @api_client.config.debugging
2406
2406
  @api_client.config.logger.debug 'Calling API: Api::UserServiceApi.resend_phone_code ...' # MODIFIED
2407
2407
  end
@@ -2454,8 +2454,8 @@ module Zitadel::Client::Api
2454
2454
  return data
2455
2455
  end
2456
2456
 
2457
- # RetrieveIdentityProviderIntent
2458
- # Retrieve the information returned by the identity provider Retrieve the information returned by the identity provider for registration or updating an existing user with new information..
2457
+ # Retrieve the information returned by the identity provider
2458
+ # Retrieve the information returned by the identity provider for registration or updating an existing user with new information..
2459
2459
  # @param user_service_retrieve_identity_provider_intent_request [UserServiceRetrieveIdentityProviderIntentRequest]
2460
2460
  # @param [Hash] opts the optional parameters
2461
2461
  # @return [UserServiceRetrieveIdentityProviderIntentResponse]
@@ -2512,12 +2512,12 @@ module Zitadel::Client::Api
2512
2512
  return data
2513
2513
  end
2514
2514
 
2515
- # SendEmailCode
2515
+ # Send code to verify user email
2516
2516
  # Send code to verify user email
2517
2517
  # @param user_service_send_email_code_request [UserServiceSendEmailCodeRequest]
2518
2518
  # @param [Hash] opts the optional parameters
2519
2519
  # @return [UserServiceSendEmailCodeResponse]
2520
- def send_email_code(user_service_send_email_code_request, opts = {})
2520
+ def send_email_code(user_service_send_email_code_request = {}, opts = {})
2521
2521
  if @api_client.config.debugging
2522
2522
  @api_client.config.logger.debug 'Calling API: Api::UserServiceApi.send_email_code ...' # MODIFIED
2523
2523
  end
@@ -2570,12 +2570,12 @@ module Zitadel::Client::Api
2570
2570
  return data
2571
2571
  end
2572
2572
 
2573
- # SetEmail
2574
- # Change the user email Deprecated: [Update the users email field](apis/resources/user_service_v2/user-service-update-user.api.mdx). Change the email address of a user. If the state is set to not verified, a verification code will be generated, which can be either returned or sent to the user by email..
2573
+ # Change the user email
2574
+ # Deprecated: [Update the users email field](apis/resources/user_service_v2/user-service-update-user.api.mdx). Change the email address of a user. If the state is set to not verified, a verification code will be generated, which can be either returned or sent to the user by email..
2575
2575
  # @param user_service_set_email_request [UserServiceSetEmailRequest]
2576
2576
  # @param [Hash] opts the optional parameters
2577
2577
  # @return [UserServiceSetEmailResponse]
2578
- def set_email(user_service_set_email_request, opts = {})
2578
+ def set_email(user_service_set_email_request = {}, opts = {})
2579
2579
  if @api_client.config.debugging
2580
2580
  @api_client.config.logger.debug 'Calling API: Api::UserServiceApi.set_email ...' # MODIFIED
2581
2581
  end
@@ -2628,12 +2628,12 @@ module Zitadel::Client::Api
2628
2628
  return data
2629
2629
  end
2630
2630
 
2631
- # SetPassword
2632
- # Change password Deprecated: [Update the users password](apis/resources/user_service_v2/user-service-update-user.api.mdx) instead. Change the password of a user with either a verification code or the current password..
2631
+ # Change password
2632
+ # Deprecated: [Update the users password](apis/resources/user_service_v2/user-service-update-user.api.mdx) instead. Change the password of a user with either a verification code or the current password..
2633
2633
  # @param user_service_set_password_request [UserServiceSetPasswordRequest]
2634
2634
  # @param [Hash] opts the optional parameters
2635
2635
  # @return [UserServiceSetPasswordResponse]
2636
- def set_password(user_service_set_password_request, opts = {})
2636
+ def set_password(user_service_set_password_request = {}, opts = {})
2637
2637
  if @api_client.config.debugging
2638
2638
  @api_client.config.logger.debug 'Calling API: Api::UserServiceApi.set_password ...' # MODIFIED
2639
2639
  end
@@ -2686,12 +2686,12 @@ module Zitadel::Client::Api
2686
2686
  return data
2687
2687
  end
2688
2688
 
2689
- # SetPhone
2690
- # Set the user phone Deprecated: [Update the users phone field](apis/resources/user_service_v2/user-service-update-user.api.mdx). Set the phone number of a user. If the state is set to not verified, a verification code will be generated, which can be either returned or sent to the user by sms..
2689
+ # Set the user phone
2690
+ # Deprecated: [Update the users phone field](apis/resources/user_service_v2/user-service-update-user.api.mdx). Set the phone number of a user. If the state is set to not verified, a verification code will be generated, which can be either returned or sent to the user by sms..
2691
2691
  # @param user_service_set_phone_request [UserServiceSetPhoneRequest]
2692
2692
  # @param [Hash] opts the optional parameters
2693
2693
  # @return [UserServiceSetPhoneResponse]
2694
- def set_phone(user_service_set_phone_request, opts = {})
2694
+ def set_phone(user_service_set_phone_request = {}, opts = {})
2695
2695
  if @api_client.config.debugging
2696
2696
  @api_client.config.logger.debug 'Calling API: Api::UserServiceApi.set_phone ...' # MODIFIED
2697
2697
  end
@@ -2744,8 +2744,8 @@ module Zitadel::Client::Api
2744
2744
  return data
2745
2745
  end
2746
2746
 
2747
- # SetUserMetadata
2748
- # Set User Metadata Sets a list of key value pairs. Existing metadata entries with matching keys are overwritten. Existing metadata entries without matching keys are untouched. To remove metadata entries, use [DeleteUserMetadata](apis/resources/user_service_v2/user-service-delete-user-metadata.api.mdx). For HTTP requests, make sure the bytes array value is base64 encoded. Required permission: - `user.write`
2747
+ # Set User Metadata
2748
+ # Sets a list of key value pairs. Existing metadata entries with matching keys are overwritten. Existing metadata entries without matching keys are untouched. To remove metadata entries, use [DeleteUserMetadata](apis/resources/user_service_v2/user-service-delete-user-metadata.api.mdx). For HTTP requests, make sure the bytes array value is base64 encoded. Required permission: - `user.write`
2749
2749
  # @param user_service_set_user_metadata_request [UserServiceSetUserMetadataRequest]
2750
2750
  # @param [Hash] opts the optional parameters
2751
2751
  # @return [UserServiceSetUserMetadataResponse]
@@ -2802,12 +2802,12 @@ module Zitadel::Client::Api
2802
2802
  return data
2803
2803
  end
2804
2804
 
2805
- # StartIdentityProviderIntent
2806
- # Start flow with an identity provider Start a flow with an identity provider, for external login, registration or linking..
2805
+ # Start flow with an identity provider
2806
+ # Start a flow with an identity provider, for external login, registration or linking..
2807
2807
  # @param user_service_start_identity_provider_intent_request [UserServiceStartIdentityProviderIntentRequest]
2808
2808
  # @param [Hash] opts the optional parameters
2809
2809
  # @return [UserServiceStartIdentityProviderIntentResponse]
2810
- def start_identity_provider_intent(user_service_start_identity_provider_intent_request, opts = {})
2810
+ def start_identity_provider_intent(user_service_start_identity_provider_intent_request = {}, opts = {})
2811
2811
  if @api_client.config.debugging
2812
2812
  @api_client.config.logger.debug 'Calling API: Api::UserServiceApi.start_identity_provider_intent ...' # MODIFIED
2813
2813
  end
@@ -2860,8 +2860,8 @@ module Zitadel::Client::Api
2860
2860
  return data
2861
2861
  end
2862
2862
 
2863
- # UnlockUser
2864
- # Unlock user The state of the user will be changed to 'active'. The user will be able to log in again. The endpoint returns an error if the user is not in the state 'locked'.
2863
+ # Unlock user
2864
+ # The state of the user will be changed to 'active'. The user will be able to log in again. The endpoint returns an error if the user is not in the state 'locked'.
2865
2865
  # @param user_service_unlock_user_request [UserServiceUnlockUserRequest]
2866
2866
  # @param [Hash] opts the optional parameters
2867
2867
  # @return [UserServiceUnlockUserResponse]
@@ -2918,8 +2918,8 @@ module Zitadel::Client::Api
2918
2918
  return data
2919
2919
  end
2920
2920
 
2921
- # UpdateHumanUser
2922
- # Update Human User Deprecated: Use [UpdateUser](apis/resources/user_service_v2/user-service-update-user.api.mdx) to update a user of type human instead. Update all information from a user.
2921
+ # Update Human User
2922
+ # Deprecated: Use [UpdateUser](apis/resources/user_service_v2/user-service-update-user.api.mdx) to update a user of type human instead. Update all information from a user.
2923
2923
  # @param user_service_update_human_user_request [UserServiceUpdateHumanUserRequest]
2924
2924
  # @param [Hash] opts the optional parameters
2925
2925
  # @return [UserServiceUpdateHumanUserResponse]
@@ -2976,12 +2976,12 @@ module Zitadel::Client::Api
2976
2976
  return data
2977
2977
  end
2978
2978
 
2979
- # UpdateUser
2980
- # Update a User Partially update an existing user. If you change the users email or phone, you can specify how the ownership should be verified. If you change the users password, you can specify if the password should be changed again on the users next login. Required permission: - user.write
2979
+ # Update a User
2980
+ # Partially update an existing user. If you change the users email or phone, you can specify how the ownership should be verified. If you change the users password, you can specify if the password should be changed again on the users next login. Required permission: - user.write
2981
2981
  # @param user_service_update_user_request [UserServiceUpdateUserRequest]
2982
2982
  # @param [Hash] opts the optional parameters
2983
2983
  # @return [UserServiceUpdateUserResponse]
2984
- def update_user(user_service_update_user_request, opts = {})
2984
+ def update_user(user_service_update_user_request = {}, opts = {})
2985
2985
  if @api_client.config.debugging
2986
2986
  @api_client.config.logger.debug 'Calling API: Api::UserServiceApi.update_user ...' # MODIFIED
2987
2987
  end
@@ -3034,8 +3034,8 @@ module Zitadel::Client::Api
3034
3034
  return data
3035
3035
  end
3036
3036
 
3037
- # VerifyEmail
3038
- # Verify the email Verify the email with the generated code.
3037
+ # Verify the email
3038
+ # Verify the email with the generated code.
3039
3039
  # @param user_service_verify_email_request [UserServiceVerifyEmailRequest]
3040
3040
  # @param [Hash] opts the optional parameters
3041
3041
  # @return [UserServiceVerifyEmailResponse]
@@ -3092,8 +3092,8 @@ module Zitadel::Client::Api
3092
3092
  return data
3093
3093
  end
3094
3094
 
3095
- # VerifyInviteCode
3096
- # Verify an invite code for a user Verify the invite code of a user previously issued. This will set their email to a verified state and allow the user to set up their first authentication method (password, passkeys, IdP) depending on the organization's available methods.
3095
+ # Verify an invite code for a user
3096
+ # Verify the invite code of a user previously issued. This will set their email to a verified state and allow the user to set up their first authentication method (password, passkeys, IdP) depending on the organization's available methods.
3097
3097
  # @param user_service_verify_invite_code_request [UserServiceVerifyInviteCodeRequest]
3098
3098
  # @param [Hash] opts the optional parameters
3099
3099
  # @return [UserServiceVerifyInviteCodeResponse]
@@ -3150,8 +3150,8 @@ module Zitadel::Client::Api
3150
3150
  return data
3151
3151
  end
3152
3152
 
3153
- # VerifyPasskeyRegistration
3154
- # Verify a passkey for a user Verify the passkey registration with the public key credential..
3153
+ # Verify a passkey for a user
3154
+ # Verify the passkey registration with the public key credential..
3155
3155
  # @param user_service_verify_passkey_registration_request [UserServiceVerifyPasskeyRegistrationRequest]
3156
3156
  # @param [Hash] opts the optional parameters
3157
3157
  # @return [UserServiceVerifyPasskeyRegistrationResponse]
@@ -3208,8 +3208,8 @@ module Zitadel::Client::Api
3208
3208
  return data
3209
3209
  end
3210
3210
 
3211
- # VerifyPhone
3212
- # Verify the phone number Verify the phone number with the generated code.
3211
+ # Verify the phone number
3212
+ # Verify the phone number with the generated code.
3213
3213
  # @param user_service_verify_phone_request [UserServiceVerifyPhoneRequest]
3214
3214
  # @param [Hash] opts the optional parameters
3215
3215
  # @return [UserServiceVerifyPhoneResponse]
@@ -3266,8 +3266,8 @@ module Zitadel::Client::Api
3266
3266
  return data
3267
3267
  end
3268
3268
 
3269
- # VerifyTOTPRegistration
3270
- # Verify a TOTP generator for a user Verify the TOTP registration with a generated code..
3269
+ # Verify a TOTP generator for a user
3270
+ # Verify the TOTP registration with a generated code..
3271
3271
  # @param user_service_verify_totp_registration_request [UserServiceVerifyTOTPRegistrationRequest]
3272
3272
  # @param [Hash] opts the optional parameters
3273
3273
  # @return [UserServiceVerifyTOTPRegistrationResponse]
@@ -3324,8 +3324,8 @@ module Zitadel::Client::Api
3324
3324
  return data
3325
3325
  end
3326
3326
 
3327
- # VerifyU2FRegistration
3328
- # Verify a u2f token for a user Verify the u2f token registration with the public key credential..
3327
+ # Verify a u2f token for a user
3328
+ # Verify the u2f token registration with the public key credential..
3329
3329
  # @param user_service_verify_u2_f_registration_request [UserServiceVerifyU2FRegistrationRequest]
3330
3330
  # @param [Hash] opts the optional parameters
3331
3331
  # @return [UserServiceVerifyU2FRegistrationResponse]