zitadel-client 4.1.0.beta.7 → 4.1.0.beta.9
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.
- checksums.yaml +4 -4
- data/lib/zitadel/client/api/action_service_api.rb +22 -22
- data/lib/zitadel/client/api/beta_action_service_api.rb +22 -22
- data/lib/zitadel/client/api/beta_app_service_api.rb +28 -28
- data/lib/zitadel/client/api/beta_authorization_service_api.rb +12 -12
- data/lib/zitadel/client/api/beta_instance_service_api.rb +20 -20
- data/lib/zitadel/client/api/beta_internal_permission_service_api.rb +8 -8
- data/lib/zitadel/client/api/beta_o_i_d_c_service_api.rb +1 -1
- data/lib/zitadel/client/api/beta_organization_service_api.rb +28 -28
- data/lib/zitadel/client/api/beta_project_service_api.rb +34 -34
- data/lib/zitadel/client/api/beta_session_service_api.rb +5 -5
- data/lib/zitadel/client/api/beta_settings_service_api.rb +11 -11
- data/lib/zitadel/client/api/beta_telemetry_service_api.rb +2 -2
- data/lib/zitadel/client/api/beta_user_service_api.rb +77 -77
- data/lib/zitadel/client/api/beta_web_key_service_api.rb +8 -8
- data/lib/zitadel/client/api/feature_service_api.rb +24 -24
- data/lib/zitadel/client/api/identity_provider_service_api.rb +2 -2
- data/lib/zitadel/client/api/o_i_d_c_service_api.rb +6 -6
- data/lib/zitadel/client/api/organization_service_api.rb +4 -4
- data/lib/zitadel/client/api/s_a_m_l_service_api.rb +1 -1
- data/lib/zitadel/client/api/session_service_api.rb +5 -5
- data/lib/zitadel/client/api/settings_service_api.rb +17 -17
- data/lib/zitadel/client/api/user_service_api.rb +125 -125
- data/lib/zitadel/client/api/web_key_service_api.rb +8 -8
- data/lib/zitadel/client/models/action_service_any.rb +7 -5
- data/lib/zitadel/client/models/action_service_connect_error.rb +10 -7
- data/lib/zitadel/client/models/action_service_delete_target_request.rb +0 -12
- data/lib/zitadel/client/models/beta_action_service_any.rb +7 -5
- data/lib/zitadel/client/models/beta_action_service_connect_error.rb +10 -7
- data/lib/zitadel/client/models/beta_action_service_delete_target_request.rb +0 -12
- data/lib/zitadel/client/models/beta_app_service_any.rb +7 -5
- data/lib/zitadel/client/models/beta_app_service_connect_error.rb +10 -7
- data/lib/zitadel/client/models/beta_app_service_create_application_request.rb +0 -12
- data/lib/zitadel/client/models/beta_app_service_get_application_request.rb +0 -12
- data/lib/zitadel/client/models/beta_app_service_update_application_request.rb +0 -12
- data/lib/zitadel/client/models/beta_authorization_service_any.rb +7 -5
- data/lib/zitadel/client/models/beta_authorization_service_connect_error.rb +10 -7
- data/lib/zitadel/client/models/beta_feature_service_any.rb +7 -5
- data/lib/zitadel/client/models/beta_feature_service_connect_error.rb +10 -7
- data/lib/zitadel/client/models/beta_instance_service_add_trusted_domain_request.rb +0 -12
- data/lib/zitadel/client/models/beta_instance_service_any.rb +7 -5
- data/lib/zitadel/client/models/beta_instance_service_connect_error.rb +10 -7
- data/lib/zitadel/client/models/beta_instance_service_remove_trusted_domain_request.rb +0 -12
- data/lib/zitadel/client/models/beta_internal_permission_service_any.rb +7 -5
- data/lib/zitadel/client/models/beta_internal_permission_service_connect_error.rb +10 -7
- data/lib/zitadel/client/models/beta_internal_permission_service_project_grant.rb +8 -8
- data/lib/zitadel/client/models/beta_o_i_d_c_service_any.rb +7 -5
- data/lib/zitadel/client/models/beta_o_i_d_c_service_connect_error.rb +10 -7
- data/lib/zitadel/client/models/beta_organization_service_add_human_user_request.rb +0 -24
- data/lib/zitadel/client/models/beta_organization_service_add_organization_domain_request.rb +0 -24
- data/lib/zitadel/client/models/beta_organization_service_any.rb +7 -5
- data/lib/zitadel/client/models/beta_organization_service_connect_error.rb +10 -7
- data/lib/zitadel/client/models/beta_organization_service_create_organization_request.rb +0 -12
- data/lib/zitadel/client/models/beta_organization_service_create_organization_response.rb +0 -12
- data/lib/zitadel/client/models/beta_organization_service_delete_organization_domain_request.rb +0 -24
- data/lib/zitadel/client/models/beta_organization_service_delete_organization_metadata_request.rb +0 -12
- data/lib/zitadel/client/models/beta_organization_service_delete_organization_request.rb +0 -12
- data/lib/zitadel/client/models/beta_organization_service_generate_organization_domain_validation_request.rb +0 -24
- data/lib/zitadel/client/models/beta_organization_service_hashed_password.rb +0 -12
- data/lib/zitadel/client/models/beta_organization_service_list_organization_domains_request.rb +0 -12
- data/lib/zitadel/client/models/beta_organization_service_list_organization_metadata_request.rb +0 -12
- data/lib/zitadel/client/models/beta_organization_service_password.rb +0 -12
- data/lib/zitadel/client/models/beta_organization_service_set_human_email.rb +0 -12
- data/lib/zitadel/client/models/beta_organization_service_set_human_profile.rb +0 -24
- data/lib/zitadel/client/models/beta_organization_service_set_metadata_entry.rb +0 -24
- data/lib/zitadel/client/models/beta_organization_service_set_organization_metadata_request.rb +0 -12
- data/lib/zitadel/client/models/beta_organization_service_update_organization_request.rb +0 -24
- data/lib/zitadel/client/models/beta_organization_service_verify_organization_domain_request.rb +0 -12
- data/lib/zitadel/client/models/beta_project_service_activate_project_grant_request.rb +0 -24
- data/lib/zitadel/client/models/beta_project_service_activate_project_request.rb +0 -12
- data/lib/zitadel/client/models/beta_project_service_add_project_role_request.rb +0 -36
- data/lib/zitadel/client/models/beta_project_service_admin.rb +227 -0
- data/lib/zitadel/client/models/beta_project_service_any.rb +7 -5
- data/lib/zitadel/client/models/beta_project_service_connect_error.rb +10 -7
- data/lib/zitadel/client/models/beta_project_service_create_project_grant_request.rb +0 -24
- data/lib/zitadel/client/models/beta_project_service_create_project_request.rb +14 -14
- data/lib/zitadel/client/models/beta_project_service_deactivate_project_grant_request.rb +0 -24
- data/lib/zitadel/client/models/beta_project_service_deactivate_project_request.rb +0 -12
- data/lib/zitadel/client/models/beta_project_service_delete_project_grant_request.rb +0 -24
- data/lib/zitadel/client/models/beta_project_service_delete_project_request.rb +0 -12
- data/lib/zitadel/client/models/beta_project_service_list_project_roles_request.rb +0 -12
- data/lib/zitadel/client/models/beta_project_service_remove_project_role_request.rb +0 -24
- data/lib/zitadel/client/models/beta_project_service_update_project_grant_request.rb +0 -24
- data/lib/zitadel/client/models/beta_project_service_update_project_request.rb +0 -12
- data/lib/zitadel/client/models/beta_project_service_update_project_role_request.rb +0 -26
- data/lib/zitadel/client/models/beta_session_service_any.rb +7 -5
- data/lib/zitadel/client/models/beta_session_service_check_web_auth_n.rb +0 -12
- data/lib/zitadel/client/models/beta_session_service_connect_error.rb +10 -7
- data/lib/zitadel/client/models/beta_session_service_web_auth_n.rb +0 -24
- data/lib/zitadel/client/models/beta_settings_service_any.rb +7 -5
- data/lib/zitadel/client/models/beta_settings_service_connect_error.rb +10 -7
- data/lib/zitadel/client/models/beta_telemetry_service_any.rb +7 -5
- data/lib/zitadel/client/models/beta_telemetry_service_connect_error.rb +10 -7
- data/lib/zitadel/client/models/beta_user_service_add_human_user_request.rb +0 -24
- data/lib/zitadel/client/models/beta_user_service_add_i_d_p_link_request.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_add_o_t_p_email_request.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_add_o_t_p_s_m_s_request.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_any.rb +7 -5
- data/lib/zitadel/client/models/beta_user_service_connect_error.rb +10 -7
- data/lib/zitadel/client/models/beta_user_service_create_passkey_registration_link_request.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_deactivate_user_request.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_delete_user_request.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_display_name_query.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_email_query.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_first_name_query.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_get_user_by_i_d_request.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_hashed_password.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_last_name_query.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_list_authentication_method_types_request.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_lock_user_request.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_login_name_query.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_nick_name_query.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_organization_id_query.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_passkey_registration_code.rb +0 -24
- data/lib/zitadel/client/models/beta_user_service_password.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_password_reset_request.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_phone_query.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_reactivate_user_request.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_register_passkey_request.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_register_t_o_t_p_request.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_register_u2_f_request.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_remove_o_t_p_email_request.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_remove_o_t_p_s_m_s_request.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_remove_phone_request.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_remove_t_o_t_p_request.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_resend_email_code_request.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_resend_phone_code_request.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_set_email_request.rb +0 -24
- data/lib/zitadel/client/models/beta_user_service_set_human_email.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_set_human_profile.rb +0 -24
- data/lib/zitadel/client/models/beta_user_service_set_metadata_entry.rb +0 -24
- data/lib/zitadel/client/models/beta_user_service_set_password_request.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_set_phone_request.rb +0 -24
- data/lib/zitadel/client/models/beta_user_service_state_query.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_type_query.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_unlock_user_request.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_user_name_query.rb +0 -12
- data/lib/zitadel/client/models/beta_user_service_verify_email_request.rb +0 -24
- data/lib/zitadel/client/models/beta_user_service_verify_passkey_registration_request.rb +0 -48
- data/lib/zitadel/client/models/beta_user_service_verify_phone_request.rb +0 -24
- data/lib/zitadel/client/models/beta_user_service_verify_t_o_t_p_registration_request.rb +0 -24
- data/lib/zitadel/client/models/beta_user_service_verify_u2_f_registration_request.rb +0 -48
- data/lib/zitadel/client/models/beta_web_key_service_activate_web_key_request.rb +0 -12
- data/lib/zitadel/client/models/beta_web_key_service_any.rb +7 -5
- data/lib/zitadel/client/models/beta_web_key_service_connect_error.rb +10 -7
- data/lib/zitadel/client/models/beta_web_key_service_delete_web_key_request.rb +0 -12
- data/lib/zitadel/client/models/feature_service_any.rb +7 -5
- data/lib/zitadel/client/models/feature_service_connect_error.rb +10 -7
- data/lib/zitadel/client/models/identity_provider_service_any.rb +7 -5
- data/lib/zitadel/client/models/identity_provider_service_connect_error.rb +10 -7
- data/lib/zitadel/client/models/o_i_d_c_service_any.rb +7 -5
- data/lib/zitadel/client/models/o_i_d_c_service_connect_error.rb +10 -7
- data/lib/zitadel/client/models/organization_service_add_human_user_request.rb +0 -24
- data/lib/zitadel/client/models/organization_service_add_organization_request.rb +0 -12
- data/lib/zitadel/client/models/organization_service_any.rb +7 -5
- data/lib/zitadel/client/models/organization_service_connect_error.rb +10 -7
- data/lib/zitadel/client/models/organization_service_hashed_password.rb +0 -12
- data/lib/zitadel/client/models/organization_service_organization_domain_query.rb +0 -12
- data/lib/zitadel/client/models/organization_service_organization_i_d_query.rb +0 -12
- data/lib/zitadel/client/models/organization_service_organization_name_query.rb +0 -12
- data/lib/zitadel/client/models/organization_service_password.rb +0 -12
- data/lib/zitadel/client/models/organization_service_set_human_email.rb +0 -12
- data/lib/zitadel/client/models/organization_service_set_human_profile.rb +0 -24
- data/lib/zitadel/client/models/organization_service_set_metadata_entry.rb +0 -24
- data/lib/zitadel/client/models/s_a_m_l_service_any.rb +7 -5
- data/lib/zitadel/client/models/s_a_m_l_service_connect_error.rb +10 -7
- data/lib/zitadel/client/models/session_service_any.rb +7 -5
- data/lib/zitadel/client/models/session_service_check_web_auth_n.rb +0 -12
- data/lib/zitadel/client/models/session_service_connect_error.rb +10 -7
- data/lib/zitadel/client/models/session_service_web_auth_n.rb +0 -24
- data/lib/zitadel/client/models/settings_service_any.rb +7 -5
- data/lib/zitadel/client/models/settings_service_connect_error.rb +10 -7
- data/lib/zitadel/client/models/user_service_add_human_user_request.rb +0 -24
- data/lib/zitadel/client/models/user_service_add_i_d_p_link_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_add_o_t_p_email_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_add_o_t_p_s_m_s_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_any.rb +7 -5
- data/lib/zitadel/client/models/user_service_connect_error.rb +10 -7
- data/lib/zitadel/client/models/user_service_create_invite_code_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_create_passkey_registration_link_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_deactivate_user_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_delete_user_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_display_name_query.rb +0 -12
- data/lib/zitadel/client/models/user_service_email_query.rb +0 -12
- data/lib/zitadel/client/models/user_service_first_name_query.rb +0 -12
- data/lib/zitadel/client/models/user_service_get_user_by_i_d_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_hashed_password.rb +0 -12
- data/lib/zitadel/client/models/user_service_human_m_f_a_init_skipped_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_last_name_query.rb +0 -12
- data/lib/zitadel/client/models/user_service_list_authentication_factors_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_list_authentication_method_types_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_list_passkeys_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_list_user_metadata_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_lock_user_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_login_name_query.rb +0 -12
- data/lib/zitadel/client/models/user_service_nick_name_query.rb +0 -12
- data/lib/zitadel/client/models/user_service_organization_id_query.rb +0 -12
- data/lib/zitadel/client/models/user_service_passkey_registration_code.rb +0 -24
- data/lib/zitadel/client/models/user_service_password.rb +0 -12
- data/lib/zitadel/client/models/user_service_password_reset_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_phone_query.rb +0 -12
- data/lib/zitadel/client/models/user_service_reactivate_user_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_register_passkey_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_register_t_o_t_p_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_register_u2_f_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_remove_i_d_p_link_request.rb +0 -36
- data/lib/zitadel/client/models/user_service_remove_o_t_p_email_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_remove_o_t_p_s_m_s_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_remove_passkey_request.rb +0 -24
- data/lib/zitadel/client/models/user_service_remove_phone_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_remove_t_o_t_p_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_remove_u2_f_request.rb +0 -24
- data/lib/zitadel/client/models/user_service_resend_email_code_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_resend_invite_code_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_resend_phone_code_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_send_email_code_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_set_email_request.rb +0 -24
- data/lib/zitadel/client/models/user_service_set_human_email.rb +0 -12
- data/lib/zitadel/client/models/user_service_set_human_profile.rb +0 -24
- data/lib/zitadel/client/models/user_service_set_metadata_entry.rb +0 -24
- data/lib/zitadel/client/models/user_service_set_password_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_set_phone_request.rb +0 -24
- data/lib/zitadel/client/models/user_service_set_user_metadata_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_state_query.rb +0 -12
- data/lib/zitadel/client/models/user_service_type_query.rb +0 -12
- data/lib/zitadel/client/models/user_service_unlock_user_request.rb +0 -12
- data/lib/zitadel/client/models/user_service_user_name_query.rb +0 -12
- data/lib/zitadel/client/models/user_service_verify_email_request.rb +0 -24
- data/lib/zitadel/client/models/user_service_verify_invite_code_request.rb +0 -24
- data/lib/zitadel/client/models/user_service_verify_passkey_registration_request.rb +0 -48
- data/lib/zitadel/client/models/user_service_verify_phone_request.rb +0 -24
- data/lib/zitadel/client/models/user_service_verify_t_o_t_p_registration_request.rb +0 -24
- data/lib/zitadel/client/models/user_service_verify_u2_f_registration_request.rb +0 -48
- data/lib/zitadel/client/models/web_key_service_activate_web_key_request.rb +0 -12
- data/lib/zitadel/client/models/web_key_service_any.rb +7 -5
- data/lib/zitadel/client/models/web_key_service_connect_error.rb +10 -7
- data/lib/zitadel/client/models/web_key_service_delete_web_key_request.rb +0 -12
- data/lib/zitadel/client/version.rb +1 -1
- metadata +3 -2
@@ -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
|
-
#
|
23
|
-
# Create
|
22
|
+
# Create a new human user
|
23
|
+
# 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. Deprecated: please move to the corresponding endpoint under user service v2 (GA)
|
24
24
|
# @param beta_user_service_add_human_user_request [BetaUserServiceAddHumanUserRequest]
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @return [BetaUserServiceAddHumanUserResponse]
|
27
|
-
def add_human_user(beta_user_service_add_human_user_request, opts = {})
|
27
|
+
def add_human_user(beta_user_service_add_human_user_request = {}, opts = {})
|
28
28
|
if @api_client.config.debugging
|
29
29
|
@api_client.config.logger.debug 'Calling API: Api::BetaUserServiceApi.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
|
-
#
|
81
|
-
# 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. Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
82
82
|
# @param beta_user_service_add_idp_link_request [BetaUserServiceAddIDPLinkRequest]
|
83
83
|
# @param [Hash] opts the optional parameters
|
84
84
|
# @return [BetaUserServiceAddIDPLinkResponse]
|
@@ -135,8 +135,8 @@ module Zitadel::Client::Api
|
|
135
135
|
return data
|
136
136
|
end
|
137
137
|
|
138
|
-
#
|
139
|
-
# Add
|
138
|
+
# Add OTP Email for a user
|
139
|
+
# 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. Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
140
140
|
# @param beta_user_service_add_otp_email_request [BetaUserServiceAddOTPEmailRequest]
|
141
141
|
# @param [Hash] opts the optional parameters
|
142
142
|
# @return [BetaUserServiceAddOTPEmailResponse]
|
@@ -193,8 +193,8 @@ module Zitadel::Client::Api
|
|
193
193
|
return data
|
194
194
|
end
|
195
195
|
|
196
|
-
#
|
197
|
-
# Add
|
196
|
+
# Add OTP SMS for a user
|
197
|
+
# 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. Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
198
198
|
# @param beta_user_service_add_otpsms_request [BetaUserServiceAddOTPSMSRequest]
|
199
199
|
# @param [Hash] opts the optional parameters
|
200
200
|
# @return [BetaUserServiceAddOTPSMSResponse]
|
@@ -251,12 +251,12 @@ module Zitadel::Client::Api
|
|
251
251
|
return data
|
252
252
|
end
|
253
253
|
|
254
|
-
#
|
255
|
-
# Create a passkey registration link
|
254
|
+
# Create a passkey registration link for a user
|
255
|
+
# Create a passkey registration link which includes a code and either return it or send it to the user. Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
256
256
|
# @param beta_user_service_create_passkey_registration_link_request [BetaUserServiceCreatePasskeyRegistrationLinkRequest]
|
257
257
|
# @param [Hash] opts the optional parameters
|
258
258
|
# @return [BetaUserServiceCreatePasskeyRegistrationLinkResponse]
|
259
|
-
def create_passkey_registration_link(beta_user_service_create_passkey_registration_link_request, opts = {})
|
259
|
+
def create_passkey_registration_link(beta_user_service_create_passkey_registration_link_request = {}, opts = {})
|
260
260
|
if @api_client.config.debugging
|
261
261
|
@api_client.config.logger.debug 'Calling API: Api::BetaUserServiceApi.create_passkey_registration_link ...' # MODIFIED
|
262
262
|
end
|
@@ -309,8 +309,8 @@ module Zitadel::Client::Api
|
|
309
309
|
return data
|
310
310
|
end
|
311
311
|
|
312
|
-
#
|
313
|
-
#
|
312
|
+
# Deactivate user
|
313
|
+
# 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. Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
314
314
|
# @param beta_user_service_deactivate_user_request [BetaUserServiceDeactivateUserRequest]
|
315
315
|
# @param [Hash] opts the optional parameters
|
316
316
|
# @return [BetaUserServiceDeactivateUserResponse]
|
@@ -367,8 +367,8 @@ module Zitadel::Client::Api
|
|
367
367
|
return data
|
368
368
|
end
|
369
369
|
|
370
|
-
#
|
371
|
-
#
|
370
|
+
# Delete user
|
371
|
+
# 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. Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
372
372
|
# @param beta_user_service_delete_user_request [BetaUserServiceDeleteUserRequest]
|
373
373
|
# @param [Hash] opts the optional parameters
|
374
374
|
# @return [BetaUserServiceDeleteUserResponse]
|
@@ -425,8 +425,8 @@ module Zitadel::Client::Api
|
|
425
425
|
return data
|
426
426
|
end
|
427
427
|
|
428
|
-
#
|
429
|
-
#
|
428
|
+
# User by ID
|
429
|
+
# Returns the full user object (human or machine) including the profile, email, etc. Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
430
430
|
# @param beta_user_service_get_user_by_id_request [BetaUserServiceGetUserByIDRequest]
|
431
431
|
# @param [Hash] opts the optional parameters
|
432
432
|
# @return [BetaUserServiceGetUserByIDResponse]
|
@@ -483,8 +483,8 @@ module Zitadel::Client::Api
|
|
483
483
|
return data
|
484
484
|
end
|
485
485
|
|
486
|
-
#
|
487
|
-
# List all possible authentication methods of a user
|
486
|
+
# List all possible authentication methods of a user
|
487
|
+
# List all possible authentication methods of a user like password, passwordless, (T)OTP and more. Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
488
488
|
# @param beta_user_service_list_authentication_method_types_request [BetaUserServiceListAuthenticationMethodTypesRequest]
|
489
489
|
# @param [Hash] opts the optional parameters
|
490
490
|
# @return [BetaUserServiceListAuthenticationMethodTypesResponse]
|
@@ -541,8 +541,8 @@ module Zitadel::Client::Api
|
|
541
541
|
return data
|
542
542
|
end
|
543
543
|
|
544
|
-
#
|
545
|
-
# Search
|
544
|
+
# Search Users
|
545
|
+
# 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. Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
546
546
|
# @param beta_user_service_list_users_request [BetaUserServiceListUsersRequest]
|
547
547
|
# @param [Hash] opts the optional parameters
|
548
548
|
# @return [BetaUserServiceListUsersResponse]
|
@@ -599,8 +599,8 @@ module Zitadel::Client::Api
|
|
599
599
|
return data
|
600
600
|
end
|
601
601
|
|
602
|
-
#
|
603
|
-
#
|
602
|
+
# Lock user
|
603
|
+
# 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.). Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
604
604
|
# @param beta_user_service_lock_user_request [BetaUserServiceLockUserRequest]
|
605
605
|
# @param [Hash] opts the optional parameters
|
606
606
|
# @return [BetaUserServiceLockUserResponse]
|
@@ -657,12 +657,12 @@ module Zitadel::Client::Api
|
|
657
657
|
return data
|
658
658
|
end
|
659
659
|
|
660
|
-
#
|
661
|
-
# Request a code to reset a password
|
660
|
+
# Request a code to reset a password
|
661
|
+
# Request a code to reset a password. Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
662
662
|
# @param beta_user_service_password_reset_request [BetaUserServicePasswordResetRequest]
|
663
663
|
# @param [Hash] opts the optional parameters
|
664
664
|
# @return [BetaUserServicePasswordResetResponse]
|
665
|
-
def password_reset(beta_user_service_password_reset_request, opts = {})
|
665
|
+
def password_reset(beta_user_service_password_reset_request = {}, opts = {})
|
666
666
|
if @api_client.config.debugging
|
667
667
|
@api_client.config.logger.debug 'Calling API: Api::BetaUserServiceApi.password_reset ...' # MODIFIED
|
668
668
|
end
|
@@ -715,8 +715,8 @@ module Zitadel::Client::Api
|
|
715
715
|
return data
|
716
716
|
end
|
717
717
|
|
718
|
-
#
|
719
|
-
# Reactivate
|
718
|
+
# Reactivate user
|
719
|
+
# 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'. Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
720
720
|
# @param beta_user_service_reactivate_user_request [BetaUserServiceReactivateUserRequest]
|
721
721
|
# @param [Hash] opts the optional parameters
|
722
722
|
# @return [BetaUserServiceReactivateUserResponse]
|
@@ -773,8 +773,8 @@ module Zitadel::Client::Api
|
|
773
773
|
return data
|
774
774
|
end
|
775
775
|
|
776
|
-
#
|
777
|
-
# Start the registration of
|
776
|
+
# Start the registration of passkey for a user
|
777
|
+
# 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. Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
778
778
|
# @param beta_user_service_register_passkey_request [BetaUserServiceRegisterPasskeyRequest]
|
779
779
|
# @param [Hash] opts the optional parameters
|
780
780
|
# @return [BetaUserServiceRegisterPasskeyResponse]
|
@@ -831,8 +831,8 @@ module Zitadel::Client::Api
|
|
831
831
|
return data
|
832
832
|
end
|
833
833
|
|
834
|
-
#
|
835
|
-
# Start the registration of a TOTP generator for a user
|
834
|
+
# Start the registration of a TOTP generator for a user
|
835
|
+
# 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. Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
836
836
|
# @param beta_user_service_register_totp_request [BetaUserServiceRegisterTOTPRequest]
|
837
837
|
# @param [Hash] opts the optional parameters
|
838
838
|
# @return [BetaUserServiceRegisterTOTPResponse]
|
@@ -889,8 +889,8 @@ module Zitadel::Client::Api
|
|
889
889
|
return data
|
890
890
|
end
|
891
891
|
|
892
|
-
#
|
893
|
-
# Start the registration of a u2f token for a user
|
892
|
+
# Start the registration of a u2f token for a user
|
893
|
+
# 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. Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
894
894
|
# @param beta_user_service_register_u2_f_request [BetaUserServiceRegisterU2FRequest]
|
895
895
|
# @param [Hash] opts the optional parameters
|
896
896
|
# @return [BetaUserServiceRegisterU2FResponse]
|
@@ -947,8 +947,8 @@ module Zitadel::Client::Api
|
|
947
947
|
return data
|
948
948
|
end
|
949
949
|
|
950
|
-
#
|
951
|
-
# Remove
|
950
|
+
# Remove One-Time Password (OTP) Email from a user
|
951
|
+
# 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. Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
952
952
|
# @param beta_user_service_remove_otp_email_request [BetaUserServiceRemoveOTPEmailRequest]
|
953
953
|
# @param [Hash] opts the optional parameters
|
954
954
|
# @return [BetaUserServiceRemoveOTPEmailResponse]
|
@@ -1005,8 +1005,8 @@ module Zitadel::Client::Api
|
|
1005
1005
|
return data
|
1006
1006
|
end
|
1007
1007
|
|
1008
|
-
#
|
1009
|
-
# Remove
|
1008
|
+
# Remove One-Time Password (OTP) SMS from a user
|
1009
|
+
# 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. Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
1010
1010
|
# @param beta_user_service_remove_otpsms_request [BetaUserServiceRemoveOTPSMSRequest]
|
1011
1011
|
# @param [Hash] opts the optional parameters
|
1012
1012
|
# @return [BetaUserServiceRemoveOTPSMSResponse]
|
@@ -1063,8 +1063,8 @@ module Zitadel::Client::Api
|
|
1063
1063
|
return data
|
1064
1064
|
end
|
1065
1065
|
|
1066
|
-
#
|
1067
|
-
# Remove the user phone
|
1066
|
+
# Remove the user phone
|
1067
|
+
# Remove the user phone Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
1068
1068
|
# @param beta_user_service_remove_phone_request [BetaUserServiceRemovePhoneRequest]
|
1069
1069
|
# @param [Hash] opts the optional parameters
|
1070
1070
|
# @return [BetaUserServiceRemovePhoneResponse]
|
@@ -1121,8 +1121,8 @@ module Zitadel::Client::Api
|
|
1121
1121
|
return data
|
1122
1122
|
end
|
1123
1123
|
|
1124
|
-
#
|
1125
|
-
# Remove
|
1124
|
+
# Remove TOTP generator from a user
|
1125
|
+
# 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. Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
1126
1126
|
# @param beta_user_service_remove_totp_request [BetaUserServiceRemoveTOTPRequest]
|
1127
1127
|
# @param [Hash] opts the optional parameters
|
1128
1128
|
# @return [BetaUserServiceRemoveTOTPResponse]
|
@@ -1179,12 +1179,12 @@ module Zitadel::Client::Api
|
|
1179
1179
|
return data
|
1180
1180
|
end
|
1181
1181
|
|
1182
|
-
#
|
1183
|
-
# Resend code to verify user email
|
1182
|
+
# Resend code to verify user email
|
1183
|
+
# Resend code to verify user email Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
1184
1184
|
# @param beta_user_service_resend_email_code_request [BetaUserServiceResendEmailCodeRequest]
|
1185
1185
|
# @param [Hash] opts the optional parameters
|
1186
1186
|
# @return [BetaUserServiceResendEmailCodeResponse]
|
1187
|
-
def resend_email_code(beta_user_service_resend_email_code_request, opts = {})
|
1187
|
+
def resend_email_code(beta_user_service_resend_email_code_request = {}, opts = {})
|
1188
1188
|
if @api_client.config.debugging
|
1189
1189
|
@api_client.config.logger.debug 'Calling API: Api::BetaUserServiceApi.resend_email_code ...' # MODIFIED
|
1190
1190
|
end
|
@@ -1237,12 +1237,12 @@ module Zitadel::Client::Api
|
|
1237
1237
|
return data
|
1238
1238
|
end
|
1239
1239
|
|
1240
|
-
#
|
1241
|
-
# Resend code to verify user phone
|
1240
|
+
# Resend code to verify user phone
|
1241
|
+
# Resend code to verify user phone Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
1242
1242
|
# @param beta_user_service_resend_phone_code_request [BetaUserServiceResendPhoneCodeRequest]
|
1243
1243
|
# @param [Hash] opts the optional parameters
|
1244
1244
|
# @return [BetaUserServiceResendPhoneCodeResponse]
|
1245
|
-
def resend_phone_code(beta_user_service_resend_phone_code_request, opts = {})
|
1245
|
+
def resend_phone_code(beta_user_service_resend_phone_code_request = {}, opts = {})
|
1246
1246
|
if @api_client.config.debugging
|
1247
1247
|
@api_client.config.logger.debug 'Calling API: Api::BetaUserServiceApi.resend_phone_code ...' # MODIFIED
|
1248
1248
|
end
|
@@ -1295,8 +1295,8 @@ module Zitadel::Client::Api
|
|
1295
1295
|
return data
|
1296
1296
|
end
|
1297
1297
|
|
1298
|
-
#
|
1299
|
-
# Retrieve the information returned by the identity provider
|
1298
|
+
# Retrieve the information returned by the identity provider
|
1299
|
+
# Retrieve the information returned by the identity provider for registration or updating an existing user with new information. Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
1300
1300
|
# @param beta_user_service_retrieve_identity_provider_intent_request [BetaUserServiceRetrieveIdentityProviderIntentRequest]
|
1301
1301
|
# @param [Hash] opts the optional parameters
|
1302
1302
|
# @return [BetaUserServiceRetrieveIdentityProviderIntentResponse]
|
@@ -1353,12 +1353,12 @@ module Zitadel::Client::Api
|
|
1353
1353
|
return data
|
1354
1354
|
end
|
1355
1355
|
|
1356
|
-
#
|
1357
|
-
# Change the
|
1356
|
+
# Change the user email
|
1357
|
+
# 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. Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
1358
1358
|
# @param beta_user_service_set_email_request [BetaUserServiceSetEmailRequest]
|
1359
1359
|
# @param [Hash] opts the optional parameters
|
1360
1360
|
# @return [BetaUserServiceSetEmailResponse]
|
1361
|
-
def set_email(beta_user_service_set_email_request, opts = {})
|
1361
|
+
def set_email(beta_user_service_set_email_request = {}, opts = {})
|
1362
1362
|
if @api_client.config.debugging
|
1363
1363
|
@api_client.config.logger.debug 'Calling API: Api::BetaUserServiceApi.set_email ...' # MODIFIED
|
1364
1364
|
end
|
@@ -1411,12 +1411,12 @@ module Zitadel::Client::Api
|
|
1411
1411
|
return data
|
1412
1412
|
end
|
1413
1413
|
|
1414
|
-
#
|
1415
|
-
# Change
|
1414
|
+
# Change password
|
1415
|
+
# Change the password of a user with either a verification code or the current password. Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
1416
1416
|
# @param beta_user_service_set_password_request [BetaUserServiceSetPasswordRequest]
|
1417
1417
|
# @param [Hash] opts the optional parameters
|
1418
1418
|
# @return [BetaUserServiceSetPasswordResponse]
|
1419
|
-
def set_password(beta_user_service_set_password_request, opts = {})
|
1419
|
+
def set_password(beta_user_service_set_password_request = {}, opts = {})
|
1420
1420
|
if @api_client.config.debugging
|
1421
1421
|
@api_client.config.logger.debug 'Calling API: Api::BetaUserServiceApi.set_password ...' # MODIFIED
|
1422
1422
|
end
|
@@ -1469,12 +1469,12 @@ module Zitadel::Client::Api
|
|
1469
1469
|
return data
|
1470
1470
|
end
|
1471
1471
|
|
1472
|
-
#
|
1473
|
-
# Set the
|
1472
|
+
# Set the user phone
|
1473
|
+
# 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. Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
1474
1474
|
# @param beta_user_service_set_phone_request [BetaUserServiceSetPhoneRequest]
|
1475
1475
|
# @param [Hash] opts the optional parameters
|
1476
1476
|
# @return [BetaUserServiceSetPhoneResponse]
|
1477
|
-
def set_phone(beta_user_service_set_phone_request, opts = {})
|
1477
|
+
def set_phone(beta_user_service_set_phone_request = {}, opts = {})
|
1478
1478
|
if @api_client.config.debugging
|
1479
1479
|
@api_client.config.logger.debug 'Calling API: Api::BetaUserServiceApi.set_phone ...' # MODIFIED
|
1480
1480
|
end
|
@@ -1527,12 +1527,12 @@ module Zitadel::Client::Api
|
|
1527
1527
|
return data
|
1528
1528
|
end
|
1529
1529
|
|
1530
|
-
#
|
1531
|
-
# Start
|
1530
|
+
# Start flow with an identity provider
|
1531
|
+
# Start a flow with an identity provider, for external login, registration or linking. Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
1532
1532
|
# @param beta_user_service_start_identity_provider_intent_request [BetaUserServiceStartIdentityProviderIntentRequest]
|
1533
1533
|
# @param [Hash] opts the optional parameters
|
1534
1534
|
# @return [BetaUserServiceStartIdentityProviderIntentResponse]
|
1535
|
-
def start_identity_provider_intent(beta_user_service_start_identity_provider_intent_request, opts = {})
|
1535
|
+
def start_identity_provider_intent(beta_user_service_start_identity_provider_intent_request = {}, opts = {})
|
1536
1536
|
if @api_client.config.debugging
|
1537
1537
|
@api_client.config.logger.debug 'Calling API: Api::BetaUserServiceApi.start_identity_provider_intent ...' # MODIFIED
|
1538
1538
|
end
|
@@ -1585,8 +1585,8 @@ module Zitadel::Client::Api
|
|
1585
1585
|
return data
|
1586
1586
|
end
|
1587
1587
|
|
1588
|
-
#
|
1589
|
-
#
|
1588
|
+
# Unlock user
|
1589
|
+
# 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.). Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
1590
1590
|
# @param beta_user_service_unlock_user_request [BetaUserServiceUnlockUserRequest]
|
1591
1591
|
# @param [Hash] opts the optional parameters
|
1592
1592
|
# @return [BetaUserServiceUnlockUserResponse]
|
@@ -1643,8 +1643,8 @@ module Zitadel::Client::Api
|
|
1643
1643
|
return data
|
1644
1644
|
end
|
1645
1645
|
|
1646
|
-
#
|
1647
|
-
# Update
|
1646
|
+
# Update User
|
1647
|
+
# Update all information from a user. Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
1648
1648
|
# @param beta_user_service_update_human_user_request [BetaUserServiceUpdateHumanUserRequest]
|
1649
1649
|
# @param [Hash] opts the optional parameters
|
1650
1650
|
# @return [BetaUserServiceUpdateHumanUserResponse]
|
@@ -1701,8 +1701,8 @@ module Zitadel::Client::Api
|
|
1701
1701
|
return data
|
1702
1702
|
end
|
1703
1703
|
|
1704
|
-
#
|
1705
|
-
# Verify the email
|
1704
|
+
# Verify the email
|
1705
|
+
# Verify the email with the generated code. Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
1706
1706
|
# @param beta_user_service_verify_email_request [BetaUserServiceVerifyEmailRequest]
|
1707
1707
|
# @param [Hash] opts the optional parameters
|
1708
1708
|
# @return [BetaUserServiceVerifyEmailResponse]
|
@@ -1759,8 +1759,8 @@ module Zitadel::Client::Api
|
|
1759
1759
|
return data
|
1760
1760
|
end
|
1761
1761
|
|
1762
|
-
#
|
1763
|
-
# Verify
|
1762
|
+
# Verify a passkey for a user
|
1763
|
+
# Verify the passkey registration with the public key credential. Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
1764
1764
|
# @param beta_user_service_verify_passkey_registration_request [BetaUserServiceVerifyPasskeyRegistrationRequest]
|
1765
1765
|
# @param [Hash] opts the optional parameters
|
1766
1766
|
# @return [BetaUserServiceVerifyPasskeyRegistrationResponse]
|
@@ -1817,8 +1817,8 @@ module Zitadel::Client::Api
|
|
1817
1817
|
return data
|
1818
1818
|
end
|
1819
1819
|
|
1820
|
-
#
|
1821
|
-
# Verify the phone
|
1820
|
+
# Verify the phone
|
1821
|
+
# Verify the phone with the generated code. Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
1822
1822
|
# @param beta_user_service_verify_phone_request [BetaUserServiceVerifyPhoneRequest]
|
1823
1823
|
# @param [Hash] opts the optional parameters
|
1824
1824
|
# @return [BetaUserServiceVerifyPhoneResponse]
|
@@ -1875,8 +1875,8 @@ module Zitadel::Client::Api
|
|
1875
1875
|
return data
|
1876
1876
|
end
|
1877
1877
|
|
1878
|
-
#
|
1879
|
-
# Verify
|
1878
|
+
# Verify a TOTP generator for a user
|
1879
|
+
# Verify the TOTP registration with a generated code. Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
1880
1880
|
# @param beta_user_service_verify_totp_registration_request [BetaUserServiceVerifyTOTPRegistrationRequest]
|
1881
1881
|
# @param [Hash] opts the optional parameters
|
1882
1882
|
# @return [BetaUserServiceVerifyTOTPRegistrationResponse]
|
@@ -1933,8 +1933,8 @@ module Zitadel::Client::Api
|
|
1933
1933
|
return data
|
1934
1934
|
end
|
1935
1935
|
|
1936
|
-
#
|
1937
|
-
# Verify
|
1936
|
+
# Verify a u2f token for a user
|
1937
|
+
# Verify the u2f token registration with the public key credential. Deprecated: please move to the corresponding endpoint under user service v2 (GA).
|
1938
1938
|
# @param beta_user_service_verify_u2_f_registration_request [BetaUserServiceVerifyU2FRegistrationRequest]
|
1939
1939
|
# @param [Hash] opts the optional parameters
|
1940
1940
|
# @return [BetaUserServiceVerifyU2FRegistrationResponse]
|
@@ -19,8 +19,8 @@ module Zitadel::Client::Api
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
#
|
23
|
-
#
|
22
|
+
# Activate Web Key
|
23
|
+
# Switch the active signing web key. The previously active key will be deactivated. Note that the JWKs OIDC endpoint returns a cacheable response. Therefore it is not advised to activate a key that has been created within the cache duration (default is 5min), as the public key may not have been propagated to caches and clients yet. Required permission: - `iam.web_key.write` Required feature flag: - `web_key`
|
24
24
|
# @param beta_web_key_service_activate_web_key_request [BetaWebKeyServiceActivateWebKeyRequest]
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @return [BetaWebKeyServiceActivateWebKeyResponse]
|
@@ -77,8 +77,8 @@ module Zitadel::Client::Api
|
|
77
77
|
return data
|
78
78
|
end
|
79
79
|
|
80
|
-
#
|
81
|
-
#
|
80
|
+
# Create Web Key
|
81
|
+
# Generate a private and public key pair. The private key can be used to sign OIDC tokens after activation. The public key can be used to validate OIDC tokens. The newly created key will have the state `STATE_INITIAL` and is published to the public key endpoint. Note that the JWKs OIDC endpoint returns a cacheable response. If no key type is provided, a RSA key pair with 2048 bits and SHA256 hashing will be created. Required permission: - `iam.web_key.write` Required feature flag: - `web_key`
|
82
82
|
# @param beta_web_key_service_create_web_key_request [BetaWebKeyServiceCreateWebKeyRequest]
|
83
83
|
# @param [Hash] opts the optional parameters
|
84
84
|
# @return [BetaWebKeyServiceCreateWebKeyResponse]
|
@@ -135,8 +135,8 @@ module Zitadel::Client::Api
|
|
135
135
|
return data
|
136
136
|
end
|
137
137
|
|
138
|
-
#
|
139
|
-
# Delete
|
138
|
+
# Delete Web Key
|
139
|
+
# Delete a web key pair. Only inactive keys can be deleted. Once a key is deleted, any tokens signed by this key will be invalid. Note that the JWKs OIDC endpoint returns a cacheable response. In case the web key is not found, the request will return a successful response as the desired state is already achieved. You can check the change date in the response to verify if the web key was deleted during the request. Required permission: - `iam.web_key.delete` Required feature flag: - `web_key`
|
140
140
|
# @param beta_web_key_service_delete_web_key_request [BetaWebKeyServiceDeleteWebKeyRequest]
|
141
141
|
# @param [Hash] opts the optional parameters
|
142
142
|
# @return [BetaWebKeyServiceDeleteWebKeyResponse]
|
@@ -193,8 +193,8 @@ module Zitadel::Client::Api
|
|
193
193
|
return data
|
194
194
|
end
|
195
195
|
|
196
|
-
#
|
197
|
-
# List
|
196
|
+
# List Web Keys
|
197
|
+
# List all web keys and their states. Required permission: - `iam.web_key.read` Required feature flag: - `web_key`
|
198
198
|
# @param body [Object]
|
199
199
|
# @param [Hash] opts the optional parameters
|
200
200
|
# @return [BetaWebKeyServiceListWebKeysResponse]
|
@@ -19,8 +19,8 @@ module Zitadel::Client::Api
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
#
|
23
|
-
#
|
22
|
+
# Get Instance Features
|
23
|
+
# Returns all configured features for an instance. Unset fields mean the feature is the current system default. Required permissions: - none
|
24
24
|
# @param feature_service_get_instance_features_request [FeatureServiceGetInstanceFeaturesRequest]
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @return [FeatureServiceGetInstanceFeaturesResponse]
|
@@ -77,8 +77,8 @@ module Zitadel::Client::Api
|
|
77
77
|
return data
|
78
78
|
end
|
79
79
|
|
80
|
-
#
|
81
|
-
#
|
80
|
+
# Get Organization Features
|
81
|
+
# Returns all configured features for an organization. Unset fields mean the feature is the current instance default. Required permissions: - org.feature.read - no permission required for the organization the user belongs to
|
82
82
|
# @param feature_service_get_organization_features_request [FeatureServiceGetOrganizationFeaturesRequest]
|
83
83
|
# @param [Hash] opts the optional parameters
|
84
84
|
# @return [FeatureServiceGetOrganizationFeaturesResponse]
|
@@ -135,8 +135,8 @@ module Zitadel::Client::Api
|
|
135
135
|
return data
|
136
136
|
end
|
137
137
|
|
138
|
-
#
|
139
|
-
#
|
138
|
+
# Get System Features
|
139
|
+
# Returns all configured features for the system. Unset fields mean the feature is the current system default. Required permissions: - none
|
140
140
|
# @param body [Object]
|
141
141
|
# @param [Hash] opts the optional parameters
|
142
142
|
# @return [FeatureServiceGetSystemFeaturesResponse]
|
@@ -193,8 +193,8 @@ module Zitadel::Client::Api
|
|
193
193
|
return data
|
194
194
|
end
|
195
195
|
|
196
|
-
#
|
197
|
-
#
|
196
|
+
# Get User Features
|
197
|
+
# Returns all configured features for a user. Unset fields mean the feature is the current organization default. Required permissions: - user.feature.read - no permission required for the own user
|
198
198
|
# @param feature_service_get_user_features_request [FeatureServiceGetUserFeaturesRequest]
|
199
199
|
# @param [Hash] opts the optional parameters
|
200
200
|
# @return [FeatureServiceGetUserFeaturesResponse]
|
@@ -251,8 +251,8 @@ module Zitadel::Client::Api
|
|
251
251
|
return data
|
252
252
|
end
|
253
253
|
|
254
|
-
#
|
255
|
-
#
|
254
|
+
# Reset Instance Features
|
255
|
+
# Deletes ALL configured features for an instance, reverting the behaviors to system defaults. Required permissions: - iam.feature.delete
|
256
256
|
# @param body [Object]
|
257
257
|
# @param [Hash] opts the optional parameters
|
258
258
|
# @return [FeatureServiceResetInstanceFeaturesResponse]
|
@@ -309,8 +309,8 @@ module Zitadel::Client::Api
|
|
309
309
|
return data
|
310
310
|
end
|
311
311
|
|
312
|
-
#
|
313
|
-
#
|
312
|
+
# Reset Organization Features
|
313
|
+
# Deletes ALL configured features for an organization, reverting the behaviors to instance defaults. Required permissions: - org.feature.delete
|
314
314
|
# @param feature_service_reset_organization_features_request [FeatureServiceResetOrganizationFeaturesRequest]
|
315
315
|
# @param [Hash] opts the optional parameters
|
316
316
|
# @return [FeatureServiceResetOrganizationFeaturesResponse]
|
@@ -367,8 +367,8 @@ module Zitadel::Client::Api
|
|
367
367
|
return data
|
368
368
|
end
|
369
369
|
|
370
|
-
#
|
371
|
-
#
|
370
|
+
# Reset System Features
|
371
|
+
# Deletes ALL configured features for the system, reverting the behaviors to system defaults. Required permissions: - system.feature.delete
|
372
372
|
# @param body [Object]
|
373
373
|
# @param [Hash] opts the optional parameters
|
374
374
|
# @return [FeatureServiceResetSystemFeaturesResponse]
|
@@ -425,8 +425,8 @@ module Zitadel::Client::Api
|
|
425
425
|
return data
|
426
426
|
end
|
427
427
|
|
428
|
-
#
|
429
|
-
#
|
428
|
+
# Reset User Features
|
429
|
+
# Deletes ALL configured features for a user, reverting the behaviors to organization defaults. Required permissions: - user.feature.delete
|
430
430
|
# @param feature_service_reset_user_features_request [FeatureServiceResetUserFeaturesRequest]
|
431
431
|
# @param [Hash] opts the optional parameters
|
432
432
|
# @return [FeatureServiceResetUserFeaturesResponse]
|
@@ -483,8 +483,8 @@ module Zitadel::Client::Api
|
|
483
483
|
return data
|
484
484
|
end
|
485
485
|
|
486
|
-
#
|
487
|
-
#
|
486
|
+
# Set Instance Features
|
487
|
+
# Configure and set features that apply to a complete instance. Only fields present in the request are set or unset. Required permissions: - iam.feature.write
|
488
488
|
# @param feature_service_set_instance_features_request [FeatureServiceSetInstanceFeaturesRequest]
|
489
489
|
# @param [Hash] opts the optional parameters
|
490
490
|
# @return [FeatureServiceSetInstanceFeaturesResponse]
|
@@ -541,8 +541,8 @@ module Zitadel::Client::Api
|
|
541
541
|
return data
|
542
542
|
end
|
543
543
|
|
544
|
-
#
|
545
|
-
#
|
544
|
+
# Set Organization Features
|
545
|
+
# Configure and set features that apply to a complete instance. Only fields present in the request are set or unset. Required permissions: - org.feature.write
|
546
546
|
# @param feature_service_set_organization_features_request [FeatureServiceSetOrganizationFeaturesRequest]
|
547
547
|
# @param [Hash] opts the optional parameters
|
548
548
|
# @return [FeatureServiceSetOrganizationFeaturesResponse]
|
@@ -599,8 +599,8 @@ module Zitadel::Client::Api
|
|
599
599
|
return data
|
600
600
|
end
|
601
601
|
|
602
|
-
#
|
603
|
-
#
|
602
|
+
# Set System Features
|
603
|
+
# Configure and set features that apply to the complete system. Only fields present in the request are set or unset. Required permissions: - system.feature.write
|
604
604
|
# @param feature_service_set_system_features_request [FeatureServiceSetSystemFeaturesRequest]
|
605
605
|
# @param [Hash] opts the optional parameters
|
606
606
|
# @return [FeatureServiceSetSystemFeaturesResponse]
|
@@ -657,8 +657,8 @@ module Zitadel::Client::Api
|
|
657
657
|
return data
|
658
658
|
end
|
659
659
|
|
660
|
-
#
|
661
|
-
#
|
660
|
+
# Set User Features
|
661
|
+
# Configure and set features that apply to an user. Only fields present in the request are set or unset. Required permissions: - user.feature.write
|
662
662
|
# @param feature_service_set_user_feature_request [FeatureServiceSetUserFeatureRequest]
|
663
663
|
# @param [Hash] opts the optional parameters
|
664
664
|
# @return [FeatureServiceSetUserFeaturesResponse]
|
@@ -19,8 +19,8 @@ module Zitadel::Client::Api
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
#
|
23
|
-
#
|
22
|
+
# Get identity provider (IdP) by ID
|
23
|
+
# Returns an identity provider (social/enterprise login) by its ID, which can be of the type Google, AzureAD, etc.
|
24
24
|
# @param identity_provider_service_get_idpby_id_request [IdentityProviderServiceGetIDPByIDRequest]
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @return [IdentityProviderServiceGetIDPByIDResponse]
|