ory-kratos-client 0.5.5.alpha2 → 0.6.0.alpha4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +85 -36
- data/docs/AdminApi.md +206 -20
- data/docs/AuthenticateOKBody.md +20 -0
- data/docs/ContainerChangeResponseItem.md +20 -0
- data/docs/ContainerCreateCreatedBody.md +20 -0
- data/docs/ContainerTopOKBody.md +20 -0
- data/docs/ContainerUpdateOKBody.md +18 -0
- data/docs/ContainerWaitOKBody.md +20 -0
- data/docs/ContainerWaitOKBodyError.md +18 -0
- data/docs/ErrorContainer.md +1 -1
- data/docs/ErrorResponse.md +18 -0
- data/docs/GenericErrorPayload.md +1 -1
- data/docs/GraphDriverData.md +20 -0
- data/docs/IdResponse.md +18 -0
- data/docs/IdentityCredentials.md +22 -0
- data/docs/ImageDeleteResponseItem.md +20 -0
- data/docs/ImageSummary.md +36 -0
- data/docs/InlineResponse200.md +18 -0
- data/docs/InlineResponse2001.md +18 -0
- data/docs/InlineResponse503.md +18 -0
- data/docs/LoginFlow.md +5 -7
- data/docs/Meta.md +18 -0
- data/docs/Plugin.md +28 -0
- data/docs/PluginConfig.md +48 -0
- data/docs/PluginConfigArgs.md +24 -0
- data/docs/PluginConfigInterface.md +20 -0
- data/docs/PluginConfigLinux.md +22 -0
- data/docs/PluginConfigNetwork.md +18 -0
- data/docs/PluginConfigRootfs.md +20 -0
- data/docs/PluginConfigUser.md +20 -0
- data/docs/PluginDevice.md +24 -0
- data/docs/PluginEnv.md +24 -0
- data/docs/PluginInterfaceType.md +22 -0
- data/docs/PluginMount.md +30 -0
- data/docs/PluginSettings.md +24 -0
- data/docs/Port.md +24 -0
- data/docs/PublicApi.md +481 -552
- data/docs/RecoveryFlow.md +4 -6
- data/docs/RegistrationFlow.md +4 -6
- data/docs/ServiceUpdateResponse.md +18 -0
- data/docs/SettingsFlow.md +4 -6
- data/docs/{RecoveryFlowMethodConfig.md → SettingsProfileFormConfig.md} +6 -6
- data/docs/SubmitSelfServiceBrowserSettingsOIDCFlowPayload.md +22 -0
- data/docs/SubmitSelfServiceLoginFlow.md +47 -0
- data/docs/SubmitSelfServiceLoginFlowWithPasswordMethod.md +24 -0
- data/docs/{CompleteSelfServiceRecoveryFlowWithLinkMethod.md → SubmitSelfServiceRecoveryFlowWithLinkMethod.md} +2 -2
- data/docs/SubmitSelfServiceRegistrationFlow.md +47 -0
- data/docs/SubmitSelfServiceRegistrationFlowWithPasswordMethod.md +24 -0
- data/docs/SubmitSelfServiceSettingsFlow.md +49 -0
- data/docs/{CompleteSelfServiceSettingsFlowWithPasswordMethod.md → SubmitSelfServiceSettingsFlowWithPasswordMethod.md} +4 -2
- data/docs/SubmitSelfServiceSettingsFlowWithProfileMethod.md +22 -0
- data/docs/{CompleteSelfServiceVerificationFlowWithLinkMethod.md → SubmitSelfServiceVerificationFlowWithLinkMethod.md} +2 -2
- data/docs/{SettingsFlowMethodConfig.md → UiContainer.md} +6 -6
- data/docs/UiNode.md +26 -0
- data/docs/UiNodeAnchorAttributes.md +20 -0
- data/docs/UiNodeAttributes.md +53 -0
- data/docs/UiNodeImageAttributes.md +18 -0
- data/docs/UiNodeInputAttributes.md +30 -0
- data/docs/UiNodeInputAttributesValue.md +51 -0
- data/docs/UiNodeTextAttributes.md +18 -0
- data/docs/UiText.md +24 -0
- data/docs/VerificationFlow.md +6 -8
- data/docs/Volume.md +34 -0
- data/docs/VolumeUsageData.md +20 -0
- data/lib/ory-kratos-client.rb +59 -23
- data/lib/ory-kratos-client/api/admin_api.rb +207 -36
- data/lib/ory-kratos-client/api/public_api.rb +494 -538
- data/lib/ory-kratos-client/api_client.rb +6 -6
- data/lib/ory-kratos-client/api_error.rb +5 -5
- data/lib/ory-kratos-client/configuration.rb +36 -13
- data/lib/ory-kratos-client/models/authenticate_ok_body.rb +240 -0
- data/lib/ory-kratos-client/models/container_change_response_item.rb +240 -0
- data/lib/ory-kratos-client/models/container_create_created_body.rb +242 -0
- data/lib/ory-kratos-client/models/container_top_ok_body.rb +244 -0
- data/lib/ory-kratos-client/models/container_update_ok_body.rb +227 -0
- data/lib/ory-kratos-client/models/container_wait_ok_body.rb +239 -0
- data/lib/ory-kratos-client/models/container_wait_ok_body_error.rb +220 -0
- data/lib/ory-kratos-client/models/create_identity.rb +5 -5
- data/lib/ory-kratos-client/models/create_recovery_link.rb +5 -5
- data/lib/ory-kratos-client/models/error_container.rb +9 -7
- data/lib/ory-kratos-client/models/{registration_flow_method.rb → error_response.rb} +19 -33
- data/lib/ory-kratos-client/models/generic_error.rb +5 -5
- data/lib/ory-kratos-client/models/generic_error_payload.rb +9 -7
- data/lib/ory-kratos-client/models/graph_driver_data.rb +241 -0
- data/lib/ory-kratos-client/models/health_not_ready_status.rb +5 -5
- data/lib/ory-kratos-client/models/health_status.rb +5 -5
- data/lib/ory-kratos-client/models/id_response.rb +225 -0
- data/lib/ory-kratos-client/models/identity.rb +5 -5
- data/lib/ory-kratos-client/models/identity_credentials.rb +241 -0
- data/lib/ory-kratos-client/models/{complete_self_service_login_flow_with_password_method.rb → image_delete_response_item.rb} +24 -33
- data/lib/ory-kratos-client/models/image_summary.rb +366 -0
- data/lib/ory-kratos-client/models/{recovery_flow_method.rb → inline_response200.rb} +19 -33
- data/lib/ory-kratos-client/models/{settings_flow_method.rb → inline_response2001.rb} +19 -33
- data/lib/ory-kratos-client/models/inline_response503.rb +226 -0
- data/lib/ory-kratos-client/models/login_flow.rb +29 -38
- data/lib/ory-kratos-client/models/login_via_api_response.rb +5 -5
- data/lib/ory-kratos-client/models/meta.rb +219 -0
- data/lib/ory-kratos-client/models/plugin.rb +288 -0
- data/lib/ory-kratos-client/models/plugin_config.rb +434 -0
- data/lib/ory-kratos-client/models/plugin_config_args.rb +274 -0
- data/lib/ory-kratos-client/models/plugin_config_interface.rb +242 -0
- data/lib/ory-kratos-client/models/plugin_config_linux.rb +259 -0
- data/lib/ory-kratos-client/models/{message.rb → plugin_config_network.rb} +17 -38
- data/lib/ory-kratos-client/models/plugin_config_rootfs.rb +232 -0
- data/lib/ory-kratos-client/models/plugin_config_user.rb +230 -0
- data/lib/ory-kratos-client/models/plugin_device.rb +272 -0
- data/lib/ory-kratos-client/models/plugin_env.rb +272 -0
- data/lib/ory-kratos-client/models/{settings_flow_method_config.rb → plugin_interface_type.rb} +40 -52
- data/lib/ory-kratos-client/models/plugin_mount.rb +319 -0
- data/lib/ory-kratos-client/models/plugin_settings.rb +277 -0
- data/lib/ory-kratos-client/models/port.rb +260 -0
- data/lib/ory-kratos-client/models/recovery_address.rb +5 -5
- data/lib/ory-kratos-client/models/recovery_flow.rb +24 -38
- data/lib/ory-kratos-client/models/recovery_link.rb +5 -5
- data/lib/ory-kratos-client/models/registration_flow.rb +24 -38
- data/lib/ory-kratos-client/models/registration_via_api_response.rb +5 -5
- data/lib/ory-kratos-client/models/revoke_session.rb +5 -5
- data/lib/ory-kratos-client/models/service_update_response.rb +222 -0
- data/lib/ory-kratos-client/models/session.rb +5 -5
- data/lib/ory-kratos-client/models/settings_flow.rb +24 -38
- data/lib/ory-kratos-client/models/{login_flow_method_config.rb → settings_profile_form_config.rb} +22 -35
- data/lib/ory-kratos-client/models/settings_via_api_response.rb +5 -5
- data/lib/ory-kratos-client/models/submit_self_service_browser_settings_oidc_flow_payload.rb +239 -0
- data/lib/ory-kratos-client/models/submit_self_service_login_flow.rb +104 -0
- data/lib/ory-kratos-client/models/submit_self_service_login_flow_with_password_method.rb +249 -0
- data/lib/ory-kratos-client/models/{complete_self_service_recovery_flow_with_link_method.rb → submit_self_service_recovery_flow_with_link_method.rb} +8 -8
- data/lib/ory-kratos-client/models/submit_self_service_registration_flow.rb +104 -0
- data/lib/ory-kratos-client/models/{recovery_flow_method_config.rb → submit_self_service_registration_flow_with_password_method.rb} +38 -50
- data/lib/ory-kratos-client/models/submit_self_service_settings_flow.rb +105 -0
- data/lib/ory-kratos-client/models/{complete_self_service_settings_flow_with_password_method.rb → submit_self_service_settings_flow_with_password_method.rb} +19 -9
- data/lib/ory-kratos-client/models/submit_self_service_settings_flow_with_profile_method.rb +245 -0
- data/lib/ory-kratos-client/models/{complete_self_service_verification_flow_with_link_method.rb → submit_self_service_verification_flow_with_link_method.rb} +9 -8
- data/lib/ory-kratos-client/models/{registration_flow_method_config.rb → ui_container.rb} +23 -35
- data/lib/ory-kratos-client/models/ui_node.rb +282 -0
- data/lib/ory-kratos-client/models/{verification_flow_method.rb → ui_node_anchor_attributes.rb} +28 -28
- data/lib/ory-kratos-client/models/ui_node_attributes.rb +107 -0
- data/lib/ory-kratos-client/models/ui_node_image_attributes.rb +224 -0
- data/lib/ory-kratos-client/models/{form_field.rb → ui_node_input_attributes.rb} +26 -25
- data/lib/ory-kratos-client/models/ui_node_input_attributes_value.rb +106 -0
- data/lib/ory-kratos-client/models/{login_flow_method.rb → ui_node_text_attributes.rb} +18 -33
- data/lib/ory-kratos-client/models/{verification_flow_method_config.rb → ui_text.rb} +44 -49
- data/lib/ory-kratos-client/models/update_identity.rb +5 -5
- data/lib/ory-kratos-client/models/verifiable_address.rb +5 -5
- data/lib/ory-kratos-client/models/verification_flow.rb +32 -36
- data/lib/ory-kratos-client/models/version.rb +5 -5
- data/lib/ory-kratos-client/models/volume.rb +335 -0
- data/lib/ory-kratos-client/models/volume_usage_data.rb +240 -0
- data/lib/ory-kratos-client/version.rb +6 -6
- data/ory-kratos-client.gemspec +7 -7
- data/spec/api/admin_api_spec.rb +134 -41
- data/spec/api/public_api_spec.rb +268 -37
- data/spec/api_client_spec.rb +5 -5
- data/spec/configuration_spec.rb +8 -8
- data/spec/models/authenticate_ok_body_spec.rb +40 -0
- data/spec/models/container_change_response_item_spec.rb +40 -0
- data/spec/models/container_create_created_body_spec.rb +40 -0
- data/spec/models/container_top_ok_body_spec.rb +40 -0
- data/spec/models/container_update_ok_body_spec.rb +34 -0
- data/spec/models/container_wait_ok_body_error_spec.rb +34 -0
- data/spec/models/container_wait_ok_body_spec.rb +40 -0
- data/spec/models/create_identity_spec.rb +8 -15
- data/spec/models/create_recovery_link_spec.rb +8 -15
- data/spec/models/error_container_spec.rb +8 -15
- data/spec/models/error_response_spec.rb +34 -0
- data/spec/models/generic_error_payload_spec.rb +8 -15
- data/spec/models/generic_error_spec.rb +8 -33
- data/spec/models/graph_driver_data_spec.rb +40 -0
- data/spec/models/health_not_ready_status_spec.rb +8 -15
- data/spec/models/health_status_spec.rb +8 -15
- data/spec/models/id_response_spec.rb +34 -0
- data/spec/models/identity_credentials_spec.rb +46 -0
- data/spec/models/identity_spec.rb +27 -16
- data/spec/models/image_delete_response_item_spec.rb +40 -0
- data/spec/models/image_summary_spec.rb +88 -0
- data/spec/models/inline_response2001_spec.rb +34 -0
- data/spec/models/inline_response200_spec.rb +34 -0
- data/spec/models/inline_response503_spec.rb +34 -0
- data/spec/models/login_flow_spec.rb +11 -24
- data/spec/models/login_via_api_response_spec.rb +8 -15
- data/spec/models/meta_spec.rb +34 -0
- data/spec/models/plugin_config_args_spec.rb +52 -0
- data/spec/models/plugin_config_interface_spec.rb +40 -0
- data/spec/models/plugin_config_linux_spec.rb +46 -0
- data/spec/models/plugin_config_network_spec.rb +34 -0
- data/spec/models/plugin_config_rootfs_spec.rb +40 -0
- data/spec/models/plugin_config_spec.rb +124 -0
- data/spec/models/plugin_config_user_spec.rb +40 -0
- data/spec/models/plugin_device_spec.rb +52 -0
- data/spec/models/plugin_env_spec.rb +52 -0
- data/spec/models/plugin_interface_type_spec.rb +46 -0
- data/spec/models/{settings_request_spec.rb → plugin_mount_spec.rb} +18 -31
- data/spec/models/plugin_settings_spec.rb +52 -0
- data/spec/models/{registration_request_spec.rb → plugin_spec.rb} +16 -23
- data/spec/models/port_spec.rb +52 -0
- data/spec/models/recovery_address_spec.rb +8 -15
- data/spec/models/recovery_flow_spec.rb +12 -25
- data/spec/models/recovery_link_spec.rb +8 -15
- data/spec/models/registration_flow_spec.rb +11 -24
- data/spec/models/registration_via_api_response_spec.rb +8 -15
- data/spec/models/revoke_session_spec.rb +8 -15
- data/spec/models/service_update_response_spec.rb +34 -0
- data/spec/models/session_spec.rb +17 -18
- data/spec/models/settings_flow_spec.rb +12 -25
- data/spec/models/settings_profile_form_config_spec.rb +52 -0
- data/spec/models/settings_via_api_response_spec.rb +8 -15
- data/spec/models/submit_self_service_browser_settings_oidc_flow_payload_spec.rb +46 -0
- data/spec/models/submit_self_service_login_flow_spec.rb +31 -0
- data/spec/models/submit_self_service_login_flow_with_password_method_spec.rb +52 -0
- data/spec/models/submit_self_service_recovery_flow_with_link_method_spec.rb +40 -0
- data/spec/models/submit_self_service_registration_flow_spec.rb +31 -0
- data/spec/models/submit_self_service_registration_flow_with_password_method_spec.rb +46 -0
- data/spec/models/submit_self_service_settings_flow_spec.rb +31 -0
- data/spec/models/submit_self_service_settings_flow_with_password_method_spec.rb +46 -0
- data/spec/models/submit_self_service_settings_flow_with_profile_method_spec.rb +46 -0
- data/spec/models/submit_self_service_verification_flow_with_link_method_spec.rb +40 -0
- data/spec/models/{registration_flow_method_config_spec.rb → ui_container_spec.rb} +12 -25
- data/spec/models/ui_node_anchor_attributes_spec.rb +40 -0
- data/spec/models/ui_node_attributes_spec.rb +31 -0
- data/spec/models/ui_node_image_attributes_spec.rb +34 -0
- data/spec/models/{verification_request_spec.rb → ui_node_input_attributes_spec.rb} +18 -25
- data/spec/models/ui_node_input_attributes_value_spec.rb +31 -0
- data/spec/models/{login_flow_method_config_spec.rb → ui_node_spec.rb} +15 -22
- data/spec/models/ui_node_text_attributes_spec.rb +34 -0
- data/spec/models/{message_spec.rb → ui_text_spec.rb} +11 -18
- data/spec/models/update_identity_spec.rb +8 -15
- data/spec/models/verifiable_address_spec.rb +10 -17
- data/spec/models/verification_flow_spec.rb +12 -25
- data/spec/models/version_spec.rb +8 -15
- data/spec/models/{recovery_request_spec.rb → volume_spec.rb} +24 -25
- data/spec/models/volume_usage_data_spec.rb +40 -0
- data/spec/spec_helper.rb +5 -5
- metadata +225 -160
- data/docs/CommonApi.md +0 -345
- data/docs/CompleteSelfServiceBrowserProfileManagementFlowPayload.md +0 -17
- data/docs/CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload.md +0 -19
- data/docs/CompleteSelfServiceLoginFlowWithPasswordMethod.md +0 -22
- data/docs/Error.md +0 -17
- data/docs/Form.md +0 -23
- data/docs/FormField.md +0 -30
- data/docs/HealthApi.md +0 -131
- data/docs/LoginFlowMethod.md +0 -20
- data/docs/LoginFlowMethodConfig.md +0 -26
- data/docs/LoginRequest.md +0 -31
- data/docs/LoginRequestMethod.md +0 -19
- data/docs/LoginRequestMethodConfig.md +0 -25
- data/docs/Message.md +0 -24
- data/docs/OidcStrategyCredentialsConfig.md +0 -19
- data/docs/OidcStrategyRequestMethod.md +0 -25
- data/docs/ProfileManagementRequest.md +0 -29
- data/docs/ProviderCredentialsConfig.md +0 -19
- data/docs/RecoveryFlowMethod.md +0 -20
- data/docs/RecoveryRequest.md +0 -31
- data/docs/RecoveryRequestMethod.md +0 -19
- data/docs/RegistrationFlowMethod.md +0 -20
- data/docs/RegistrationFlowMethodConfig.md +0 -26
- data/docs/RegistrationRequest.md +0 -29
- data/docs/RegistrationRequestMethod.md +0 -19
- data/docs/RegistrationRequestMethodConfig.md +0 -25
- data/docs/RequestMethodConfig.md +0 -23
- data/docs/SettingsFlowMethod.md +0 -20
- data/docs/SettingsRequest.md +0 -33
- data/docs/SettingsRequestMethod.md +0 -19
- data/docs/VerificationFlowMethod.md +0 -20
- data/docs/VerificationFlowMethodConfig.md +0 -24
- data/docs/VerificationRequest.md +0 -31
- data/docs/VersionApi.md +0 -69
- data/lib/ory-kratos-client/api/common_api.rb +0 -456
- data/lib/ory-kratos-client/api/health_api.rb +0 -136
- data/lib/ory-kratos-client/api/version_api.rb +0 -79
- data/lib/ory-kratos-client/models/complete_self_service_browser_profile_management_flow_payload.rb +0 -212
- data/lib/ory-kratos-client/models/complete_self_service_browser_settings_strategy_profile_flow_payload.rb +0 -222
- data/lib/ory-kratos-client/models/error.rb +0 -207
- data/lib/ory-kratos-client/models/form.rb +0 -256
- data/lib/ory-kratos-client/models/login_request.rb +0 -304
- data/lib/ory-kratos-client/models/login_request_method.rb +0 -226
- data/lib/ory-kratos-client/models/login_request_method_config.rb +0 -267
- data/lib/ory-kratos-client/models/oidc_strategy_credentials_config.rb +0 -215
- data/lib/ory-kratos-client/models/oidc_strategy_request_method.rb +0 -252
- data/lib/ory-kratos-client/models/profile_management_request.rb +0 -300
- data/lib/ory-kratos-client/models/provider_credentials_config.rb +0 -215
- data/lib/ory-kratos-client/models/recovery_request.rb +0 -309
- data/lib/ory-kratos-client/models/recovery_request_method.rb +0 -216
- data/lib/ory-kratos-client/models/registration_request.rb +0 -294
- data/lib/ory-kratos-client/models/registration_request_method.rb +0 -216
- data/lib/ory-kratos-client/models/registration_request_method_config.rb +0 -267
- data/lib/ory-kratos-client/models/request_method_config.rb +0 -255
- data/lib/ory-kratos-client/models/settings_request.rb +0 -323
- data/lib/ory-kratos-client/models/settings_request_method.rb +0 -216
- data/lib/ory-kratos-client/models/verification_request.rb +0 -276
- data/spec/api/common_api_spec.rb +0 -83
- data/spec/api/health_api_spec.rb +0 -57
- data/spec/api/version_api_spec.rb +0 -46
- data/spec/models/complete_self_service_browser_profile_management_flow_payload_spec.rb +0 -41
- data/spec/models/complete_self_service_browser_settings_strategy_profile_flow_payload_spec.rb +0 -47
- data/spec/models/complete_self_service_login_flow_with_password_method_spec.rb +0 -53
- data/spec/models/complete_self_service_recovery_flow_with_link_method_spec.rb +0 -47
- data/spec/models/complete_self_service_settings_flow_with_password_method_spec.rb +0 -47
- data/spec/models/complete_self_service_verification_flow_with_link_method_spec.rb +0 -47
- data/spec/models/error_spec.rb +0 -41
- data/spec/models/form_field_spec.rb +0 -65
- data/spec/models/form_spec.rb +0 -59
- data/spec/models/login_flow_method_spec.rb +0 -47
- data/spec/models/login_request_method_config_spec.rb +0 -35
- data/spec/models/login_request_method_spec.rb +0 -47
- data/spec/models/login_request_spec.rb +0 -71
- data/spec/models/oidc_strategy_credentials_config_spec.rb +0 -47
- data/spec/models/oidc_strategy_request_method_spec.rb +0 -65
- data/spec/models/profile_management_request_spec.rb +0 -77
- data/spec/models/provider_credentials_config_spec.rb +0 -47
- data/spec/models/recovery_flow_method_config_spec.rb +0 -59
- data/spec/models/recovery_flow_method_spec.rb +0 -47
- data/spec/models/recovery_request_method_spec.rb +0 -47
- data/spec/models/registration_flow_method_spec.rb +0 -47
- data/spec/models/registration_request_method_config_spec.rb +0 -35
- data/spec/models/registration_request_method_spec.rb +0 -47
- data/spec/models/request_method_config_spec.rb +0 -59
- data/spec/models/settings_flow_method_config_spec.rb +0 -59
- data/spec/models/settings_flow_method_spec.rb +0 -47
- data/spec/models/settings_request_method_spec.rb +0 -47
- data/spec/models/verification_flow_method_config_spec.rb +0 -59
- data/spec/models/verification_flow_method_spec.rb +0 -47
@@ -1,12 +1,12 @@
|
|
1
1
|
=begin
|
2
|
-
#Ory Kratos
|
2
|
+
#Ory Kratos API
|
3
3
|
|
4
|
-
#
|
5
|
-
|
6
|
-
The version of the OpenAPI document: v0.5.5-alpha.2
|
4
|
+
#Documentation for all public and administrative Ory Kratos APIs. Public and administrative APIs are exposed on different ports. Public APIs can face the public internet without any protection while administrative APIs should never be exposed without prior authorization. To protect the administative API port you should use something like Nginx, Ory Oathkeeper, or any other technology capable of authorizing incoming requests.
|
7
5
|
|
6
|
+
The version of the OpenAPI document: v0.6.0-alpha.4
|
7
|
+
Contact: hi@ory.sh
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 5.
|
9
|
+
OpenAPI Generator version: 5.1.1
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -20,9 +20,9 @@ module OryHydraClient
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Create an Identity
|
23
|
-
# This endpoint creates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future. Learn how identities work in [
|
23
|
+
# This endpoint creates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
24
24
|
# @param [Hash] opts the optional parameters
|
25
|
-
# @option opts [CreateIdentity] :
|
25
|
+
# @option opts [CreateIdentity] :create_identity
|
26
26
|
# @return [Identity]
|
27
27
|
def create_identity(opts = {})
|
28
28
|
data, _status_code, _headers = create_identity_with_http_info(opts)
|
@@ -30,9 +30,9 @@ module OryHydraClient
|
|
30
30
|
end
|
31
31
|
|
32
32
|
# Create an Identity
|
33
|
-
# This endpoint creates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future. Learn how identities work in [
|
33
|
+
# This endpoint creates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
34
34
|
# @param [Hash] opts the optional parameters
|
35
|
-
# @option opts [CreateIdentity] :
|
35
|
+
# @option opts [CreateIdentity] :create_identity
|
36
36
|
# @return [Array<(Identity, Integer, Hash)>] Identity data, response status code and response headers
|
37
37
|
def create_identity_with_http_info(opts = {})
|
38
38
|
if @api_client.config.debugging
|
@@ -55,7 +55,7 @@ module OryHydraClient
|
|
55
55
|
form_params = opts[:form_params] || {}
|
56
56
|
|
57
57
|
# http body (model)
|
58
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'
|
58
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_identity'])
|
59
59
|
|
60
60
|
# return_type
|
61
61
|
return_type = opts[:debug_return_type] || 'Identity'
|
@@ -83,7 +83,7 @@ module OryHydraClient
|
|
83
83
|
# Create a Recovery Link
|
84
84
|
# This endpoint creates a recovery link which should be given to the user in order for them to recover (or activate) their account.
|
85
85
|
# @param [Hash] opts the optional parameters
|
86
|
-
# @option opts [CreateRecoveryLink] :
|
86
|
+
# @option opts [CreateRecoveryLink] :create_recovery_link
|
87
87
|
# @return [RecoveryLink]
|
88
88
|
def create_recovery_link(opts = {})
|
89
89
|
data, _status_code, _headers = create_recovery_link_with_http_info(opts)
|
@@ -93,7 +93,7 @@ module OryHydraClient
|
|
93
93
|
# Create a Recovery Link
|
94
94
|
# This endpoint creates a recovery link which should be given to the user in order for them to recover (or activate) their account.
|
95
95
|
# @param [Hash] opts the optional parameters
|
96
|
-
# @option opts [CreateRecoveryLink] :
|
96
|
+
# @option opts [CreateRecoveryLink] :create_recovery_link
|
97
97
|
# @return [Array<(RecoveryLink, Integer, Hash)>] RecoveryLink data, response status code and response headers
|
98
98
|
def create_recovery_link_with_http_info(opts = {})
|
99
99
|
if @api_client.config.debugging
|
@@ -116,7 +116,7 @@ module OryHydraClient
|
|
116
116
|
form_params = opts[:form_params] || {}
|
117
117
|
|
118
118
|
# http body (model)
|
119
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'
|
119
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_recovery_link'])
|
120
120
|
|
121
121
|
# return_type
|
122
122
|
return_type = opts[:debug_return_type] || 'RecoveryLink'
|
@@ -142,7 +142,7 @@ module OryHydraClient
|
|
142
142
|
end
|
143
143
|
|
144
144
|
# Delete an Identity
|
145
|
-
# Calling this endpoint irrecoverably and permanently deletes the identity given its ID. This action can not be undone. This endpoint returns 204 when the identity was deleted or when the identity was not found, in which case it is assumed that is has been deleted already. Learn how identities work in [
|
145
|
+
# Calling this endpoint irrecoverably and permanently deletes the identity given its ID. This action can not be undone. This endpoint returns 204 when the identity was deleted or when the identity was not found, in which case it is assumed that is has been deleted already. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
146
146
|
# @param id [String] ID is the identity's ID.
|
147
147
|
# @param [Hash] opts the optional parameters
|
148
148
|
# @return [nil]
|
@@ -152,7 +152,7 @@ module OryHydraClient
|
|
152
152
|
end
|
153
153
|
|
154
154
|
# Delete an Identity
|
155
|
-
# Calling this endpoint irrecoverably and permanently deletes the identity given its ID. This action can not be undone. This endpoint returns 204 when the identity was deleted or when the identity was not found, in which case it is assumed that is has been deleted already. Learn how identities work in [
|
155
|
+
# Calling this endpoint irrecoverably and permanently deletes the identity given its ID. This action can not be undone. This endpoint returns 204 when the identity was deleted or when the identity was not found, in which case it is assumed that is has been deleted already. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
156
156
|
# @param id [String] ID is the identity's ID.
|
157
157
|
# @param [Hash] opts the optional parameters
|
158
158
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -205,7 +205,7 @@ module OryHydraClient
|
|
205
205
|
end
|
206
206
|
|
207
207
|
# Get an Identity
|
208
|
-
# Learn how identities work in [
|
208
|
+
# Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
209
209
|
# @param id [String] ID must be set to the ID of identity you want to get
|
210
210
|
# @param [Hash] opts the optional parameters
|
211
211
|
# @return [Identity]
|
@@ -215,7 +215,7 @@ module OryHydraClient
|
|
215
215
|
end
|
216
216
|
|
217
217
|
# Get an Identity
|
218
|
-
# Learn how identities work in [
|
218
|
+
# Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
219
219
|
# @param id [String] ID must be set to the ID of identity you want to get
|
220
220
|
# @param [Hash] opts the optional parameters
|
221
221
|
# @return [Array<(Identity, Integer, Hash)>] Identity data, response status code and response headers
|
@@ -329,7 +329,7 @@ module OryHydraClient
|
|
329
329
|
end
|
330
330
|
|
331
331
|
# Get User-Facing Self-Service Errors
|
332
|
-
# This endpoint returns the error associated with a user-facing self service errors. This endpoint supports stub values to help you implement the error UI: `?error=stub:500` - returns a stub 500 (Internal Server Error) error. More information can be found at [
|
332
|
+
# This endpoint returns the error associated with a user-facing self service errors. This endpoint supports stub values to help you implement the error UI: `?error=stub:500` - returns a stub 500 (Internal Server Error) error. More information can be found at [Ory Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
|
333
333
|
# @param error [String] Error is the container's ID
|
334
334
|
# @param [Hash] opts the optional parameters
|
335
335
|
# @return [ErrorContainer]
|
@@ -339,7 +339,7 @@ module OryHydraClient
|
|
339
339
|
end
|
340
340
|
|
341
341
|
# Get User-Facing Self-Service Errors
|
342
|
-
# This endpoint returns the error associated with a user-facing self service errors. This endpoint supports stub values to help you implement the error UI: `?error=stub:500` - returns a stub 500 (Internal Server Error) error. More information can be found at [
|
342
|
+
# This endpoint returns the error associated with a user-facing self service errors. This endpoint supports stub values to help you implement the error UI: `?error=stub:500` - returns a stub 500 (Internal Server Error) error. More information can be found at [Ory Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
|
343
343
|
# @param error [String] Error is the container's ID
|
344
344
|
# @param [Hash] opts the optional parameters
|
345
345
|
# @return [Array<(ErrorContainer, Integer, Hash)>] ErrorContainer data, response status code and response headers
|
@@ -393,7 +393,7 @@ module OryHydraClient
|
|
393
393
|
end
|
394
394
|
|
395
395
|
# Get Login Flow
|
396
|
-
# This endpoint returns a login flow's context with, for example, error details and other information. More information can be found at [
|
396
|
+
# This endpoint returns a login flow's context with, for example, error details and other information. More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
397
397
|
# @param id [String] The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`).
|
398
398
|
# @param [Hash] opts the optional parameters
|
399
399
|
# @return [LoginFlow]
|
@@ -403,7 +403,7 @@ module OryHydraClient
|
|
403
403
|
end
|
404
404
|
|
405
405
|
# Get Login Flow
|
406
|
-
# This endpoint returns a login flow's context with, for example, error details and other information. More information can be found at [
|
406
|
+
# This endpoint returns a login flow's context with, for example, error details and other information. More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
407
407
|
# @param id [String] The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`).
|
408
408
|
# @param [Hash] opts the optional parameters
|
409
409
|
# @return [Array<(LoginFlow, Integer, Hash)>] LoginFlow data, response status code and response headers
|
@@ -457,7 +457,7 @@ module OryHydraClient
|
|
457
457
|
end
|
458
458
|
|
459
459
|
# Get information about a recovery flow
|
460
|
-
# This endpoint returns a recovery flow's context with, for example, error details and other information. More information can be found at [
|
460
|
+
# This endpoint returns a recovery flow's context with, for example, error details and other information. More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
|
461
461
|
# @param id [String] The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`).
|
462
462
|
# @param [Hash] opts the optional parameters
|
463
463
|
# @return [RecoveryFlow]
|
@@ -467,7 +467,7 @@ module OryHydraClient
|
|
467
467
|
end
|
468
468
|
|
469
469
|
# Get information about a recovery flow
|
470
|
-
# This endpoint returns a recovery flow's context with, for example, error details and other information. More information can be found at [
|
470
|
+
# This endpoint returns a recovery flow's context with, for example, error details and other information. More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
|
471
471
|
# @param id [String] The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`).
|
472
472
|
# @param [Hash] opts the optional parameters
|
473
473
|
# @return [Array<(RecoveryFlow, Integer, Hash)>] RecoveryFlow data, response status code and response headers
|
@@ -521,7 +521,7 @@ module OryHydraClient
|
|
521
521
|
end
|
522
522
|
|
523
523
|
# Get Registration Flow
|
524
|
-
# This endpoint returns a registration flow's context with, for example, error details and other information. More information can be found at [
|
524
|
+
# This endpoint returns a registration flow's context with, for example, error details and other information. More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
525
525
|
# @param id [String] The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`).
|
526
526
|
# @param [Hash] opts the optional parameters
|
527
527
|
# @return [RegistrationFlow]
|
@@ -531,7 +531,7 @@ module OryHydraClient
|
|
531
531
|
end
|
532
532
|
|
533
533
|
# Get Registration Flow
|
534
|
-
# This endpoint returns a registration flow's context with, for example, error details and other information. More information can be found at [
|
534
|
+
# This endpoint returns a registration flow's context with, for example, error details and other information. More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
535
535
|
# @param id [String] The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`).
|
536
536
|
# @param [Hash] opts the optional parameters
|
537
537
|
# @return [Array<(RegistrationFlow, Integer, Hash)>] RegistrationFlow data, response status code and response headers
|
@@ -585,7 +585,7 @@ module OryHydraClient
|
|
585
585
|
end
|
586
586
|
|
587
587
|
# Get Settings Flow
|
588
|
-
# When accessing this endpoint through
|
588
|
+
# When accessing this endpoint through Ory Kratos' Public API you must ensure that either the Ory Kratos Session Cookie or the Ory Kratos Session Token are set. The public endpoint does not return 404 status codes but instead 403 or 500 to improve data privacy. You can access this endpoint without credentials when using Ory Kratos' Admin API. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
589
589
|
# @param id [String] ID is the Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`).
|
590
590
|
# @param [Hash] opts the optional parameters
|
591
591
|
# @return [SettingsFlow]
|
@@ -595,7 +595,7 @@ module OryHydraClient
|
|
595
595
|
end
|
596
596
|
|
597
597
|
# Get Settings Flow
|
598
|
-
# When accessing this endpoint through
|
598
|
+
# When accessing this endpoint through Ory Kratos' Public API you must ensure that either the Ory Kratos Session Cookie or the Ory Kratos Session Token are set. The public endpoint does not return 404 status codes but instead 403 or 500 to improve data privacy. You can access this endpoint without credentials when using Ory Kratos' Admin API. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
599
599
|
# @param id [String] ID is the Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`).
|
600
600
|
# @param [Hash] opts the optional parameters
|
601
601
|
# @return [Array<(SettingsFlow, Integer, Hash)>] SettingsFlow data, response status code and response headers
|
@@ -649,7 +649,7 @@ module OryHydraClient
|
|
649
649
|
end
|
650
650
|
|
651
651
|
# Get Verification Flow
|
652
|
-
# This endpoint returns a verification flow's context with, for example, error details and other information. More information can be found at [
|
652
|
+
# This endpoint returns a verification flow's context with, for example, error details and other information. More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
|
653
653
|
# @param id [String] The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`).
|
654
654
|
# @param [Hash] opts the optional parameters
|
655
655
|
# @return [VerificationFlow]
|
@@ -659,7 +659,7 @@ module OryHydraClient
|
|
659
659
|
end
|
660
660
|
|
661
661
|
# Get Verification Flow
|
662
|
-
# This endpoint returns a verification flow's context with, for example, error details and other information. More information can be found at [
|
662
|
+
# This endpoint returns a verification flow's context with, for example, error details and other information. More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
|
663
663
|
# @param id [String] The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`).
|
664
664
|
# @param [Hash] opts the optional parameters
|
665
665
|
# @return [Array<(VerificationFlow, Integer, Hash)>] VerificationFlow data, response status code and response headers
|
@@ -712,8 +712,179 @@ module OryHydraClient
|
|
712
712
|
return data, status_code, headers
|
713
713
|
end
|
714
714
|
|
715
|
+
# Return Running Software Version.
|
716
|
+
# This endpoint returns the version of Ory Kratos. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the version will never refer to the cluster state, only to a single instance.
|
717
|
+
# @param [Hash] opts the optional parameters
|
718
|
+
# @return [InlineResponse2001]
|
719
|
+
def get_version(opts = {})
|
720
|
+
data, _status_code, _headers = get_version_with_http_info(opts)
|
721
|
+
data
|
722
|
+
end
|
723
|
+
|
724
|
+
# Return Running Software Version.
|
725
|
+
# This endpoint returns the version of Ory Kratos. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the version will never refer to the cluster state, only to a single instance.
|
726
|
+
# @param [Hash] opts the optional parameters
|
727
|
+
# @return [Array<(InlineResponse2001, Integer, Hash)>] InlineResponse2001 data, response status code and response headers
|
728
|
+
def get_version_with_http_info(opts = {})
|
729
|
+
if @api_client.config.debugging
|
730
|
+
@api_client.config.logger.debug 'Calling API: AdminApi.get_version ...'
|
731
|
+
end
|
732
|
+
# resource path
|
733
|
+
local_var_path = '/version'
|
734
|
+
|
735
|
+
# query parameters
|
736
|
+
query_params = opts[:query_params] || {}
|
737
|
+
|
738
|
+
# header parameters
|
739
|
+
header_params = opts[:header_params] || {}
|
740
|
+
# HTTP header 'Accept' (if needed)
|
741
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
742
|
+
|
743
|
+
# form parameters
|
744
|
+
form_params = opts[:form_params] || {}
|
745
|
+
|
746
|
+
# http body (model)
|
747
|
+
post_body = opts[:debug_body]
|
748
|
+
|
749
|
+
# return_type
|
750
|
+
return_type = opts[:debug_return_type] || 'InlineResponse2001'
|
751
|
+
|
752
|
+
# auth_names
|
753
|
+
auth_names = opts[:debug_auth_names] || []
|
754
|
+
|
755
|
+
new_options = opts.merge(
|
756
|
+
:operation => :"AdminApi.get_version",
|
757
|
+
:header_params => header_params,
|
758
|
+
:query_params => query_params,
|
759
|
+
:form_params => form_params,
|
760
|
+
:body => post_body,
|
761
|
+
:auth_names => auth_names,
|
762
|
+
:return_type => return_type
|
763
|
+
)
|
764
|
+
|
765
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
766
|
+
if @api_client.config.debugging
|
767
|
+
@api_client.config.logger.debug "API called: AdminApi#get_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
768
|
+
end
|
769
|
+
return data, status_code, headers
|
770
|
+
end
|
771
|
+
|
772
|
+
# Check HTTP Server Status
|
773
|
+
# This endpoint returns a HTTP 200 status code when Ory Kratos is accepting incoming HTTP requests. This status does currently not include checks whether the database connection is working. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.
|
774
|
+
# @param [Hash] opts the optional parameters
|
775
|
+
# @return [InlineResponse200]
|
776
|
+
def is_alive(opts = {})
|
777
|
+
data, _status_code, _headers = is_alive_with_http_info(opts)
|
778
|
+
data
|
779
|
+
end
|
780
|
+
|
781
|
+
# Check HTTP Server Status
|
782
|
+
# This endpoint returns a HTTP 200 status code when Ory Kratos is accepting incoming HTTP requests. This status does currently not include checks whether the database connection is working. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.
|
783
|
+
# @param [Hash] opts the optional parameters
|
784
|
+
# @return [Array<(InlineResponse200, Integer, Hash)>] InlineResponse200 data, response status code and response headers
|
785
|
+
def is_alive_with_http_info(opts = {})
|
786
|
+
if @api_client.config.debugging
|
787
|
+
@api_client.config.logger.debug 'Calling API: AdminApi.is_alive ...'
|
788
|
+
end
|
789
|
+
# resource path
|
790
|
+
local_var_path = '/health/alive'
|
791
|
+
|
792
|
+
# query parameters
|
793
|
+
query_params = opts[:query_params] || {}
|
794
|
+
|
795
|
+
# header parameters
|
796
|
+
header_params = opts[:header_params] || {}
|
797
|
+
# HTTP header 'Accept' (if needed)
|
798
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
799
|
+
|
800
|
+
# form parameters
|
801
|
+
form_params = opts[:form_params] || {}
|
802
|
+
|
803
|
+
# http body (model)
|
804
|
+
post_body = opts[:debug_body]
|
805
|
+
|
806
|
+
# return_type
|
807
|
+
return_type = opts[:debug_return_type] || 'InlineResponse200'
|
808
|
+
|
809
|
+
# auth_names
|
810
|
+
auth_names = opts[:debug_auth_names] || []
|
811
|
+
|
812
|
+
new_options = opts.merge(
|
813
|
+
:operation => :"AdminApi.is_alive",
|
814
|
+
:header_params => header_params,
|
815
|
+
:query_params => query_params,
|
816
|
+
:form_params => form_params,
|
817
|
+
:body => post_body,
|
818
|
+
:auth_names => auth_names,
|
819
|
+
:return_type => return_type
|
820
|
+
)
|
821
|
+
|
822
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
823
|
+
if @api_client.config.debugging
|
824
|
+
@api_client.config.logger.debug "API called: AdminApi#is_alive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
825
|
+
end
|
826
|
+
return data, status_code, headers
|
827
|
+
end
|
828
|
+
|
829
|
+
# Check HTTP Server and Database Status
|
830
|
+
# This endpoint returns a HTTP 200 status code when Ory Kratos is up running and the environment dependencies (e.g. the database) are responsive as well. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of Ory Kratos, the health status will never refer to the cluster state, only to a single instance.
|
831
|
+
# @param [Hash] opts the optional parameters
|
832
|
+
# @return [InlineResponse200]
|
833
|
+
def is_ready(opts = {})
|
834
|
+
data, _status_code, _headers = is_ready_with_http_info(opts)
|
835
|
+
data
|
836
|
+
end
|
837
|
+
|
838
|
+
# Check HTTP Server and Database Status
|
839
|
+
# This endpoint returns a HTTP 200 status code when Ory Kratos is up running and the environment dependencies (e.g. the database) are responsive as well. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of Ory Kratos, the health status will never refer to the cluster state, only to a single instance.
|
840
|
+
# @param [Hash] opts the optional parameters
|
841
|
+
# @return [Array<(InlineResponse200, Integer, Hash)>] InlineResponse200 data, response status code and response headers
|
842
|
+
def is_ready_with_http_info(opts = {})
|
843
|
+
if @api_client.config.debugging
|
844
|
+
@api_client.config.logger.debug 'Calling API: AdminApi.is_ready ...'
|
845
|
+
end
|
846
|
+
# resource path
|
847
|
+
local_var_path = '/health/ready'
|
848
|
+
|
849
|
+
# query parameters
|
850
|
+
query_params = opts[:query_params] || {}
|
851
|
+
|
852
|
+
# header parameters
|
853
|
+
header_params = opts[:header_params] || {}
|
854
|
+
# HTTP header 'Accept' (if needed)
|
855
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
856
|
+
|
857
|
+
# form parameters
|
858
|
+
form_params = opts[:form_params] || {}
|
859
|
+
|
860
|
+
# http body (model)
|
861
|
+
post_body = opts[:debug_body]
|
862
|
+
|
863
|
+
# return_type
|
864
|
+
return_type = opts[:debug_return_type] || 'InlineResponse200'
|
865
|
+
|
866
|
+
# auth_names
|
867
|
+
auth_names = opts[:debug_auth_names] || []
|
868
|
+
|
869
|
+
new_options = opts.merge(
|
870
|
+
:operation => :"AdminApi.is_ready",
|
871
|
+
:header_params => header_params,
|
872
|
+
:query_params => query_params,
|
873
|
+
:form_params => form_params,
|
874
|
+
:body => post_body,
|
875
|
+
:auth_names => auth_names,
|
876
|
+
:return_type => return_type
|
877
|
+
)
|
878
|
+
|
879
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
880
|
+
if @api_client.config.debugging
|
881
|
+
@api_client.config.logger.debug "API called: AdminApi#is_ready\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
882
|
+
end
|
883
|
+
return data, status_code, headers
|
884
|
+
end
|
885
|
+
|
715
886
|
# List Identities
|
716
|
-
# Lists all identities. Does not support search at the moment. Learn how identities work in [
|
887
|
+
# Lists all identities. Does not support search at the moment. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
717
888
|
# @param [Hash] opts the optional parameters
|
718
889
|
# @option opts [Integer] :per_page Items per Page This is the number of items per page. (default to 100)
|
719
890
|
# @option opts [Integer] :page Pagination Page (default to 0)
|
@@ -724,7 +895,7 @@ module OryHydraClient
|
|
724
895
|
end
|
725
896
|
|
726
897
|
# List Identities
|
727
|
-
# Lists all identities. Does not support search at the moment. Learn how identities work in [
|
898
|
+
# Lists all identities. Does not support search at the moment. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
728
899
|
# @param [Hash] opts the optional parameters
|
729
900
|
# @option opts [Integer] :per_page Items per Page This is the number of items per page.
|
730
901
|
# @option opts [Integer] :page Pagination Page
|
@@ -843,10 +1014,10 @@ module OryHydraClient
|
|
843
1014
|
end
|
844
1015
|
|
845
1016
|
# Update an Identity
|
846
|
-
# This endpoint updates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future. The full identity payload (except credentials) is expected. This endpoint does not support patching. Learn how identities work in [
|
1017
|
+
# This endpoint updates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future. The full identity payload (except credentials) is expected. This endpoint does not support patching. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
847
1018
|
# @param id [String] ID must be set to the ID of identity you want to update
|
848
1019
|
# @param [Hash] opts the optional parameters
|
849
|
-
# @option opts [UpdateIdentity] :
|
1020
|
+
# @option opts [UpdateIdentity] :update_identity
|
850
1021
|
# @return [Identity]
|
851
1022
|
def update_identity(id, opts = {})
|
852
1023
|
data, _status_code, _headers = update_identity_with_http_info(id, opts)
|
@@ -854,10 +1025,10 @@ module OryHydraClient
|
|
854
1025
|
end
|
855
1026
|
|
856
1027
|
# Update an Identity
|
857
|
-
# This endpoint updates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future. The full identity payload (except credentials) is expected. This endpoint does not support patching. Learn how identities work in [
|
1028
|
+
# This endpoint updates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future. The full identity payload (except credentials) is expected. This endpoint does not support patching. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
858
1029
|
# @param id [String] ID must be set to the ID of identity you want to update
|
859
1030
|
# @param [Hash] opts the optional parameters
|
860
|
-
# @option opts [UpdateIdentity] :
|
1031
|
+
# @option opts [UpdateIdentity] :update_identity
|
861
1032
|
# @return [Array<(Identity, Integer, Hash)>] Identity data, response status code and response headers
|
862
1033
|
def update_identity_with_http_info(id, opts = {})
|
863
1034
|
if @api_client.config.debugging
|
@@ -884,7 +1055,7 @@ module OryHydraClient
|
|
884
1055
|
form_params = opts[:form_params] || {}
|
885
1056
|
|
886
1057
|
# http body (model)
|
887
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'
|
1058
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'update_identity'])
|
888
1059
|
|
889
1060
|
# return_type
|
890
1061
|
return_type = opts[:debug_return_type] || 'Identity'
|
@@ -1,12 +1,12 @@
|
|
1
1
|
=begin
|
2
|
-
#Ory Kratos
|
2
|
+
#Ory Kratos API
|
3
3
|
|
4
|
-
#
|
5
|
-
|
6
|
-
The version of the OpenAPI document: v0.5.5-alpha.2
|
4
|
+
#Documentation for all public and administrative Ory Kratos APIs. Public and administrative APIs are exposed on different ports. Public APIs can face the public internet without any protection while administrative APIs should never be exposed without prior authorization. To protect the administative API port you should use something like Nginx, Ory Oathkeeper, or any other technology capable of authorizing incoming requests.
|
7
5
|
|
6
|
+
The version of the OpenAPI document: v0.6.0-alpha.4
|
7
|
+
Contact: hi@ory.sh
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 5.
|
9
|
+
OpenAPI Generator version: 5.1.1
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -19,25 +19,29 @@ module OryHydraClient
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
#
|
23
|
-
#
|
22
|
+
# Get a Traits Schema Definition
|
23
|
+
# @param id [String] ID must be set to the ID of schema you want to get
|
24
24
|
# @param [Hash] opts the optional parameters
|
25
|
-
# @return [
|
26
|
-
def
|
27
|
-
|
28
|
-
|
25
|
+
# @return [Object]
|
26
|
+
def get_schema(id, opts = {})
|
27
|
+
data, _status_code, _headers = get_schema_with_http_info(id, opts)
|
28
|
+
data
|
29
29
|
end
|
30
30
|
|
31
|
-
#
|
32
|
-
#
|
31
|
+
# Get a Traits Schema Definition
|
32
|
+
# @param id [String] ID must be set to the ID of schema you want to get
|
33
33
|
# @param [Hash] opts the optional parameters
|
34
|
-
# @return [Array<(
|
35
|
-
def
|
34
|
+
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
35
|
+
def get_schema_with_http_info(id, opts = {})
|
36
36
|
if @api_client.config.debugging
|
37
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
37
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.get_schema ...'
|
38
|
+
end
|
39
|
+
# verify the required parameter 'id' is set
|
40
|
+
if @api_client.config.client_side_validation && id.nil?
|
41
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling PublicApi.get_schema"
|
38
42
|
end
|
39
43
|
# resource path
|
40
|
-
local_var_path = '/
|
44
|
+
local_var_path = '/schemas/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
41
45
|
|
42
46
|
# query parameters
|
43
47
|
query_params = opts[:query_params] || {}
|
@@ -54,13 +58,13 @@ module OryHydraClient
|
|
54
58
|
post_body = opts[:debug_body]
|
55
59
|
|
56
60
|
# return_type
|
57
|
-
return_type = opts[:debug_return_type]
|
61
|
+
return_type = opts[:debug_return_type] || 'Object'
|
58
62
|
|
59
63
|
# auth_names
|
60
64
|
auth_names = opts[:debug_auth_names] || []
|
61
65
|
|
62
66
|
new_options = opts.merge(
|
63
|
-
:operation => :"PublicApi.
|
67
|
+
:operation => :"PublicApi.get_schema",
|
64
68
|
:header_params => header_params,
|
65
69
|
:query_params => query_params,
|
66
70
|
:form_params => form_params,
|
@@ -69,66 +73,62 @@ module OryHydraClient
|
|
69
73
|
:return_type => return_type
|
70
74
|
)
|
71
75
|
|
72
|
-
data, status_code, headers = @api_client.call_api(:
|
76
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
73
77
|
if @api_client.config.debugging
|
74
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
78
|
+
@api_client.config.logger.debug "API called: PublicApi#get_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
75
79
|
end
|
76
80
|
return data, status_code, headers
|
77
81
|
end
|
78
82
|
|
79
|
-
#
|
80
|
-
#
|
81
|
-
# @param
|
83
|
+
# Get User-Facing Self-Service Errors
|
84
|
+
# This endpoint returns the error associated with a user-facing self service errors. This endpoint supports stub values to help you implement the error UI: `?error=stub:500` - returns a stub 500 (Internal Server Error) error. More information can be found at [Ory Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
|
85
|
+
# @param error [String] Error is the container's ID
|
82
86
|
# @param [Hash] opts the optional parameters
|
83
|
-
# @
|
84
|
-
|
85
|
-
|
86
|
-
data, _status_code, _headers = complete_self_service_login_flow_with_password_method_with_http_info(flow, opts)
|
87
|
+
# @return [ErrorContainer]
|
88
|
+
def get_self_service_error(error, opts = {})
|
89
|
+
data, _status_code, _headers = get_self_service_error_with_http_info(error, opts)
|
87
90
|
data
|
88
91
|
end
|
89
92
|
|
90
|
-
#
|
91
|
-
#
|
92
|
-
# @param
|
93
|
+
# Get User-Facing Self-Service Errors
|
94
|
+
# This endpoint returns the error associated with a user-facing self service errors. This endpoint supports stub values to help you implement the error UI: `?error=stub:500` - returns a stub 500 (Internal Server Error) error. More information can be found at [Ory Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
|
95
|
+
# @param error [String] Error is the container's ID
|
93
96
|
# @param [Hash] opts the optional parameters
|
94
|
-
# @
|
95
|
-
|
96
|
-
def complete_self_service_login_flow_with_password_method_with_http_info(flow, opts = {})
|
97
|
+
# @return [Array<(ErrorContainer, Integer, Hash)>] ErrorContainer data, response status code and response headers
|
98
|
+
def get_self_service_error_with_http_info(error, opts = {})
|
97
99
|
if @api_client.config.debugging
|
98
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
100
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.get_self_service_error ...'
|
99
101
|
end
|
100
|
-
# verify the required parameter '
|
101
|
-
if @api_client.config.client_side_validation &&
|
102
|
-
fail ArgumentError, "Missing the required parameter '
|
102
|
+
# verify the required parameter 'error' is set
|
103
|
+
if @api_client.config.client_side_validation && error.nil?
|
104
|
+
fail ArgumentError, "Missing the required parameter 'error' when calling PublicApi.get_self_service_error"
|
103
105
|
end
|
104
106
|
# resource path
|
105
|
-
local_var_path = '/self-service/
|
107
|
+
local_var_path = '/self-service/errors'
|
106
108
|
|
107
109
|
# query parameters
|
108
110
|
query_params = opts[:query_params] || {}
|
109
|
-
query_params[:'
|
111
|
+
query_params[:'error'] = error
|
110
112
|
|
111
113
|
# header parameters
|
112
114
|
header_params = opts[:header_params] || {}
|
113
115
|
# HTTP header 'Accept' (if needed)
|
114
116
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
115
|
-
# HTTP header 'Content-Type'
|
116
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])
|
117
117
|
|
118
118
|
# form parameters
|
119
119
|
form_params = opts[:form_params] || {}
|
120
120
|
|
121
121
|
# http body (model)
|
122
|
-
post_body = opts[:debug_body]
|
122
|
+
post_body = opts[:debug_body]
|
123
123
|
|
124
124
|
# return_type
|
125
|
-
return_type = opts[:debug_return_type] || '
|
125
|
+
return_type = opts[:debug_return_type] || 'ErrorContainer'
|
126
126
|
|
127
127
|
# auth_names
|
128
128
|
auth_names = opts[:debug_auth_names] || []
|
129
129
|
|
130
130
|
new_options = opts.merge(
|
131
|
-
:operation => :"PublicApi.
|
131
|
+
:operation => :"PublicApi.get_self_service_error",
|
132
132
|
:header_params => header_params,
|
133
133
|
:query_params => query_params,
|
134
134
|
:form_params => form_params,
|
@@ -137,65 +137,62 @@ module OryHydraClient
|
|
137
137
|
:return_type => return_type
|
138
138
|
)
|
139
139
|
|
140
|
-
data, status_code, headers = @api_client.call_api(:
|
140
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
141
141
|
if @api_client.config.debugging
|
142
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
142
|
+
@api_client.config.logger.debug "API called: PublicApi#get_self_service_error\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
143
143
|
end
|
144
144
|
return data, status_code, headers
|
145
145
|
end
|
146
146
|
|
147
|
-
#
|
148
|
-
#
|
147
|
+
# Get Login Flow
|
148
|
+
# This endpoint returns a login flow's context with, for example, error details and other information. More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
149
|
+
# @param id [String] The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`).
|
149
150
|
# @param [Hash] opts the optional parameters
|
150
|
-
# @
|
151
|
-
|
152
|
-
|
153
|
-
|
154
|
-
def complete_self_service_recovery_flow_with_link_method(opts = {})
|
155
|
-
complete_self_service_recovery_flow_with_link_method_with_http_info(opts)
|
156
|
-
nil
|
151
|
+
# @return [LoginFlow]
|
152
|
+
def get_self_service_login_flow(id, opts = {})
|
153
|
+
data, _status_code, _headers = get_self_service_login_flow_with_http_info(id, opts)
|
154
|
+
data
|
157
155
|
end
|
158
156
|
|
159
|
-
#
|
160
|
-
#
|
157
|
+
# Get Login Flow
|
158
|
+
# This endpoint returns a login flow's context with, for example, error details and other information. More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
159
|
+
# @param id [String] The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`).
|
161
160
|
# @param [Hash] opts the optional parameters
|
162
|
-
# @
|
163
|
-
|
164
|
-
# @option opts [CompleteSelfServiceRecoveryFlowWithLinkMethod] :body
|
165
|
-
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
166
|
-
def complete_self_service_recovery_flow_with_link_method_with_http_info(opts = {})
|
161
|
+
# @return [Array<(LoginFlow, Integer, Hash)>] LoginFlow data, response status code and response headers
|
162
|
+
def get_self_service_login_flow_with_http_info(id, opts = {})
|
167
163
|
if @api_client.config.debugging
|
168
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
164
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.get_self_service_login_flow ...'
|
165
|
+
end
|
166
|
+
# verify the required parameter 'id' is set
|
167
|
+
if @api_client.config.client_side_validation && id.nil?
|
168
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling PublicApi.get_self_service_login_flow"
|
169
169
|
end
|
170
170
|
# resource path
|
171
|
-
local_var_path = '/self-service/
|
171
|
+
local_var_path = '/self-service/login/flows'
|
172
172
|
|
173
173
|
# query parameters
|
174
174
|
query_params = opts[:query_params] || {}
|
175
|
-
query_params[:'
|
176
|
-
query_params[:'flow'] = opts[:'flow'] if !opts[:'flow'].nil?
|
175
|
+
query_params[:'id'] = id
|
177
176
|
|
178
177
|
# header parameters
|
179
178
|
header_params = opts[:header_params] || {}
|
180
179
|
# HTTP header 'Accept' (if needed)
|
181
180
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
182
|
-
# HTTP header 'Content-Type'
|
183
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])
|
184
181
|
|
185
182
|
# form parameters
|
186
183
|
form_params = opts[:form_params] || {}
|
187
184
|
|
188
185
|
# http body (model)
|
189
|
-
post_body = opts[:debug_body]
|
186
|
+
post_body = opts[:debug_body]
|
190
187
|
|
191
188
|
# return_type
|
192
|
-
return_type = opts[:debug_return_type]
|
189
|
+
return_type = opts[:debug_return_type] || 'LoginFlow'
|
193
190
|
|
194
191
|
# auth_names
|
195
192
|
auth_names = opts[:debug_auth_names] || []
|
196
193
|
|
197
194
|
new_options = opts.merge(
|
198
|
-
:operation => :"PublicApi.
|
195
|
+
:operation => :"PublicApi.get_self_service_login_flow",
|
199
196
|
:header_params => header_params,
|
200
197
|
:query_params => query_params,
|
201
198
|
:form_params => form_params,
|
@@ -204,62 +201,62 @@ module OryHydraClient
|
|
204
201
|
:return_type => return_type
|
205
202
|
)
|
206
203
|
|
207
|
-
data, status_code, headers = @api_client.call_api(:
|
204
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
208
205
|
if @api_client.config.debugging
|
209
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
206
|
+
@api_client.config.logger.debug "API called: PublicApi#get_self_service_login_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
210
207
|
end
|
211
208
|
return data, status_code, headers
|
212
209
|
end
|
213
210
|
|
214
|
-
#
|
215
|
-
#
|
211
|
+
# Get information about a recovery flow
|
212
|
+
# This endpoint returns a recovery flow's context with, for example, error details and other information. More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
|
213
|
+
# @param id [String] The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`).
|
216
214
|
# @param [Hash] opts the optional parameters
|
217
|
-
# @
|
218
|
-
|
219
|
-
|
220
|
-
def complete_self_service_registration_flow_with_password_method(opts = {})
|
221
|
-
data, _status_code, _headers = complete_self_service_registration_flow_with_password_method_with_http_info(opts)
|
215
|
+
# @return [RecoveryFlow]
|
216
|
+
def get_self_service_recovery_flow(id, opts = {})
|
217
|
+
data, _status_code, _headers = get_self_service_recovery_flow_with_http_info(id, opts)
|
222
218
|
data
|
223
219
|
end
|
224
220
|
|
225
|
-
#
|
226
|
-
#
|
221
|
+
# Get information about a recovery flow
|
222
|
+
# This endpoint returns a recovery flow's context with, for example, error details and other information. More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
|
223
|
+
# @param id [String] The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`).
|
227
224
|
# @param [Hash] opts the optional parameters
|
228
|
-
# @
|
229
|
-
|
230
|
-
# @return [Array<(RegistrationViaApiResponse, Integer, Hash)>] RegistrationViaApiResponse data, response status code and response headers
|
231
|
-
def complete_self_service_registration_flow_with_password_method_with_http_info(opts = {})
|
225
|
+
# @return [Array<(RecoveryFlow, Integer, Hash)>] RecoveryFlow data, response status code and response headers
|
226
|
+
def get_self_service_recovery_flow_with_http_info(id, opts = {})
|
232
227
|
if @api_client.config.debugging
|
233
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
228
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.get_self_service_recovery_flow ...'
|
229
|
+
end
|
230
|
+
# verify the required parameter 'id' is set
|
231
|
+
if @api_client.config.client_side_validation && id.nil?
|
232
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling PublicApi.get_self_service_recovery_flow"
|
234
233
|
end
|
235
234
|
# resource path
|
236
|
-
local_var_path = '/self-service/
|
235
|
+
local_var_path = '/self-service/recovery/flows'
|
237
236
|
|
238
237
|
# query parameters
|
239
238
|
query_params = opts[:query_params] || {}
|
240
|
-
query_params[:'
|
239
|
+
query_params[:'id'] = id
|
241
240
|
|
242
241
|
# header parameters
|
243
242
|
header_params = opts[:header_params] || {}
|
244
243
|
# HTTP header 'Accept' (if needed)
|
245
244
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
246
|
-
# HTTP header 'Content-Type'
|
247
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])
|
248
245
|
|
249
246
|
# form parameters
|
250
247
|
form_params = opts[:form_params] || {}
|
251
248
|
|
252
249
|
# http body (model)
|
253
|
-
post_body = opts[:debug_body]
|
250
|
+
post_body = opts[:debug_body]
|
254
251
|
|
255
252
|
# return_type
|
256
|
-
return_type = opts[:debug_return_type] || '
|
253
|
+
return_type = opts[:debug_return_type] || 'RecoveryFlow'
|
257
254
|
|
258
255
|
# auth_names
|
259
256
|
auth_names = opts[:debug_auth_names] || []
|
260
257
|
|
261
258
|
new_options = opts.merge(
|
262
|
-
:operation => :"PublicApi.
|
259
|
+
:operation => :"PublicApi.get_self_service_recovery_flow",
|
263
260
|
:header_params => header_params,
|
264
261
|
:query_params => query_params,
|
265
262
|
:form_params => form_params,
|
@@ -268,62 +265,62 @@ module OryHydraClient
|
|
268
265
|
:return_type => return_type
|
269
266
|
)
|
270
267
|
|
271
|
-
data, status_code, headers = @api_client.call_api(:
|
268
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
272
269
|
if @api_client.config.debugging
|
273
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
270
|
+
@api_client.config.logger.debug "API called: PublicApi#get_self_service_recovery_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
274
271
|
end
|
275
272
|
return data, status_code, headers
|
276
273
|
end
|
277
274
|
|
278
|
-
#
|
279
|
-
#
|
275
|
+
# Get Registration Flow
|
276
|
+
# This endpoint returns a registration flow's context with, for example, error details and other information. More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
277
|
+
# @param id [String] The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`).
|
280
278
|
# @param [Hash] opts the optional parameters
|
281
|
-
# @
|
282
|
-
|
283
|
-
|
284
|
-
def complete_self_service_settings_flow_with_password_method(opts = {})
|
285
|
-
data, _status_code, _headers = complete_self_service_settings_flow_with_password_method_with_http_info(opts)
|
279
|
+
# @return [RegistrationFlow]
|
280
|
+
def get_self_service_registration_flow(id, opts = {})
|
281
|
+
data, _status_code, _headers = get_self_service_registration_flow_with_http_info(id, opts)
|
286
282
|
data
|
287
283
|
end
|
288
284
|
|
289
|
-
#
|
290
|
-
#
|
285
|
+
# Get Registration Flow
|
286
|
+
# This endpoint returns a registration flow's context with, for example, error details and other information. More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
287
|
+
# @param id [String] The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`).
|
291
288
|
# @param [Hash] opts the optional parameters
|
292
|
-
# @
|
293
|
-
|
294
|
-
# @return [Array<(SettingsViaApiResponse, Integer, Hash)>] SettingsViaApiResponse data, response status code and response headers
|
295
|
-
def complete_self_service_settings_flow_with_password_method_with_http_info(opts = {})
|
289
|
+
# @return [Array<(RegistrationFlow, Integer, Hash)>] RegistrationFlow data, response status code and response headers
|
290
|
+
def get_self_service_registration_flow_with_http_info(id, opts = {})
|
296
291
|
if @api_client.config.debugging
|
297
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
292
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.get_self_service_registration_flow ...'
|
293
|
+
end
|
294
|
+
# verify the required parameter 'id' is set
|
295
|
+
if @api_client.config.client_side_validation && id.nil?
|
296
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling PublicApi.get_self_service_registration_flow"
|
298
297
|
end
|
299
298
|
# resource path
|
300
|
-
local_var_path = '/self-service/
|
299
|
+
local_var_path = '/self-service/registration/flows'
|
301
300
|
|
302
301
|
# query parameters
|
303
302
|
query_params = opts[:query_params] || {}
|
304
|
-
query_params[:'
|
303
|
+
query_params[:'id'] = id
|
305
304
|
|
306
305
|
# header parameters
|
307
306
|
header_params = opts[:header_params] || {}
|
308
307
|
# HTTP header 'Accept' (if needed)
|
309
308
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
310
|
-
# HTTP header 'Content-Type'
|
311
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])
|
312
309
|
|
313
310
|
# form parameters
|
314
311
|
form_params = opts[:form_params] || {}
|
315
312
|
|
316
313
|
# http body (model)
|
317
|
-
post_body = opts[:debug_body]
|
314
|
+
post_body = opts[:debug_body]
|
318
315
|
|
319
316
|
# return_type
|
320
|
-
return_type = opts[:debug_return_type] || '
|
317
|
+
return_type = opts[:debug_return_type] || 'RegistrationFlow'
|
321
318
|
|
322
319
|
# auth_names
|
323
|
-
auth_names = opts[:debug_auth_names] || [
|
320
|
+
auth_names = opts[:debug_auth_names] || []
|
324
321
|
|
325
322
|
new_options = opts.merge(
|
326
|
-
:operation => :"PublicApi.
|
323
|
+
:operation => :"PublicApi.get_self_service_registration_flow",
|
327
324
|
:header_params => header_params,
|
328
325
|
:query_params => query_params,
|
329
326
|
:form_params => form_params,
|
@@ -332,53 +329,53 @@ module OryHydraClient
|
|
332
329
|
:return_type => return_type
|
333
330
|
)
|
334
331
|
|
335
|
-
data, status_code, headers = @api_client.call_api(:
|
332
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
336
333
|
if @api_client.config.debugging
|
337
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
334
|
+
@api_client.config.logger.debug "API called: PublicApi#get_self_service_registration_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
338
335
|
end
|
339
336
|
return data, status_code, headers
|
340
337
|
end
|
341
338
|
|
342
|
-
#
|
343
|
-
#
|
339
|
+
# Get Settings Flow
|
340
|
+
# When accessing this endpoint through Ory Kratos' Public API you must ensure that either the Ory Kratos Session Cookie or the Ory Kratos Session Token are set. The public endpoint does not return 404 status codes but instead 403 or 500 to improve data privacy. You can access this endpoint without credentials when using Ory Kratos' Admin API. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
341
|
+
# @param id [String] ID is the Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`).
|
344
342
|
# @param [Hash] opts the optional parameters
|
345
|
-
# @option opts [String] :flow Flow is flow ID.
|
346
|
-
# @option opts [Object] :payload
|
347
343
|
# @return [SettingsFlow]
|
348
|
-
def
|
349
|
-
data, _status_code, _headers =
|
344
|
+
def get_self_service_settings_flow(id, opts = {})
|
345
|
+
data, _status_code, _headers = get_self_service_settings_flow_with_http_info(id, opts)
|
350
346
|
data
|
351
347
|
end
|
352
348
|
|
353
|
-
#
|
354
|
-
#
|
349
|
+
# Get Settings Flow
|
350
|
+
# When accessing this endpoint through Ory Kratos' Public API you must ensure that either the Ory Kratos Session Cookie or the Ory Kratos Session Token are set. The public endpoint does not return 404 status codes but instead 403 or 500 to improve data privacy. You can access this endpoint without credentials when using Ory Kratos' Admin API. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
351
|
+
# @param id [String] ID is the Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`).
|
355
352
|
# @param [Hash] opts the optional parameters
|
356
|
-
# @option opts [String] :flow Flow is flow ID.
|
357
|
-
# @option opts [Object] :payload
|
358
353
|
# @return [Array<(SettingsFlow, Integer, Hash)>] SettingsFlow data, response status code and response headers
|
359
|
-
def
|
354
|
+
def get_self_service_settings_flow_with_http_info(id, opts = {})
|
360
355
|
if @api_client.config.debugging
|
361
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
356
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.get_self_service_settings_flow ...'
|
357
|
+
end
|
358
|
+
# verify the required parameter 'id' is set
|
359
|
+
if @api_client.config.client_side_validation && id.nil?
|
360
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling PublicApi.get_self_service_settings_flow"
|
362
361
|
end
|
363
362
|
# resource path
|
364
|
-
local_var_path = '/self-service/settings/
|
363
|
+
local_var_path = '/self-service/settings/flows'
|
365
364
|
|
366
365
|
# query parameters
|
367
366
|
query_params = opts[:query_params] || {}
|
368
|
-
query_params[:'
|
367
|
+
query_params[:'id'] = id
|
369
368
|
|
370
369
|
# header parameters
|
371
370
|
header_params = opts[:header_params] || {}
|
372
371
|
# HTTP header 'Accept' (if needed)
|
373
372
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
374
|
-
# HTTP header 'Content-Type'
|
375
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])
|
376
373
|
|
377
374
|
# form parameters
|
378
375
|
form_params = opts[:form_params] || {}
|
379
376
|
|
380
377
|
# http body (model)
|
381
|
-
post_body = opts[:debug_body]
|
378
|
+
post_body = opts[:debug_body]
|
382
379
|
|
383
380
|
# return_type
|
384
381
|
return_type = opts[:debug_return_type] || 'SettingsFlow'
|
@@ -387,74 +384,7 @@ module OryHydraClient
|
|
387
384
|
auth_names = opts[:debug_auth_names] || ['sessionToken']
|
388
385
|
|
389
386
|
new_options = opts.merge(
|
390
|
-
:operation => :"PublicApi.
|
391
|
-
:header_params => header_params,
|
392
|
-
:query_params => query_params,
|
393
|
-
:form_params => form_params,
|
394
|
-
:body => post_body,
|
395
|
-
:auth_names => auth_names,
|
396
|
-
:return_type => return_type
|
397
|
-
)
|
398
|
-
|
399
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
400
|
-
if @api_client.config.debugging
|
401
|
-
@api_client.config.logger.debug "API called: PublicApi#complete_self_service_settings_flow_with_profile_method\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
402
|
-
end
|
403
|
-
return data, status_code, headers
|
404
|
-
end
|
405
|
-
|
406
|
-
# Complete Verification Flow with Link Method
|
407
|
-
# Use this endpoint to complete a verification flow using the link method. This endpoint behaves differently for API and browser flows and has several states: `choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent and works with API- and Browser-initiated flows. For API clients it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid and a HTTP 302 Found redirect with a fresh verification flow if the flow was otherwise invalid (e.g. expired). For Browser clients it returns a HTTP 302 Found redirect to the Verification UI URL with the Verification Flow ID appended. `sent_email` is the success state after `choose_method` and allows the user to request another verification email. It works for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state. `passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow (\"sending a verification link\") does not have any API capabilities. The server responds with a HTTP 302 Found redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Verification UI URL with a new Verification Flow ID which contains an error message that the verification link was invalid. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
|
408
|
-
# @param [Hash] opts the optional parameters
|
409
|
-
# @option opts [String] :token Verification Token The verification token which completes the verification request. If the token is invalid (e.g. expired) an error will be shown to the end-user.
|
410
|
-
# @option opts [String] :flow The Flow ID format: uuid
|
411
|
-
# @option opts [CompleteSelfServiceVerificationFlowWithLinkMethod] :body
|
412
|
-
# @return [nil]
|
413
|
-
def complete_self_service_verification_flow_with_link_method(opts = {})
|
414
|
-
complete_self_service_verification_flow_with_link_method_with_http_info(opts)
|
415
|
-
nil
|
416
|
-
end
|
417
|
-
|
418
|
-
# Complete Verification Flow with Link Method
|
419
|
-
# Use this endpoint to complete a verification flow using the link method. This endpoint behaves differently for API and browser flows and has several states: `choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent and works with API- and Browser-initiated flows. For API clients it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid and a HTTP 302 Found redirect with a fresh verification flow if the flow was otherwise invalid (e.g. expired). For Browser clients it returns a HTTP 302 Found redirect to the Verification UI URL with the Verification Flow ID appended. `sent_email` is the success state after `choose_method` and allows the user to request another verification email. It works for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state. `passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow (\"sending a verification link\") does not have any API capabilities. The server responds with a HTTP 302 Found redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Verification UI URL with a new Verification Flow ID which contains an error message that the verification link was invalid. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
|
420
|
-
# @param [Hash] opts the optional parameters
|
421
|
-
# @option opts [String] :token Verification Token The verification token which completes the verification request. If the token is invalid (e.g. expired) an error will be shown to the end-user.
|
422
|
-
# @option opts [String] :flow The Flow ID format: uuid
|
423
|
-
# @option opts [CompleteSelfServiceVerificationFlowWithLinkMethod] :body
|
424
|
-
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
425
|
-
def complete_self_service_verification_flow_with_link_method_with_http_info(opts = {})
|
426
|
-
if @api_client.config.debugging
|
427
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.complete_self_service_verification_flow_with_link_method ...'
|
428
|
-
end
|
429
|
-
# resource path
|
430
|
-
local_var_path = '/self-service/verification/methods/link'
|
431
|
-
|
432
|
-
# query parameters
|
433
|
-
query_params = opts[:query_params] || {}
|
434
|
-
query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?
|
435
|
-
query_params[:'flow'] = opts[:'flow'] if !opts[:'flow'].nil?
|
436
|
-
|
437
|
-
# header parameters
|
438
|
-
header_params = opts[:header_params] || {}
|
439
|
-
# HTTP header 'Accept' (if needed)
|
440
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
441
|
-
# HTTP header 'Content-Type'
|
442
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])
|
443
|
-
|
444
|
-
# form parameters
|
445
|
-
form_params = opts[:form_params] || {}
|
446
|
-
|
447
|
-
# http body (model)
|
448
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'body'])
|
449
|
-
|
450
|
-
# return_type
|
451
|
-
return_type = opts[:debug_return_type]
|
452
|
-
|
453
|
-
# auth_names
|
454
|
-
auth_names = opts[:debug_auth_names] || []
|
455
|
-
|
456
|
-
new_options = opts.merge(
|
457
|
-
:operation => :"PublicApi.complete_self_service_verification_flow_with_link_method",
|
387
|
+
:operation => :"PublicApi.get_self_service_settings_flow",
|
458
388
|
:header_params => header_params,
|
459
389
|
:query_params => query_params,
|
460
390
|
:form_params => form_params,
|
@@ -463,39 +393,42 @@ module OryHydraClient
|
|
463
393
|
:return_type => return_type
|
464
394
|
)
|
465
395
|
|
466
|
-
data, status_code, headers = @api_client.call_api(:
|
396
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
467
397
|
if @api_client.config.debugging
|
468
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
398
|
+
@api_client.config.logger.debug "API called: PublicApi#get_self_service_settings_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
469
399
|
end
|
470
400
|
return data, status_code, headers
|
471
401
|
end
|
472
402
|
|
473
|
-
# Get
|
474
|
-
#
|
403
|
+
# Get Verification Flow
|
404
|
+
# This endpoint returns a verification flow's context with, for example, error details and other information. More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
|
405
|
+
# @param id [String] The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`).
|
475
406
|
# @param [Hash] opts the optional parameters
|
476
|
-
# @return [
|
477
|
-
def
|
478
|
-
data, _status_code, _headers =
|
407
|
+
# @return [VerificationFlow]
|
408
|
+
def get_self_service_verification_flow(id, opts = {})
|
409
|
+
data, _status_code, _headers = get_self_service_verification_flow_with_http_info(id, opts)
|
479
410
|
data
|
480
411
|
end
|
481
412
|
|
482
|
-
# Get
|
483
|
-
#
|
413
|
+
# Get Verification Flow
|
414
|
+
# This endpoint returns a verification flow's context with, for example, error details and other information. More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
|
415
|
+
# @param id [String] The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`).
|
484
416
|
# @param [Hash] opts the optional parameters
|
485
|
-
# @return [Array<(
|
486
|
-
def
|
417
|
+
# @return [Array<(VerificationFlow, Integer, Hash)>] VerificationFlow data, response status code and response headers
|
418
|
+
def get_self_service_verification_flow_with_http_info(id, opts = {})
|
487
419
|
if @api_client.config.debugging
|
488
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
420
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.get_self_service_verification_flow ...'
|
489
421
|
end
|
490
422
|
# verify the required parameter 'id' is set
|
491
423
|
if @api_client.config.client_side_validation && id.nil?
|
492
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling PublicApi.
|
424
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling PublicApi.get_self_service_verification_flow"
|
493
425
|
end
|
494
426
|
# resource path
|
495
|
-
local_var_path = '/
|
427
|
+
local_var_path = '/self-service/verification/flows'
|
496
428
|
|
497
429
|
# query parameters
|
498
430
|
query_params = opts[:query_params] || {}
|
431
|
+
query_params[:'id'] = id
|
499
432
|
|
500
433
|
# header parameters
|
501
434
|
header_params = opts[:header_params] || {}
|
@@ -509,13 +442,13 @@ module OryHydraClient
|
|
509
442
|
post_body = opts[:debug_body]
|
510
443
|
|
511
444
|
# return_type
|
512
|
-
return_type = opts[:debug_return_type] || '
|
445
|
+
return_type = opts[:debug_return_type] || 'VerificationFlow'
|
513
446
|
|
514
447
|
# auth_names
|
515
448
|
auth_names = opts[:debug_auth_names] || []
|
516
449
|
|
517
450
|
new_options = opts.merge(
|
518
|
-
:operation => :"PublicApi.
|
451
|
+
:operation => :"PublicApi.get_self_service_verification_flow",
|
519
452
|
:header_params => header_params,
|
520
453
|
:query_params => query_params,
|
521
454
|
:form_params => form_params,
|
@@ -526,40 +459,33 @@ module OryHydraClient
|
|
526
459
|
|
527
460
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
528
461
|
if @api_client.config.debugging
|
529
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
462
|
+
@api_client.config.logger.debug "API called: PublicApi#get_self_service_verification_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
530
463
|
end
|
531
464
|
return data, status_code, headers
|
532
465
|
end
|
533
466
|
|
534
|
-
#
|
535
|
-
# This endpoint
|
536
|
-
# @param error [String] Error is the container's ID
|
467
|
+
# Initialize Browser-Based Logout User Flow
|
468
|
+
# This endpoint initializes a logout flow. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). On successful logout, the browser will be redirected (HTTP 302 Found) to the `return_to` parameter of the initial request or fall back to `urls.default_return_to`. More information can be found at [Ory Kratos User Logout Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-logout).
|
537
469
|
# @param [Hash] opts the optional parameters
|
538
|
-
# @return [
|
539
|
-
def
|
540
|
-
|
541
|
-
|
470
|
+
# @return [nil]
|
471
|
+
def initialize_self_service_browser_logout_flow(opts = {})
|
472
|
+
initialize_self_service_browser_logout_flow_with_http_info(opts)
|
473
|
+
nil
|
542
474
|
end
|
543
475
|
|
544
|
-
#
|
545
|
-
# This endpoint
|
546
|
-
# @param error [String] Error is the container's ID
|
476
|
+
# Initialize Browser-Based Logout User Flow
|
477
|
+
# This endpoint initializes a logout flow. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). On successful logout, the browser will be redirected (HTTP 302 Found) to the `return_to` parameter of the initial request or fall back to `urls.default_return_to`. More information can be found at [Ory Kratos User Logout Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-logout).
|
547
478
|
# @param [Hash] opts the optional parameters
|
548
|
-
# @return [Array<(
|
549
|
-
def
|
479
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
480
|
+
def initialize_self_service_browser_logout_flow_with_http_info(opts = {})
|
550
481
|
if @api_client.config.debugging
|
551
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
552
|
-
end
|
553
|
-
# verify the required parameter 'error' is set
|
554
|
-
if @api_client.config.client_side_validation && error.nil?
|
555
|
-
fail ArgumentError, "Missing the required parameter 'error' when calling PublicApi.get_self_service_error"
|
482
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_browser_logout_flow ...'
|
556
483
|
end
|
557
484
|
# resource path
|
558
|
-
local_var_path = '/self-service/
|
485
|
+
local_var_path = '/self-service/browser/flows/logout'
|
559
486
|
|
560
487
|
# query parameters
|
561
488
|
query_params = opts[:query_params] || {}
|
562
|
-
query_params[:'error'] = error
|
563
489
|
|
564
490
|
# header parameters
|
565
491
|
header_params = opts[:header_params] || {}
|
@@ -573,13 +499,13 @@ module OryHydraClient
|
|
573
499
|
post_body = opts[:debug_body]
|
574
500
|
|
575
501
|
# return_type
|
576
|
-
return_type = opts[:debug_return_type]
|
502
|
+
return_type = opts[:debug_return_type]
|
577
503
|
|
578
504
|
# auth_names
|
579
505
|
auth_names = opts[:debug_auth_names] || []
|
580
506
|
|
581
507
|
new_options = opts.merge(
|
582
|
-
:operation => :"PublicApi.
|
508
|
+
:operation => :"PublicApi.initialize_self_service_browser_logout_flow",
|
583
509
|
:header_params => header_params,
|
584
510
|
:query_params => query_params,
|
585
511
|
:form_params => form_params,
|
@@ -590,40 +516,36 @@ module OryHydraClient
|
|
590
516
|
|
591
517
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
592
518
|
if @api_client.config.debugging
|
593
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
519
|
+
@api_client.config.logger.debug "API called: PublicApi#initialize_self_service_browser_logout_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
594
520
|
end
|
595
521
|
return data, status_code, headers
|
596
522
|
end
|
597
523
|
|
598
|
-
#
|
599
|
-
# This endpoint
|
600
|
-
# @param id [String] The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`).
|
524
|
+
# Initialize Login Flow for API clients
|
525
|
+
# This endpoint initiates a login flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing login flow call `/self-service/login/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks, including CSRF login attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
601
526
|
# @param [Hash] opts the optional parameters
|
527
|
+
# @option opts [Boolean] :refresh Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session.
|
602
528
|
# @return [LoginFlow]
|
603
|
-
def
|
604
|
-
data, _status_code, _headers =
|
529
|
+
def initialize_self_service_login_via_api_flow(opts = {})
|
530
|
+
data, _status_code, _headers = initialize_self_service_login_via_api_flow_with_http_info(opts)
|
605
531
|
data
|
606
532
|
end
|
607
533
|
|
608
|
-
#
|
609
|
-
# This endpoint
|
610
|
-
# @param id [String] The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`).
|
534
|
+
# Initialize Login Flow for API clients
|
535
|
+
# This endpoint initiates a login flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing login flow call `/self-service/login/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks, including CSRF login attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
611
536
|
# @param [Hash] opts the optional parameters
|
537
|
+
# @option opts [Boolean] :refresh Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session.
|
612
538
|
# @return [Array<(LoginFlow, Integer, Hash)>] LoginFlow data, response status code and response headers
|
613
|
-
def
|
539
|
+
def initialize_self_service_login_via_api_flow_with_http_info(opts = {})
|
614
540
|
if @api_client.config.debugging
|
615
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
616
|
-
end
|
617
|
-
# verify the required parameter 'id' is set
|
618
|
-
if @api_client.config.client_side_validation && id.nil?
|
619
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling PublicApi.get_self_service_login_flow"
|
541
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_login_via_api_flow ...'
|
620
542
|
end
|
621
543
|
# resource path
|
622
|
-
local_var_path = '/self-service/login/
|
544
|
+
local_var_path = '/self-service/login/api'
|
623
545
|
|
624
546
|
# query parameters
|
625
547
|
query_params = opts[:query_params] || {}
|
626
|
-
query_params[:'
|
548
|
+
query_params[:'refresh'] = opts[:'refresh'] if !opts[:'refresh'].nil?
|
627
549
|
|
628
550
|
# header parameters
|
629
551
|
header_params = opts[:header_params] || {}
|
@@ -643,7 +565,7 @@ module OryHydraClient
|
|
643
565
|
auth_names = opts[:debug_auth_names] || []
|
644
566
|
|
645
567
|
new_options = opts.merge(
|
646
|
-
:operation => :"PublicApi.
|
568
|
+
:operation => :"PublicApi.initialize_self_service_login_via_api_flow",
|
647
569
|
:header_params => header_params,
|
648
570
|
:query_params => query_params,
|
649
571
|
:form_params => form_params,
|
@@ -654,40 +576,33 @@ module OryHydraClient
|
|
654
576
|
|
655
577
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
656
578
|
if @api_client.config.debugging
|
657
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
579
|
+
@api_client.config.logger.debug "API called: PublicApi#initialize_self_service_login_via_api_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
658
580
|
end
|
659
581
|
return data, status_code, headers
|
660
582
|
end
|
661
583
|
|
662
|
-
#
|
663
|
-
# This endpoint
|
664
|
-
# @param id [String] The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`).
|
584
|
+
# Initialize Login Flow for browsers
|
585
|
+
# This endpoint initializes a browser-based user login flow. Once initialized, the browser will be redirected to `selfservice.flows.login.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url` unless the query parameter `?refresh=true` was set. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
665
586
|
# @param [Hash] opts the optional parameters
|
666
|
-
# @return [
|
667
|
-
def
|
668
|
-
|
669
|
-
|
587
|
+
# @return [nil]
|
588
|
+
def initialize_self_service_login_via_browser_flow(opts = {})
|
589
|
+
initialize_self_service_login_via_browser_flow_with_http_info(opts)
|
590
|
+
nil
|
670
591
|
end
|
671
592
|
|
672
|
-
#
|
673
|
-
# This endpoint
|
674
|
-
# @param id [String] The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`).
|
593
|
+
# Initialize Login Flow for browsers
|
594
|
+
# This endpoint initializes a browser-based user login flow. Once initialized, the browser will be redirected to `selfservice.flows.login.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url` unless the query parameter `?refresh=true` was set. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
675
595
|
# @param [Hash] opts the optional parameters
|
676
|
-
# @return [Array<(
|
677
|
-
def
|
596
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
597
|
+
def initialize_self_service_login_via_browser_flow_with_http_info(opts = {})
|
678
598
|
if @api_client.config.debugging
|
679
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
680
|
-
end
|
681
|
-
# verify the required parameter 'id' is set
|
682
|
-
if @api_client.config.client_side_validation && id.nil?
|
683
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling PublicApi.get_self_service_recovery_flow"
|
599
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_login_via_browser_flow ...'
|
684
600
|
end
|
685
601
|
# resource path
|
686
|
-
local_var_path = '/self-service/
|
602
|
+
local_var_path = '/self-service/login/browser'
|
687
603
|
|
688
604
|
# query parameters
|
689
605
|
query_params = opts[:query_params] || {}
|
690
|
-
query_params[:'id'] = id
|
691
606
|
|
692
607
|
# header parameters
|
693
608
|
header_params = opts[:header_params] || {}
|
@@ -701,13 +616,13 @@ module OryHydraClient
|
|
701
616
|
post_body = opts[:debug_body]
|
702
617
|
|
703
618
|
# return_type
|
704
|
-
return_type = opts[:debug_return_type]
|
619
|
+
return_type = opts[:debug_return_type]
|
705
620
|
|
706
621
|
# auth_names
|
707
622
|
auth_names = opts[:debug_auth_names] || []
|
708
623
|
|
709
624
|
new_options = opts.merge(
|
710
|
-
:operation => :"PublicApi.
|
625
|
+
:operation => :"PublicApi.initialize_self_service_login_via_browser_flow",
|
711
626
|
:header_params => header_params,
|
712
627
|
:query_params => query_params,
|
713
628
|
:form_params => form_params,
|
@@ -718,40 +633,33 @@ module OryHydraClient
|
|
718
633
|
|
719
634
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
720
635
|
if @api_client.config.debugging
|
721
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
636
|
+
@api_client.config.logger.debug "API called: PublicApi#initialize_self_service_login_via_browser_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
722
637
|
end
|
723
638
|
return data, status_code, headers
|
724
639
|
end
|
725
640
|
|
726
|
-
#
|
727
|
-
# This endpoint
|
728
|
-
# @param id [String] The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`).
|
641
|
+
# Initialize Recovery Flow for API Clients
|
642
|
+
# This endpoint initiates a recovery flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error. To fetch an existing recovery flow call `/self-service/recovery/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
|
729
643
|
# @param [Hash] opts the optional parameters
|
730
|
-
# @return [
|
731
|
-
def
|
732
|
-
data, _status_code, _headers =
|
644
|
+
# @return [RecoveryFlow]
|
645
|
+
def initialize_self_service_recovery_via_api_flow(opts = {})
|
646
|
+
data, _status_code, _headers = initialize_self_service_recovery_via_api_flow_with_http_info(opts)
|
733
647
|
data
|
734
648
|
end
|
735
649
|
|
736
|
-
#
|
737
|
-
# This endpoint
|
738
|
-
# @param id [String] The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`).
|
650
|
+
# Initialize Recovery Flow for API Clients
|
651
|
+
# This endpoint initiates a recovery flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error. To fetch an existing recovery flow call `/self-service/recovery/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
|
739
652
|
# @param [Hash] opts the optional parameters
|
740
|
-
# @return [Array<(
|
741
|
-
def
|
653
|
+
# @return [Array<(RecoveryFlow, Integer, Hash)>] RecoveryFlow data, response status code and response headers
|
654
|
+
def initialize_self_service_recovery_via_api_flow_with_http_info(opts = {})
|
742
655
|
if @api_client.config.debugging
|
743
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
744
|
-
end
|
745
|
-
# verify the required parameter 'id' is set
|
746
|
-
if @api_client.config.client_side_validation && id.nil?
|
747
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling PublicApi.get_self_service_registration_flow"
|
656
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_recovery_via_api_flow ...'
|
748
657
|
end
|
749
658
|
# resource path
|
750
|
-
local_var_path = '/self-service/
|
659
|
+
local_var_path = '/self-service/recovery/api'
|
751
660
|
|
752
661
|
# query parameters
|
753
662
|
query_params = opts[:query_params] || {}
|
754
|
-
query_params[:'id'] = id
|
755
663
|
|
756
664
|
# header parameters
|
757
665
|
header_params = opts[:header_params] || {}
|
@@ -765,13 +673,13 @@ module OryHydraClient
|
|
765
673
|
post_body = opts[:debug_body]
|
766
674
|
|
767
675
|
# return_type
|
768
|
-
return_type = opts[:debug_return_type] || '
|
676
|
+
return_type = opts[:debug_return_type] || 'RecoveryFlow'
|
769
677
|
|
770
678
|
# auth_names
|
771
679
|
auth_names = opts[:debug_auth_names] || []
|
772
680
|
|
773
681
|
new_options = opts.merge(
|
774
|
-
:operation => :"PublicApi.
|
682
|
+
:operation => :"PublicApi.initialize_self_service_recovery_via_api_flow",
|
775
683
|
:header_params => header_params,
|
776
684
|
:query_params => query_params,
|
777
685
|
:form_params => form_params,
|
@@ -782,40 +690,33 @@ module OryHydraClient
|
|
782
690
|
|
783
691
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
784
692
|
if @api_client.config.debugging
|
785
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
693
|
+
@api_client.config.logger.debug "API called: PublicApi#initialize_self_service_recovery_via_api_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
786
694
|
end
|
787
695
|
return data, status_code, headers
|
788
696
|
end
|
789
697
|
|
790
|
-
#
|
791
|
-
#
|
792
|
-
# @param id [String] ID is the Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`).
|
698
|
+
# Initialize Recovery Flow for Browser Clients
|
699
|
+
# This endpoint initializes a browser-based account recovery flow. Once initialized, the browser will be redirected to `selfservice.flows.recovery.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists, the browser is returned to the configured return URL. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
|
793
700
|
# @param [Hash] opts the optional parameters
|
794
|
-
# @return [
|
795
|
-
def
|
796
|
-
|
797
|
-
|
701
|
+
# @return [nil]
|
702
|
+
def initialize_self_service_recovery_via_browser_flow(opts = {})
|
703
|
+
initialize_self_service_recovery_via_browser_flow_with_http_info(opts)
|
704
|
+
nil
|
798
705
|
end
|
799
706
|
|
800
|
-
#
|
801
|
-
#
|
802
|
-
# @param id [String] ID is the Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`).
|
707
|
+
# Initialize Recovery Flow for Browser Clients
|
708
|
+
# This endpoint initializes a browser-based account recovery flow. Once initialized, the browser will be redirected to `selfservice.flows.recovery.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists, the browser is returned to the configured return URL. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
|
803
709
|
# @param [Hash] opts the optional parameters
|
804
|
-
# @return [Array<(
|
805
|
-
def
|
710
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
711
|
+
def initialize_self_service_recovery_via_browser_flow_with_http_info(opts = {})
|
806
712
|
if @api_client.config.debugging
|
807
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
808
|
-
end
|
809
|
-
# verify the required parameter 'id' is set
|
810
|
-
if @api_client.config.client_side_validation && id.nil?
|
811
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling PublicApi.get_self_service_settings_flow"
|
713
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_recovery_via_browser_flow ...'
|
812
714
|
end
|
813
715
|
# resource path
|
814
|
-
local_var_path = '/self-service/
|
716
|
+
local_var_path = '/self-service/recovery/browser'
|
815
717
|
|
816
718
|
# query parameters
|
817
719
|
query_params = opts[:query_params] || {}
|
818
|
-
query_params[:'id'] = id
|
819
720
|
|
820
721
|
# header parameters
|
821
722
|
header_params = opts[:header_params] || {}
|
@@ -829,13 +730,13 @@ module OryHydraClient
|
|
829
730
|
post_body = opts[:debug_body]
|
830
731
|
|
831
732
|
# return_type
|
832
|
-
return_type = opts[:debug_return_type]
|
733
|
+
return_type = opts[:debug_return_type]
|
833
734
|
|
834
735
|
# auth_names
|
835
|
-
auth_names = opts[:debug_auth_names] || [
|
736
|
+
auth_names = opts[:debug_auth_names] || []
|
836
737
|
|
837
738
|
new_options = opts.merge(
|
838
|
-
:operation => :"PublicApi.
|
739
|
+
:operation => :"PublicApi.initialize_self_service_recovery_via_browser_flow",
|
839
740
|
:header_params => header_params,
|
840
741
|
:query_params => query_params,
|
841
742
|
:form_params => form_params,
|
@@ -846,40 +747,33 @@ module OryHydraClient
|
|
846
747
|
|
847
748
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
848
749
|
if @api_client.config.debugging
|
849
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
750
|
+
@api_client.config.logger.debug "API called: PublicApi#initialize_self_service_recovery_via_browser_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
850
751
|
end
|
851
752
|
return data, status_code, headers
|
852
753
|
end
|
853
754
|
|
854
|
-
#
|
855
|
-
# This endpoint
|
856
|
-
# @param id [String] The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`).
|
755
|
+
# Initialize Registration Flow for API clients
|
756
|
+
# This endpoint initiates a registration flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing registration flow call `/self-service/registration/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
857
757
|
# @param [Hash] opts the optional parameters
|
858
|
-
# @return [
|
859
|
-
def
|
860
|
-
data, _status_code, _headers =
|
758
|
+
# @return [RegistrationFlow]
|
759
|
+
def initialize_self_service_registration_via_api_flow(opts = {})
|
760
|
+
data, _status_code, _headers = initialize_self_service_registration_via_api_flow_with_http_info(opts)
|
861
761
|
data
|
862
762
|
end
|
863
763
|
|
864
|
-
#
|
865
|
-
# This endpoint
|
866
|
-
# @param id [String] The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`).
|
764
|
+
# Initialize Registration Flow for API clients
|
765
|
+
# This endpoint initiates a registration flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing registration flow call `/self-service/registration/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
867
766
|
# @param [Hash] opts the optional parameters
|
868
|
-
# @return [Array<(
|
869
|
-
def
|
767
|
+
# @return [Array<(RegistrationFlow, Integer, Hash)>] RegistrationFlow data, response status code and response headers
|
768
|
+
def initialize_self_service_registration_via_api_flow_with_http_info(opts = {})
|
870
769
|
if @api_client.config.debugging
|
871
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
872
|
-
end
|
873
|
-
# verify the required parameter 'id' is set
|
874
|
-
if @api_client.config.client_side_validation && id.nil?
|
875
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling PublicApi.get_self_service_verification_flow"
|
770
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_registration_via_api_flow ...'
|
876
771
|
end
|
877
772
|
# resource path
|
878
|
-
local_var_path = '/self-service/
|
773
|
+
local_var_path = '/self-service/registration/api'
|
879
774
|
|
880
775
|
# query parameters
|
881
776
|
query_params = opts[:query_params] || {}
|
882
|
-
query_params[:'id'] = id
|
883
777
|
|
884
778
|
# header parameters
|
885
779
|
header_params = opts[:header_params] || {}
|
@@ -893,13 +787,13 @@ module OryHydraClient
|
|
893
787
|
post_body = opts[:debug_body]
|
894
788
|
|
895
789
|
# return_type
|
896
|
-
return_type = opts[:debug_return_type] || '
|
790
|
+
return_type = opts[:debug_return_type] || 'RegistrationFlow'
|
897
791
|
|
898
792
|
# auth_names
|
899
793
|
auth_names = opts[:debug_auth_names] || []
|
900
794
|
|
901
795
|
new_options = opts.merge(
|
902
|
-
:operation => :"PublicApi.
|
796
|
+
:operation => :"PublicApi.initialize_self_service_registration_via_api_flow",
|
903
797
|
:header_params => header_params,
|
904
798
|
:query_params => query_params,
|
905
799
|
:form_params => form_params,
|
@@ -910,30 +804,30 @@ module OryHydraClient
|
|
910
804
|
|
911
805
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
912
806
|
if @api_client.config.debugging
|
913
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
807
|
+
@api_client.config.logger.debug "API called: PublicApi#initialize_self_service_registration_via_api_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
914
808
|
end
|
915
809
|
return data, status_code, headers
|
916
810
|
end
|
917
811
|
|
918
|
-
# Initialize
|
919
|
-
# This endpoint initializes a
|
812
|
+
# Initialize Registration Flow for browsers
|
813
|
+
# This endpoint initializes a browser-based user registration flow. Once initialized, the browser will be redirected to `selfservice.flows.registration.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url` unless the query parameter `?refresh=true` was set. :::note This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). ::: More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
920
814
|
# @param [Hash] opts the optional parameters
|
921
815
|
# @return [nil]
|
922
|
-
def
|
923
|
-
|
816
|
+
def initialize_self_service_registration_via_browser_flow(opts = {})
|
817
|
+
initialize_self_service_registration_via_browser_flow_with_http_info(opts)
|
924
818
|
nil
|
925
819
|
end
|
926
820
|
|
927
|
-
# Initialize
|
928
|
-
# This endpoint initializes a
|
821
|
+
# Initialize Registration Flow for browsers
|
822
|
+
# This endpoint initializes a browser-based user registration flow. Once initialized, the browser will be redirected to `selfservice.flows.registration.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url` unless the query parameter `?refresh=true` was set. :::note This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). ::: More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
929
823
|
# @param [Hash] opts the optional parameters
|
930
824
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
931
|
-
def
|
825
|
+
def initialize_self_service_registration_via_browser_flow_with_http_info(opts = {})
|
932
826
|
if @api_client.config.debugging
|
933
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
827
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_registration_via_browser_flow ...'
|
934
828
|
end
|
935
829
|
# resource path
|
936
|
-
local_var_path = '/self-service/browser
|
830
|
+
local_var_path = '/self-service/registration/browser'
|
937
831
|
|
938
832
|
# query parameters
|
939
833
|
query_params = opts[:query_params] || {}
|
@@ -956,7 +850,7 @@ module OryHydraClient
|
|
956
850
|
auth_names = opts[:debug_auth_names] || []
|
957
851
|
|
958
852
|
new_options = opts.merge(
|
959
|
-
:operation => :"PublicApi.
|
853
|
+
:operation => :"PublicApi.initialize_self_service_registration_via_browser_flow",
|
960
854
|
:header_params => header_params,
|
961
855
|
:query_params => query_params,
|
962
856
|
:form_params => form_params,
|
@@ -967,36 +861,33 @@ module OryHydraClient
|
|
967
861
|
|
968
862
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
969
863
|
if @api_client.config.debugging
|
970
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
864
|
+
@api_client.config.logger.debug "API called: PublicApi#initialize_self_service_registration_via_browser_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
971
865
|
end
|
972
866
|
return data, status_code, headers
|
973
867
|
end
|
974
868
|
|
975
|
-
# Initialize
|
976
|
-
# This endpoint initiates a
|
869
|
+
# Initialize Settings Flow for API Clients
|
870
|
+
# This endpoint initiates a settings flow for API clients such as mobile devices, smart TVs, and so on. You must provide a valid Ory Kratos Session Token for this endpoint to respond with HTTP 200 OK. To fetch an existing settings flow call `/self-service/settings/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
977
871
|
# @param [Hash] opts the optional parameters
|
978
|
-
# @
|
979
|
-
|
980
|
-
|
981
|
-
data, _status_code, _headers = initialize_self_service_login_via_api_flow_with_http_info(opts)
|
872
|
+
# @return [SettingsFlow]
|
873
|
+
def initialize_self_service_settings_via_api_flow(opts = {})
|
874
|
+
data, _status_code, _headers = initialize_self_service_settings_via_api_flow_with_http_info(opts)
|
982
875
|
data
|
983
876
|
end
|
984
877
|
|
985
|
-
# Initialize
|
986
|
-
# This endpoint initiates a
|
878
|
+
# Initialize Settings Flow for API Clients
|
879
|
+
# This endpoint initiates a settings flow for API clients such as mobile devices, smart TVs, and so on. You must provide a valid Ory Kratos Session Token for this endpoint to respond with HTTP 200 OK. To fetch an existing settings flow call `/self-service/settings/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
987
880
|
# @param [Hash] opts the optional parameters
|
988
|
-
# @
|
989
|
-
|
990
|
-
def initialize_self_service_login_via_api_flow_with_http_info(opts = {})
|
881
|
+
# @return [Array<(SettingsFlow, Integer, Hash)>] SettingsFlow data, response status code and response headers
|
882
|
+
def initialize_self_service_settings_via_api_flow_with_http_info(opts = {})
|
991
883
|
if @api_client.config.debugging
|
992
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
884
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_settings_via_api_flow ...'
|
993
885
|
end
|
994
886
|
# resource path
|
995
|
-
local_var_path = '/self-service/
|
887
|
+
local_var_path = '/self-service/settings/api'
|
996
888
|
|
997
889
|
# query parameters
|
998
890
|
query_params = opts[:query_params] || {}
|
999
|
-
query_params[:'refresh'] = opts[:'refresh'] if !opts[:'refresh'].nil?
|
1000
891
|
|
1001
892
|
# header parameters
|
1002
893
|
header_params = opts[:header_params] || {}
|
@@ -1010,13 +901,13 @@ module OryHydraClient
|
|
1010
901
|
post_body = opts[:debug_body]
|
1011
902
|
|
1012
903
|
# return_type
|
1013
|
-
return_type = opts[:debug_return_type] || '
|
904
|
+
return_type = opts[:debug_return_type] || 'SettingsFlow'
|
1014
905
|
|
1015
906
|
# auth_names
|
1016
|
-
auth_names = opts[:debug_auth_names] || []
|
907
|
+
auth_names = opts[:debug_auth_names] || ['sessionToken']
|
1017
908
|
|
1018
909
|
new_options = opts.merge(
|
1019
|
-
:operation => :"PublicApi.
|
910
|
+
:operation => :"PublicApi.initialize_self_service_settings_via_api_flow",
|
1020
911
|
:header_params => header_params,
|
1021
912
|
:query_params => query_params,
|
1022
913
|
:form_params => form_params,
|
@@ -1027,30 +918,30 @@ module OryHydraClient
|
|
1027
918
|
|
1028
919
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1029
920
|
if @api_client.config.debugging
|
1030
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
921
|
+
@api_client.config.logger.debug "API called: PublicApi#initialize_self_service_settings_via_api_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1031
922
|
end
|
1032
923
|
return data, status_code, headers
|
1033
924
|
end
|
1034
925
|
|
1035
|
-
# Initialize
|
1036
|
-
# This endpoint initializes a browser-based user
|
926
|
+
# Initialize Settings Flow for Browsers
|
927
|
+
# This endpoint initializes a browser-based user settings flow. Once initialized, the browser will be redirected to `selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid Ory Kratos Session Cookie is included in the request, a login flow will be initialized. :::note This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). ::: More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
1037
928
|
# @param [Hash] opts the optional parameters
|
1038
929
|
# @return [nil]
|
1039
|
-
def
|
1040
|
-
|
930
|
+
def initialize_self_service_settings_via_browser_flow(opts = {})
|
931
|
+
initialize_self_service_settings_via_browser_flow_with_http_info(opts)
|
1041
932
|
nil
|
1042
933
|
end
|
1043
934
|
|
1044
|
-
# Initialize
|
1045
|
-
# This endpoint initializes a browser-based user
|
935
|
+
# Initialize Settings Flow for Browsers
|
936
|
+
# This endpoint initializes a browser-based user settings flow. Once initialized, the browser will be redirected to `selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid Ory Kratos Session Cookie is included in the request, a login flow will be initialized. :::note This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). ::: More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
1046
937
|
# @param [Hash] opts the optional parameters
|
1047
938
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1048
|
-
def
|
939
|
+
def initialize_self_service_settings_via_browser_flow_with_http_info(opts = {})
|
1049
940
|
if @api_client.config.debugging
|
1050
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
941
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_settings_via_browser_flow ...'
|
1051
942
|
end
|
1052
943
|
# resource path
|
1053
|
-
local_var_path = '/self-service/
|
944
|
+
local_var_path = '/self-service/settings/browser'
|
1054
945
|
|
1055
946
|
# query parameters
|
1056
947
|
query_params = opts[:query_params] || {}
|
@@ -1070,10 +961,10 @@ module OryHydraClient
|
|
1070
961
|
return_type = opts[:debug_return_type]
|
1071
962
|
|
1072
963
|
# auth_names
|
1073
|
-
auth_names = opts[:debug_auth_names] || []
|
964
|
+
auth_names = opts[:debug_auth_names] || ['sessionToken']
|
1074
965
|
|
1075
966
|
new_options = opts.merge(
|
1076
|
-
:operation => :"PublicApi.
|
967
|
+
:operation => :"PublicApi.initialize_self_service_settings_via_browser_flow",
|
1077
968
|
:header_params => header_params,
|
1078
969
|
:query_params => query_params,
|
1079
970
|
:form_params => form_params,
|
@@ -1084,30 +975,30 @@ module OryHydraClient
|
|
1084
975
|
|
1085
976
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1086
977
|
if @api_client.config.debugging
|
1087
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
978
|
+
@api_client.config.logger.debug "API called: PublicApi#initialize_self_service_settings_via_browser_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1088
979
|
end
|
1089
980
|
return data, status_code, headers
|
1090
981
|
end
|
1091
982
|
|
1092
|
-
# Initialize
|
1093
|
-
# This endpoint initiates a
|
983
|
+
# Initialize Verification Flow for API Clients
|
984
|
+
# This endpoint initiates a verification flow for API clients such as mobile devices, smart TVs, and so on. To fetch an existing verification flow call `/self-service/verification/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
|
1094
985
|
# @param [Hash] opts the optional parameters
|
1095
|
-
# @return [
|
1096
|
-
def
|
1097
|
-
data, _status_code, _headers =
|
986
|
+
# @return [VerificationFlow]
|
987
|
+
def initialize_self_service_verification_via_api_flow(opts = {})
|
988
|
+
data, _status_code, _headers = initialize_self_service_verification_via_api_flow_with_http_info(opts)
|
1098
989
|
data
|
1099
990
|
end
|
1100
991
|
|
1101
|
-
# Initialize
|
1102
|
-
# This endpoint initiates a
|
992
|
+
# Initialize Verification Flow for API Clients
|
993
|
+
# This endpoint initiates a verification flow for API clients such as mobile devices, smart TVs, and so on. To fetch an existing verification flow call `/self-service/verification/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
|
1103
994
|
# @param [Hash] opts the optional parameters
|
1104
|
-
# @return [Array<(
|
1105
|
-
def
|
995
|
+
# @return [Array<(VerificationFlow, Integer, Hash)>] VerificationFlow data, response status code and response headers
|
996
|
+
def initialize_self_service_verification_via_api_flow_with_http_info(opts = {})
|
1106
997
|
if @api_client.config.debugging
|
1107
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
998
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_verification_via_api_flow ...'
|
1108
999
|
end
|
1109
1000
|
# resource path
|
1110
|
-
local_var_path = '/self-service/
|
1001
|
+
local_var_path = '/self-service/verification/api'
|
1111
1002
|
|
1112
1003
|
# query parameters
|
1113
1004
|
query_params = opts[:query_params] || {}
|
@@ -1124,13 +1015,13 @@ module OryHydraClient
|
|
1124
1015
|
post_body = opts[:debug_body]
|
1125
1016
|
|
1126
1017
|
# return_type
|
1127
|
-
return_type = opts[:debug_return_type] || '
|
1018
|
+
return_type = opts[:debug_return_type] || 'VerificationFlow'
|
1128
1019
|
|
1129
1020
|
# auth_names
|
1130
1021
|
auth_names = opts[:debug_auth_names] || []
|
1131
1022
|
|
1132
1023
|
new_options = opts.merge(
|
1133
|
-
:operation => :"PublicApi.
|
1024
|
+
:operation => :"PublicApi.initialize_self_service_verification_via_api_flow",
|
1134
1025
|
:header_params => header_params,
|
1135
1026
|
:query_params => query_params,
|
1136
1027
|
:form_params => form_params,
|
@@ -1141,30 +1032,30 @@ module OryHydraClient
|
|
1141
1032
|
|
1142
1033
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1143
1034
|
if @api_client.config.debugging
|
1144
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
1035
|
+
@api_client.config.logger.debug "API called: PublicApi#initialize_self_service_verification_via_api_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1145
1036
|
end
|
1146
1037
|
return data, status_code, headers
|
1147
1038
|
end
|
1148
1039
|
|
1149
|
-
# Initialize
|
1150
|
-
# This endpoint initializes a browser-based account
|
1040
|
+
# Initialize Verification Flow for Browser Clients
|
1041
|
+
# This endpoint initializes a browser-based account verification flow. Once initialized, the browser will be redirected to `selfservice.flows.verification.ui_url` with the flow ID set as the query parameter `?flow=`. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
|
1151
1042
|
# @param [Hash] opts the optional parameters
|
1152
1043
|
# @return [nil]
|
1153
|
-
def
|
1154
|
-
|
1044
|
+
def initialize_self_service_verification_via_browser_flow(opts = {})
|
1045
|
+
initialize_self_service_verification_via_browser_flow_with_http_info(opts)
|
1155
1046
|
nil
|
1156
1047
|
end
|
1157
1048
|
|
1158
|
-
# Initialize
|
1159
|
-
# This endpoint initializes a browser-based account
|
1049
|
+
# Initialize Verification Flow for Browser Clients
|
1050
|
+
# This endpoint initializes a browser-based account verification flow. Once initialized, the browser will be redirected to `selfservice.flows.verification.ui_url` with the flow ID set as the query parameter `?flow=`. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
|
1160
1051
|
# @param [Hash] opts the optional parameters
|
1161
1052
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1162
|
-
def
|
1053
|
+
def initialize_self_service_verification_via_browser_flow_with_http_info(opts = {})
|
1163
1054
|
if @api_client.config.debugging
|
1164
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
1055
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_verification_via_browser_flow ...'
|
1165
1056
|
end
|
1166
1057
|
# resource path
|
1167
|
-
local_var_path = '/self-service/
|
1058
|
+
local_var_path = '/self-service/verification/browser'
|
1168
1059
|
|
1169
1060
|
# query parameters
|
1170
1061
|
query_params = opts[:query_params] || {}
|
@@ -1187,7 +1078,7 @@ module OryHydraClient
|
|
1187
1078
|
auth_names = opts[:debug_auth_names] || []
|
1188
1079
|
|
1189
1080
|
new_options = opts.merge(
|
1190
|
-
:operation => :"PublicApi.
|
1081
|
+
:operation => :"PublicApi.initialize_self_service_verification_via_browser_flow",
|
1191
1082
|
:header_params => header_params,
|
1192
1083
|
:query_params => query_params,
|
1193
1084
|
:form_params => form_params,
|
@@ -1198,30 +1089,36 @@ module OryHydraClient
|
|
1198
1089
|
|
1199
1090
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1200
1091
|
if @api_client.config.debugging
|
1201
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
1092
|
+
@api_client.config.logger.debug "API called: PublicApi#initialize_self_service_verification_via_browser_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1202
1093
|
end
|
1203
1094
|
return data, status_code, headers
|
1204
1095
|
end
|
1205
1096
|
|
1206
|
-
# Initialize
|
1207
|
-
#
|
1097
|
+
# Initialize Logout Flow for API Clients - Revoke a Session
|
1098
|
+
# Use this endpoint to revoke a session using its token. This endpoint is particularly useful for API clients such as mobile apps to log the user out of the system and invalidate the session. This endpoint does not remove any HTTP Cookies - use the Browser-Based Self-Service Logout Flow instead.
|
1099
|
+
# @param revoke_session [RevokeSession]
|
1208
1100
|
# @param [Hash] opts the optional parameters
|
1209
|
-
# @return [
|
1210
|
-
def
|
1211
|
-
|
1212
|
-
|
1101
|
+
# @return [nil]
|
1102
|
+
def revoke_session(revoke_session, opts = {})
|
1103
|
+
revoke_session_with_http_info(revoke_session, opts)
|
1104
|
+
nil
|
1213
1105
|
end
|
1214
1106
|
|
1215
|
-
# Initialize
|
1216
|
-
#
|
1107
|
+
# Initialize Logout Flow for API Clients - Revoke a Session
|
1108
|
+
# Use this endpoint to revoke a session using its token. This endpoint is particularly useful for API clients such as mobile apps to log the user out of the system and invalidate the session. This endpoint does not remove any HTTP Cookies - use the Browser-Based Self-Service Logout Flow instead.
|
1109
|
+
# @param revoke_session [RevokeSession]
|
1217
1110
|
# @param [Hash] opts the optional parameters
|
1218
|
-
# @return [Array<(
|
1219
|
-
def
|
1111
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1112
|
+
def revoke_session_with_http_info(revoke_session, opts = {})
|
1220
1113
|
if @api_client.config.debugging
|
1221
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
1114
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.revoke_session ...'
|
1115
|
+
end
|
1116
|
+
# verify the required parameter 'revoke_session' is set
|
1117
|
+
if @api_client.config.client_side_validation && revoke_session.nil?
|
1118
|
+
fail ArgumentError, "Missing the required parameter 'revoke_session' when calling PublicApi.revoke_session"
|
1222
1119
|
end
|
1223
1120
|
# resource path
|
1224
|
-
local_var_path = '/
|
1121
|
+
local_var_path = '/sessions'
|
1225
1122
|
|
1226
1123
|
# query parameters
|
1227
1124
|
query_params = opts[:query_params] || {}
|
@@ -1230,21 +1127,23 @@ module OryHydraClient
|
|
1230
1127
|
header_params = opts[:header_params] || {}
|
1231
1128
|
# HTTP header 'Accept' (if needed)
|
1232
1129
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1130
|
+
# HTTP header 'Content-Type'
|
1131
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1233
1132
|
|
1234
1133
|
# form parameters
|
1235
1134
|
form_params = opts[:form_params] || {}
|
1236
1135
|
|
1237
1136
|
# http body (model)
|
1238
|
-
post_body = opts[:debug_body]
|
1137
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(revoke_session)
|
1239
1138
|
|
1240
1139
|
# return_type
|
1241
|
-
return_type = opts[:debug_return_type]
|
1140
|
+
return_type = opts[:debug_return_type]
|
1242
1141
|
|
1243
1142
|
# auth_names
|
1244
1143
|
auth_names = opts[:debug_auth_names] || []
|
1245
1144
|
|
1246
1145
|
new_options = opts.merge(
|
1247
|
-
:operation => :"PublicApi.
|
1146
|
+
:operation => :"PublicApi.revoke_session",
|
1248
1147
|
:header_params => header_params,
|
1249
1148
|
:query_params => query_params,
|
1250
1149
|
:form_params => form_params,
|
@@ -1253,55 +1152,66 @@ module OryHydraClient
|
|
1253
1152
|
:return_type => return_type
|
1254
1153
|
)
|
1255
1154
|
|
1256
|
-
data, status_code, headers = @api_client.call_api(:
|
1155
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
1257
1156
|
if @api_client.config.debugging
|
1258
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
1157
|
+
@api_client.config.logger.debug "API called: PublicApi#revoke_session\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1259
1158
|
end
|
1260
1159
|
return data, status_code, headers
|
1261
1160
|
end
|
1262
1161
|
|
1263
|
-
#
|
1264
|
-
#
|
1162
|
+
# Submit a Login Flow
|
1163
|
+
# Use this endpoint to complete a login flow. This endpoint behaves differently for API and browser flows. API flows expect `application/json` to be sent in the body and responds with HTTP 200 and a application/json body with the session token on success; HTTP 302 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. Browser flows expect `application/x-www-form-urlencoded` to be sent in the body and responds with a HTTP 302 redirect to the post/after login URL or the `return_to` value if it was set and if the login succeeded; a HTTP 302 redirect to the login UI URL with the flow ID containing the validation errors otherwise. More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
1164
|
+
# @param flow [String] The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`).
|
1265
1165
|
# @param [Hash] opts the optional parameters
|
1266
|
-
# @
|
1267
|
-
|
1268
|
-
|
1269
|
-
|
1166
|
+
# @option opts [SubmitSelfServiceLoginFlow] :submit_self_service_login_flow
|
1167
|
+
# @return [LoginViaApiResponse]
|
1168
|
+
def submit_self_service_login_flow(flow, opts = {})
|
1169
|
+
data, _status_code, _headers = submit_self_service_login_flow_with_http_info(flow, opts)
|
1170
|
+
data
|
1270
1171
|
end
|
1271
1172
|
|
1272
|
-
#
|
1273
|
-
#
|
1173
|
+
# Submit a Login Flow
|
1174
|
+
# Use this endpoint to complete a login flow. This endpoint behaves differently for API and browser flows. API flows expect `application/json` to be sent in the body and responds with HTTP 200 and a application/json body with the session token on success; HTTP 302 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. Browser flows expect `application/x-www-form-urlencoded` to be sent in the body and responds with a HTTP 302 redirect to the post/after login URL or the `return_to` value if it was set and if the login succeeded; a HTTP 302 redirect to the login UI URL with the flow ID containing the validation errors otherwise. More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
1175
|
+
# @param flow [String] The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`).
|
1274
1176
|
# @param [Hash] opts the optional parameters
|
1275
|
-
# @
|
1276
|
-
|
1177
|
+
# @option opts [SubmitSelfServiceLoginFlow] :submit_self_service_login_flow
|
1178
|
+
# @return [Array<(LoginViaApiResponse, Integer, Hash)>] LoginViaApiResponse data, response status code and response headers
|
1179
|
+
def submit_self_service_login_flow_with_http_info(flow, opts = {})
|
1277
1180
|
if @api_client.config.debugging
|
1278
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
1181
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.submit_self_service_login_flow ...'
|
1182
|
+
end
|
1183
|
+
# verify the required parameter 'flow' is set
|
1184
|
+
if @api_client.config.client_side_validation && flow.nil?
|
1185
|
+
fail ArgumentError, "Missing the required parameter 'flow' when calling PublicApi.submit_self_service_login_flow"
|
1279
1186
|
end
|
1280
1187
|
# resource path
|
1281
|
-
local_var_path = '/self-service/
|
1188
|
+
local_var_path = '/self-service/login'
|
1282
1189
|
|
1283
1190
|
# query parameters
|
1284
1191
|
query_params = opts[:query_params] || {}
|
1192
|
+
query_params[:'flow'] = flow
|
1285
1193
|
|
1286
1194
|
# header parameters
|
1287
1195
|
header_params = opts[:header_params] || {}
|
1288
1196
|
# HTTP header 'Accept' (if needed)
|
1289
1197
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1198
|
+
# HTTP header 'Content-Type'
|
1199
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])
|
1290
1200
|
|
1291
1201
|
# form parameters
|
1292
1202
|
form_params = opts[:form_params] || {}
|
1293
1203
|
|
1294
1204
|
# http body (model)
|
1295
|
-
post_body = opts[:debug_body]
|
1205
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'submit_self_service_login_flow'])
|
1296
1206
|
|
1297
1207
|
# return_type
|
1298
|
-
return_type = opts[:debug_return_type]
|
1208
|
+
return_type = opts[:debug_return_type] || 'LoginViaApiResponse'
|
1299
1209
|
|
1300
1210
|
# auth_names
|
1301
1211
|
auth_names = opts[:debug_auth_names] || []
|
1302
1212
|
|
1303
1213
|
new_options = opts.merge(
|
1304
|
-
:operation => :"PublicApi.
|
1214
|
+
:operation => :"PublicApi.submit_self_service_login_flow",
|
1305
1215
|
:header_params => header_params,
|
1306
1216
|
:query_params => query_params,
|
1307
1217
|
:form_params => form_params,
|
@@ -1310,55 +1220,66 @@ module OryHydraClient
|
|
1310
1220
|
:return_type => return_type
|
1311
1221
|
)
|
1312
1222
|
|
1313
|
-
data, status_code, headers = @api_client.call_api(:
|
1223
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1314
1224
|
if @api_client.config.debugging
|
1315
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
1225
|
+
@api_client.config.logger.debug "API called: PublicApi#submit_self_service_login_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1316
1226
|
end
|
1317
1227
|
return data, status_code, headers
|
1318
1228
|
end
|
1319
1229
|
|
1320
|
-
#
|
1321
|
-
#
|
1230
|
+
# Complete Recovery Flow
|
1231
|
+
# Use this endpoint to complete a recovery flow. This endpoint behaves differently for API and browser flows and has several states: `choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent and works with API- and Browser-initiated flows. For API clients it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid and a HTTP 302 Found redirect with a fresh recovery flow if the flow was otherwise invalid (e.g. expired). For Browser clients it returns a HTTP 302 Found redirect to the Recovery UI URL with the Recovery Flow ID appended. `sent_email` is the success state after `choose_method` for the `link` method and allows the user to request another recovery email. It works for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state. `passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow (\"sending a recovery link\") does not have any API capabilities. The server responds with a HTTP 302 Found redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Recover UI URL with a new Recovery Flow ID which contains an error message that the recovery link was invalid. More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
|
1232
|
+
# @param flow [String] The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`).
|
1322
1233
|
# @param [Hash] opts the optional parameters
|
1323
|
-
# @
|
1324
|
-
|
1325
|
-
|
1326
|
-
|
1234
|
+
# @option opts [Object] :body
|
1235
|
+
# @return [nil]
|
1236
|
+
def submit_self_service_recovery_flow(flow, opts = {})
|
1237
|
+
submit_self_service_recovery_flow_with_http_info(flow, opts)
|
1238
|
+
nil
|
1327
1239
|
end
|
1328
1240
|
|
1329
|
-
#
|
1330
|
-
#
|
1241
|
+
# Complete Recovery Flow
|
1242
|
+
# Use this endpoint to complete a recovery flow. This endpoint behaves differently for API and browser flows and has several states: `choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent and works with API- and Browser-initiated flows. For API clients it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid and a HTTP 302 Found redirect with a fresh recovery flow if the flow was otherwise invalid (e.g. expired). For Browser clients it returns a HTTP 302 Found redirect to the Recovery UI URL with the Recovery Flow ID appended. `sent_email` is the success state after `choose_method` for the `link` method and allows the user to request another recovery email. It works for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state. `passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow (\"sending a recovery link\") does not have any API capabilities. The server responds with a HTTP 302 Found redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Recover UI URL with a new Recovery Flow ID which contains an error message that the recovery link was invalid. More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
|
1243
|
+
# @param flow [String] The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`).
|
1331
1244
|
# @param [Hash] opts the optional parameters
|
1332
|
-
# @
|
1333
|
-
|
1245
|
+
# @option opts [Object] :body
|
1246
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1247
|
+
def submit_self_service_recovery_flow_with_http_info(flow, opts = {})
|
1334
1248
|
if @api_client.config.debugging
|
1335
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
1249
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.submit_self_service_recovery_flow ...'
|
1250
|
+
end
|
1251
|
+
# verify the required parameter 'flow' is set
|
1252
|
+
if @api_client.config.client_side_validation && flow.nil?
|
1253
|
+
fail ArgumentError, "Missing the required parameter 'flow' when calling PublicApi.submit_self_service_recovery_flow"
|
1336
1254
|
end
|
1337
1255
|
# resource path
|
1338
|
-
local_var_path = '/self-service/
|
1256
|
+
local_var_path = '/self-service/recovery'
|
1339
1257
|
|
1340
1258
|
# query parameters
|
1341
1259
|
query_params = opts[:query_params] || {}
|
1260
|
+
query_params[:'flow'] = flow
|
1342
1261
|
|
1343
1262
|
# header parameters
|
1344
1263
|
header_params = opts[:header_params] || {}
|
1345
1264
|
# HTTP header 'Accept' (if needed)
|
1346
1265
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1266
|
+
# HTTP header 'Content-Type'
|
1267
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])
|
1347
1268
|
|
1348
1269
|
# form parameters
|
1349
1270
|
form_params = opts[:form_params] || {}
|
1350
1271
|
|
1351
1272
|
# http body (model)
|
1352
|
-
post_body = opts[:debug_body]
|
1273
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'body'])
|
1353
1274
|
|
1354
1275
|
# return_type
|
1355
|
-
return_type = opts[:debug_return_type]
|
1276
|
+
return_type = opts[:debug_return_type]
|
1356
1277
|
|
1357
1278
|
# auth_names
|
1358
|
-
auth_names = opts[:debug_auth_names] || [
|
1279
|
+
auth_names = opts[:debug_auth_names] || []
|
1359
1280
|
|
1360
1281
|
new_options = opts.merge(
|
1361
|
-
:operation => :"PublicApi.
|
1282
|
+
:operation => :"PublicApi.submit_self_service_recovery_flow",
|
1362
1283
|
:header_params => header_params,
|
1363
1284
|
:query_params => query_params,
|
1364
1285
|
:form_params => form_params,
|
@@ -1367,55 +1288,65 @@ module OryHydraClient
|
|
1367
1288
|
:return_type => return_type
|
1368
1289
|
)
|
1369
1290
|
|
1370
|
-
data, status_code, headers = @api_client.call_api(:
|
1291
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1371
1292
|
if @api_client.config.debugging
|
1372
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
1293
|
+
@api_client.config.logger.debug "API called: PublicApi#submit_self_service_recovery_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1373
1294
|
end
|
1374
1295
|
return data, status_code, headers
|
1375
1296
|
end
|
1376
1297
|
|
1377
|
-
#
|
1378
|
-
#
|
1298
|
+
# Complete Recovery Flow with Link Method
|
1299
|
+
# Use this endpoint to complete a recovery flow using the link method. This endpoint behaves differently for API and browser flows and has several states: `choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent and works with API- and Browser-initiated flows. For API clients it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid and a HTTP 302 Found redirect with a fresh recovery flow if the flow was otherwise invalid (e.g. expired). For Browser clients it returns a HTTP 302 Found redirect to the Recovery UI URL with the Recovery Flow ID appended. `sent_email` is the success state after `choose_method` and allows the user to request another recovery email. It works for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state. `passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow (\"sending a recovery link\") does not have any API capabilities. The server responds with a HTTP 302 Found redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Recover UI URL with a new Recovery Flow ID which contains an error message that the recovery link was invalid. More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
|
1379
1300
|
# @param [Hash] opts the optional parameters
|
1301
|
+
# @option opts [String] :token Recovery Token The recovery token which completes the recovery request. If the token is invalid (e.g. expired) an error will be shown to the end-user.
|
1302
|
+
# @option opts [String] :flow The Flow ID format: uuid
|
1303
|
+
# @option opts [SubmitSelfServiceRecoveryFlowWithLinkMethod] :submit_self_service_recovery_flow_with_link_method
|
1380
1304
|
# @return [nil]
|
1381
|
-
def
|
1382
|
-
|
1305
|
+
def submit_self_service_recovery_flow_with_link_method(opts = {})
|
1306
|
+
submit_self_service_recovery_flow_with_link_method_with_http_info(opts)
|
1383
1307
|
nil
|
1384
1308
|
end
|
1385
1309
|
|
1386
|
-
#
|
1387
|
-
#
|
1310
|
+
# Complete Recovery Flow with Link Method
|
1311
|
+
# Use this endpoint to complete a recovery flow using the link method. This endpoint behaves differently for API and browser flows and has several states: `choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent and works with API- and Browser-initiated flows. For API clients it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid and a HTTP 302 Found redirect with a fresh recovery flow if the flow was otherwise invalid (e.g. expired). For Browser clients it returns a HTTP 302 Found redirect to the Recovery UI URL with the Recovery Flow ID appended. `sent_email` is the success state after `choose_method` and allows the user to request another recovery email. It works for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state. `passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow (\"sending a recovery link\") does not have any API capabilities. The server responds with a HTTP 302 Found redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Recover UI URL with a new Recovery Flow ID which contains an error message that the recovery link was invalid. More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
|
1388
1312
|
# @param [Hash] opts the optional parameters
|
1313
|
+
# @option opts [String] :token Recovery Token The recovery token which completes the recovery request. If the token is invalid (e.g. expired) an error will be shown to the end-user.
|
1314
|
+
# @option opts [String] :flow The Flow ID format: uuid
|
1315
|
+
# @option opts [SubmitSelfServiceRecoveryFlowWithLinkMethod] :submit_self_service_recovery_flow_with_link_method
|
1389
1316
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1390
|
-
def
|
1317
|
+
def submit_self_service_recovery_flow_with_link_method_with_http_info(opts = {})
|
1391
1318
|
if @api_client.config.debugging
|
1392
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
1319
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.submit_self_service_recovery_flow_with_link_method ...'
|
1393
1320
|
end
|
1394
1321
|
# resource path
|
1395
|
-
local_var_path = '/self-service/
|
1322
|
+
local_var_path = '/self-service/recovery/methods/link'
|
1396
1323
|
|
1397
1324
|
# query parameters
|
1398
1325
|
query_params = opts[:query_params] || {}
|
1326
|
+
query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?
|
1327
|
+
query_params[:'flow'] = opts[:'flow'] if !opts[:'flow'].nil?
|
1399
1328
|
|
1400
1329
|
# header parameters
|
1401
1330
|
header_params = opts[:header_params] || {}
|
1402
1331
|
# HTTP header 'Accept' (if needed)
|
1403
1332
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1333
|
+
# HTTP header 'Content-Type'
|
1334
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])
|
1404
1335
|
|
1405
1336
|
# form parameters
|
1406
1337
|
form_params = opts[:form_params] || {}
|
1407
1338
|
|
1408
1339
|
# http body (model)
|
1409
|
-
post_body = opts[:debug_body]
|
1340
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'submit_self_service_recovery_flow_with_link_method'])
|
1410
1341
|
|
1411
1342
|
# return_type
|
1412
1343
|
return_type = opts[:debug_return_type]
|
1413
1344
|
|
1414
1345
|
# auth_names
|
1415
|
-
auth_names = opts[:debug_auth_names] || [
|
1346
|
+
auth_names = opts[:debug_auth_names] || []
|
1416
1347
|
|
1417
1348
|
new_options = opts.merge(
|
1418
|
-
:operation => :"PublicApi.
|
1349
|
+
:operation => :"PublicApi.submit_self_service_recovery_flow_with_link_method",
|
1419
1350
|
:header_params => header_params,
|
1420
1351
|
:query_params => query_params,
|
1421
1352
|
:form_params => form_params,
|
@@ -1424,55 +1355,66 @@ module OryHydraClient
|
|
1424
1355
|
:return_type => return_type
|
1425
1356
|
)
|
1426
1357
|
|
1427
|
-
data, status_code, headers = @api_client.call_api(:
|
1358
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1428
1359
|
if @api_client.config.debugging
|
1429
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
1360
|
+
@api_client.config.logger.debug "API called: PublicApi#submit_self_service_recovery_flow_with_link_method\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1430
1361
|
end
|
1431
1362
|
return data, status_code, headers
|
1432
1363
|
end
|
1433
1364
|
|
1434
|
-
#
|
1435
|
-
#
|
1365
|
+
# Submit a Registration Flow
|
1366
|
+
# Use this endpoint to complete a registration flow by sending an identity's traits and password. This endpoint behaves differently for API and browser flows. API flows expect `application/json` to be sent in the body and respond with HTTP 200 and a application/json body with the created identity success - if the session hook is configured the `session` and `session_token` will also be included; HTTP 302 redirect to a fresh registration flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. Browser flows expect `application/x-www-form-urlencoded` to be sent in the body and responds with a HTTP 302 redirect to the post/after registration URL or the `return_to` value if it was set and if the registration succeeded; a HTTP 302 redirect to the registration UI URL with the flow ID containing the validation errors otherwise. More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
1367
|
+
# @param flow [String] The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`).
|
1436
1368
|
# @param [Hash] opts the optional parameters
|
1437
|
-
# @
|
1438
|
-
|
1439
|
-
|
1369
|
+
# @option opts [SubmitSelfServiceRegistrationFlow] :submit_self_service_registration_flow
|
1370
|
+
# @return [RegistrationViaApiResponse]
|
1371
|
+
def submit_self_service_registration_flow(flow, opts = {})
|
1372
|
+
data, _status_code, _headers = submit_self_service_registration_flow_with_http_info(flow, opts)
|
1440
1373
|
data
|
1441
1374
|
end
|
1442
1375
|
|
1443
|
-
#
|
1444
|
-
#
|
1376
|
+
# Submit a Registration Flow
|
1377
|
+
# Use this endpoint to complete a registration flow by sending an identity's traits and password. This endpoint behaves differently for API and browser flows. API flows expect `application/json` to be sent in the body and respond with HTTP 200 and a application/json body with the created identity success - if the session hook is configured the `session` and `session_token` will also be included; HTTP 302 redirect to a fresh registration flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. Browser flows expect `application/x-www-form-urlencoded` to be sent in the body and responds with a HTTP 302 redirect to the post/after registration URL or the `return_to` value if it was set and if the registration succeeded; a HTTP 302 redirect to the registration UI URL with the flow ID containing the validation errors otherwise. More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
1378
|
+
# @param flow [String] The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`).
|
1445
1379
|
# @param [Hash] opts the optional parameters
|
1446
|
-
# @
|
1447
|
-
|
1380
|
+
# @option opts [SubmitSelfServiceRegistrationFlow] :submit_self_service_registration_flow
|
1381
|
+
# @return [Array<(RegistrationViaApiResponse, Integer, Hash)>] RegistrationViaApiResponse data, response status code and response headers
|
1382
|
+
def submit_self_service_registration_flow_with_http_info(flow, opts = {})
|
1448
1383
|
if @api_client.config.debugging
|
1449
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
1384
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.submit_self_service_registration_flow ...'
|
1385
|
+
end
|
1386
|
+
# verify the required parameter 'flow' is set
|
1387
|
+
if @api_client.config.client_side_validation && flow.nil?
|
1388
|
+
fail ArgumentError, "Missing the required parameter 'flow' when calling PublicApi.submit_self_service_registration_flow"
|
1450
1389
|
end
|
1451
1390
|
# resource path
|
1452
|
-
local_var_path = '/self-service/
|
1391
|
+
local_var_path = '/self-service/registration'
|
1453
1392
|
|
1454
1393
|
# query parameters
|
1455
1394
|
query_params = opts[:query_params] || {}
|
1395
|
+
query_params[:'flow'] = flow
|
1456
1396
|
|
1457
1397
|
# header parameters
|
1458
1398
|
header_params = opts[:header_params] || {}
|
1459
1399
|
# HTTP header 'Accept' (if needed)
|
1460
1400
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1401
|
+
# HTTP header 'Content-Type'
|
1402
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])
|
1461
1403
|
|
1462
1404
|
# form parameters
|
1463
1405
|
form_params = opts[:form_params] || {}
|
1464
1406
|
|
1465
1407
|
# http body (model)
|
1466
|
-
post_body = opts[:debug_body]
|
1408
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'submit_self_service_registration_flow'])
|
1467
1409
|
|
1468
1410
|
# return_type
|
1469
|
-
return_type = opts[:debug_return_type] || '
|
1411
|
+
return_type = opts[:debug_return_type] || 'RegistrationViaApiResponse'
|
1470
1412
|
|
1471
1413
|
# auth_names
|
1472
1414
|
auth_names = opts[:debug_auth_names] || []
|
1473
1415
|
|
1474
1416
|
new_options = opts.merge(
|
1475
|
-
:operation => :"PublicApi.
|
1417
|
+
:operation => :"PublicApi.submit_self_service_registration_flow",
|
1476
1418
|
:header_params => header_params,
|
1477
1419
|
:query_params => query_params,
|
1478
1420
|
:form_params => form_params,
|
@@ -1481,55 +1423,66 @@ module OryHydraClient
|
|
1481
1423
|
:return_type => return_type
|
1482
1424
|
)
|
1483
1425
|
|
1484
|
-
data, status_code, headers = @api_client.call_api(:
|
1426
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1485
1427
|
if @api_client.config.debugging
|
1486
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
1428
|
+
@api_client.config.logger.debug "API called: PublicApi#submit_self_service_registration_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1487
1429
|
end
|
1488
1430
|
return data, status_code, headers
|
1489
1431
|
end
|
1490
1432
|
|
1491
|
-
#
|
1492
|
-
#
|
1433
|
+
# Complete Settings Flow
|
1434
|
+
# Use this endpoint to complete a settings flow by sending an identity's updated password. This endpoint behaves differently for API and browser flows. API-initiated flows expect `application/json` to be sent in the body and respond with HTTP 200 and an application/json body with the session token on success; HTTP 302 redirect to a fresh settings flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. HTTP 401 when the endpoint is called without a valid session token. HTTP 403 when `selfservice.flows.settings.privileged_session_max_age` was reached. Implies that the user needs to re-authenticate. Browser flows expect `application/x-www-form-urlencoded` to be sent in the body and responds with a HTTP 302 redirect to the post/after settings URL or the `return_to` value if it was set and if the flow succeeded; a HTTP 302 redirect to the Settings UI URL with the flow ID containing the validation errors otherwise. a HTTP 302 redirect to the login endpoint when `selfservice.flows.settings.privileged_session_max_age` was reached. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
1435
|
+
# @param flow [String] The Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`).
|
1493
1436
|
# @param [Hash] opts the optional parameters
|
1494
|
-
# @
|
1495
|
-
|
1496
|
-
|
1497
|
-
|
1437
|
+
# @option opts [SubmitSelfServiceSettingsFlow] :submit_self_service_settings_flow
|
1438
|
+
# @return [SettingsViaApiResponse]
|
1439
|
+
def submit_self_service_settings_flow(flow, opts = {})
|
1440
|
+
data, _status_code, _headers = submit_self_service_settings_flow_with_http_info(flow, opts)
|
1441
|
+
data
|
1498
1442
|
end
|
1499
1443
|
|
1500
|
-
#
|
1501
|
-
#
|
1444
|
+
# Complete Settings Flow
|
1445
|
+
# Use this endpoint to complete a settings flow by sending an identity's updated password. This endpoint behaves differently for API and browser flows. API-initiated flows expect `application/json` to be sent in the body and respond with HTTP 200 and an application/json body with the session token on success; HTTP 302 redirect to a fresh settings flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. HTTP 401 when the endpoint is called without a valid session token. HTTP 403 when `selfservice.flows.settings.privileged_session_max_age` was reached. Implies that the user needs to re-authenticate. Browser flows expect `application/x-www-form-urlencoded` to be sent in the body and responds with a HTTP 302 redirect to the post/after settings URL or the `return_to` value if it was set and if the flow succeeded; a HTTP 302 redirect to the Settings UI URL with the flow ID containing the validation errors otherwise. a HTTP 302 redirect to the login endpoint when `selfservice.flows.settings.privileged_session_max_age` was reached. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
1446
|
+
# @param flow [String] The Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`).
|
1502
1447
|
# @param [Hash] opts the optional parameters
|
1503
|
-
# @
|
1504
|
-
|
1448
|
+
# @option opts [SubmitSelfServiceSettingsFlow] :submit_self_service_settings_flow
|
1449
|
+
# @return [Array<(SettingsViaApiResponse, Integer, Hash)>] SettingsViaApiResponse data, response status code and response headers
|
1450
|
+
def submit_self_service_settings_flow_with_http_info(flow, opts = {})
|
1505
1451
|
if @api_client.config.debugging
|
1506
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
1452
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.submit_self_service_settings_flow ...'
|
1453
|
+
end
|
1454
|
+
# verify the required parameter 'flow' is set
|
1455
|
+
if @api_client.config.client_side_validation && flow.nil?
|
1456
|
+
fail ArgumentError, "Missing the required parameter 'flow' when calling PublicApi.submit_self_service_settings_flow"
|
1507
1457
|
end
|
1508
1458
|
# resource path
|
1509
|
-
local_var_path = '/self-service/
|
1459
|
+
local_var_path = '/self-service/settings'
|
1510
1460
|
|
1511
1461
|
# query parameters
|
1512
1462
|
query_params = opts[:query_params] || {}
|
1463
|
+
query_params[:'flow'] = flow
|
1513
1464
|
|
1514
1465
|
# header parameters
|
1515
1466
|
header_params = opts[:header_params] || {}
|
1516
1467
|
# HTTP header 'Accept' (if needed)
|
1517
1468
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1469
|
+
# HTTP header 'Content-Type'
|
1470
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])
|
1518
1471
|
|
1519
1472
|
# form parameters
|
1520
1473
|
form_params = opts[:form_params] || {}
|
1521
1474
|
|
1522
1475
|
# http body (model)
|
1523
|
-
post_body = opts[:debug_body]
|
1476
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'submit_self_service_settings_flow'])
|
1524
1477
|
|
1525
1478
|
# return_type
|
1526
|
-
return_type = opts[:debug_return_type]
|
1479
|
+
return_type = opts[:debug_return_type] || 'SettingsViaApiResponse'
|
1527
1480
|
|
1528
1481
|
# auth_names
|
1529
|
-
auth_names = opts[:debug_auth_names] || []
|
1482
|
+
auth_names = opts[:debug_auth_names] || ['sessionToken']
|
1530
1483
|
|
1531
1484
|
new_options = opts.merge(
|
1532
|
-
:operation => :"PublicApi.
|
1485
|
+
:operation => :"PublicApi.submit_self_service_settings_flow",
|
1533
1486
|
:header_params => header_params,
|
1534
1487
|
:query_params => query_params,
|
1535
1488
|
:form_params => form_params,
|
@@ -1538,54 +1491,57 @@ module OryHydraClient
|
|
1538
1491
|
:return_type => return_type
|
1539
1492
|
)
|
1540
1493
|
|
1541
|
-
data, status_code, headers = @api_client.call_api(:
|
1494
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1542
1495
|
if @api_client.config.debugging
|
1543
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
1496
|
+
@api_client.config.logger.debug "API called: PublicApi#submit_self_service_settings_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1544
1497
|
end
|
1545
1498
|
return data, status_code, headers
|
1546
1499
|
end
|
1547
1500
|
|
1548
|
-
#
|
1549
|
-
# Use this endpoint to
|
1550
|
-
# @param
|
1501
|
+
# Complete Verification Flow
|
1502
|
+
# Use this endpoint to complete a verification flow. This endpoint behaves differently for API and browser flows and has several states: `choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent and works with API- and Browser-initiated flows. For API clients it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid and a HTTP 302 Found redirect with a fresh verification flow if the flow was otherwise invalid (e.g. expired). For Browser clients it returns a HTTP 302 Found redirect to the Verification UI URL with the Verification Flow ID appended. `sent_email` is the success state after `choose_method` when using the `link` method and allows the user to request another verification email. It works for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state. `passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow (\"sending a verification link\") does not have any API capabilities. The server responds with a HTTP 302 Found redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Verification UI URL with a new Verification Flow ID which contains an error message that the verification link was invalid. More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
|
1503
|
+
# @param flow [String] The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`).
|
1551
1504
|
# @param [Hash] opts the optional parameters
|
1505
|
+
# @option opts [Object] :body
|
1552
1506
|
# @return [nil]
|
1553
|
-
def
|
1554
|
-
|
1507
|
+
def submit_self_service_verification_flow(flow, opts = {})
|
1508
|
+
submit_self_service_verification_flow_with_http_info(flow, opts)
|
1555
1509
|
nil
|
1556
1510
|
end
|
1557
1511
|
|
1558
|
-
#
|
1559
|
-
# Use this endpoint to
|
1560
|
-
# @param
|
1512
|
+
# Complete Verification Flow
|
1513
|
+
# Use this endpoint to complete a verification flow. This endpoint behaves differently for API and browser flows and has several states: `choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent and works with API- and Browser-initiated flows. For API clients it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid and a HTTP 302 Found redirect with a fresh verification flow if the flow was otherwise invalid (e.g. expired). For Browser clients it returns a HTTP 302 Found redirect to the Verification UI URL with the Verification Flow ID appended. `sent_email` is the success state after `choose_method` when using the `link` method and allows the user to request another verification email. It works for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state. `passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow (\"sending a verification link\") does not have any API capabilities. The server responds with a HTTP 302 Found redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Verification UI URL with a new Verification Flow ID which contains an error message that the verification link was invalid. More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
|
1514
|
+
# @param flow [String] The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`).
|
1561
1515
|
# @param [Hash] opts the optional parameters
|
1516
|
+
# @option opts [Object] :body
|
1562
1517
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1563
|
-
def
|
1518
|
+
def submit_self_service_verification_flow_with_http_info(flow, opts = {})
|
1564
1519
|
if @api_client.config.debugging
|
1565
|
-
@api_client.config.logger.debug 'Calling API: PublicApi.
|
1520
|
+
@api_client.config.logger.debug 'Calling API: PublicApi.submit_self_service_verification_flow ...'
|
1566
1521
|
end
|
1567
|
-
# verify the required parameter '
|
1568
|
-
if @api_client.config.client_side_validation &&
|
1569
|
-
fail ArgumentError, "Missing the required parameter '
|
1522
|
+
# verify the required parameter 'flow' is set
|
1523
|
+
if @api_client.config.client_side_validation && flow.nil?
|
1524
|
+
fail ArgumentError, "Missing the required parameter 'flow' when calling PublicApi.submit_self_service_verification_flow"
|
1570
1525
|
end
|
1571
1526
|
# resource path
|
1572
|
-
local_var_path = '/
|
1527
|
+
local_var_path = '/self-service/verification/methods/link'
|
1573
1528
|
|
1574
1529
|
# query parameters
|
1575
1530
|
query_params = opts[:query_params] || {}
|
1531
|
+
query_params[:'flow'] = flow
|
1576
1532
|
|
1577
1533
|
# header parameters
|
1578
1534
|
header_params = opts[:header_params] || {}
|
1579
1535
|
# HTTP header 'Accept' (if needed)
|
1580
1536
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1581
1537
|
# HTTP header 'Content-Type'
|
1582
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1538
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])
|
1583
1539
|
|
1584
1540
|
# form parameters
|
1585
1541
|
form_params = opts[:form_params] || {}
|
1586
1542
|
|
1587
1543
|
# http body (model)
|
1588
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
|
1544
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'body'])
|
1589
1545
|
|
1590
1546
|
# return_type
|
1591
1547
|
return_type = opts[:debug_return_type]
|
@@ -1594,7 +1550,7 @@ module OryHydraClient
|
|
1594
1550
|
auth_names = opts[:debug_auth_names] || []
|
1595
1551
|
|
1596
1552
|
new_options = opts.merge(
|
1597
|
-
:operation => :"PublicApi.
|
1553
|
+
:operation => :"PublicApi.submit_self_service_verification_flow",
|
1598
1554
|
:header_params => header_params,
|
1599
1555
|
:query_params => query_params,
|
1600
1556
|
:form_params => form_params,
|
@@ -1603,9 +1559,9 @@ module OryHydraClient
|
|
1603
1559
|
:return_type => return_type
|
1604
1560
|
)
|
1605
1561
|
|
1606
|
-
data, status_code, headers = @api_client.call_api(:
|
1562
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1607
1563
|
if @api_client.config.debugging
|
1608
|
-
@api_client.config.logger.debug "API called: PublicApi#
|
1564
|
+
@api_client.config.logger.debug "API called: PublicApi#submit_self_service_verification_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1609
1565
|
end
|
1610
1566
|
return data, status_code, headers
|
1611
1567
|
end
|
@@ -1614,7 +1570,7 @@ module OryHydraClient
|
|
1614
1570
|
# Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated. Returns a session object in the body or 401 if the credentials are invalid or no credentials were sent. Additionally when the request it successful it adds the user ID to the 'X-Kratos-Authenticated-Identity-Id' header in the response. This endpoint is useful for reverse proxies and API Gateways.
|
1615
1571
|
# @param [Hash] opts the optional parameters
|
1616
1572
|
# @option opts [String] :cookie
|
1617
|
-
# @option opts [String] :authorization
|
1573
|
+
# @option opts [String] :authorization
|
1618
1574
|
# @return [Session]
|
1619
1575
|
def whoami(opts = {})
|
1620
1576
|
data, _status_code, _headers = whoami_with_http_info(opts)
|
@@ -1625,7 +1581,7 @@ module OryHydraClient
|
|
1625
1581
|
# Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated. Returns a session object in the body or 401 if the credentials are invalid or no credentials were sent. Additionally when the request it successful it adds the user ID to the 'X-Kratos-Authenticated-Identity-Id' header in the response. This endpoint is useful for reverse proxies and API Gateways.
|
1626
1582
|
# @param [Hash] opts the optional parameters
|
1627
1583
|
# @option opts [String] :cookie
|
1628
|
-
# @option opts [String] :authorization
|
1584
|
+
# @option opts [String] :authorization
|
1629
1585
|
# @return [Array<(Session, Integer, Hash)>] Session data, response status code and response headers
|
1630
1586
|
def whoami_with_http_info(opts = {})
|
1631
1587
|
if @api_client.config.debugging
|
@@ -1636,13 +1592,13 @@ module OryHydraClient
|
|
1636
1592
|
|
1637
1593
|
# query parameters
|
1638
1594
|
query_params = opts[:query_params] || {}
|
1639
|
-
query_params[:'Authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
|
1640
1595
|
|
1641
1596
|
# header parameters
|
1642
1597
|
header_params = opts[:header_params] || {}
|
1643
1598
|
# HTTP header 'Accept' (if needed)
|
1644
1599
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1645
1600
|
header_params[:'Cookie'] = opts[:'cookie'] if !opts[:'cookie'].nil?
|
1601
|
+
header_params[:'Authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
|
1646
1602
|
|
1647
1603
|
# form parameters
|
1648
1604
|
form_params = opts[:form_params] || {}
|