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
@@ -0,0 +1,48 @@
|
|
1
|
+
# OryHydraClient::PluginConfig
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **args** | [**PluginConfigArgs**](PluginConfigArgs.md) | | |
|
8
|
+
| **description** | **String** | description | |
|
9
|
+
| **docker_version** | **String** | Docker Version used to create the plugin | [optional] |
|
10
|
+
| **documentation** | **String** | documentation | |
|
11
|
+
| **entrypoint** | **Array<String>** | entrypoint | |
|
12
|
+
| **env** | [**Array<PluginEnv>**](PluginEnv.md) | env | |
|
13
|
+
| **interface** | [**PluginConfigInterface**](PluginConfigInterface.md) | | |
|
14
|
+
| **ipc_host** | **Boolean** | ipc host | |
|
15
|
+
| **linux** | [**PluginConfigLinux**](PluginConfigLinux.md) | | |
|
16
|
+
| **mounts** | [**Array<PluginMount>**](PluginMount.md) | mounts | |
|
17
|
+
| **network** | [**PluginConfigNetwork**](PluginConfigNetwork.md) | | |
|
18
|
+
| **pid_host** | **Boolean** | pid host | |
|
19
|
+
| **propagated_mount** | **String** | propagated mount | |
|
20
|
+
| **user** | [**PluginConfigUser**](PluginConfigUser.md) | | [optional] |
|
21
|
+
| **work_dir** | **String** | work dir | |
|
22
|
+
| **rootfs** | [**PluginConfigRootfs**](PluginConfigRootfs.md) | | [optional] |
|
23
|
+
|
24
|
+
## Example
|
25
|
+
|
26
|
+
```ruby
|
27
|
+
require 'ory-kratos-client'
|
28
|
+
|
29
|
+
instance = OryHydraClient::PluginConfig.new(
|
30
|
+
args: null,
|
31
|
+
description: null,
|
32
|
+
docker_version: null,
|
33
|
+
documentation: null,
|
34
|
+
entrypoint: null,
|
35
|
+
env: null,
|
36
|
+
interface: null,
|
37
|
+
ipc_host: null,
|
38
|
+
linux: null,
|
39
|
+
mounts: null,
|
40
|
+
network: null,
|
41
|
+
pid_host: null,
|
42
|
+
propagated_mount: null,
|
43
|
+
user: null,
|
44
|
+
work_dir: null,
|
45
|
+
rootfs: null
|
46
|
+
)
|
47
|
+
```
|
48
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# OryHydraClient::PluginConfigArgs
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **description** | **String** | description | |
|
8
|
+
| **name** | **String** | name | |
|
9
|
+
| **settable** | **Array<String>** | settable | |
|
10
|
+
| **value** | **Array<String>** | value | |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'ory-kratos-client'
|
16
|
+
|
17
|
+
instance = OryHydraClient::PluginConfigArgs.new(
|
18
|
+
description: null,
|
19
|
+
name: null,
|
20
|
+
settable: null,
|
21
|
+
value: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# OryHydraClient::PluginConfigInterface
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **socket** | **String** | socket | |
|
8
|
+
| **types** | [**Array<PluginInterfaceType>**](PluginInterfaceType.md) | types | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'ory-kratos-client'
|
14
|
+
|
15
|
+
instance = OryHydraClient::PluginConfigInterface.new(
|
16
|
+
socket: null,
|
17
|
+
types: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# OryHydraClient::PluginConfigLinux
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **allow_all_devices** | **Boolean** | allow all devices | |
|
8
|
+
| **capabilities** | **Array<String>** | capabilities | |
|
9
|
+
| **devices** | [**Array<PluginDevice>**](PluginDevice.md) | devices | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'ory-kratos-client'
|
15
|
+
|
16
|
+
instance = OryHydraClient::PluginConfigLinux.new(
|
17
|
+
allow_all_devices: null,
|
18
|
+
capabilities: null,
|
19
|
+
devices: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# OryHydraClient::PluginConfigNetwork
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **type** | **String** | type | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'ory-kratos-client'
|
13
|
+
|
14
|
+
instance = OryHydraClient::PluginConfigNetwork.new(
|
15
|
+
type: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# OryHydraClient::PluginConfigRootfs
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **diff_ids** | **Array<String>** | diff ids | [optional] |
|
8
|
+
| **type** | **String** | type | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'ory-kratos-client'
|
14
|
+
|
15
|
+
instance = OryHydraClient::PluginConfigRootfs.new(
|
16
|
+
diff_ids: null,
|
17
|
+
type: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# OryHydraClient::PluginConfigUser
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **gid** | **Integer** | g ID | [optional] |
|
8
|
+
| **uid** | **Integer** | UID | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'ory-kratos-client'
|
14
|
+
|
15
|
+
instance = OryHydraClient::PluginConfigUser.new(
|
16
|
+
gid: null,
|
17
|
+
uid: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# OryHydraClient::PluginDevice
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **description** | **String** | description | |
|
8
|
+
| **name** | **String** | name | |
|
9
|
+
| **path** | **String** | path | |
|
10
|
+
| **settable** | **Array<String>** | settable | |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'ory-kratos-client'
|
16
|
+
|
17
|
+
instance = OryHydraClient::PluginDevice.new(
|
18
|
+
description: null,
|
19
|
+
name: null,
|
20
|
+
path: null,
|
21
|
+
settable: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/PluginEnv.md
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# OryHydraClient::PluginEnv
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **description** | **String** | description | |
|
8
|
+
| **name** | **String** | name | |
|
9
|
+
| **settable** | **Array<String>** | settable | |
|
10
|
+
| **value** | **String** | value | |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'ory-kratos-client'
|
16
|
+
|
17
|
+
instance = OryHydraClient::PluginEnv.new(
|
18
|
+
description: null,
|
19
|
+
name: null,
|
20
|
+
settable: null,
|
21
|
+
value: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# OryHydraClient::PluginInterfaceType
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **capability** | **String** | capability | |
|
8
|
+
| **prefix** | **String** | prefix | |
|
9
|
+
| **version** | **String** | version | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'ory-kratos-client'
|
15
|
+
|
16
|
+
instance = OryHydraClient::PluginInterfaceType.new(
|
17
|
+
capability: null,
|
18
|
+
prefix: null,
|
19
|
+
version: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/PluginMount.md
ADDED
@@ -0,0 +1,30 @@
|
|
1
|
+
# OryHydraClient::PluginMount
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **description** | **String** | description | |
|
8
|
+
| **destination** | **String** | destination | |
|
9
|
+
| **name** | **String** | name | |
|
10
|
+
| **options** | **Array<String>** | options | |
|
11
|
+
| **settable** | **Array<String>** | settable | |
|
12
|
+
| **source** | **String** | source | |
|
13
|
+
| **type** | **String** | type | |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'ory-kratos-client'
|
19
|
+
|
20
|
+
instance = OryHydraClient::PluginMount.new(
|
21
|
+
description: null,
|
22
|
+
destination: null,
|
23
|
+
name: null,
|
24
|
+
options: null,
|
25
|
+
settable: null,
|
26
|
+
source: null,
|
27
|
+
type: null
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# OryHydraClient::PluginSettings
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **args** | **Array<String>** | args | |
|
8
|
+
| **devices** | [**Array<PluginDevice>**](PluginDevice.md) | devices | |
|
9
|
+
| **env** | **Array<String>** | env | |
|
10
|
+
| **mounts** | [**Array<PluginMount>**](PluginMount.md) | mounts | |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'ory-kratos-client'
|
16
|
+
|
17
|
+
instance = OryHydraClient::PluginSettings.new(
|
18
|
+
args: null,
|
19
|
+
devices: null,
|
20
|
+
env: null,
|
21
|
+
mounts: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/Port.md
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# OryHydraClient::Port
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **ip** | **String** | IP | [optional] |
|
8
|
+
| **private_port** | **Integer** | Port on the container | |
|
9
|
+
| **public_port** | **Integer** | Port exposed on the host | [optional] |
|
10
|
+
| **type** | **String** | type | |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'ory-kratos-client'
|
16
|
+
|
17
|
+
instance = OryHydraClient::Port.new(
|
18
|
+
ip: null,
|
19
|
+
private_port: null,
|
20
|
+
public_port: null,
|
21
|
+
type: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/PublicApi.md
CHANGED
@@ -1,16 +1,9 @@
|
|
1
1
|
# OryHydraClient::PublicApi
|
2
2
|
|
3
|
-
All URIs are relative to *
|
3
|
+
All URIs are relative to *https://demo.tenants.oryapis.com/api/kratos/public*
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**complete_self_service_browser_settings_oidc_settings_flow**](PublicApi.md#complete_self_service_browser_settings_oidc_settings_flow) | **POST** /self-service/browser/flows/registration/strategies/oidc/settings/connections | Complete the Browser-Based Settings Flow for the OpenID Connect Strategy |
|
8
|
-
| [**complete_self_service_login_flow_with_password_method**](PublicApi.md#complete_self_service_login_flow_with_password_method) | **POST** /self-service/login/methods/password | Complete Login Flow with Username/Email Password Method |
|
9
|
-
| [**complete_self_service_recovery_flow_with_link_method**](PublicApi.md#complete_self_service_recovery_flow_with_link_method) | **POST** /self-service/recovery/methods/link | Complete Recovery Flow with Link Method |
|
10
|
-
| [**complete_self_service_registration_flow_with_password_method**](PublicApi.md#complete_self_service_registration_flow_with_password_method) | **POST** /self-service/registration/methods/password | Complete Registration Flow with Username/Email Password Method |
|
11
|
-
| [**complete_self_service_settings_flow_with_password_method**](PublicApi.md#complete_self_service_settings_flow_with_password_method) | **POST** /self-service/settings/methods/password | Complete Settings Flow with Username/Email Password Method |
|
12
|
-
| [**complete_self_service_settings_flow_with_profile_method**](PublicApi.md#complete_self_service_settings_flow_with_profile_method) | **POST** /self-service/settings/methods/profile | Complete Settings Flow with Profile Method |
|
13
|
-
| [**complete_self_service_verification_flow_with_link_method**](PublicApi.md#complete_self_service_verification_flow_with_link_method) | **POST** /self-service/verification/methods/link | Complete Verification Flow with Link Method |
|
14
7
|
| [**get_schema**](PublicApi.md#get_schema) | **GET** /schemas/{id} | |
|
15
8
|
| [**get_self_service_error**](PublicApi.md#get_self_service_error) | **GET** /self-service/errors | Get User-Facing Self-Service Errors |
|
16
9
|
| [**get_self_service_login_flow**](PublicApi.md#get_self_service_login_flow) | **GET** /self-service/login/flows | Get Login Flow |
|
@@ -29,17 +22,23 @@ All URIs are relative to *http://localhost*
|
|
29
22
|
| [**initialize_self_service_settings_via_browser_flow**](PublicApi.md#initialize_self_service_settings_via_browser_flow) | **GET** /self-service/settings/browser | Initialize Settings Flow for Browsers |
|
30
23
|
| [**initialize_self_service_verification_via_api_flow**](PublicApi.md#initialize_self_service_verification_via_api_flow) | **GET** /self-service/verification/api | Initialize Verification Flow for API Clients |
|
31
24
|
| [**initialize_self_service_verification_via_browser_flow**](PublicApi.md#initialize_self_service_verification_via_browser_flow) | **GET** /self-service/verification/browser | Initialize Verification Flow for Browser Clients |
|
32
|
-
| [**revoke_session**](PublicApi.md#revoke_session) | **DELETE** /sessions |
|
25
|
+
| [**revoke_session**](PublicApi.md#revoke_session) | **DELETE** /sessions | Initialize Logout Flow for API Clients - Revoke a Session |
|
26
|
+
| [**submit_self_service_login_flow**](PublicApi.md#submit_self_service_login_flow) | **POST** /self-service/login | Submit a Login Flow |
|
27
|
+
| [**submit_self_service_recovery_flow**](PublicApi.md#submit_self_service_recovery_flow) | **POST** /self-service/recovery | Complete Recovery Flow |
|
28
|
+
| [**submit_self_service_recovery_flow_with_link_method**](PublicApi.md#submit_self_service_recovery_flow_with_link_method) | **POST** /self-service/recovery/methods/link | Complete Recovery Flow with Link Method |
|
29
|
+
| [**submit_self_service_registration_flow**](PublicApi.md#submit_self_service_registration_flow) | **POST** /self-service/registration | Submit a Registration Flow |
|
30
|
+
| [**submit_self_service_settings_flow**](PublicApi.md#submit_self_service_settings_flow) | **POST** /self-service/settings | Complete Settings Flow |
|
31
|
+
| [**submit_self_service_verification_flow**](PublicApi.md#submit_self_service_verification_flow) | **POST** /self-service/verification/methods/link | Complete Verification Flow |
|
33
32
|
| [**whoami**](PublicApi.md#whoami) | **GET** /sessions/whoami | Check Who the Current HTTP Session Belongs To |
|
34
33
|
|
35
34
|
|
36
|
-
##
|
35
|
+
## get_schema
|
36
|
+
|
37
|
+
> Object get_schema(id)
|
37
38
|
|
38
|
-
> complete_self_service_browser_settings_oidc_settings_flow
|
39
39
|
|
40
|
-
Complete the Browser-Based Settings Flow for the OpenID Connect Strategy
|
41
40
|
|
42
|
-
|
41
|
+
Get a Traits Schema Definition
|
43
42
|
|
44
43
|
### Examples
|
45
44
|
|
@@ -48,40 +47,44 @@ require 'time'
|
|
48
47
|
require 'ory-kratos-client'
|
49
48
|
|
50
49
|
api_instance = OryHydraClient::PublicApi.new
|
50
|
+
id = 'id_example' # String | ID must be set to the ID of schema you want to get
|
51
51
|
|
52
52
|
begin
|
53
|
-
|
54
|
-
api_instance.
|
53
|
+
|
54
|
+
result = api_instance.get_schema(id)
|
55
|
+
p result
|
55
56
|
rescue OryHydraClient::ApiError => e
|
56
|
-
puts "Error when calling PublicApi->
|
57
|
+
puts "Error when calling PublicApi->get_schema: #{e}"
|
57
58
|
end
|
58
59
|
```
|
59
60
|
|
60
|
-
#### Using the
|
61
|
+
#### Using the get_schema_with_http_info variant
|
61
62
|
|
62
|
-
This returns an Array which contains the response data
|
63
|
+
This returns an Array which contains the response data, status code and headers.
|
63
64
|
|
64
|
-
> <Array(
|
65
|
+
> <Array(Object, Integer, Hash)> get_schema_with_http_info(id)
|
65
66
|
|
66
67
|
```ruby
|
67
68
|
begin
|
68
|
-
|
69
|
-
data, status_code, headers = api_instance.
|
69
|
+
|
70
|
+
data, status_code, headers = api_instance.get_schema_with_http_info(id)
|
70
71
|
p status_code # => 2xx
|
71
72
|
p headers # => { ... }
|
72
|
-
p data # =>
|
73
|
+
p data # => Object
|
73
74
|
rescue OryHydraClient::ApiError => e
|
74
|
-
puts "Error when calling PublicApi->
|
75
|
+
puts "Error when calling PublicApi->get_schema_with_http_info: #{e}"
|
75
76
|
end
|
76
77
|
```
|
77
78
|
|
78
79
|
### Parameters
|
79
80
|
|
80
|
-
|
81
|
+
| Name | Type | Description | Notes |
|
82
|
+
| ---- | ---- | ----------- | ----- |
|
83
|
+
| **id** | **String** | ID must be set to the ID of schema you want to get | |
|
81
84
|
|
82
85
|
### Return type
|
83
86
|
|
84
|
-
|
87
|
+
**Object**
|
85
88
|
|
86
89
|
### Authorization
|
87
90
|
|
@@ -93,13 +96,13 @@ No authorization required
|
|
93
96
|
- **Accept**: application/json
|
94
97
|
|
95
98
|
|
96
|
-
##
|
99
|
+
## get_self_service_error
|
97
100
|
|
98
|
-
> <
|
101
|
+
> <ErrorContainer> get_self_service_error(error)
|
99
102
|
|
100
|
-
|
103
|
+
Get User-Facing Self-Service Errors
|
101
104
|
|
102
|
-
|
105
|
+
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).
|
103
106
|
|
104
107
|
### Examples
|
105
108
|
|
@@ -108,35 +111,32 @@ require 'time'
|
|
108
111
|
require 'ory-kratos-client'
|
109
112
|
|
110
113
|
api_instance = OryHydraClient::PublicApi.new
|
111
|
-
|
112
|
-
opts = {
|
113
|
-
body: OryHydraClient::CompleteSelfServiceLoginFlowWithPasswordMethod.new # CompleteSelfServiceLoginFlowWithPasswordMethod |
|
114
|
-
}
|
114
|
+
error = 'error_example' # String | Error is the container's ID
|
115
115
|
|
116
116
|
begin
|
117
|
-
#
|
118
|
-
result = api_instance.
|
117
|
+
# Get User-Facing Self-Service Errors
|
118
|
+
result = api_instance.get_self_service_error(error)
|
119
119
|
p result
|
120
120
|
rescue OryHydraClient::ApiError => e
|
121
|
-
puts "Error when calling PublicApi->
|
121
|
+
puts "Error when calling PublicApi->get_self_service_error: #{e}"
|
122
122
|
end
|
123
123
|
```
|
124
124
|
|
125
|
-
#### Using the
|
125
|
+
#### Using the get_self_service_error_with_http_info variant
|
126
126
|
|
127
127
|
This returns an Array which contains the response data, status code and headers.
|
128
128
|
|
129
|
-
> <Array(<
|
129
|
+
> <Array(<ErrorContainer>, Integer, Hash)> get_self_service_error_with_http_info(error)
|
130
130
|
|
131
131
|
```ruby
|
132
132
|
begin
|
133
|
-
#
|
134
|
-
data, status_code, headers = api_instance.
|
133
|
+
# Get User-Facing Self-Service Errors
|
134
|
+
data, status_code, headers = api_instance.get_self_service_error_with_http_info(error)
|
135
135
|
p status_code # => 2xx
|
136
136
|
p headers # => { ... }
|
137
|
-
p data # => <
|
137
|
+
p data # => <ErrorContainer>
|
138
138
|
rescue OryHydraClient::ApiError => e
|
139
|
-
puts "Error when calling PublicApi->
|
139
|
+
puts "Error when calling PublicApi->get_self_service_error_with_http_info: #{e}"
|
140
140
|
end
|
141
141
|
```
|
142
142
|
|
@@ -144,12 +144,11 @@ end
|
|
144
144
|
|
145
145
|
| Name | Type | Description | Notes |
|
146
146
|
| ---- | ---- | ----------- | ----- |
|
147
|
-
| **
|
148
|
-
| **body** | [**CompleteSelfServiceLoginFlowWithPasswordMethod**](CompleteSelfServiceLoginFlowWithPasswordMethod.md) | | [optional] |
|
147
|
+
| **error** | **String** | Error is the container's ID | |
|
149
148
|
|
150
149
|
### Return type
|
151
150
|
|
152
|
-
[**
|
151
|
+
[**ErrorContainer**](ErrorContainer.md)
|
153
152
|
|
154
153
|
### Authorization
|
155
154
|
|
@@ -157,17 +156,17 @@ No authorization required
|
|
157
156
|
|
158
157
|
### HTTP request headers
|
159
158
|
|
160
|
-
- **Content-Type**:
|
159
|
+
- **Content-Type**: Not defined
|
161
160
|
- **Accept**: application/json
|
162
161
|
|
163
162
|
|
164
|
-
##
|
163
|
+
## get_self_service_login_flow
|
165
164
|
|
166
|
-
>
|
165
|
+
> <LoginFlow> get_self_service_login_flow(id)
|
167
166
|
|
168
|
-
|
167
|
+
Get Login Flow
|
169
168
|
|
170
|
-
|
169
|
+
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).
|
171
170
|
|
172
171
|
### Examples
|
173
172
|
|
@@ -176,35 +175,32 @@ require 'time'
|
|
176
175
|
require 'ory-kratos-client'
|
177
176
|
|
178
177
|
api_instance = OryHydraClient::PublicApi.new
|
179
|
-
|
180
|
-
token: 'token_example', # String | 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.
|
181
|
-
flow: 'flow_example', # String | The Flow ID format: uuid
|
182
|
-
body: OryHydraClient::CompleteSelfServiceRecoveryFlowWithLinkMethod.new # CompleteSelfServiceRecoveryFlowWithLinkMethod |
|
183
|
-
}
|
178
|
+
id = 'id_example' # 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`).
|
184
179
|
|
185
180
|
begin
|
186
|
-
#
|
187
|
-
api_instance.
|
181
|
+
# Get Login Flow
|
182
|
+
result = api_instance.get_self_service_login_flow(id)
|
183
|
+
p result
|
188
184
|
rescue OryHydraClient::ApiError => e
|
189
|
-
puts "Error when calling PublicApi->
|
185
|
+
puts "Error when calling PublicApi->get_self_service_login_flow: #{e}"
|
190
186
|
end
|
191
187
|
```
|
192
188
|
|
193
|
-
#### Using the
|
189
|
+
#### Using the get_self_service_login_flow_with_http_info variant
|
194
190
|
|
195
|
-
This returns an Array which contains the response data
|
191
|
+
This returns an Array which contains the response data, status code and headers.
|
196
192
|
|
197
|
-
> <Array(
|
193
|
+
> <Array(<LoginFlow>, Integer, Hash)> get_self_service_login_flow_with_http_info(id)
|
198
194
|
|
199
195
|
```ruby
|
200
196
|
begin
|
201
|
-
#
|
202
|
-
data, status_code, headers = api_instance.
|
197
|
+
# Get Login Flow
|
198
|
+
data, status_code, headers = api_instance.get_self_service_login_flow_with_http_info(id)
|
203
199
|
p status_code # => 2xx
|
204
200
|
p headers # => { ... }
|
205
|
-
p data # =>
|
201
|
+
p data # => <LoginFlow>
|
206
202
|
rescue OryHydraClient::ApiError => e
|
207
|
-
puts "Error when calling PublicApi->
|
203
|
+
puts "Error when calling PublicApi->get_self_service_login_flow_with_http_info: #{e}"
|
208
204
|
end
|
209
205
|
```
|
210
206
|
|
@@ -212,13 +208,11 @@ end
|
|
212
208
|
|
213
209
|
| Name | Type | Description | Notes |
|
214
210
|
| ---- | ---- | ----------- | ----- |
|
215
|
-
| **
|
216
|
-
| **flow** | **String** | The Flow ID format: uuid | [optional] |
|
217
|
-
| **body** | [**CompleteSelfServiceRecoveryFlowWithLinkMethod**](CompleteSelfServiceRecoveryFlowWithLinkMethod.md) | | [optional] |
|
211
|
+
| **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`). | |
|
218
212
|
|
219
213
|
### Return type
|
220
214
|
|
221
|
-
|
215
|
+
[**LoginFlow**](LoginFlow.md)
|
222
216
|
|
223
217
|
### Authorization
|
224
218
|
|
@@ -226,17 +220,17 @@ No authorization required
|
|
226
220
|
|
227
221
|
### HTTP request headers
|
228
222
|
|
229
|
-
- **Content-Type**:
|
223
|
+
- **Content-Type**: Not defined
|
230
224
|
- **Accept**: application/json
|
231
225
|
|
232
226
|
|
233
|
-
##
|
227
|
+
## get_self_service_recovery_flow
|
234
228
|
|
235
|
-
> <
|
229
|
+
> <RecoveryFlow> get_self_service_recovery_flow(id)
|
236
230
|
|
237
|
-
|
231
|
+
Get information about a recovery flow
|
238
232
|
|
239
|
-
|
233
|
+
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).
|
240
234
|
|
241
235
|
### Examples
|
242
236
|
|
@@ -245,35 +239,32 @@ require 'time'
|
|
245
239
|
require 'ory-kratos-client'
|
246
240
|
|
247
241
|
api_instance = OryHydraClient::PublicApi.new
|
248
|
-
|
249
|
-
flow: 'flow_example', # String | Flow is flow ID.
|
250
|
-
payload: Object # Object |
|
251
|
-
}
|
242
|
+
id = 'id_example' # String | The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`).
|
252
243
|
|
253
244
|
begin
|
254
|
-
#
|
255
|
-
result = api_instance.
|
245
|
+
# Get information about a recovery flow
|
246
|
+
result = api_instance.get_self_service_recovery_flow(id)
|
256
247
|
p result
|
257
248
|
rescue OryHydraClient::ApiError => e
|
258
|
-
puts "Error when calling PublicApi->
|
249
|
+
puts "Error when calling PublicApi->get_self_service_recovery_flow: #{e}"
|
259
250
|
end
|
260
251
|
```
|
261
252
|
|
262
|
-
#### Using the
|
253
|
+
#### Using the get_self_service_recovery_flow_with_http_info variant
|
263
254
|
|
264
255
|
This returns an Array which contains the response data, status code and headers.
|
265
256
|
|
266
|
-
> <Array(<
|
257
|
+
> <Array(<RecoveryFlow>, Integer, Hash)> get_self_service_recovery_flow_with_http_info(id)
|
267
258
|
|
268
259
|
```ruby
|
269
260
|
begin
|
270
|
-
#
|
271
|
-
data, status_code, headers = api_instance.
|
261
|
+
# Get information about a recovery flow
|
262
|
+
data, status_code, headers = api_instance.get_self_service_recovery_flow_with_http_info(id)
|
272
263
|
p status_code # => 2xx
|
273
264
|
p headers # => { ... }
|
274
|
-
p data # => <
|
265
|
+
p data # => <RecoveryFlow>
|
275
266
|
rescue OryHydraClient::ApiError => e
|
276
|
-
puts "Error when calling PublicApi->
|
267
|
+
puts "Error when calling PublicApi->get_self_service_recovery_flow_with_http_info: #{e}"
|
277
268
|
end
|
278
269
|
```
|
279
270
|
|
@@ -281,12 +272,11 @@ end
|
|
281
272
|
|
282
273
|
| Name | Type | Description | Notes |
|
283
274
|
| ---- | ---- | ----------- | ----- |
|
284
|
-
| **
|
285
|
-
| **payload** | **Object** | | [optional] |
|
275
|
+
| **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`). | |
|
286
276
|
|
287
277
|
### Return type
|
288
278
|
|
289
|
-
[**
|
279
|
+
[**RecoveryFlow**](RecoveryFlow.md)
|
290
280
|
|
291
281
|
### Authorization
|
292
282
|
|
@@ -294,61 +284,51 @@ No authorization required
|
|
294
284
|
|
295
285
|
### HTTP request headers
|
296
286
|
|
297
|
-
- **Content-Type**:
|
287
|
+
- **Content-Type**: Not defined
|
298
288
|
- **Accept**: application/json
|
299
289
|
|
300
290
|
|
301
|
-
##
|
291
|
+
## get_self_service_registration_flow
|
302
292
|
|
303
|
-
> <
|
293
|
+
> <RegistrationFlow> get_self_service_registration_flow(id)
|
304
294
|
|
305
|
-
|
295
|
+
Get Registration Flow
|
306
296
|
|
307
|
-
|
297
|
+
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).
|
308
298
|
|
309
299
|
### Examples
|
310
300
|
|
311
301
|
```ruby
|
312
302
|
require 'time'
|
313
303
|
require 'ory-kratos-client'
|
314
|
-
# setup authorization
|
315
|
-
OryHydraClient.configure do |config|
|
316
|
-
# Configure API key authorization: sessionToken
|
317
|
-
config.api_key['X-Session-Token'] = 'YOUR API KEY'
|
318
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
319
|
-
# config.api_key_prefix['X-Session-Token'] = 'Bearer'
|
320
|
-
end
|
321
304
|
|
322
305
|
api_instance = OryHydraClient::PublicApi.new
|
323
|
-
|
324
|
-
flow: 'flow_example', # String | Flow is flow ID.
|
325
|
-
body: OryHydraClient::CompleteSelfServiceSettingsFlowWithPasswordMethod.new({password: 'password_example'}) # CompleteSelfServiceSettingsFlowWithPasswordMethod |
|
326
|
-
}
|
306
|
+
id = 'id_example' # 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`).
|
327
307
|
|
328
308
|
begin
|
329
|
-
#
|
330
|
-
result = api_instance.
|
309
|
+
# Get Registration Flow
|
310
|
+
result = api_instance.get_self_service_registration_flow(id)
|
331
311
|
p result
|
332
312
|
rescue OryHydraClient::ApiError => e
|
333
|
-
puts "Error when calling PublicApi->
|
313
|
+
puts "Error when calling PublicApi->get_self_service_registration_flow: #{e}"
|
334
314
|
end
|
335
315
|
```
|
336
316
|
|
337
|
-
#### Using the
|
317
|
+
#### Using the get_self_service_registration_flow_with_http_info variant
|
338
318
|
|
339
319
|
This returns an Array which contains the response data, status code and headers.
|
340
320
|
|
341
|
-
> <Array(<
|
321
|
+
> <Array(<RegistrationFlow>, Integer, Hash)> get_self_service_registration_flow_with_http_info(id)
|
342
322
|
|
343
323
|
```ruby
|
344
324
|
begin
|
345
|
-
#
|
346
|
-
data, status_code, headers = api_instance.
|
325
|
+
# Get Registration Flow
|
326
|
+
data, status_code, headers = api_instance.get_self_service_registration_flow_with_http_info(id)
|
347
327
|
p status_code # => 2xx
|
348
328
|
p headers # => { ... }
|
349
|
-
p data # => <
|
329
|
+
p data # => <RegistrationFlow>
|
350
330
|
rescue OryHydraClient::ApiError => e
|
351
|
-
puts "Error when calling PublicApi->
|
331
|
+
puts "Error when calling PublicApi->get_self_service_registration_flow_with_http_info: #{e}"
|
352
332
|
end
|
353
333
|
```
|
354
334
|
|
@@ -356,30 +336,29 @@ end
|
|
356
336
|
|
357
337
|
| Name | Type | Description | Notes |
|
358
338
|
| ---- | ---- | ----------- | ----- |
|
359
|
-
| **
|
360
|
-
| **body** | [**CompleteSelfServiceSettingsFlowWithPasswordMethod**](CompleteSelfServiceSettingsFlowWithPasswordMethod.md) | | [optional] |
|
339
|
+
| **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`). | |
|
361
340
|
|
362
341
|
### Return type
|
363
342
|
|
364
|
-
[**
|
343
|
+
[**RegistrationFlow**](RegistrationFlow.md)
|
365
344
|
|
366
345
|
### Authorization
|
367
346
|
|
368
|
-
|
347
|
+
No authorization required
|
369
348
|
|
370
349
|
### HTTP request headers
|
371
350
|
|
372
|
-
- **Content-Type**:
|
351
|
+
- **Content-Type**: Not defined
|
373
352
|
- **Accept**: application/json
|
374
353
|
|
375
354
|
|
376
|
-
##
|
355
|
+
## get_self_service_settings_flow
|
377
356
|
|
378
|
-
> <SettingsFlow>
|
357
|
+
> <SettingsFlow> get_self_service_settings_flow(id)
|
379
358
|
|
380
|
-
|
359
|
+
Get Settings Flow
|
381
360
|
|
382
|
-
|
361
|
+
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).
|
383
362
|
|
384
363
|
### Examples
|
385
364
|
|
@@ -389,41 +368,38 @@ require 'ory-kratos-client'
|
|
389
368
|
# setup authorization
|
390
369
|
OryHydraClient.configure do |config|
|
391
370
|
# Configure API key authorization: sessionToken
|
392
|
-
config.api_key['
|
371
|
+
config.api_key['sessionToken'] = 'YOUR API KEY'
|
393
372
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
394
|
-
# config.api_key_prefix['
|
373
|
+
# config.api_key_prefix['sessionToken'] = 'Bearer'
|
395
374
|
end
|
396
375
|
|
397
376
|
api_instance = OryHydraClient::PublicApi.new
|
398
|
-
|
399
|
-
flow: 'flow_example', # String | Flow is flow ID.
|
400
|
-
payload: Object # Object |
|
401
|
-
}
|
377
|
+
id = 'id_example' # 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`).
|
402
378
|
|
403
379
|
begin
|
404
|
-
#
|
405
|
-
result = api_instance.
|
380
|
+
# Get Settings Flow
|
381
|
+
result = api_instance.get_self_service_settings_flow(id)
|
406
382
|
p result
|
407
383
|
rescue OryHydraClient::ApiError => e
|
408
|
-
puts "Error when calling PublicApi->
|
384
|
+
puts "Error when calling PublicApi->get_self_service_settings_flow: #{e}"
|
409
385
|
end
|
410
386
|
```
|
411
387
|
|
412
|
-
#### Using the
|
388
|
+
#### Using the get_self_service_settings_flow_with_http_info variant
|
413
389
|
|
414
390
|
This returns an Array which contains the response data, status code and headers.
|
415
391
|
|
416
|
-
> <Array(<SettingsFlow>, Integer, Hash)>
|
392
|
+
> <Array(<SettingsFlow>, Integer, Hash)> get_self_service_settings_flow_with_http_info(id)
|
417
393
|
|
418
394
|
```ruby
|
419
395
|
begin
|
420
|
-
#
|
421
|
-
data, status_code, headers = api_instance.
|
396
|
+
# Get Settings Flow
|
397
|
+
data, status_code, headers = api_instance.get_self_service_settings_flow_with_http_info(id)
|
422
398
|
p status_code # => 2xx
|
423
399
|
p headers # => { ... }
|
424
400
|
p data # => <SettingsFlow>
|
425
401
|
rescue OryHydraClient::ApiError => e
|
426
|
-
puts "Error when calling PublicApi->
|
402
|
+
puts "Error when calling PublicApi->get_self_service_settings_flow_with_http_info: #{e}"
|
427
403
|
end
|
428
404
|
```
|
429
405
|
|
@@ -431,8 +407,7 @@ end
|
|
431
407
|
|
432
408
|
| Name | Type | Description | Notes |
|
433
409
|
| ---- | ---- | ----------- | ----- |
|
434
|
-
| **
|
435
|
-
| **payload** | **Object** | | [optional] |
|
410
|
+
| **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`). | |
|
436
411
|
|
437
412
|
### Return type
|
438
413
|
|
@@ -444,86 +419,17 @@ end
|
|
444
419
|
|
445
420
|
### HTTP request headers
|
446
421
|
|
447
|
-
- **Content-Type**:
|
448
|
-
- **Accept**: application/json
|
449
|
-
|
450
|
-
|
451
|
-
## complete_self_service_verification_flow_with_link_method
|
452
|
-
|
453
|
-
> complete_self_service_verification_flow_with_link_method(opts)
|
454
|
-
|
455
|
-
Complete Verification Flow with Link Method
|
456
|
-
|
457
|
-
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).
|
458
|
-
|
459
|
-
### Examples
|
460
|
-
|
461
|
-
```ruby
|
462
|
-
require 'time'
|
463
|
-
require 'ory-kratos-client'
|
464
|
-
|
465
|
-
api_instance = OryHydraClient::PublicApi.new
|
466
|
-
opts = {
|
467
|
-
token: 'token_example', # String | 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.
|
468
|
-
flow: 'flow_example', # String | The Flow ID format: uuid
|
469
|
-
body: OryHydraClient::CompleteSelfServiceVerificationFlowWithLinkMethod.new # CompleteSelfServiceVerificationFlowWithLinkMethod |
|
470
|
-
}
|
471
|
-
|
472
|
-
begin
|
473
|
-
# Complete Verification Flow with Link Method
|
474
|
-
api_instance.complete_self_service_verification_flow_with_link_method(opts)
|
475
|
-
rescue OryHydraClient::ApiError => e
|
476
|
-
puts "Error when calling PublicApi->complete_self_service_verification_flow_with_link_method: #{e}"
|
477
|
-
end
|
478
|
-
```
|
479
|
-
|
480
|
-
#### Using the complete_self_service_verification_flow_with_link_method_with_http_info variant
|
481
|
-
|
482
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
483
|
-
|
484
|
-
> <Array(nil, Integer, Hash)> complete_self_service_verification_flow_with_link_method_with_http_info(opts)
|
485
|
-
|
486
|
-
```ruby
|
487
|
-
begin
|
488
|
-
# Complete Verification Flow with Link Method
|
489
|
-
data, status_code, headers = api_instance.complete_self_service_verification_flow_with_link_method_with_http_info(opts)
|
490
|
-
p status_code # => 2xx
|
491
|
-
p headers # => { ... }
|
492
|
-
p data # => nil
|
493
|
-
rescue OryHydraClient::ApiError => e
|
494
|
-
puts "Error when calling PublicApi->complete_self_service_verification_flow_with_link_method_with_http_info: #{e}"
|
495
|
-
end
|
496
|
-
```
|
497
|
-
|
498
|
-
### Parameters
|
499
|
-
|
500
|
-
| Name | Type | Description | Notes |
|
501
|
-
| ---- | ---- | ----------- | ----- |
|
502
|
-
| **token** | **String** | 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. | [optional] |
|
503
|
-
| **flow** | **String** | The Flow ID format: uuid | [optional] |
|
504
|
-
| **body** | [**CompleteSelfServiceVerificationFlowWithLinkMethod**](CompleteSelfServiceVerificationFlowWithLinkMethod.md) | | [optional] |
|
505
|
-
|
506
|
-
### Return type
|
507
|
-
|
508
|
-
nil (empty response body)
|
509
|
-
|
510
|
-
### Authorization
|
511
|
-
|
512
|
-
No authorization required
|
513
|
-
|
514
|
-
### HTTP request headers
|
515
|
-
|
516
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded
|
422
|
+
- **Content-Type**: Not defined
|
517
423
|
- **Accept**: application/json
|
518
424
|
|
519
425
|
|
520
|
-
##
|
521
|
-
|
522
|
-
> Object get_schema(id)
|
426
|
+
## get_self_service_verification_flow
|
523
427
|
|
428
|
+
> <VerificationFlow> get_self_service_verification_flow(id)
|
524
429
|
|
430
|
+
Get Verification Flow
|
525
431
|
|
526
|
-
|
432
|
+
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).
|
527
433
|
|
528
434
|
### Examples
|
529
435
|
|
@@ -532,32 +438,32 @@ require 'time'
|
|
532
438
|
require 'ory-kratos-client'
|
533
439
|
|
534
440
|
api_instance = OryHydraClient::PublicApi.new
|
535
|
-
id = 'id_example' # String | ID
|
441
|
+
id = 'id_example' # String | The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`).
|
536
442
|
|
537
443
|
begin
|
538
|
-
|
539
|
-
result = api_instance.
|
444
|
+
# Get Verification Flow
|
445
|
+
result = api_instance.get_self_service_verification_flow(id)
|
540
446
|
p result
|
541
447
|
rescue OryHydraClient::ApiError => e
|
542
|
-
puts "Error when calling PublicApi->
|
448
|
+
puts "Error when calling PublicApi->get_self_service_verification_flow: #{e}"
|
543
449
|
end
|
544
450
|
```
|
545
451
|
|
546
|
-
#### Using the
|
452
|
+
#### Using the get_self_service_verification_flow_with_http_info variant
|
547
453
|
|
548
454
|
This returns an Array which contains the response data, status code and headers.
|
549
455
|
|
550
|
-
> <Array(
|
456
|
+
> <Array(<VerificationFlow>, Integer, Hash)> get_self_service_verification_flow_with_http_info(id)
|
551
457
|
|
552
458
|
```ruby
|
553
459
|
begin
|
554
|
-
|
555
|
-
data, status_code, headers = api_instance.
|
460
|
+
# Get Verification Flow
|
461
|
+
data, status_code, headers = api_instance.get_self_service_verification_flow_with_http_info(id)
|
556
462
|
p status_code # => 2xx
|
557
463
|
p headers # => { ... }
|
558
|
-
p data # =>
|
464
|
+
p data # => <VerificationFlow>
|
559
465
|
rescue OryHydraClient::ApiError => e
|
560
|
-
puts "Error when calling PublicApi->
|
466
|
+
puts "Error when calling PublicApi->get_self_service_verification_flow_with_http_info: #{e}"
|
561
467
|
end
|
562
468
|
```
|
563
469
|
|
@@ -565,11 +471,11 @@ end
|
|
565
471
|
|
566
472
|
| Name | Type | Description | Notes |
|
567
473
|
| ---- | ---- | ----------- | ----- |
|
568
|
-
| **id** | **String** | ID
|
474
|
+
| **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`). | |
|
569
475
|
|
570
476
|
### Return type
|
571
477
|
|
572
|
-
**
|
478
|
+
[**VerificationFlow**](VerificationFlow.md)
|
573
479
|
|
574
480
|
### Authorization
|
575
481
|
|
@@ -581,13 +487,13 @@ No authorization required
|
|
581
487
|
- **Accept**: application/json
|
582
488
|
|
583
489
|
|
584
|
-
##
|
490
|
+
## initialize_self_service_browser_logout_flow
|
585
491
|
|
586
|
-
>
|
492
|
+
> initialize_self_service_browser_logout_flow
|
587
493
|
|
588
|
-
|
494
|
+
Initialize Browser-Based Logout User Flow
|
589
495
|
|
590
|
-
This endpoint
|
496
|
+
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).
|
591
497
|
|
592
498
|
### Examples
|
593
499
|
|
@@ -596,44 +502,40 @@ require 'time'
|
|
596
502
|
require 'ory-kratos-client'
|
597
503
|
|
598
504
|
api_instance = OryHydraClient::PublicApi.new
|
599
|
-
error = 'error_example' # String | Error is the container's ID
|
600
505
|
|
601
506
|
begin
|
602
|
-
#
|
603
|
-
|
604
|
-
p result
|
507
|
+
# Initialize Browser-Based Logout User Flow
|
508
|
+
api_instance.initialize_self_service_browser_logout_flow
|
605
509
|
rescue OryHydraClient::ApiError => e
|
606
|
-
puts "Error when calling PublicApi->
|
510
|
+
puts "Error when calling PublicApi->initialize_self_service_browser_logout_flow: #{e}"
|
607
511
|
end
|
608
512
|
```
|
609
513
|
|
610
|
-
#### Using the
|
514
|
+
#### Using the initialize_self_service_browser_logout_flow_with_http_info variant
|
611
515
|
|
612
|
-
This returns an Array which contains the response data, status code and headers.
|
516
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
613
517
|
|
614
|
-
> <Array(
|
518
|
+
> <Array(nil, Integer, Hash)> initialize_self_service_browser_logout_flow_with_http_info
|
615
519
|
|
616
520
|
```ruby
|
617
521
|
begin
|
618
|
-
#
|
619
|
-
data, status_code, headers = api_instance.
|
522
|
+
# Initialize Browser-Based Logout User Flow
|
523
|
+
data, status_code, headers = api_instance.initialize_self_service_browser_logout_flow_with_http_info
|
620
524
|
p status_code # => 2xx
|
621
525
|
p headers # => { ... }
|
622
|
-
p data # =>
|
526
|
+
p data # => nil
|
623
527
|
rescue OryHydraClient::ApiError => e
|
624
|
-
puts "Error when calling PublicApi->
|
528
|
+
puts "Error when calling PublicApi->initialize_self_service_browser_logout_flow_with_http_info: #{e}"
|
625
529
|
end
|
626
530
|
```
|
627
531
|
|
628
532
|
### Parameters
|
629
533
|
|
630
|
-
|
631
|
-
| ---- | ---- | ----------- | ----- |
|
632
|
-
| **error** | **String** | Error is the container's ID | |
|
534
|
+
This endpoint does not need any parameter.
|
633
535
|
|
634
536
|
### Return type
|
635
537
|
|
636
|
-
|
538
|
+
nil (empty response body)
|
637
539
|
|
638
540
|
### Authorization
|
639
541
|
|
@@ -645,13 +547,13 @@ No authorization required
|
|
645
547
|
- **Accept**: application/json
|
646
548
|
|
647
549
|
|
648
|
-
##
|
550
|
+
## initialize_self_service_login_via_api_flow
|
649
551
|
|
650
|
-
> <LoginFlow>
|
552
|
+
> <LoginFlow> initialize_self_service_login_via_api_flow(opts)
|
651
553
|
|
652
|
-
|
554
|
+
Initialize Login Flow for API clients
|
653
555
|
|
654
|
-
This endpoint
|
556
|
+
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).
|
655
557
|
|
656
558
|
### Examples
|
657
559
|
|
@@ -660,32 +562,34 @@ require 'time'
|
|
660
562
|
require 'ory-kratos-client'
|
661
563
|
|
662
564
|
api_instance = OryHydraClient::PublicApi.new
|
663
|
-
|
565
|
+
opts = {
|
566
|
+
refresh: true # Boolean | 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.
|
567
|
+
}
|
664
568
|
|
665
569
|
begin
|
666
|
-
#
|
667
|
-
result = api_instance.
|
570
|
+
# Initialize Login Flow for API clients
|
571
|
+
result = api_instance.initialize_self_service_login_via_api_flow(opts)
|
668
572
|
p result
|
669
573
|
rescue OryHydraClient::ApiError => e
|
670
|
-
puts "Error when calling PublicApi->
|
574
|
+
puts "Error when calling PublicApi->initialize_self_service_login_via_api_flow: #{e}"
|
671
575
|
end
|
672
576
|
```
|
673
577
|
|
674
|
-
#### Using the
|
578
|
+
#### Using the initialize_self_service_login_via_api_flow_with_http_info variant
|
675
579
|
|
676
580
|
This returns an Array which contains the response data, status code and headers.
|
677
581
|
|
678
|
-
> <Array(<LoginFlow>, Integer, Hash)>
|
582
|
+
> <Array(<LoginFlow>, Integer, Hash)> initialize_self_service_login_via_api_flow_with_http_info(opts)
|
679
583
|
|
680
584
|
```ruby
|
681
585
|
begin
|
682
|
-
#
|
683
|
-
data, status_code, headers = api_instance.
|
586
|
+
# Initialize Login Flow for API clients
|
587
|
+
data, status_code, headers = api_instance.initialize_self_service_login_via_api_flow_with_http_info(opts)
|
684
588
|
p status_code # => 2xx
|
685
589
|
p headers # => { ... }
|
686
590
|
p data # => <LoginFlow>
|
687
591
|
rescue OryHydraClient::ApiError => e
|
688
|
-
puts "Error when calling PublicApi->
|
592
|
+
puts "Error when calling PublicApi->initialize_self_service_login_via_api_flow_with_http_info: #{e}"
|
689
593
|
end
|
690
594
|
```
|
691
595
|
|
@@ -693,7 +597,7 @@ end
|
|
693
597
|
|
694
598
|
| Name | Type | Description | Notes |
|
695
599
|
| ---- | ---- | ----------- | ----- |
|
696
|
-
| **
|
600
|
+
| **refresh** | **Boolean** | 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. | [optional] |
|
697
601
|
|
698
602
|
### Return type
|
699
603
|
|
@@ -709,13 +613,13 @@ No authorization required
|
|
709
613
|
- **Accept**: application/json
|
710
614
|
|
711
615
|
|
712
|
-
##
|
616
|
+
## initialize_self_service_login_via_browser_flow
|
713
617
|
|
714
|
-
>
|
618
|
+
> initialize_self_service_login_via_browser_flow
|
715
619
|
|
716
|
-
|
620
|
+
Initialize Login Flow for browsers
|
717
621
|
|
718
|
-
This endpoint
|
622
|
+
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).
|
719
623
|
|
720
624
|
### Examples
|
721
625
|
|
@@ -724,44 +628,40 @@ require 'time'
|
|
724
628
|
require 'ory-kratos-client'
|
725
629
|
|
726
630
|
api_instance = OryHydraClient::PublicApi.new
|
727
|
-
id = 'id_example' # String | The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`).
|
728
631
|
|
729
632
|
begin
|
730
|
-
#
|
731
|
-
|
732
|
-
p result
|
633
|
+
# Initialize Login Flow for browsers
|
634
|
+
api_instance.initialize_self_service_login_via_browser_flow
|
733
635
|
rescue OryHydraClient::ApiError => e
|
734
|
-
puts "Error when calling PublicApi->
|
636
|
+
puts "Error when calling PublicApi->initialize_self_service_login_via_browser_flow: #{e}"
|
735
637
|
end
|
736
638
|
```
|
737
639
|
|
738
|
-
#### Using the
|
640
|
+
#### Using the initialize_self_service_login_via_browser_flow_with_http_info variant
|
739
641
|
|
740
|
-
This returns an Array which contains the response data, status code and headers.
|
642
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
741
643
|
|
742
|
-
> <Array(
|
644
|
+
> <Array(nil, Integer, Hash)> initialize_self_service_login_via_browser_flow_with_http_info
|
743
645
|
|
744
646
|
```ruby
|
745
647
|
begin
|
746
|
-
#
|
747
|
-
data, status_code, headers = api_instance.
|
648
|
+
# Initialize Login Flow for browsers
|
649
|
+
data, status_code, headers = api_instance.initialize_self_service_login_via_browser_flow_with_http_info
|
748
650
|
p status_code # => 2xx
|
749
651
|
p headers # => { ... }
|
750
|
-
p data # =>
|
652
|
+
p data # => nil
|
751
653
|
rescue OryHydraClient::ApiError => e
|
752
|
-
puts "Error when calling PublicApi->
|
654
|
+
puts "Error when calling PublicApi->initialize_self_service_login_via_browser_flow_with_http_info: #{e}"
|
753
655
|
end
|
754
656
|
```
|
755
657
|
|
756
658
|
### Parameters
|
757
659
|
|
758
|
-
|
759
|
-
| ---- | ---- | ----------- | ----- |
|
760
|
-
| **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`). | |
|
660
|
+
This endpoint does not need any parameter.
|
761
661
|
|
762
662
|
### Return type
|
763
663
|
|
764
|
-
|
664
|
+
nil (empty response body)
|
765
665
|
|
766
666
|
### Authorization
|
767
667
|
|
@@ -773,13 +673,13 @@ No authorization required
|
|
773
673
|
- **Accept**: application/json
|
774
674
|
|
775
675
|
|
776
|
-
##
|
676
|
+
## initialize_self_service_recovery_via_api_flow
|
777
677
|
|
778
|
-
> <
|
678
|
+
> <RecoveryFlow> initialize_self_service_recovery_via_api_flow
|
779
679
|
|
780
|
-
|
680
|
+
Initialize Recovery Flow for API Clients
|
781
681
|
|
782
|
-
This endpoint
|
682
|
+
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).
|
783
683
|
|
784
684
|
### Examples
|
785
685
|
|
@@ -788,44 +688,41 @@ require 'time'
|
|
788
688
|
require 'ory-kratos-client'
|
789
689
|
|
790
690
|
api_instance = OryHydraClient::PublicApi.new
|
791
|
-
id = 'id_example' # 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`).
|
792
691
|
|
793
692
|
begin
|
794
|
-
#
|
795
|
-
result = api_instance.
|
693
|
+
# Initialize Recovery Flow for API Clients
|
694
|
+
result = api_instance.initialize_self_service_recovery_via_api_flow
|
796
695
|
p result
|
797
696
|
rescue OryHydraClient::ApiError => e
|
798
|
-
puts "Error when calling PublicApi->
|
697
|
+
puts "Error when calling PublicApi->initialize_self_service_recovery_via_api_flow: #{e}"
|
799
698
|
end
|
800
699
|
```
|
801
700
|
|
802
|
-
#### Using the
|
701
|
+
#### Using the initialize_self_service_recovery_via_api_flow_with_http_info variant
|
803
702
|
|
804
703
|
This returns an Array which contains the response data, status code and headers.
|
805
704
|
|
806
|
-
> <Array(<
|
705
|
+
> <Array(<RecoveryFlow>, Integer, Hash)> initialize_self_service_recovery_via_api_flow_with_http_info
|
807
706
|
|
808
707
|
```ruby
|
809
708
|
begin
|
810
|
-
#
|
811
|
-
data, status_code, headers = api_instance.
|
709
|
+
# Initialize Recovery Flow for API Clients
|
710
|
+
data, status_code, headers = api_instance.initialize_self_service_recovery_via_api_flow_with_http_info
|
812
711
|
p status_code # => 2xx
|
813
712
|
p headers # => { ... }
|
814
|
-
p data # => <
|
713
|
+
p data # => <RecoveryFlow>
|
815
714
|
rescue OryHydraClient::ApiError => e
|
816
|
-
puts "Error when calling PublicApi->
|
715
|
+
puts "Error when calling PublicApi->initialize_self_service_recovery_via_api_flow_with_http_info: #{e}"
|
817
716
|
end
|
818
717
|
```
|
819
718
|
|
820
719
|
### Parameters
|
821
720
|
|
822
|
-
|
823
|
-
| ---- | ---- | ----------- | ----- |
|
824
|
-
| **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`). | |
|
721
|
+
This endpoint does not need any parameter.
|
825
722
|
|
826
723
|
### Return type
|
827
724
|
|
828
|
-
[**
|
725
|
+
[**RecoveryFlow**](RecoveryFlow.md)
|
829
726
|
|
830
727
|
### Authorization
|
831
728
|
|
@@ -837,70 +734,59 @@ No authorization required
|
|
837
734
|
- **Accept**: application/json
|
838
735
|
|
839
736
|
|
840
|
-
##
|
737
|
+
## initialize_self_service_recovery_via_browser_flow
|
841
738
|
|
842
|
-
>
|
739
|
+
> initialize_self_service_recovery_via_browser_flow
|
843
740
|
|
844
|
-
|
741
|
+
Initialize Recovery Flow for Browser Clients
|
845
742
|
|
846
|
-
|
743
|
+
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).
|
847
744
|
|
848
745
|
### Examples
|
849
746
|
|
850
747
|
```ruby
|
851
748
|
require 'time'
|
852
749
|
require 'ory-kratos-client'
|
853
|
-
# setup authorization
|
854
|
-
OryHydraClient.configure do |config|
|
855
|
-
# Configure API key authorization: sessionToken
|
856
|
-
config.api_key['X-Session-Token'] = 'YOUR API KEY'
|
857
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
858
|
-
# config.api_key_prefix['X-Session-Token'] = 'Bearer'
|
859
|
-
end
|
860
750
|
|
861
751
|
api_instance = OryHydraClient::PublicApi.new
|
862
|
-
id = 'id_example' # 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`).
|
863
752
|
|
864
753
|
begin
|
865
|
-
#
|
866
|
-
|
867
|
-
p result
|
754
|
+
# Initialize Recovery Flow for Browser Clients
|
755
|
+
api_instance.initialize_self_service_recovery_via_browser_flow
|
868
756
|
rescue OryHydraClient::ApiError => e
|
869
|
-
puts "Error when calling PublicApi->
|
757
|
+
puts "Error when calling PublicApi->initialize_self_service_recovery_via_browser_flow: #{e}"
|
870
758
|
end
|
871
759
|
```
|
872
760
|
|
873
|
-
#### Using the
|
761
|
+
#### Using the initialize_self_service_recovery_via_browser_flow_with_http_info variant
|
874
762
|
|
875
|
-
This returns an Array which contains the response data, status code and headers.
|
763
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
876
764
|
|
877
|
-
> <Array(
|
765
|
+
> <Array(nil, Integer, Hash)> initialize_self_service_recovery_via_browser_flow_with_http_info
|
878
766
|
|
879
767
|
```ruby
|
880
768
|
begin
|
881
|
-
#
|
882
|
-
data, status_code, headers = api_instance.
|
769
|
+
# Initialize Recovery Flow for Browser Clients
|
770
|
+
data, status_code, headers = api_instance.initialize_self_service_recovery_via_browser_flow_with_http_info
|
883
771
|
p status_code # => 2xx
|
884
772
|
p headers # => { ... }
|
885
|
-
p data # =>
|
773
|
+
p data # => nil
|
886
774
|
rescue OryHydraClient::ApiError => e
|
887
|
-
puts "Error when calling PublicApi->
|
775
|
+
puts "Error when calling PublicApi->initialize_self_service_recovery_via_browser_flow_with_http_info: #{e}"
|
888
776
|
end
|
889
777
|
```
|
890
778
|
|
891
779
|
### Parameters
|
892
780
|
|
893
|
-
|
894
|
-
| ---- | ---- | ----------- | ----- |
|
895
|
-
| **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`). | |
|
781
|
+
This endpoint does not need any parameter.
|
896
782
|
|
897
783
|
### Return type
|
898
784
|
|
899
|
-
|
785
|
+
nil (empty response body)
|
900
786
|
|
901
787
|
### Authorization
|
902
788
|
|
903
|
-
|
789
|
+
No authorization required
|
904
790
|
|
905
791
|
### HTTP request headers
|
906
792
|
|
@@ -908,13 +794,13 @@ end
|
|
908
794
|
- **Accept**: application/json
|
909
795
|
|
910
796
|
|
911
|
-
##
|
797
|
+
## initialize_self_service_registration_via_api_flow
|
912
798
|
|
913
|
-
> <
|
799
|
+
> <RegistrationFlow> initialize_self_service_registration_via_api_flow
|
914
800
|
|
915
|
-
|
801
|
+
Initialize Registration Flow for API clients
|
916
802
|
|
917
|
-
This endpoint
|
803
|
+
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).
|
918
804
|
|
919
805
|
### Examples
|
920
806
|
|
@@ -923,44 +809,41 @@ require 'time'
|
|
923
809
|
require 'ory-kratos-client'
|
924
810
|
|
925
811
|
api_instance = OryHydraClient::PublicApi.new
|
926
|
-
id = 'id_example' # String | The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`).
|
927
812
|
|
928
813
|
begin
|
929
|
-
#
|
930
|
-
result = api_instance.
|
814
|
+
# Initialize Registration Flow for API clients
|
815
|
+
result = api_instance.initialize_self_service_registration_via_api_flow
|
931
816
|
p result
|
932
817
|
rescue OryHydraClient::ApiError => e
|
933
|
-
puts "Error when calling PublicApi->
|
818
|
+
puts "Error when calling PublicApi->initialize_self_service_registration_via_api_flow: #{e}"
|
934
819
|
end
|
935
820
|
```
|
936
821
|
|
937
|
-
#### Using the
|
822
|
+
#### Using the initialize_self_service_registration_via_api_flow_with_http_info variant
|
938
823
|
|
939
824
|
This returns an Array which contains the response data, status code and headers.
|
940
825
|
|
941
|
-
> <Array(<
|
826
|
+
> <Array(<RegistrationFlow>, Integer, Hash)> initialize_self_service_registration_via_api_flow_with_http_info
|
942
827
|
|
943
828
|
```ruby
|
944
829
|
begin
|
945
|
-
#
|
946
|
-
data, status_code, headers = api_instance.
|
830
|
+
# Initialize Registration Flow for API clients
|
831
|
+
data, status_code, headers = api_instance.initialize_self_service_registration_via_api_flow_with_http_info
|
947
832
|
p status_code # => 2xx
|
948
833
|
p headers # => { ... }
|
949
|
-
p data # => <
|
834
|
+
p data # => <RegistrationFlow>
|
950
835
|
rescue OryHydraClient::ApiError => e
|
951
|
-
puts "Error when calling PublicApi->
|
836
|
+
puts "Error when calling PublicApi->initialize_self_service_registration_via_api_flow_with_http_info: #{e}"
|
952
837
|
end
|
953
838
|
```
|
954
839
|
|
955
840
|
### Parameters
|
956
841
|
|
957
|
-
|
958
|
-
| ---- | ---- | ----------- | ----- |
|
959
|
-
| **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`). | |
|
842
|
+
This endpoint does not need any parameter.
|
960
843
|
|
961
844
|
### Return type
|
962
845
|
|
963
|
-
[**
|
846
|
+
[**RegistrationFlow**](RegistrationFlow.md)
|
964
847
|
|
965
848
|
### Authorization
|
966
849
|
|
@@ -972,13 +855,13 @@ No authorization required
|
|
972
855
|
- **Accept**: application/json
|
973
856
|
|
974
857
|
|
975
|
-
##
|
858
|
+
## initialize_self_service_registration_via_browser_flow
|
976
859
|
|
977
|
-
>
|
860
|
+
> initialize_self_service_registration_via_browser_flow
|
978
861
|
|
979
|
-
Initialize
|
862
|
+
Initialize Registration Flow for browsers
|
980
863
|
|
981
|
-
This endpoint initializes a
|
864
|
+
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).
|
982
865
|
|
983
866
|
### Examples
|
984
867
|
|
@@ -989,28 +872,28 @@ require 'ory-kratos-client'
|
|
989
872
|
api_instance = OryHydraClient::PublicApi.new
|
990
873
|
|
991
874
|
begin
|
992
|
-
# Initialize
|
993
|
-
api_instance.
|
875
|
+
# Initialize Registration Flow for browsers
|
876
|
+
api_instance.initialize_self_service_registration_via_browser_flow
|
994
877
|
rescue OryHydraClient::ApiError => e
|
995
|
-
puts "Error when calling PublicApi->
|
878
|
+
puts "Error when calling PublicApi->initialize_self_service_registration_via_browser_flow: #{e}"
|
996
879
|
end
|
997
880
|
```
|
998
881
|
|
999
|
-
#### Using the
|
882
|
+
#### Using the initialize_self_service_registration_via_browser_flow_with_http_info variant
|
1000
883
|
|
1001
884
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1002
885
|
|
1003
|
-
> <Array(nil, Integer, Hash)>
|
886
|
+
> <Array(nil, Integer, Hash)> initialize_self_service_registration_via_browser_flow_with_http_info
|
1004
887
|
|
1005
888
|
```ruby
|
1006
889
|
begin
|
1007
|
-
# Initialize
|
1008
|
-
data, status_code, headers = api_instance.
|
890
|
+
# Initialize Registration Flow for browsers
|
891
|
+
data, status_code, headers = api_instance.initialize_self_service_registration_via_browser_flow_with_http_info
|
1009
892
|
p status_code # => 2xx
|
1010
893
|
p headers # => { ... }
|
1011
894
|
p data # => nil
|
1012
895
|
rescue OryHydraClient::ApiError => e
|
1013
|
-
puts "Error when calling PublicApi->
|
896
|
+
puts "Error when calling PublicApi->initialize_self_service_registration_via_browser_flow_with_http_info: #{e}"
|
1014
897
|
end
|
1015
898
|
```
|
1016
899
|
|
@@ -1032,65 +915,67 @@ No authorization required
|
|
1032
915
|
- **Accept**: application/json
|
1033
916
|
|
1034
917
|
|
1035
|
-
##
|
918
|
+
## initialize_self_service_settings_via_api_flow
|
1036
919
|
|
1037
|
-
> <
|
920
|
+
> <SettingsFlow> initialize_self_service_settings_via_api_flow
|
1038
921
|
|
1039
|
-
Initialize
|
922
|
+
Initialize Settings Flow for API Clients
|
1040
923
|
|
1041
|
-
This endpoint initiates a
|
924
|
+
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).
|
1042
925
|
|
1043
926
|
### Examples
|
1044
927
|
|
1045
928
|
```ruby
|
1046
929
|
require 'time'
|
1047
930
|
require 'ory-kratos-client'
|
931
|
+
# setup authorization
|
932
|
+
OryHydraClient.configure do |config|
|
933
|
+
# Configure API key authorization: sessionToken
|
934
|
+
config.api_key['sessionToken'] = 'YOUR API KEY'
|
935
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
936
|
+
# config.api_key_prefix['sessionToken'] = 'Bearer'
|
937
|
+
end
|
1048
938
|
|
1049
939
|
api_instance = OryHydraClient::PublicApi.new
|
1050
|
-
opts = {
|
1051
|
-
refresh: true # Boolean | 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.
|
1052
|
-
}
|
1053
940
|
|
1054
941
|
begin
|
1055
|
-
# Initialize
|
1056
|
-
result = api_instance.
|
942
|
+
# Initialize Settings Flow for API Clients
|
943
|
+
result = api_instance.initialize_self_service_settings_via_api_flow
|
1057
944
|
p result
|
1058
945
|
rescue OryHydraClient::ApiError => e
|
1059
|
-
puts "Error when calling PublicApi->
|
946
|
+
puts "Error when calling PublicApi->initialize_self_service_settings_via_api_flow: #{e}"
|
1060
947
|
end
|
1061
948
|
```
|
1062
949
|
|
1063
|
-
#### Using the
|
950
|
+
#### Using the initialize_self_service_settings_via_api_flow_with_http_info variant
|
1064
951
|
|
1065
952
|
This returns an Array which contains the response data, status code and headers.
|
1066
953
|
|
1067
|
-
> <Array(<
|
954
|
+
> <Array(<SettingsFlow>, Integer, Hash)> initialize_self_service_settings_via_api_flow_with_http_info
|
1068
955
|
|
1069
956
|
```ruby
|
1070
957
|
begin
|
1071
|
-
# Initialize
|
1072
|
-
data, status_code, headers = api_instance.
|
958
|
+
# Initialize Settings Flow for API Clients
|
959
|
+
data, status_code, headers = api_instance.initialize_self_service_settings_via_api_flow_with_http_info
|
1073
960
|
p status_code # => 2xx
|
1074
961
|
p headers # => { ... }
|
1075
|
-
p data # => <
|
962
|
+
p data # => <SettingsFlow>
|
1076
963
|
rescue OryHydraClient::ApiError => e
|
1077
|
-
puts "Error when calling PublicApi->
|
964
|
+
puts "Error when calling PublicApi->initialize_self_service_settings_via_api_flow_with_http_info: #{e}"
|
1078
965
|
end
|
1079
966
|
```
|
1080
967
|
|
1081
968
|
### Parameters
|
1082
969
|
|
1083
|
-
|
1084
|
-
| ---- | ---- | ----------- | ----- |
|
1085
|
-
| **refresh** | **Boolean** | 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. | [optional] |
|
970
|
+
This endpoint does not need any parameter.
|
1086
971
|
|
1087
972
|
### Return type
|
1088
973
|
|
1089
|
-
[**
|
974
|
+
[**SettingsFlow**](SettingsFlow.md)
|
1090
975
|
|
1091
976
|
### Authorization
|
1092
977
|
|
1093
|
-
|
978
|
+
[sessionToken](../README.md#sessionToken)
|
1094
979
|
|
1095
980
|
### HTTP request headers
|
1096
981
|
|
@@ -1098,45 +983,52 @@ No authorization required
|
|
1098
983
|
- **Accept**: application/json
|
1099
984
|
|
1100
985
|
|
1101
|
-
##
|
986
|
+
## initialize_self_service_settings_via_browser_flow
|
1102
987
|
|
1103
|
-
>
|
988
|
+
> initialize_self_service_settings_via_browser_flow
|
1104
989
|
|
1105
|
-
Initialize
|
990
|
+
Initialize Settings Flow for Browsers
|
1106
991
|
|
1107
|
-
This endpoint initializes a browser-based user
|
992
|
+
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).
|
1108
993
|
|
1109
994
|
### Examples
|
1110
995
|
|
1111
996
|
```ruby
|
1112
997
|
require 'time'
|
1113
998
|
require 'ory-kratos-client'
|
999
|
+
# setup authorization
|
1000
|
+
OryHydraClient.configure do |config|
|
1001
|
+
# Configure API key authorization: sessionToken
|
1002
|
+
config.api_key['sessionToken'] = 'YOUR API KEY'
|
1003
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1004
|
+
# config.api_key_prefix['sessionToken'] = 'Bearer'
|
1005
|
+
end
|
1114
1006
|
|
1115
1007
|
api_instance = OryHydraClient::PublicApi.new
|
1116
1008
|
|
1117
1009
|
begin
|
1118
|
-
# Initialize
|
1119
|
-
api_instance.
|
1010
|
+
# Initialize Settings Flow for Browsers
|
1011
|
+
api_instance.initialize_self_service_settings_via_browser_flow
|
1120
1012
|
rescue OryHydraClient::ApiError => e
|
1121
|
-
puts "Error when calling PublicApi->
|
1013
|
+
puts "Error when calling PublicApi->initialize_self_service_settings_via_browser_flow: #{e}"
|
1122
1014
|
end
|
1123
1015
|
```
|
1124
1016
|
|
1125
|
-
#### Using the
|
1017
|
+
#### Using the initialize_self_service_settings_via_browser_flow_with_http_info variant
|
1126
1018
|
|
1127
1019
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1128
1020
|
|
1129
|
-
> <Array(nil, Integer, Hash)>
|
1021
|
+
> <Array(nil, Integer, Hash)> initialize_self_service_settings_via_browser_flow_with_http_info
|
1130
1022
|
|
1131
1023
|
```ruby
|
1132
1024
|
begin
|
1133
|
-
# Initialize
|
1134
|
-
data, status_code, headers = api_instance.
|
1025
|
+
# Initialize Settings Flow for Browsers
|
1026
|
+
data, status_code, headers = api_instance.initialize_self_service_settings_via_browser_flow_with_http_info
|
1135
1027
|
p status_code # => 2xx
|
1136
1028
|
p headers # => { ... }
|
1137
1029
|
p data # => nil
|
1138
1030
|
rescue OryHydraClient::ApiError => e
|
1139
|
-
puts "Error when calling PublicApi->
|
1031
|
+
puts "Error when calling PublicApi->initialize_self_service_settings_via_browser_flow_with_http_info: #{e}"
|
1140
1032
|
end
|
1141
1033
|
```
|
1142
1034
|
|
@@ -1150,7 +1042,7 @@ nil (empty response body)
|
|
1150
1042
|
|
1151
1043
|
### Authorization
|
1152
1044
|
|
1153
|
-
|
1045
|
+
[sessionToken](../README.md#sessionToken)
|
1154
1046
|
|
1155
1047
|
### HTTP request headers
|
1156
1048
|
|
@@ -1158,13 +1050,13 @@ No authorization required
|
|
1158
1050
|
- **Accept**: application/json
|
1159
1051
|
|
1160
1052
|
|
1161
|
-
##
|
1053
|
+
## initialize_self_service_verification_via_api_flow
|
1162
1054
|
|
1163
|
-
> <
|
1055
|
+
> <VerificationFlow> initialize_self_service_verification_via_api_flow
|
1164
1056
|
|
1165
|
-
Initialize
|
1057
|
+
Initialize Verification Flow for API Clients
|
1166
1058
|
|
1167
|
-
This endpoint initiates a
|
1059
|
+
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).
|
1168
1060
|
|
1169
1061
|
### Examples
|
1170
1062
|
|
@@ -1175,29 +1067,29 @@ require 'ory-kratos-client'
|
|
1175
1067
|
api_instance = OryHydraClient::PublicApi.new
|
1176
1068
|
|
1177
1069
|
begin
|
1178
|
-
# Initialize
|
1179
|
-
result = api_instance.
|
1070
|
+
# Initialize Verification Flow for API Clients
|
1071
|
+
result = api_instance.initialize_self_service_verification_via_api_flow
|
1180
1072
|
p result
|
1181
1073
|
rescue OryHydraClient::ApiError => e
|
1182
|
-
puts "Error when calling PublicApi->
|
1074
|
+
puts "Error when calling PublicApi->initialize_self_service_verification_via_api_flow: #{e}"
|
1183
1075
|
end
|
1184
1076
|
```
|
1185
1077
|
|
1186
|
-
#### Using the
|
1078
|
+
#### Using the initialize_self_service_verification_via_api_flow_with_http_info variant
|
1187
1079
|
|
1188
1080
|
This returns an Array which contains the response data, status code and headers.
|
1189
1081
|
|
1190
|
-
> <Array(<
|
1082
|
+
> <Array(<VerificationFlow>, Integer, Hash)> initialize_self_service_verification_via_api_flow_with_http_info
|
1191
1083
|
|
1192
1084
|
```ruby
|
1193
1085
|
begin
|
1194
|
-
# Initialize
|
1195
|
-
data, status_code, headers = api_instance.
|
1086
|
+
# Initialize Verification Flow for API Clients
|
1087
|
+
data, status_code, headers = api_instance.initialize_self_service_verification_via_api_flow_with_http_info
|
1196
1088
|
p status_code # => 2xx
|
1197
1089
|
p headers # => { ... }
|
1198
|
-
p data # => <
|
1090
|
+
p data # => <VerificationFlow>
|
1199
1091
|
rescue OryHydraClient::ApiError => e
|
1200
|
-
puts "Error when calling PublicApi->
|
1092
|
+
puts "Error when calling PublicApi->initialize_self_service_verification_via_api_flow_with_http_info: #{e}"
|
1201
1093
|
end
|
1202
1094
|
```
|
1203
1095
|
|
@@ -1207,7 +1099,7 @@ This endpoint does not need any parameter.
|
|
1207
1099
|
|
1208
1100
|
### Return type
|
1209
1101
|
|
1210
|
-
[**
|
1102
|
+
[**VerificationFlow**](VerificationFlow.md)
|
1211
1103
|
|
1212
1104
|
### Authorization
|
1213
1105
|
|
@@ -1219,13 +1111,13 @@ No authorization required
|
|
1219
1111
|
- **Accept**: application/json
|
1220
1112
|
|
1221
1113
|
|
1222
|
-
##
|
1114
|
+
## initialize_self_service_verification_via_browser_flow
|
1223
1115
|
|
1224
|
-
>
|
1116
|
+
> initialize_self_service_verification_via_browser_flow
|
1225
1117
|
|
1226
|
-
Initialize
|
1118
|
+
Initialize Verification Flow for Browser Clients
|
1227
1119
|
|
1228
|
-
This endpoint initializes a browser-based account
|
1120
|
+
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).
|
1229
1121
|
|
1230
1122
|
### Examples
|
1231
1123
|
|
@@ -1236,28 +1128,28 @@ require 'ory-kratos-client'
|
|
1236
1128
|
api_instance = OryHydraClient::PublicApi.new
|
1237
1129
|
|
1238
1130
|
begin
|
1239
|
-
# Initialize
|
1240
|
-
api_instance.
|
1131
|
+
# Initialize Verification Flow for Browser Clients
|
1132
|
+
api_instance.initialize_self_service_verification_via_browser_flow
|
1241
1133
|
rescue OryHydraClient::ApiError => e
|
1242
|
-
puts "Error when calling PublicApi->
|
1134
|
+
puts "Error when calling PublicApi->initialize_self_service_verification_via_browser_flow: #{e}"
|
1243
1135
|
end
|
1244
1136
|
```
|
1245
1137
|
|
1246
|
-
#### Using the
|
1138
|
+
#### Using the initialize_self_service_verification_via_browser_flow_with_http_info variant
|
1247
1139
|
|
1248
1140
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1249
1141
|
|
1250
|
-
> <Array(nil, Integer, Hash)>
|
1142
|
+
> <Array(nil, Integer, Hash)> initialize_self_service_verification_via_browser_flow_with_http_info
|
1251
1143
|
|
1252
1144
|
```ruby
|
1253
1145
|
begin
|
1254
|
-
# Initialize
|
1255
|
-
data, status_code, headers = api_instance.
|
1146
|
+
# Initialize Verification Flow for Browser Clients
|
1147
|
+
data, status_code, headers = api_instance.initialize_self_service_verification_via_browser_flow_with_http_info
|
1256
1148
|
p status_code # => 2xx
|
1257
1149
|
p headers # => { ... }
|
1258
1150
|
p data # => nil
|
1259
1151
|
rescue OryHydraClient::ApiError => e
|
1260
|
-
puts "Error when calling PublicApi->
|
1152
|
+
puts "Error when calling PublicApi->initialize_self_service_verification_via_browser_flow_with_http_info: #{e}"
|
1261
1153
|
end
|
1262
1154
|
```
|
1263
1155
|
|
@@ -1279,13 +1171,13 @@ No authorization required
|
|
1279
1171
|
- **Accept**: application/json
|
1280
1172
|
|
1281
1173
|
|
1282
|
-
##
|
1174
|
+
## revoke_session
|
1283
1175
|
|
1284
|
-
>
|
1176
|
+
> revoke_session(revoke_session)
|
1285
1177
|
|
1286
|
-
Initialize
|
1178
|
+
Initialize Logout Flow for API Clients - Revoke a Session
|
1287
1179
|
|
1288
|
-
|
1180
|
+
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.
|
1289
1181
|
|
1290
1182
|
### Examples
|
1291
1183
|
|
@@ -1294,41 +1186,43 @@ require 'time'
|
|
1294
1186
|
require 'ory-kratos-client'
|
1295
1187
|
|
1296
1188
|
api_instance = OryHydraClient::PublicApi.new
|
1189
|
+
revoke_session = OryHydraClient::RevokeSession.new({session_token: 'session_token_example'}) # RevokeSession |
|
1297
1190
|
|
1298
1191
|
begin
|
1299
|
-
# Initialize
|
1300
|
-
|
1301
|
-
p result
|
1192
|
+
# Initialize Logout Flow for API Clients - Revoke a Session
|
1193
|
+
api_instance.revoke_session(revoke_session)
|
1302
1194
|
rescue OryHydraClient::ApiError => e
|
1303
|
-
puts "Error when calling PublicApi->
|
1195
|
+
puts "Error when calling PublicApi->revoke_session: #{e}"
|
1304
1196
|
end
|
1305
1197
|
```
|
1306
1198
|
|
1307
|
-
#### Using the
|
1199
|
+
#### Using the revoke_session_with_http_info variant
|
1308
1200
|
|
1309
|
-
This returns an Array which contains the response data, status code and headers.
|
1201
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1310
1202
|
|
1311
|
-
> <Array(
|
1203
|
+
> <Array(nil, Integer, Hash)> revoke_session_with_http_info(revoke_session)
|
1312
1204
|
|
1313
1205
|
```ruby
|
1314
1206
|
begin
|
1315
|
-
# Initialize
|
1316
|
-
data, status_code, headers = api_instance.
|
1207
|
+
# Initialize Logout Flow for API Clients - Revoke a Session
|
1208
|
+
data, status_code, headers = api_instance.revoke_session_with_http_info(revoke_session)
|
1317
1209
|
p status_code # => 2xx
|
1318
1210
|
p headers # => { ... }
|
1319
|
-
p data # =>
|
1211
|
+
p data # => nil
|
1320
1212
|
rescue OryHydraClient::ApiError => e
|
1321
|
-
puts "Error when calling PublicApi->
|
1213
|
+
puts "Error when calling PublicApi->revoke_session_with_http_info: #{e}"
|
1322
1214
|
end
|
1323
1215
|
```
|
1324
1216
|
|
1325
1217
|
### Parameters
|
1326
1218
|
|
1327
|
-
|
1219
|
+
| Name | Type | Description | Notes |
|
1220
|
+
| ---- | ---- | ----------- | ----- |
|
1221
|
+
| **revoke_session** | [**RevokeSession**](RevokeSession.md) | | |
|
1328
1222
|
|
1329
1223
|
### Return type
|
1330
1224
|
|
1331
|
-
|
1225
|
+
nil (empty response body)
|
1332
1226
|
|
1333
1227
|
### Authorization
|
1334
1228
|
|
@@ -1336,17 +1230,17 @@ No authorization required
|
|
1336
1230
|
|
1337
1231
|
### HTTP request headers
|
1338
1232
|
|
1339
|
-
- **Content-Type**:
|
1233
|
+
- **Content-Type**: application/json
|
1340
1234
|
- **Accept**: application/json
|
1341
1235
|
|
1342
1236
|
|
1343
|
-
##
|
1237
|
+
## submit_self_service_login_flow
|
1344
1238
|
|
1345
|
-
>
|
1239
|
+
> <LoginViaApiResponse> submit_self_service_login_flow(flow, opts)
|
1346
1240
|
|
1347
|
-
|
1241
|
+
Submit a Login Flow
|
1348
1242
|
|
1349
|
-
|
1243
|
+
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).
|
1350
1244
|
|
1351
1245
|
### Examples
|
1352
1246
|
|
@@ -1355,40 +1249,48 @@ require 'time'
|
|
1355
1249
|
require 'ory-kratos-client'
|
1356
1250
|
|
1357
1251
|
api_instance = OryHydraClient::PublicApi.new
|
1252
|
+
flow = 'flow_example' # 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`).
|
1253
|
+
opts = {
|
1254
|
+
submit_self_service_login_flow: OryHydraClient::SubmitSelfServiceLoginFlowWithPasswordMethod.new # SubmitSelfServiceLoginFlow |
|
1255
|
+
}
|
1358
1256
|
|
1359
1257
|
begin
|
1360
|
-
#
|
1361
|
-
api_instance.
|
1258
|
+
# Submit a Login Flow
|
1259
|
+
result = api_instance.submit_self_service_login_flow(flow, opts)
|
1260
|
+
p result
|
1362
1261
|
rescue OryHydraClient::ApiError => e
|
1363
|
-
puts "Error when calling PublicApi->
|
1262
|
+
puts "Error when calling PublicApi->submit_self_service_login_flow: #{e}"
|
1364
1263
|
end
|
1365
1264
|
```
|
1366
1265
|
|
1367
|
-
#### Using the
|
1266
|
+
#### Using the submit_self_service_login_flow_with_http_info variant
|
1368
1267
|
|
1369
|
-
This returns an Array which contains the response data
|
1268
|
+
This returns an Array which contains the response data, status code and headers.
|
1370
1269
|
|
1371
|
-
> <Array(
|
1270
|
+
> <Array(<LoginViaApiResponse>, Integer, Hash)> submit_self_service_login_flow_with_http_info(flow, opts)
|
1372
1271
|
|
1373
1272
|
```ruby
|
1374
1273
|
begin
|
1375
|
-
#
|
1376
|
-
data, status_code, headers = api_instance.
|
1274
|
+
# Submit a Login Flow
|
1275
|
+
data, status_code, headers = api_instance.submit_self_service_login_flow_with_http_info(flow, opts)
|
1377
1276
|
p status_code # => 2xx
|
1378
1277
|
p headers # => { ... }
|
1379
|
-
p data # =>
|
1278
|
+
p data # => <LoginViaApiResponse>
|
1380
1279
|
rescue OryHydraClient::ApiError => e
|
1381
|
-
puts "Error when calling PublicApi->
|
1280
|
+
puts "Error when calling PublicApi->submit_self_service_login_flow_with_http_info: #{e}"
|
1382
1281
|
end
|
1383
1282
|
```
|
1384
1283
|
|
1385
1284
|
### Parameters
|
1386
1285
|
|
1387
|
-
|
1286
|
+
| Name | Type | Description | Notes |
|
1287
|
+
| ---- | ---- | ----------- | ----- |
|
1288
|
+
| **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`). | |
|
1289
|
+
| **submit_self_service_login_flow** | [**SubmitSelfServiceLoginFlow**](SubmitSelfServiceLoginFlow.md) | | [optional] |
|
1388
1290
|
|
1389
1291
|
### Return type
|
1390
1292
|
|
1391
|
-
|
1293
|
+
[**LoginViaApiResponse**](LoginViaApiResponse.md)
|
1392
1294
|
|
1393
1295
|
### Authorization
|
1394
1296
|
|
@@ -1396,130 +1298,131 @@ No authorization required
|
|
1396
1298
|
|
1397
1299
|
### HTTP request headers
|
1398
1300
|
|
1399
|
-
- **Content-Type**:
|
1301
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded
|
1400
1302
|
- **Accept**: application/json
|
1401
1303
|
|
1402
1304
|
|
1403
|
-
##
|
1305
|
+
## submit_self_service_recovery_flow
|
1404
1306
|
|
1405
|
-
>
|
1307
|
+
> submit_self_service_recovery_flow(flow, opts)
|
1406
1308
|
|
1407
|
-
|
1309
|
+
Complete Recovery Flow
|
1408
1310
|
|
1409
|
-
|
1311
|
+
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).
|
1410
1312
|
|
1411
1313
|
### Examples
|
1412
1314
|
|
1413
1315
|
```ruby
|
1414
1316
|
require 'time'
|
1415
1317
|
require 'ory-kratos-client'
|
1416
|
-
# setup authorization
|
1417
|
-
OryHydraClient.configure do |config|
|
1418
|
-
# Configure API key authorization: sessionToken
|
1419
|
-
config.api_key['X-Session-Token'] = 'YOUR API KEY'
|
1420
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1421
|
-
# config.api_key_prefix['X-Session-Token'] = 'Bearer'
|
1422
|
-
end
|
1423
1318
|
|
1424
1319
|
api_instance = OryHydraClient::PublicApi.new
|
1320
|
+
flow = 'flow_example' # 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`).
|
1321
|
+
opts = {
|
1322
|
+
body: Object # Object |
|
1323
|
+
}
|
1425
1324
|
|
1426
1325
|
begin
|
1427
|
-
#
|
1428
|
-
|
1429
|
-
p result
|
1326
|
+
# Complete Recovery Flow
|
1327
|
+
api_instance.submit_self_service_recovery_flow(flow, opts)
|
1430
1328
|
rescue OryHydraClient::ApiError => e
|
1431
|
-
puts "Error when calling PublicApi->
|
1329
|
+
puts "Error when calling PublicApi->submit_self_service_recovery_flow: #{e}"
|
1432
1330
|
end
|
1433
1331
|
```
|
1434
1332
|
|
1435
|
-
#### Using the
|
1333
|
+
#### Using the submit_self_service_recovery_flow_with_http_info variant
|
1436
1334
|
|
1437
|
-
This returns an Array which contains the response data, status code and headers.
|
1335
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1438
1336
|
|
1439
|
-
> <Array(
|
1337
|
+
> <Array(nil, Integer, Hash)> submit_self_service_recovery_flow_with_http_info(flow, opts)
|
1440
1338
|
|
1441
1339
|
```ruby
|
1442
1340
|
begin
|
1443
|
-
#
|
1444
|
-
data, status_code, headers = api_instance.
|
1341
|
+
# Complete Recovery Flow
|
1342
|
+
data, status_code, headers = api_instance.submit_self_service_recovery_flow_with_http_info(flow, opts)
|
1445
1343
|
p status_code # => 2xx
|
1446
1344
|
p headers # => { ... }
|
1447
|
-
p data # =>
|
1345
|
+
p data # => nil
|
1448
1346
|
rescue OryHydraClient::ApiError => e
|
1449
|
-
puts "Error when calling PublicApi->
|
1347
|
+
puts "Error when calling PublicApi->submit_self_service_recovery_flow_with_http_info: #{e}"
|
1450
1348
|
end
|
1451
1349
|
```
|
1452
1350
|
|
1453
1351
|
### Parameters
|
1454
1352
|
|
1455
|
-
|
1353
|
+
| Name | Type | Description | Notes |
|
1354
|
+
| ---- | ---- | ----------- | ----- |
|
1355
|
+
| **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`). | |
|
1356
|
+
| **body** | **Object** | | [optional] |
|
1456
1357
|
|
1457
1358
|
### Return type
|
1458
1359
|
|
1459
|
-
|
1360
|
+
nil (empty response body)
|
1460
1361
|
|
1461
1362
|
### Authorization
|
1462
1363
|
|
1463
|
-
|
1364
|
+
No authorization required
|
1464
1365
|
|
1465
1366
|
### HTTP request headers
|
1466
1367
|
|
1467
|
-
- **Content-Type**:
|
1368
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded
|
1468
1369
|
- **Accept**: application/json
|
1469
1370
|
|
1470
1371
|
|
1471
|
-
##
|
1372
|
+
## submit_self_service_recovery_flow_with_link_method
|
1472
1373
|
|
1473
|
-
>
|
1374
|
+
> submit_self_service_recovery_flow_with_link_method(opts)
|
1474
1375
|
|
1475
|
-
|
1376
|
+
Complete Recovery Flow with Link Method
|
1476
1377
|
|
1477
|
-
|
1378
|
+
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).
|
1478
1379
|
|
1479
1380
|
### Examples
|
1480
1381
|
|
1481
1382
|
```ruby
|
1482
1383
|
require 'time'
|
1483
1384
|
require 'ory-kratos-client'
|
1484
|
-
# setup authorization
|
1485
|
-
OryHydraClient.configure do |config|
|
1486
|
-
# Configure API key authorization: sessionToken
|
1487
|
-
config.api_key['X-Session-Token'] = 'YOUR API KEY'
|
1488
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1489
|
-
# config.api_key_prefix['X-Session-Token'] = 'Bearer'
|
1490
|
-
end
|
1491
1385
|
|
1492
1386
|
api_instance = OryHydraClient::PublicApi.new
|
1387
|
+
opts = {
|
1388
|
+
token: 'token_example', # String | 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.
|
1389
|
+
flow: 'flow_example', # String | The Flow ID format: uuid
|
1390
|
+
submit_self_service_recovery_flow_with_link_method: OryHydraClient::SubmitSelfServiceRecoveryFlowWithLinkMethod.new # SubmitSelfServiceRecoveryFlowWithLinkMethod |
|
1391
|
+
}
|
1493
1392
|
|
1494
1393
|
begin
|
1495
|
-
#
|
1496
|
-
api_instance.
|
1394
|
+
# Complete Recovery Flow with Link Method
|
1395
|
+
api_instance.submit_self_service_recovery_flow_with_link_method(opts)
|
1497
1396
|
rescue OryHydraClient::ApiError => e
|
1498
|
-
puts "Error when calling PublicApi->
|
1397
|
+
puts "Error when calling PublicApi->submit_self_service_recovery_flow_with_link_method: #{e}"
|
1499
1398
|
end
|
1500
1399
|
```
|
1501
1400
|
|
1502
|
-
#### Using the
|
1401
|
+
#### Using the submit_self_service_recovery_flow_with_link_method_with_http_info variant
|
1503
1402
|
|
1504
1403
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1505
1404
|
|
1506
|
-
> <Array(nil, Integer, Hash)>
|
1405
|
+
> <Array(nil, Integer, Hash)> submit_self_service_recovery_flow_with_link_method_with_http_info(opts)
|
1507
1406
|
|
1508
1407
|
```ruby
|
1509
1408
|
begin
|
1510
|
-
#
|
1511
|
-
data, status_code, headers = api_instance.
|
1409
|
+
# Complete Recovery Flow with Link Method
|
1410
|
+
data, status_code, headers = api_instance.submit_self_service_recovery_flow_with_link_method_with_http_info(opts)
|
1512
1411
|
p status_code # => 2xx
|
1513
1412
|
p headers # => { ... }
|
1514
1413
|
p data # => nil
|
1515
1414
|
rescue OryHydraClient::ApiError => e
|
1516
|
-
puts "Error when calling PublicApi->
|
1415
|
+
puts "Error when calling PublicApi->submit_self_service_recovery_flow_with_link_method_with_http_info: #{e}"
|
1517
1416
|
end
|
1518
1417
|
```
|
1519
1418
|
|
1520
1419
|
### Parameters
|
1521
1420
|
|
1522
|
-
|
1421
|
+
| Name | Type | Description | Notes |
|
1422
|
+
| ---- | ---- | ----------- | ----- |
|
1423
|
+
| **token** | **String** | 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. | [optional] |
|
1424
|
+
| **flow** | **String** | The Flow ID format: uuid | [optional] |
|
1425
|
+
| **submit_self_service_recovery_flow_with_link_method** | [**SubmitSelfServiceRecoveryFlowWithLinkMethod**](SubmitSelfServiceRecoveryFlowWithLinkMethod.md) | | [optional] |
|
1523
1426
|
|
1524
1427
|
### Return type
|
1525
1428
|
|
@@ -1527,21 +1430,21 @@ nil (empty response body)
|
|
1527
1430
|
|
1528
1431
|
### Authorization
|
1529
1432
|
|
1530
|
-
|
1433
|
+
No authorization required
|
1531
1434
|
|
1532
1435
|
### HTTP request headers
|
1533
1436
|
|
1534
|
-
- **Content-Type**:
|
1437
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded
|
1535
1438
|
- **Accept**: application/json
|
1536
1439
|
|
1537
1440
|
|
1538
|
-
##
|
1441
|
+
## submit_self_service_registration_flow
|
1539
1442
|
|
1540
|
-
> <
|
1443
|
+
> <RegistrationViaApiResponse> submit_self_service_registration_flow(flow, opts)
|
1541
1444
|
|
1542
|
-
|
1445
|
+
Submit a Registration Flow
|
1543
1446
|
|
1544
|
-
|
1447
|
+
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).
|
1545
1448
|
|
1546
1449
|
### Examples
|
1547
1450
|
|
@@ -1550,41 +1453,48 @@ require 'time'
|
|
1550
1453
|
require 'ory-kratos-client'
|
1551
1454
|
|
1552
1455
|
api_instance = OryHydraClient::PublicApi.new
|
1456
|
+
flow = 'flow_example' # 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`).
|
1457
|
+
opts = {
|
1458
|
+
submit_self_service_registration_flow: OryHydraClient::SubmitSelfServiceRegistrationFlowWithPasswordMethod.new({method: 'method_example'}) # SubmitSelfServiceRegistrationFlow |
|
1459
|
+
}
|
1553
1460
|
|
1554
1461
|
begin
|
1555
|
-
#
|
1556
|
-
result = api_instance.
|
1462
|
+
# Submit a Registration Flow
|
1463
|
+
result = api_instance.submit_self_service_registration_flow(flow, opts)
|
1557
1464
|
p result
|
1558
1465
|
rescue OryHydraClient::ApiError => e
|
1559
|
-
puts "Error when calling PublicApi->
|
1466
|
+
puts "Error when calling PublicApi->submit_self_service_registration_flow: #{e}"
|
1560
1467
|
end
|
1561
1468
|
```
|
1562
1469
|
|
1563
|
-
#### Using the
|
1470
|
+
#### Using the submit_self_service_registration_flow_with_http_info variant
|
1564
1471
|
|
1565
1472
|
This returns an Array which contains the response data, status code and headers.
|
1566
1473
|
|
1567
|
-
> <Array(<
|
1474
|
+
> <Array(<RegistrationViaApiResponse>, Integer, Hash)> submit_self_service_registration_flow_with_http_info(flow, opts)
|
1568
1475
|
|
1569
1476
|
```ruby
|
1570
1477
|
begin
|
1571
|
-
#
|
1572
|
-
data, status_code, headers = api_instance.
|
1478
|
+
# Submit a Registration Flow
|
1479
|
+
data, status_code, headers = api_instance.submit_self_service_registration_flow_with_http_info(flow, opts)
|
1573
1480
|
p status_code # => 2xx
|
1574
1481
|
p headers # => { ... }
|
1575
|
-
p data # => <
|
1482
|
+
p data # => <RegistrationViaApiResponse>
|
1576
1483
|
rescue OryHydraClient::ApiError => e
|
1577
|
-
puts "Error when calling PublicApi->
|
1484
|
+
puts "Error when calling PublicApi->submit_self_service_registration_flow_with_http_info: #{e}"
|
1578
1485
|
end
|
1579
1486
|
```
|
1580
1487
|
|
1581
1488
|
### Parameters
|
1582
1489
|
|
1583
|
-
|
1490
|
+
| Name | Type | Description | Notes |
|
1491
|
+
| ---- | ---- | ----------- | ----- |
|
1492
|
+
| **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`). | |
|
1493
|
+
| **submit_self_service_registration_flow** | [**SubmitSelfServiceRegistrationFlow**](SubmitSelfServiceRegistrationFlow.md) | | [optional] |
|
1584
1494
|
|
1585
1495
|
### Return type
|
1586
1496
|
|
1587
|
-
[**
|
1497
|
+
[**RegistrationViaApiResponse**](RegistrationViaApiResponse.md)
|
1588
1498
|
|
1589
1499
|
### Authorization
|
1590
1500
|
|
@@ -1592,77 +1502,92 @@ No authorization required
|
|
1592
1502
|
|
1593
1503
|
### HTTP request headers
|
1594
1504
|
|
1595
|
-
- **Content-Type**:
|
1505
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded
|
1596
1506
|
- **Accept**: application/json
|
1597
1507
|
|
1598
1508
|
|
1599
|
-
##
|
1509
|
+
## submit_self_service_settings_flow
|
1600
1510
|
|
1601
|
-
>
|
1511
|
+
> <SettingsViaApiResponse> submit_self_service_settings_flow(flow, opts)
|
1602
1512
|
|
1603
|
-
|
1513
|
+
Complete Settings Flow
|
1604
1514
|
|
1605
|
-
|
1515
|
+
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).
|
1606
1516
|
|
1607
1517
|
### Examples
|
1608
1518
|
|
1609
1519
|
```ruby
|
1610
1520
|
require 'time'
|
1611
1521
|
require 'ory-kratos-client'
|
1522
|
+
# setup authorization
|
1523
|
+
OryHydraClient.configure do |config|
|
1524
|
+
# Configure API key authorization: sessionToken
|
1525
|
+
config.api_key['sessionToken'] = 'YOUR API KEY'
|
1526
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1527
|
+
# config.api_key_prefix['sessionToken'] = 'Bearer'
|
1528
|
+
end
|
1612
1529
|
|
1613
1530
|
api_instance = OryHydraClient::PublicApi.new
|
1531
|
+
flow = 'flow_example' # 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`).
|
1532
|
+
opts = {
|
1533
|
+
submit_self_service_settings_flow: OryHydraClient::SubmitSelfServiceSettingsFlowWithPasswordMethod.new({password: 'password_example'}) # SubmitSelfServiceSettingsFlow |
|
1534
|
+
}
|
1614
1535
|
|
1615
1536
|
begin
|
1616
|
-
#
|
1617
|
-
api_instance.
|
1537
|
+
# Complete Settings Flow
|
1538
|
+
result = api_instance.submit_self_service_settings_flow(flow, opts)
|
1539
|
+
p result
|
1618
1540
|
rescue OryHydraClient::ApiError => e
|
1619
|
-
puts "Error when calling PublicApi->
|
1541
|
+
puts "Error when calling PublicApi->submit_self_service_settings_flow: #{e}"
|
1620
1542
|
end
|
1621
1543
|
```
|
1622
1544
|
|
1623
|
-
#### Using the
|
1545
|
+
#### Using the submit_self_service_settings_flow_with_http_info variant
|
1624
1546
|
|
1625
|
-
This returns an Array which contains the response data
|
1547
|
+
This returns an Array which contains the response data, status code and headers.
|
1626
1548
|
|
1627
|
-
> <Array(
|
1549
|
+
> <Array(<SettingsViaApiResponse>, Integer, Hash)> submit_self_service_settings_flow_with_http_info(flow, opts)
|
1628
1550
|
|
1629
1551
|
```ruby
|
1630
1552
|
begin
|
1631
|
-
#
|
1632
|
-
data, status_code, headers = api_instance.
|
1553
|
+
# Complete Settings Flow
|
1554
|
+
data, status_code, headers = api_instance.submit_self_service_settings_flow_with_http_info(flow, opts)
|
1633
1555
|
p status_code # => 2xx
|
1634
1556
|
p headers # => { ... }
|
1635
|
-
p data # =>
|
1557
|
+
p data # => <SettingsViaApiResponse>
|
1636
1558
|
rescue OryHydraClient::ApiError => e
|
1637
|
-
puts "Error when calling PublicApi->
|
1559
|
+
puts "Error when calling PublicApi->submit_self_service_settings_flow_with_http_info: #{e}"
|
1638
1560
|
end
|
1639
1561
|
```
|
1640
1562
|
|
1641
1563
|
### Parameters
|
1642
1564
|
|
1643
|
-
|
1565
|
+
| Name | Type | Description | Notes |
|
1566
|
+
| ---- | ---- | ----------- | ----- |
|
1567
|
+
| **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`). | |
|
1568
|
+
| **submit_self_service_settings_flow** | [**SubmitSelfServiceSettingsFlow**](SubmitSelfServiceSettingsFlow.md) | | [optional] |
|
1644
1569
|
|
1645
1570
|
### Return type
|
1646
1571
|
|
1647
|
-
|
1572
|
+
[**SettingsViaApiResponse**](SettingsViaApiResponse.md)
|
1648
1573
|
|
1649
1574
|
### Authorization
|
1650
1575
|
|
1651
|
-
|
1576
|
+
[sessionToken](../README.md#sessionToken)
|
1652
1577
|
|
1653
1578
|
### HTTP request headers
|
1654
1579
|
|
1655
|
-
- **Content-Type**:
|
1580
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded
|
1656
1581
|
- **Accept**: application/json
|
1657
1582
|
|
1658
1583
|
|
1659
|
-
##
|
1584
|
+
## submit_self_service_verification_flow
|
1660
1585
|
|
1661
|
-
>
|
1586
|
+
> submit_self_service_verification_flow(flow, opts)
|
1662
1587
|
|
1663
|
-
|
1588
|
+
Complete Verification Flow
|
1664
1589
|
|
1665
|
-
Use this endpoint to
|
1590
|
+
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).
|
1666
1591
|
|
1667
1592
|
### Examples
|
1668
1593
|
|
@@ -1671,31 +1596,34 @@ require 'time'
|
|
1671
1596
|
require 'ory-kratos-client'
|
1672
1597
|
|
1673
1598
|
api_instance = OryHydraClient::PublicApi.new
|
1674
|
-
|
1599
|
+
flow = 'flow_example' # 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`).
|
1600
|
+
opts = {
|
1601
|
+
body: Object # Object |
|
1602
|
+
}
|
1675
1603
|
|
1676
1604
|
begin
|
1677
|
-
#
|
1678
|
-
api_instance.
|
1605
|
+
# Complete Verification Flow
|
1606
|
+
api_instance.submit_self_service_verification_flow(flow, opts)
|
1679
1607
|
rescue OryHydraClient::ApiError => e
|
1680
|
-
puts "Error when calling PublicApi->
|
1608
|
+
puts "Error when calling PublicApi->submit_self_service_verification_flow: #{e}"
|
1681
1609
|
end
|
1682
1610
|
```
|
1683
1611
|
|
1684
|
-
#### Using the
|
1612
|
+
#### Using the submit_self_service_verification_flow_with_http_info variant
|
1685
1613
|
|
1686
1614
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1687
1615
|
|
1688
|
-
> <Array(nil, Integer, Hash)>
|
1616
|
+
> <Array(nil, Integer, Hash)> submit_self_service_verification_flow_with_http_info(flow, opts)
|
1689
1617
|
|
1690
1618
|
```ruby
|
1691
1619
|
begin
|
1692
|
-
#
|
1693
|
-
data, status_code, headers = api_instance.
|
1620
|
+
# Complete Verification Flow
|
1621
|
+
data, status_code, headers = api_instance.submit_self_service_verification_flow_with_http_info(flow, opts)
|
1694
1622
|
p status_code # => 2xx
|
1695
1623
|
p headers # => { ... }
|
1696
1624
|
p data # => nil
|
1697
1625
|
rescue OryHydraClient::ApiError => e
|
1698
|
-
puts "Error when calling PublicApi->
|
1626
|
+
puts "Error when calling PublicApi->submit_self_service_verification_flow_with_http_info: #{e}"
|
1699
1627
|
end
|
1700
1628
|
```
|
1701
1629
|
|
@@ -1703,7 +1631,8 @@ end
|
|
1703
1631
|
|
1704
1632
|
| Name | Type | Description | Notes |
|
1705
1633
|
| ---- | ---- | ----------- | ----- |
|
1706
|
-
| **
|
1634
|
+
| **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`). | |
|
1635
|
+
| **body** | **Object** | | [optional] |
|
1707
1636
|
|
1708
1637
|
### Return type
|
1709
1638
|
|
@@ -1715,7 +1644,7 @@ No authorization required
|
|
1715
1644
|
|
1716
1645
|
### HTTP request headers
|
1717
1646
|
|
1718
|
-
- **Content-Type**: application/json
|
1647
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded
|
1719
1648
|
- **Accept**: application/json
|
1720
1649
|
|
1721
1650
|
|
@@ -1735,15 +1664,15 @@ require 'ory-kratos-client'
|
|
1735
1664
|
# setup authorization
|
1736
1665
|
OryHydraClient.configure do |config|
|
1737
1666
|
# Configure API key authorization: sessionToken
|
1738
|
-
config.api_key['
|
1667
|
+
config.api_key['sessionToken'] = 'YOUR API KEY'
|
1739
1668
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1740
|
-
# config.api_key_prefix['
|
1669
|
+
# config.api_key_prefix['sessionToken'] = 'Bearer'
|
1741
1670
|
end
|
1742
1671
|
|
1743
1672
|
api_instance = OryHydraClient::PublicApi.new
|
1744
1673
|
opts = {
|
1745
1674
|
cookie: 'cookie_example', # String |
|
1746
|
-
authorization: 'authorization_example' # String |
|
1675
|
+
authorization: 'authorization_example' # String |
|
1747
1676
|
}
|
1748
1677
|
|
1749
1678
|
begin
|
@@ -1778,7 +1707,7 @@ end
|
|
1778
1707
|
| Name | Type | Description | Notes |
|
1779
1708
|
| ---- | ---- | ----------- | ----- |
|
1780
1709
|
| **cookie** | **String** | | [optional] |
|
1781
|
-
| **authorization** | **String** |
|
1710
|
+
| **authorization** | **String** | | [optional] |
|
1782
1711
|
|
1783
1712
|
### Return type
|
1784
1713
|
|