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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f0fea8248d383a9de6a7b66847732230321110fdd02bc1ea12e7055fa6444d29
|
4
|
+
data.tar.gz: ef19d94fb3c04c6b2523d38a3e23f87875c45e7a0842e23583a4254b6a5a901f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e08649608f7d9201a6a39e3ac1151457abeedaaa550131ace8c0f5db88f884743e12c96bb3908cce1c95fdbb96ec6937a307621309b78c3c630c62f3be2a6ed8
|
7
|
+
data.tar.gz: f94039e5a8ea82470649ae39ddcafd2057e249e02708db76f225d1654d3f2a0376450c5438d6b9f3dc415fb98d81ad895e0c789cee88e00ae2eaf3885ea481fe
|
data/README.md
CHANGED
@@ -1,13 +1,18 @@
|
|
1
1
|
# ory-kratos-client
|
2
2
|
|
3
|
-
OryHydraClient - the Ruby gem for the Ory Kratos
|
3
|
+
OryHydraClient - the Ruby gem for the Ory Kratos API
|
4
|
+
|
5
|
+
Documentation for all public and administrative Ory Kratos APIs. Public and administrative APIs
|
6
|
+
are exposed on different ports. Public APIs can face the public internet without any protection
|
7
|
+
while administrative APIs should never be exposed without prior authorization. To protect
|
8
|
+
the administative API port you should use something like Nginx, Ory Oathkeeper, or any other
|
9
|
+
technology capable of authorizing incoming requests.
|
4
10
|
|
5
|
-
Welcome to the ORY Kratos HTTP API documentation!
|
6
11
|
|
7
12
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
13
|
|
9
|
-
- API version: v0.
|
10
|
-
- Package version: v0.
|
14
|
+
- API version: v0.6.0-alpha.4
|
15
|
+
- Package version: v0.6.0-alpha.4
|
11
16
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
17
|
|
13
18
|
## Installation
|
@@ -23,16 +28,16 @@ gem build ory-kratos-client.gemspec
|
|
23
28
|
Then either install the gem locally:
|
24
29
|
|
25
30
|
```shell
|
26
|
-
gem install ./ory-kratos-client-v0.
|
31
|
+
gem install ./ory-kratos-client-v0.6.0-alpha.4.gem
|
27
32
|
```
|
28
33
|
|
29
|
-
(for development, run `gem install --dev ./ory-kratos-client-v0.
|
34
|
+
(for development, run `gem install --dev ./ory-kratos-client-v0.6.0-alpha.4.gem` to install the development dependencies)
|
30
35
|
|
31
36
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
37
|
|
33
38
|
Finally add this to the Gemfile:
|
34
39
|
|
35
|
-
gem 'ory-kratos-client', '~> v0.
|
40
|
+
gem 'ory-kratos-client', '~> v0.6.0-alpha.4'
|
36
41
|
|
37
42
|
### Install from Git
|
38
43
|
|
@@ -58,7 +63,7 @@ require 'ory-kratos-client'
|
|
58
63
|
|
59
64
|
api_instance = OryHydraClient::AdminApi.new
|
60
65
|
opts = {
|
61
|
-
|
66
|
+
create_identity: OryHydraClient::CreateIdentity.new({schema_id: 'schema_id_example', traits: 3.56}) # CreateIdentity |
|
62
67
|
}
|
63
68
|
|
64
69
|
begin
|
@@ -73,7 +78,7 @@ end
|
|
73
78
|
|
74
79
|
## Documentation for API Endpoints
|
75
80
|
|
76
|
-
All URIs are relative to *
|
81
|
+
All URIs are relative to *https://demo.tenants.oryapis.com/api/kratos/public*
|
77
82
|
|
78
83
|
Class | Method | HTTP request | Description
|
79
84
|
------------ | ------------- | ------------- | -------------
|
@@ -88,18 +93,12 @@ Class | Method | HTTP request | Description
|
|
88
93
|
*OryHydraClient::AdminApi* | [**get_self_service_registration_flow**](docs/AdminApi.md#get_self_service_registration_flow) | **GET** /self-service/registration/flows | Get Registration Flow
|
89
94
|
*OryHydraClient::AdminApi* | [**get_self_service_settings_flow**](docs/AdminApi.md#get_self_service_settings_flow) | **GET** /self-service/settings/flows | Get Settings Flow
|
90
95
|
*OryHydraClient::AdminApi* | [**get_self_service_verification_flow**](docs/AdminApi.md#get_self_service_verification_flow) | **GET** /self-service/verification/flows | Get Verification Flow
|
96
|
+
*OryHydraClient::AdminApi* | [**get_version**](docs/AdminApi.md#get_version) | **GET** /version | Return Running Software Version.
|
97
|
+
*OryHydraClient::AdminApi* | [**is_alive**](docs/AdminApi.md#is_alive) | **GET** /health/alive | Check HTTP Server Status
|
98
|
+
*OryHydraClient::AdminApi* | [**is_ready**](docs/AdminApi.md#is_ready) | **GET** /health/ready | Check HTTP Server and Database Status
|
91
99
|
*OryHydraClient::AdminApi* | [**list_identities**](docs/AdminApi.md#list_identities) | **GET** /identities | List Identities
|
92
100
|
*OryHydraClient::AdminApi* | [**prometheus**](docs/AdminApi.md#prometheus) | **GET** /metrics/prometheus | Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
|
93
101
|
*OryHydraClient::AdminApi* | [**update_identity**](docs/AdminApi.md#update_identity) | **PUT** /identities/{id} | Update an Identity
|
94
|
-
*OryHydraClient::HealthApi* | [**is_instance_alive**](docs/HealthApi.md#is_instance_alive) | **GET** /health/alive | Check alive status
|
95
|
-
*OryHydraClient::HealthApi* | [**is_instance_ready**](docs/HealthApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status
|
96
|
-
*OryHydraClient::PublicApi* | [**complete_self_service_browser_settings_oidc_settings_flow**](docs/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
|
97
|
-
*OryHydraClient::PublicApi* | [**complete_self_service_login_flow_with_password_method**](docs/PublicApi.md#complete_self_service_login_flow_with_password_method) | **POST** /self-service/login/methods/password | Complete Login Flow with Username/Email Password Method
|
98
|
-
*OryHydraClient::PublicApi* | [**complete_self_service_recovery_flow_with_link_method**](docs/PublicApi.md#complete_self_service_recovery_flow_with_link_method) | **POST** /self-service/recovery/methods/link | Complete Recovery Flow with Link Method
|
99
|
-
*OryHydraClient::PublicApi* | [**complete_self_service_registration_flow_with_password_method**](docs/PublicApi.md#complete_self_service_registration_flow_with_password_method) | **POST** /self-service/registration/methods/password | Complete Registration Flow with Username/Email Password Method
|
100
|
-
*OryHydraClient::PublicApi* | [**complete_self_service_settings_flow_with_password_method**](docs/PublicApi.md#complete_self_service_settings_flow_with_password_method) | **POST** /self-service/settings/methods/password | Complete Settings Flow with Username/Email Password Method
|
101
|
-
*OryHydraClient::PublicApi* | [**complete_self_service_settings_flow_with_profile_method**](docs/PublicApi.md#complete_self_service_settings_flow_with_profile_method) | **POST** /self-service/settings/methods/profile | Complete Settings Flow with Profile Method
|
102
|
-
*OryHydraClient::PublicApi* | [**complete_self_service_verification_flow_with_link_method**](docs/PublicApi.md#complete_self_service_verification_flow_with_link_method) | **POST** /self-service/verification/methods/link | Complete Verification Flow with Link Method
|
103
102
|
*OryHydraClient::PublicApi* | [**get_schema**](docs/PublicApi.md#get_schema) | **GET** /schemas/{id} |
|
104
103
|
*OryHydraClient::PublicApi* | [**get_self_service_error**](docs/PublicApi.md#get_self_service_error) | **GET** /self-service/errors | Get User-Facing Self-Service Errors
|
105
104
|
*OryHydraClient::PublicApi* | [**get_self_service_login_flow**](docs/PublicApi.md#get_self_service_login_flow) | **GET** /self-service/login/flows | Get Login Flow
|
@@ -118,57 +117,107 @@ Class | Method | HTTP request | Description
|
|
118
117
|
*OryHydraClient::PublicApi* | [**initialize_self_service_settings_via_browser_flow**](docs/PublicApi.md#initialize_self_service_settings_via_browser_flow) | **GET** /self-service/settings/browser | Initialize Settings Flow for Browsers
|
119
118
|
*OryHydraClient::PublicApi* | [**initialize_self_service_verification_via_api_flow**](docs/PublicApi.md#initialize_self_service_verification_via_api_flow) | **GET** /self-service/verification/api | Initialize Verification Flow for API Clients
|
120
119
|
*OryHydraClient::PublicApi* | [**initialize_self_service_verification_via_browser_flow**](docs/PublicApi.md#initialize_self_service_verification_via_browser_flow) | **GET** /self-service/verification/browser | Initialize Verification Flow for Browser Clients
|
121
|
-
*OryHydraClient::PublicApi* | [**revoke_session**](docs/PublicApi.md#revoke_session) | **DELETE** /sessions |
|
120
|
+
*OryHydraClient::PublicApi* | [**revoke_session**](docs/PublicApi.md#revoke_session) | **DELETE** /sessions | Initialize Logout Flow for API Clients - Revoke a Session
|
121
|
+
*OryHydraClient::PublicApi* | [**submit_self_service_login_flow**](docs/PublicApi.md#submit_self_service_login_flow) | **POST** /self-service/login | Submit a Login Flow
|
122
|
+
*OryHydraClient::PublicApi* | [**submit_self_service_recovery_flow**](docs/PublicApi.md#submit_self_service_recovery_flow) | **POST** /self-service/recovery | Complete Recovery Flow
|
123
|
+
*OryHydraClient::PublicApi* | [**submit_self_service_recovery_flow_with_link_method**](docs/PublicApi.md#submit_self_service_recovery_flow_with_link_method) | **POST** /self-service/recovery/methods/link | Complete Recovery Flow with Link Method
|
124
|
+
*OryHydraClient::PublicApi* | [**submit_self_service_registration_flow**](docs/PublicApi.md#submit_self_service_registration_flow) | **POST** /self-service/registration | Submit a Registration Flow
|
125
|
+
*OryHydraClient::PublicApi* | [**submit_self_service_settings_flow**](docs/PublicApi.md#submit_self_service_settings_flow) | **POST** /self-service/settings | Complete Settings Flow
|
126
|
+
*OryHydraClient::PublicApi* | [**submit_self_service_verification_flow**](docs/PublicApi.md#submit_self_service_verification_flow) | **POST** /self-service/verification/methods/link | Complete Verification Flow
|
122
127
|
*OryHydraClient::PublicApi* | [**whoami**](docs/PublicApi.md#whoami) | **GET** /sessions/whoami | Check Who the Current HTTP Session Belongs To
|
123
|
-
*OryHydraClient::VersionApi* | [**get_version**](docs/VersionApi.md#get_version) | **GET** /version | Get service version
|
124
128
|
|
125
129
|
|
126
130
|
## Documentation for Models
|
127
131
|
|
128
|
-
- [OryHydraClient::
|
129
|
-
- [OryHydraClient::
|
130
|
-
- [OryHydraClient::
|
131
|
-
- [OryHydraClient::
|
132
|
+
- [OryHydraClient::AuthenticateOKBody](docs/AuthenticateOKBody.md)
|
133
|
+
- [OryHydraClient::ContainerChangeResponseItem](docs/ContainerChangeResponseItem.md)
|
134
|
+
- [OryHydraClient::ContainerCreateCreatedBody](docs/ContainerCreateCreatedBody.md)
|
135
|
+
- [OryHydraClient::ContainerTopOKBody](docs/ContainerTopOKBody.md)
|
136
|
+
- [OryHydraClient::ContainerUpdateOKBody](docs/ContainerUpdateOKBody.md)
|
137
|
+
- [OryHydraClient::ContainerWaitOKBody](docs/ContainerWaitOKBody.md)
|
138
|
+
- [OryHydraClient::ContainerWaitOKBodyError](docs/ContainerWaitOKBodyError.md)
|
132
139
|
- [OryHydraClient::CreateIdentity](docs/CreateIdentity.md)
|
133
140
|
- [OryHydraClient::CreateRecoveryLink](docs/CreateRecoveryLink.md)
|
134
141
|
- [OryHydraClient::ErrorContainer](docs/ErrorContainer.md)
|
135
|
-
- [OryHydraClient::
|
142
|
+
- [OryHydraClient::ErrorResponse](docs/ErrorResponse.md)
|
136
143
|
- [OryHydraClient::GenericError](docs/GenericError.md)
|
137
144
|
- [OryHydraClient::GenericErrorPayload](docs/GenericErrorPayload.md)
|
145
|
+
- [OryHydraClient::GraphDriverData](docs/GraphDriverData.md)
|
138
146
|
- [OryHydraClient::HealthNotReadyStatus](docs/HealthNotReadyStatus.md)
|
139
147
|
- [OryHydraClient::HealthStatus](docs/HealthStatus.md)
|
148
|
+
- [OryHydraClient::IdResponse](docs/IdResponse.md)
|
140
149
|
- [OryHydraClient::Identity](docs/Identity.md)
|
150
|
+
- [OryHydraClient::IdentityCredentials](docs/IdentityCredentials.md)
|
151
|
+
- [OryHydraClient::ImageDeleteResponseItem](docs/ImageDeleteResponseItem.md)
|
152
|
+
- [OryHydraClient::ImageSummary](docs/ImageSummary.md)
|
153
|
+
- [OryHydraClient::InlineResponse200](docs/InlineResponse200.md)
|
154
|
+
- [OryHydraClient::InlineResponse2001](docs/InlineResponse2001.md)
|
155
|
+
- [OryHydraClient::InlineResponse503](docs/InlineResponse503.md)
|
141
156
|
- [OryHydraClient::LoginFlow](docs/LoginFlow.md)
|
142
|
-
- [OryHydraClient::LoginFlowMethod](docs/LoginFlowMethod.md)
|
143
|
-
- [OryHydraClient::LoginFlowMethodConfig](docs/LoginFlowMethodConfig.md)
|
144
157
|
- [OryHydraClient::LoginViaApiResponse](docs/LoginViaApiResponse.md)
|
145
|
-
- [OryHydraClient::
|
158
|
+
- [OryHydraClient::Meta](docs/Meta.md)
|
159
|
+
- [OryHydraClient::Plugin](docs/Plugin.md)
|
160
|
+
- [OryHydraClient::PluginConfig](docs/PluginConfig.md)
|
161
|
+
- [OryHydraClient::PluginConfigArgs](docs/PluginConfigArgs.md)
|
162
|
+
- [OryHydraClient::PluginConfigInterface](docs/PluginConfigInterface.md)
|
163
|
+
- [OryHydraClient::PluginConfigLinux](docs/PluginConfigLinux.md)
|
164
|
+
- [OryHydraClient::PluginConfigNetwork](docs/PluginConfigNetwork.md)
|
165
|
+
- [OryHydraClient::PluginConfigRootfs](docs/PluginConfigRootfs.md)
|
166
|
+
- [OryHydraClient::PluginConfigUser](docs/PluginConfigUser.md)
|
167
|
+
- [OryHydraClient::PluginDevice](docs/PluginDevice.md)
|
168
|
+
- [OryHydraClient::PluginEnv](docs/PluginEnv.md)
|
169
|
+
- [OryHydraClient::PluginInterfaceType](docs/PluginInterfaceType.md)
|
170
|
+
- [OryHydraClient::PluginMount](docs/PluginMount.md)
|
171
|
+
- [OryHydraClient::PluginSettings](docs/PluginSettings.md)
|
172
|
+
- [OryHydraClient::Port](docs/Port.md)
|
146
173
|
- [OryHydraClient::RecoveryAddress](docs/RecoveryAddress.md)
|
147
174
|
- [OryHydraClient::RecoveryFlow](docs/RecoveryFlow.md)
|
148
|
-
- [OryHydraClient::RecoveryFlowMethod](docs/RecoveryFlowMethod.md)
|
149
|
-
- [OryHydraClient::RecoveryFlowMethodConfig](docs/RecoveryFlowMethodConfig.md)
|
150
175
|
- [OryHydraClient::RecoveryLink](docs/RecoveryLink.md)
|
151
176
|
- [OryHydraClient::RegistrationFlow](docs/RegistrationFlow.md)
|
152
|
-
- [OryHydraClient::RegistrationFlowMethod](docs/RegistrationFlowMethod.md)
|
153
|
-
- [OryHydraClient::RegistrationFlowMethodConfig](docs/RegistrationFlowMethodConfig.md)
|
154
177
|
- [OryHydraClient::RegistrationViaApiResponse](docs/RegistrationViaApiResponse.md)
|
155
178
|
- [OryHydraClient::RevokeSession](docs/RevokeSession.md)
|
179
|
+
- [OryHydraClient::ServiceUpdateResponse](docs/ServiceUpdateResponse.md)
|
156
180
|
- [OryHydraClient::Session](docs/Session.md)
|
157
181
|
- [OryHydraClient::SettingsFlow](docs/SettingsFlow.md)
|
158
|
-
- [OryHydraClient::
|
159
|
-
- [OryHydraClient::SettingsFlowMethodConfig](docs/SettingsFlowMethodConfig.md)
|
182
|
+
- [OryHydraClient::SettingsProfileFormConfig](docs/SettingsProfileFormConfig.md)
|
160
183
|
- [OryHydraClient::SettingsViaApiResponse](docs/SettingsViaApiResponse.md)
|
184
|
+
- [OryHydraClient::SubmitSelfServiceBrowserSettingsOIDCFlowPayload](docs/SubmitSelfServiceBrowserSettingsOIDCFlowPayload.md)
|
185
|
+
- [OryHydraClient::SubmitSelfServiceLoginFlow](docs/SubmitSelfServiceLoginFlow.md)
|
186
|
+
- [OryHydraClient::SubmitSelfServiceLoginFlowWithPasswordMethod](docs/SubmitSelfServiceLoginFlowWithPasswordMethod.md)
|
187
|
+
- [OryHydraClient::SubmitSelfServiceRecoveryFlowWithLinkMethod](docs/SubmitSelfServiceRecoveryFlowWithLinkMethod.md)
|
188
|
+
- [OryHydraClient::SubmitSelfServiceRegistrationFlow](docs/SubmitSelfServiceRegistrationFlow.md)
|
189
|
+
- [OryHydraClient::SubmitSelfServiceRegistrationFlowWithPasswordMethod](docs/SubmitSelfServiceRegistrationFlowWithPasswordMethod.md)
|
190
|
+
- [OryHydraClient::SubmitSelfServiceSettingsFlow](docs/SubmitSelfServiceSettingsFlow.md)
|
191
|
+
- [OryHydraClient::SubmitSelfServiceSettingsFlowWithPasswordMethod](docs/SubmitSelfServiceSettingsFlowWithPasswordMethod.md)
|
192
|
+
- [OryHydraClient::SubmitSelfServiceSettingsFlowWithProfileMethod](docs/SubmitSelfServiceSettingsFlowWithProfileMethod.md)
|
193
|
+
- [OryHydraClient::SubmitSelfServiceVerificationFlowWithLinkMethod](docs/SubmitSelfServiceVerificationFlowWithLinkMethod.md)
|
194
|
+
- [OryHydraClient::UiContainer](docs/UiContainer.md)
|
195
|
+
- [OryHydraClient::UiNode](docs/UiNode.md)
|
196
|
+
- [OryHydraClient::UiNodeAnchorAttributes](docs/UiNodeAnchorAttributes.md)
|
197
|
+
- [OryHydraClient::UiNodeAttributes](docs/UiNodeAttributes.md)
|
198
|
+
- [OryHydraClient::UiNodeImageAttributes](docs/UiNodeImageAttributes.md)
|
199
|
+
- [OryHydraClient::UiNodeInputAttributes](docs/UiNodeInputAttributes.md)
|
200
|
+
- [OryHydraClient::UiNodeInputAttributesValue](docs/UiNodeInputAttributesValue.md)
|
201
|
+
- [OryHydraClient::UiNodeTextAttributes](docs/UiNodeTextAttributes.md)
|
202
|
+
- [OryHydraClient::UiText](docs/UiText.md)
|
161
203
|
- [OryHydraClient::UpdateIdentity](docs/UpdateIdentity.md)
|
162
204
|
- [OryHydraClient::VerifiableAddress](docs/VerifiableAddress.md)
|
163
205
|
- [OryHydraClient::VerificationFlow](docs/VerificationFlow.md)
|
164
|
-
- [OryHydraClient::VerificationFlowMethod](docs/VerificationFlowMethod.md)
|
165
|
-
- [OryHydraClient::VerificationFlowMethodConfig](docs/VerificationFlowMethodConfig.md)
|
166
206
|
- [OryHydraClient::Version](docs/Version.md)
|
207
|
+
- [OryHydraClient::Volume](docs/Volume.md)
|
208
|
+
- [OryHydraClient::VolumeUsageData](docs/VolumeUsageData.md)
|
167
209
|
|
168
210
|
|
169
211
|
## Documentation for Authorization
|
170
212
|
|
171
213
|
|
214
|
+
### sessionCookie
|
215
|
+
|
216
|
+
|
217
|
+
- **Type**: API key
|
218
|
+
- **API key parameter name**: ory_kratos_session
|
219
|
+
- **Location**:
|
220
|
+
|
172
221
|
### sessionToken
|
173
222
|
|
174
223
|
|
data/docs/AdminApi.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# OryHydraClient::AdminApi
|
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
|
| ------ | ------------ | ----------- |
|
@@ -15,6 +15,9 @@ All URIs are relative to *http://localhost*
|
|
15
15
|
| [**get_self_service_registration_flow**](AdminApi.md#get_self_service_registration_flow) | **GET** /self-service/registration/flows | Get Registration Flow |
|
16
16
|
| [**get_self_service_settings_flow**](AdminApi.md#get_self_service_settings_flow) | **GET** /self-service/settings/flows | Get Settings Flow |
|
17
17
|
| [**get_self_service_verification_flow**](AdminApi.md#get_self_service_verification_flow) | **GET** /self-service/verification/flows | Get Verification Flow |
|
18
|
+
| [**get_version**](AdminApi.md#get_version) | **GET** /version | Return Running Software Version. |
|
19
|
+
| [**is_alive**](AdminApi.md#is_alive) | **GET** /health/alive | Check HTTP Server Status |
|
20
|
+
| [**is_ready**](AdminApi.md#is_ready) | **GET** /health/ready | Check HTTP Server and Database Status |
|
18
21
|
| [**list_identities**](AdminApi.md#list_identities) | **GET** /identities | List Identities |
|
19
22
|
| [**prometheus**](AdminApi.md#prometheus) | **GET** /metrics/prometheus | Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so: |
|
20
23
|
| [**update_identity**](AdminApi.md#update_identity) | **PUT** /identities/{id} | Update an Identity |
|
@@ -26,7 +29,7 @@ All URIs are relative to *http://localhost*
|
|
26
29
|
|
27
30
|
Create an Identity
|
28
31
|
|
29
|
-
This endpoint creates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future. Learn how identities work in [
|
32
|
+
This endpoint creates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
30
33
|
|
31
34
|
### Examples
|
32
35
|
|
@@ -36,7 +39,7 @@ require 'ory-kratos-client'
|
|
36
39
|
|
37
40
|
api_instance = OryHydraClient::AdminApi.new
|
38
41
|
opts = {
|
39
|
-
|
42
|
+
create_identity: OryHydraClient::CreateIdentity.new({schema_id: 'schema_id_example', traits: 3.56}) # CreateIdentity |
|
40
43
|
}
|
41
44
|
|
42
45
|
begin
|
@@ -70,7 +73,7 @@ end
|
|
70
73
|
|
71
74
|
| Name | Type | Description | Notes |
|
72
75
|
| ---- | ---- | ----------- | ----- |
|
73
|
-
| **
|
76
|
+
| **create_identity** | [**CreateIdentity**](CreateIdentity.md) | | [optional] |
|
74
77
|
|
75
78
|
### Return type
|
76
79
|
|
@@ -102,7 +105,7 @@ require 'ory-kratos-client'
|
|
102
105
|
|
103
106
|
api_instance = OryHydraClient::AdminApi.new
|
104
107
|
opts = {
|
105
|
-
|
108
|
+
create_recovery_link: OryHydraClient::CreateRecoveryLink.new({identity_id: 'identity_id_example'}) # CreateRecoveryLink |
|
106
109
|
}
|
107
110
|
|
108
111
|
begin
|
@@ -136,7 +139,7 @@ end
|
|
136
139
|
|
137
140
|
| Name | Type | Description | Notes |
|
138
141
|
| ---- | ---- | ----------- | ----- |
|
139
|
-
| **
|
142
|
+
| **create_recovery_link** | [**CreateRecoveryLink**](CreateRecoveryLink.md) | | [optional] |
|
140
143
|
|
141
144
|
### Return type
|
142
145
|
|
@@ -158,7 +161,7 @@ No authorization required
|
|
158
161
|
|
159
162
|
Delete an Identity
|
160
163
|
|
161
|
-
Calling this endpoint irrecoverably and permanently deletes the identity given its ID. This action can not be undone. This endpoint returns 204 when the identity was deleted or when the identity was not found, in which case it is assumed that is has been deleted already. Learn how identities work in [
|
164
|
+
Calling this endpoint irrecoverably and permanently deletes the identity given its ID. This action can not be undone. This endpoint returns 204 when the identity was deleted or when the identity was not found, in which case it is assumed that is has been deleted already. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
162
165
|
|
163
166
|
### Examples
|
164
167
|
|
@@ -221,7 +224,7 @@ No authorization required
|
|
221
224
|
|
222
225
|
Get an Identity
|
223
226
|
|
224
|
-
Learn how identities work in [
|
227
|
+
Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
225
228
|
|
226
229
|
### Examples
|
227
230
|
|
@@ -349,7 +352,7 @@ No authorization required
|
|
349
352
|
|
350
353
|
Get User-Facing Self-Service Errors
|
351
354
|
|
352
|
-
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 [
|
355
|
+
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).
|
353
356
|
|
354
357
|
### Examples
|
355
358
|
|
@@ -413,7 +416,7 @@ No authorization required
|
|
413
416
|
|
414
417
|
Get Login Flow
|
415
418
|
|
416
|
-
This endpoint returns a login flow's context with, for example, error details and other information. More information can be found at [
|
419
|
+
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).
|
417
420
|
|
418
421
|
### Examples
|
419
422
|
|
@@ -477,7 +480,7 @@ No authorization required
|
|
477
480
|
|
478
481
|
Get information about a recovery flow
|
479
482
|
|
480
|
-
This endpoint returns a recovery flow's context with, for example, error details and other information. More information can be found at [
|
483
|
+
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).
|
481
484
|
|
482
485
|
### Examples
|
483
486
|
|
@@ -541,7 +544,7 @@ No authorization required
|
|
541
544
|
|
542
545
|
Get Registration Flow
|
543
546
|
|
544
|
-
This endpoint returns a registration flow's context with, for example, error details and other information. More information can be found at [
|
547
|
+
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).
|
545
548
|
|
546
549
|
### Examples
|
547
550
|
|
@@ -605,7 +608,7 @@ No authorization required
|
|
605
608
|
|
606
609
|
Get Settings Flow
|
607
610
|
|
608
|
-
When accessing this endpoint through
|
611
|
+
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).
|
609
612
|
|
610
613
|
### Examples
|
611
614
|
|
@@ -615,9 +618,9 @@ require 'ory-kratos-client'
|
|
615
618
|
# setup authorization
|
616
619
|
OryHydraClient.configure do |config|
|
617
620
|
# Configure API key authorization: sessionToken
|
618
|
-
config.api_key['
|
621
|
+
config.api_key['sessionToken'] = 'YOUR API KEY'
|
619
622
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
620
|
-
# config.api_key_prefix['
|
623
|
+
# config.api_key_prefix['sessionToken'] = 'Bearer'
|
621
624
|
end
|
622
625
|
|
623
626
|
api_instance = OryHydraClient::AdminApi.new
|
@@ -676,7 +679,7 @@ end
|
|
676
679
|
|
677
680
|
Get Verification Flow
|
678
681
|
|
679
|
-
This endpoint returns a verification flow's context with, for example, error details and other information. More information can be found at [
|
682
|
+
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).
|
680
683
|
|
681
684
|
### Examples
|
682
685
|
|
@@ -734,13 +737,196 @@ No authorization required
|
|
734
737
|
- **Accept**: application/json
|
735
738
|
|
736
739
|
|
740
|
+
## get_version
|
741
|
+
|
742
|
+
> <InlineResponse2001> get_version
|
743
|
+
|
744
|
+
Return Running Software Version.
|
745
|
+
|
746
|
+
This endpoint returns the version of Ory Kratos. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the version will never refer to the cluster state, only to a single instance.
|
747
|
+
|
748
|
+
### Examples
|
749
|
+
|
750
|
+
```ruby
|
751
|
+
require 'time'
|
752
|
+
require 'ory-kratos-client'
|
753
|
+
|
754
|
+
api_instance = OryHydraClient::AdminApi.new
|
755
|
+
|
756
|
+
begin
|
757
|
+
# Return Running Software Version.
|
758
|
+
result = api_instance.get_version
|
759
|
+
p result
|
760
|
+
rescue OryHydraClient::ApiError => e
|
761
|
+
puts "Error when calling AdminApi->get_version: #{e}"
|
762
|
+
end
|
763
|
+
```
|
764
|
+
|
765
|
+
#### Using the get_version_with_http_info variant
|
766
|
+
|
767
|
+
This returns an Array which contains the response data, status code and headers.
|
768
|
+
|
769
|
+
> <Array(<InlineResponse2001>, Integer, Hash)> get_version_with_http_info
|
770
|
+
|
771
|
+
```ruby
|
772
|
+
begin
|
773
|
+
# Return Running Software Version.
|
774
|
+
data, status_code, headers = api_instance.get_version_with_http_info
|
775
|
+
p status_code # => 2xx
|
776
|
+
p headers # => { ... }
|
777
|
+
p data # => <InlineResponse2001>
|
778
|
+
rescue OryHydraClient::ApiError => e
|
779
|
+
puts "Error when calling AdminApi->get_version_with_http_info: #{e}"
|
780
|
+
end
|
781
|
+
```
|
782
|
+
|
783
|
+
### Parameters
|
784
|
+
|
785
|
+
This endpoint does not need any parameter.
|
786
|
+
|
787
|
+
### Return type
|
788
|
+
|
789
|
+
[**InlineResponse2001**](InlineResponse2001.md)
|
790
|
+
|
791
|
+
### Authorization
|
792
|
+
|
793
|
+
No authorization required
|
794
|
+
|
795
|
+
### HTTP request headers
|
796
|
+
|
797
|
+
- **Content-Type**: Not defined
|
798
|
+
- **Accept**: application/json
|
799
|
+
|
800
|
+
|
801
|
+
## is_alive
|
802
|
+
|
803
|
+
> <InlineResponse200> is_alive
|
804
|
+
|
805
|
+
Check HTTP Server Status
|
806
|
+
|
807
|
+
This endpoint returns a HTTP 200 status code when Ory Kratos is accepting incoming HTTP requests. This status does currently not include checks whether the database connection is working. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.
|
808
|
+
|
809
|
+
### Examples
|
810
|
+
|
811
|
+
```ruby
|
812
|
+
require 'time'
|
813
|
+
require 'ory-kratos-client'
|
814
|
+
|
815
|
+
api_instance = OryHydraClient::AdminApi.new
|
816
|
+
|
817
|
+
begin
|
818
|
+
# Check HTTP Server Status
|
819
|
+
result = api_instance.is_alive
|
820
|
+
p result
|
821
|
+
rescue OryHydraClient::ApiError => e
|
822
|
+
puts "Error when calling AdminApi->is_alive: #{e}"
|
823
|
+
end
|
824
|
+
```
|
825
|
+
|
826
|
+
#### Using the is_alive_with_http_info variant
|
827
|
+
|
828
|
+
This returns an Array which contains the response data, status code and headers.
|
829
|
+
|
830
|
+
> <Array(<InlineResponse200>, Integer, Hash)> is_alive_with_http_info
|
831
|
+
|
832
|
+
```ruby
|
833
|
+
begin
|
834
|
+
# Check HTTP Server Status
|
835
|
+
data, status_code, headers = api_instance.is_alive_with_http_info
|
836
|
+
p status_code # => 2xx
|
837
|
+
p headers # => { ... }
|
838
|
+
p data # => <InlineResponse200>
|
839
|
+
rescue OryHydraClient::ApiError => e
|
840
|
+
puts "Error when calling AdminApi->is_alive_with_http_info: #{e}"
|
841
|
+
end
|
842
|
+
```
|
843
|
+
|
844
|
+
### Parameters
|
845
|
+
|
846
|
+
This endpoint does not need any parameter.
|
847
|
+
|
848
|
+
### Return type
|
849
|
+
|
850
|
+
[**InlineResponse200**](InlineResponse200.md)
|
851
|
+
|
852
|
+
### Authorization
|
853
|
+
|
854
|
+
No authorization required
|
855
|
+
|
856
|
+
### HTTP request headers
|
857
|
+
|
858
|
+
- **Content-Type**: Not defined
|
859
|
+
- **Accept**: application/json
|
860
|
+
|
861
|
+
|
862
|
+
## is_ready
|
863
|
+
|
864
|
+
> <InlineResponse200> is_ready
|
865
|
+
|
866
|
+
Check HTTP Server and Database Status
|
867
|
+
|
868
|
+
This endpoint returns a HTTP 200 status code when Ory Kratos is up running and the environment dependencies (e.g. the database) are responsive as well. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of Ory Kratos, the health status will never refer to the cluster state, only to a single instance.
|
869
|
+
|
870
|
+
### Examples
|
871
|
+
|
872
|
+
```ruby
|
873
|
+
require 'time'
|
874
|
+
require 'ory-kratos-client'
|
875
|
+
|
876
|
+
api_instance = OryHydraClient::AdminApi.new
|
877
|
+
|
878
|
+
begin
|
879
|
+
# Check HTTP Server and Database Status
|
880
|
+
result = api_instance.is_ready
|
881
|
+
p result
|
882
|
+
rescue OryHydraClient::ApiError => e
|
883
|
+
puts "Error when calling AdminApi->is_ready: #{e}"
|
884
|
+
end
|
885
|
+
```
|
886
|
+
|
887
|
+
#### Using the is_ready_with_http_info variant
|
888
|
+
|
889
|
+
This returns an Array which contains the response data, status code and headers.
|
890
|
+
|
891
|
+
> <Array(<InlineResponse200>, Integer, Hash)> is_ready_with_http_info
|
892
|
+
|
893
|
+
```ruby
|
894
|
+
begin
|
895
|
+
# Check HTTP Server and Database Status
|
896
|
+
data, status_code, headers = api_instance.is_ready_with_http_info
|
897
|
+
p status_code # => 2xx
|
898
|
+
p headers # => { ... }
|
899
|
+
p data # => <InlineResponse200>
|
900
|
+
rescue OryHydraClient::ApiError => e
|
901
|
+
puts "Error when calling AdminApi->is_ready_with_http_info: #{e}"
|
902
|
+
end
|
903
|
+
```
|
904
|
+
|
905
|
+
### Parameters
|
906
|
+
|
907
|
+
This endpoint does not need any parameter.
|
908
|
+
|
909
|
+
### Return type
|
910
|
+
|
911
|
+
[**InlineResponse200**](InlineResponse200.md)
|
912
|
+
|
913
|
+
### Authorization
|
914
|
+
|
915
|
+
No authorization required
|
916
|
+
|
917
|
+
### HTTP request headers
|
918
|
+
|
919
|
+
- **Content-Type**: Not defined
|
920
|
+
- **Accept**: application/json
|
921
|
+
|
922
|
+
|
737
923
|
## list_identities
|
738
924
|
|
739
925
|
> <Array<Identity>> list_identities(opts)
|
740
926
|
|
741
927
|
List Identities
|
742
928
|
|
743
|
-
Lists all identities. Does not support search at the moment. Learn how identities work in [
|
929
|
+
Lists all identities. Does not support search at the moment. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
744
930
|
|
745
931
|
### Examples
|
746
932
|
|
@@ -868,7 +1054,7 @@ No authorization required
|
|
868
1054
|
|
869
1055
|
Update an Identity
|
870
1056
|
|
871
|
-
This endpoint updates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future. The full identity payload (except credentials) is expected. This endpoint does not support patching. Learn how identities work in [
|
1057
|
+
This endpoint updates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future. The full identity payload (except credentials) is expected. This endpoint does not support patching. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
872
1058
|
|
873
1059
|
### Examples
|
874
1060
|
|
@@ -879,7 +1065,7 @@ require 'ory-kratos-client'
|
|
879
1065
|
api_instance = OryHydraClient::AdminApi.new
|
880
1066
|
id = 'id_example' # String | ID must be set to the ID of identity you want to update
|
881
1067
|
opts = {
|
882
|
-
|
1068
|
+
update_identity: OryHydraClient::UpdateIdentity.new({traits: 3.56}) # UpdateIdentity |
|
883
1069
|
}
|
884
1070
|
|
885
1071
|
begin
|
@@ -914,7 +1100,7 @@ end
|
|
914
1100
|
| Name | Type | Description | Notes |
|
915
1101
|
| ---- | ---- | ----------- | ----- |
|
916
1102
|
| **id** | **String** | ID must be set to the ID of identity you want to update | |
|
917
|
-
| **
|
1103
|
+
| **update_identity** | [**UpdateIdentity**](UpdateIdentity.md) | | [optional] |
|
918
1104
|
|
919
1105
|
### Return type
|
920
1106
|
|