ory-kratos-client 0.5.4.alpha1 → 0.6.0.alpha2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +86 -37
- data/docs/AdminApi.md +582 -157
- 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/CreateIdentity.md +10 -9
- data/docs/CreateRecoveryLink.md +10 -9
- data/docs/ErrorContainer.md +10 -9
- data/docs/ErrorResponse.md +18 -0
- data/docs/GenericError.md +8 -7
- data/docs/GenericErrorPayload.md +20 -19
- data/docs/GraphDriverData.md +20 -0
- data/docs/HealthNotReadyStatus.md +8 -7
- data/docs/HealthStatus.md +8 -7
- data/docs/IdResponse.md +18 -0
- data/docs/Identity.md +18 -17
- 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 +22 -23
- data/docs/LoginViaApiResponse.md +10 -9
- 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 +891 -492
- data/docs/RecoveryAddress.md +12 -11
- data/docs/RecoveryFlow.md +22 -23
- data/docs/RecoveryLink.md +10 -9
- data/docs/RegistrationFlow.md +20 -21
- data/docs/RegistrationViaApiResponse.md +12 -11
- data/docs/RevokeSession.md +8 -7
- data/docs/ServiceUpdateResponse.md +18 -0
- data/docs/Session.md +18 -17
- data/docs/SettingsFlow.md +24 -25
- data/docs/SettingsProfileFormConfig.md +24 -0
- data/docs/SettingsViaApiResponse.md +10 -9
- data/docs/SubmitSelfServiceBrowserSettingsOIDCFlowPayload.md +22 -0
- data/docs/SubmitSelfServiceLoginFlow.md +47 -0
- data/docs/SubmitSelfServiceLoginFlowWithPasswordMethod.md +24 -0
- data/docs/SubmitSelfServiceRecoveryFlowWithLinkMethod.md +20 -0
- data/docs/SubmitSelfServiceRegistrationFlow.md +47 -0
- data/docs/SubmitSelfServiceRegistrationFlowWithPasswordMethod.md +24 -0
- data/docs/SubmitSelfServiceSettingsFlow.md +49 -0
- data/docs/SubmitSelfServiceSettingsFlowWithPasswordMethod.md +22 -0
- data/docs/SubmitSelfServiceSettingsFlowWithProfileMethod.md +22 -0
- data/docs/SubmitSelfServiceVerificationFlowWithLinkMethod.md +20 -0
- data/docs/UiContainer.md +24 -0
- 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/UpdateIdentity.md +10 -9
- data/docs/VerifiableAddress.md +18 -17
- data/docs/VerificationFlow.md +22 -23
- data/docs/Version.md +8 -7
- 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 +260 -75
- data/lib/ory-kratos-client/api/public_api.rb +535 -552
- data/lib/ory-kratos-client/api_client.rb +54 -52
- data/lib/ory-kratos-client/api_error.rb +5 -5
- data/lib/ory-kratos-client/configuration.rb +68 -18
- 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/{recovery_flow_method_config.rb → container_create_created_body.rb} +49 -62
- 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/{request_method_config.rb → container_wait_ok_body.rb} +47 -63
- data/lib/ory-kratos-client/models/{error.rb → container_wait_ok_body_error.rb} +29 -16
- data/lib/ory-kratos-client/models/create_identity.rb +23 -11
- data/lib/ory-kratos-client/models/create_recovery_link.rb +23 -11
- data/lib/ory-kratos-client/models/error_container.rb +27 -13
- data/lib/ory-kratos-client/models/error_response.rb +224 -0
- data/lib/ory-kratos-client/models/generic_error.rb +23 -11
- data/lib/ory-kratos-client/models/generic_error_payload.rb +27 -13
- data/lib/ory-kratos-client/models/graph_driver_data.rb +241 -0
- data/lib/ory-kratos-client/models/health_not_ready_status.rb +23 -11
- data/lib/ory-kratos-client/models/health_status.rb +23 -11
- data/lib/ory-kratos-client/models/id_response.rb +225 -0
- data/lib/ory-kratos-client/models/identity.rb +23 -11
- data/lib/ory-kratos-client/models/identity_credentials.rb +241 -0
- data/lib/ory-kratos-client/models/image_delete_response_item.rb +230 -0
- data/lib/ory-kratos-client/models/{recovery_request.rb → image_summary.rb} +138 -81
- data/lib/ory-kratos-client/models/{login_request_method.rb → inline_response200.rb} +37 -39
- data/lib/ory-kratos-client/models/{recovery_flow_method.rb → inline_response2001.rb} +37 -39
- data/lib/ory-kratos-client/models/inline_response503.rb +226 -0
- data/lib/ory-kratos-client/models/login_flow.rb +49 -46
- data/lib/ory-kratos-client/models/login_via_api_response.rb +23 -11
- data/lib/ory-kratos-client/models/{login_flow_method.rb → meta.rb} +34 -41
- 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/{oidc_strategy_request_method.rb → plugin_config_interface.rb} +53 -63
- data/lib/ory-kratos-client/models/{login_request_method_config.rb → plugin_config_linux.rb} +60 -68
- data/lib/ory-kratos-client/models/{message.rb → plugin_config_network.rb} +35 -44
- data/lib/ory-kratos-client/models/{settings_flow_method.rb → plugin_config_rootfs.rb} +44 -38
- 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} +58 -58
- data/lib/ory-kratos-client/models/{login_request.rb → plugin_mount.rb} +105 -90
- data/lib/ory-kratos-client/models/plugin_settings.rb +277 -0
- data/lib/ory-kratos-client/models/{form.rb → port.rb} +62 -58
- data/lib/ory-kratos-client/models/recovery_address.rb +23 -11
- data/lib/ory-kratos-client/models/recovery_flow.rb +44 -46
- data/lib/ory-kratos-client/models/recovery_link.rb +24 -12
- data/lib/ory-kratos-client/models/registration_flow.rb +44 -46
- data/lib/ory-kratos-client/models/registration_via_api_response.rb +23 -11
- data/lib/ory-kratos-client/models/revoke_session.rb +23 -11
- data/lib/ory-kratos-client/models/{settings_request_method.rb → service_update_response.rb} +37 -31
- data/lib/ory-kratos-client/models/session.rb +26 -14
- data/lib/ory-kratos-client/models/settings_flow.rb +44 -46
- data/lib/ory-kratos-client/models/{login_flow_method_config.rb → settings_profile_form_config.rb} +40 -41
- data/lib/ory-kratos-client/models/settings_via_api_response.rb +23 -11
- 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} +26 -14
- data/lib/ory-kratos-client/models/submit_self_service_registration_flow.rb +104 -0
- data/lib/ory-kratos-client/models/{registration_request_method_config.rb → submit_self_service_registration_flow_with_password_method.rb} +53 -65
- 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} +37 -15
- data/lib/ory-kratos-client/models/{complete_self_service_browser_settings_strategy_profile_flow_payload.rb → submit_self_service_settings_flow_with_profile_method.rb} +46 -23
- data/lib/ory-kratos-client/models/{complete_self_service_verification_flow_with_link_method.rb → submit_self_service_verification_flow_with_link_method.rb} +27 -14
- data/lib/ory-kratos-client/models/{registration_flow_method_config.rb → ui_container.rb} +41 -41
- data/lib/ory-kratos-client/models/ui_node.rb +282 -0
- data/lib/ory-kratos-client/models/{registration_flow_method.rb → ui_node_anchor_attributes.rb} +46 -34
- data/lib/ory-kratos-client/models/ui_node_attributes.rb +107 -0
- data/lib/ory-kratos-client/models/{recovery_request_method.rb → ui_node_image_attributes.rb} +39 -31
- data/lib/ory-kratos-client/models/{form_field.rb → ui_node_input_attributes.rb} +44 -31
- data/lib/ory-kratos-client/models/ui_node_input_attributes_value.rb +106 -0
- data/lib/ory-kratos-client/models/{complete_self_service_login_flow_with_password_method.rb → ui_node_text_attributes.rb} +38 -42
- data/lib/ory-kratos-client/models/ui_text.rb +262 -0
- data/lib/ory-kratos-client/models/update_identity.rb +23 -11
- data/lib/ory-kratos-client/models/verifiable_address.rb +24 -12
- data/lib/ory-kratos-client/models/verification_flow.rb +52 -44
- data/lib/ory-kratos-client/models/version.rb +23 -11
- data/lib/ory-kratos-client/models/{settings_request.rb → volume.rb} +113 -101
- 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 +9 -10
- data/spec/api/admin_api_spec.rb +134 -41
- data/spec/api/public_api_spec.rb +268 -37
- data/spec/api_client_spec.rb +6 -6
- 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 +242 -197
- data/docs/CommonApi.md +0 -345
- data/docs/CompleteSelfServiceBrowserProfileManagementFlowPayload.md +0 -17
- data/docs/CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload.md +0 -19
- data/docs/CompleteSelfServiceLoginFlowWithPasswordMethod.md +0 -21
- data/docs/CompleteSelfServiceRecoveryFlowWithLinkMethod.md +0 -19
- data/docs/CompleteSelfServiceSettingsFlowWithPasswordMethod.md +0 -19
- data/docs/CompleteSelfServiceVerificationFlowWithLinkMethod.md +0 -19
- data/docs/Error.md +0 -17
- data/docs/Form.md +0 -23
- data/docs/FormField.md +0 -29
- data/docs/HealthApi.md +0 -96
- data/docs/LoginFlowMethod.md +0 -19
- data/docs/LoginFlowMethodConfig.md +0 -25
- data/docs/LoginRequest.md +0 -31
- data/docs/LoginRequestMethod.md +0 -19
- data/docs/LoginRequestMethodConfig.md +0 -25
- data/docs/Message.md +0 -23
- 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 -19
- data/docs/RecoveryFlowMethodConfig.md +0 -23
- data/docs/RecoveryRequest.md +0 -31
- data/docs/RecoveryRequestMethod.md +0 -19
- data/docs/RegistrationFlowMethod.md +0 -19
- data/docs/RegistrationFlowMethodConfig.md +0 -25
- 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 -19
- data/docs/SettingsFlowMethodConfig.md +0 -23
- data/docs/SettingsRequest.md +0 -33
- data/docs/SettingsRequestMethod.md +0 -19
- data/docs/VerificationFlowMethod.md +0 -19
- data/docs/VerificationFlowMethodConfig.md +0 -23
- data/docs/VerificationRequest.md +0 -31
- data/docs/VersionApi.md +0 -52
- data/lib/ory-kratos-client/api/common_api.rb +0 -456
- data/lib/ory-kratos-client/api/health_api.rb +0 -134
- data/lib/ory-kratos-client/api/version_api.rb +0 -78
- data/lib/ory-kratos-client/models/complete_self_service_browser_profile_management_flow_payload.rb +0 -212
- data/lib/ory-kratos-client/models/oidc_strategy_credentials_config.rb +0 -215
- 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/registration_request.rb +0 -294
- data/lib/ory-kratos-client/models/registration_request_method.rb +0 -216
- data/lib/ory-kratos-client/models/verification_flow_method.rb +0 -226
- data/lib/ory-kratos-client/models/verification_flow_method_config.rb +0 -255
- 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: e9525e70a418a4cebe8f7945a146d32732865eea64bed7d2d340a249b0162d13
|
4
|
+
data.tar.gz: 05f5e8759ed19c1a54e7fce47738831701d6904f6a00710c9bdf5d73d4363791
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2667592d22714a2c1bf1f98b86ec1e682854a04a492314760706db4fc17c457ab5700d69a9c94fec08d2f18060ce37ae9e95432e1845250ce09db03c01477014
|
7
|
+
data.tar.gz: 272ca9f835d96dce09ca03a07607e537be26c603110635b3b8b88aed6fa6791f5c0f9f99e595cf776721673099207e3ab84e3e3c043421443632d7472a9c6a6d
|
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.2
|
15
|
+
- Package version: v0.6.0-alpha.2
|
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.2.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.2.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.2'
|
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
|
@@ -115,60 +114,110 @@ Class | Method | HTTP request | Description
|
|
115
114
|
*OryHydraClient::PublicApi* | [**initialize_self_service_registration_via_api_flow**](docs/PublicApi.md#initialize_self_service_registration_via_api_flow) | **GET** /self-service/registration/api | Initialize Registration Flow for API clients
|
116
115
|
*OryHydraClient::PublicApi* | [**initialize_self_service_registration_via_browser_flow**](docs/PublicApi.md#initialize_self_service_registration_via_browser_flow) | **GET** /self-service/registration/browser | Initialize Registration Flow for browsers
|
117
116
|
*OryHydraClient::PublicApi* | [**initialize_self_service_settings_via_api_flow**](docs/PublicApi.md#initialize_self_service_settings_via_api_flow) | **GET** /self-service/settings/api | Initialize Settings Flow for API Clients
|
118
|
-
*OryHydraClient::PublicApi* | [**initialize_self_service_settings_via_browser_flow**](docs/PublicApi.md#initialize_self_service_settings_via_browser_flow) | **GET** /self-service/settings/browser
|
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,60 +1,79 @@
|
|
1
1
|
# OryHydraClient::AdminApi
|
2
2
|
|
3
|
-
All URIs are relative to *
|
4
|
-
|
5
|
-
Method | HTTP request | Description
|
6
|
-
|
7
|
-
[**create_identity**](AdminApi.md#create_identity) | **POST** /identities | Create an Identity
|
8
|
-
[**create_recovery_link**](AdminApi.md#create_recovery_link) | **POST** /recovery/link | Create a Recovery Link
|
9
|
-
[**delete_identity**](AdminApi.md#delete_identity) | **DELETE** /identities/{id} | Delete an Identity
|
10
|
-
[**get_identity**](AdminApi.md#get_identity) | **GET** /identities/{id} | Get an Identity
|
11
|
-
[**get_schema**](AdminApi.md#get_schema) | **GET** /schemas/{id} |
|
12
|
-
[**get_self_service_error**](AdminApi.md#get_self_service_error) | **GET** /self-service/errors | Get User-Facing Self-Service Errors
|
13
|
-
[**get_self_service_login_flow**](AdminApi.md#get_self_service_login_flow) | **GET** /self-service/login/flows | Get Login Flow
|
14
|
-
[**get_self_service_recovery_flow**](AdminApi.md#get_self_service_recovery_flow) | **GET** /self-service/recovery/flows | Get information about a recovery flow
|
15
|
-
[**get_self_service_registration_flow**](AdminApi.md#get_self_service_registration_flow) | **GET** /self-service/registration/flows | Get Registration Flow
|
16
|
-
[**get_self_service_settings_flow**](AdminApi.md#get_self_service_settings_flow) | **GET** /self-service/settings/flows | Get Settings Flow
|
17
|
-
[**get_self_service_verification_flow**](AdminApi.md#get_self_service_verification_flow) | **GET** /self-service/verification/flows | Get Verification Flow
|
18
|
-
[**
|
19
|
-
[**
|
20
|
-
[**
|
21
|
-
|
3
|
+
All URIs are relative to *https://demo.tenants.oryapis.com/api/kratos/public*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**create_identity**](AdminApi.md#create_identity) | **POST** /identities | Create an Identity |
|
8
|
+
| [**create_recovery_link**](AdminApi.md#create_recovery_link) | **POST** /recovery/link | Create a Recovery Link |
|
9
|
+
| [**delete_identity**](AdminApi.md#delete_identity) | **DELETE** /identities/{id} | Delete an Identity |
|
10
|
+
| [**get_identity**](AdminApi.md#get_identity) | **GET** /identities/{id} | Get an Identity |
|
11
|
+
| [**get_schema**](AdminApi.md#get_schema) | **GET** /schemas/{id} | |
|
12
|
+
| [**get_self_service_error**](AdminApi.md#get_self_service_error) | **GET** /self-service/errors | Get User-Facing Self-Service Errors |
|
13
|
+
| [**get_self_service_login_flow**](AdminApi.md#get_self_service_login_flow) | **GET** /self-service/login/flows | Get Login Flow |
|
14
|
+
| [**get_self_service_recovery_flow**](AdminApi.md#get_self_service_recovery_flow) | **GET** /self-service/recovery/flows | Get information about a recovery flow |
|
15
|
+
| [**get_self_service_registration_flow**](AdminApi.md#get_self_service_registration_flow) | **GET** /self-service/registration/flows | Get Registration Flow |
|
16
|
+
| [**get_self_service_settings_flow**](AdminApi.md#get_self_service_settings_flow) | **GET** /self-service/settings/flows | Get Settings Flow |
|
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 |
|
21
|
+
| [**list_identities**](AdminApi.md#list_identities) | **GET** /identities | List Identities |
|
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: |
|
23
|
+
| [**update_identity**](AdminApi.md#update_identity) | **PUT** /identities/{id} | Update an Identity |
|
22
24
|
|
23
25
|
|
24
26
|
## create_identity
|
25
27
|
|
26
|
-
> Identity create_identity(opts)
|
28
|
+
> <Identity> create_identity(opts)
|
27
29
|
|
28
30
|
Create an Identity
|
29
31
|
|
30
|
-
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).
|
31
33
|
|
32
|
-
###
|
34
|
+
### Examples
|
33
35
|
|
34
36
|
```ruby
|
35
|
-
|
37
|
+
require 'time'
|
36
38
|
require 'ory-kratos-client'
|
37
39
|
|
38
40
|
api_instance = OryHydraClient::AdminApi.new
|
39
41
|
opts = {
|
40
|
-
|
42
|
+
create_identity: OryHydraClient::CreateIdentity.new({schema_id: 'schema_id_example', traits: 3.56}) # CreateIdentity |
|
41
43
|
}
|
42
44
|
|
43
45
|
begin
|
44
|
-
#Create an Identity
|
46
|
+
# Create an Identity
|
45
47
|
result = api_instance.create_identity(opts)
|
46
48
|
p result
|
47
49
|
rescue OryHydraClient::ApiError => e
|
48
|
-
puts "
|
50
|
+
puts "Error when calling AdminApi->create_identity: #{e}"
|
49
51
|
end
|
50
52
|
```
|
51
53
|
|
52
|
-
|
54
|
+
#### Using the create_identity_with_http_info variant
|
53
55
|
|
56
|
+
This returns an Array which contains the response data, status code and headers.
|
54
57
|
|
55
|
-
|
56
|
-
|
57
|
-
|
58
|
+
> <Array(<Identity>, Integer, Hash)> create_identity_with_http_info(opts)
|
59
|
+
|
60
|
+
```ruby
|
61
|
+
begin
|
62
|
+
# Create an Identity
|
63
|
+
data, status_code, headers = api_instance.create_identity_with_http_info(opts)
|
64
|
+
p status_code # => 2xx
|
65
|
+
p headers # => { ... }
|
66
|
+
p data # => <Identity>
|
67
|
+
rescue OryHydraClient::ApiError => e
|
68
|
+
puts "Error when calling AdminApi->create_identity_with_http_info: #{e}"
|
69
|
+
end
|
70
|
+
```
|
71
|
+
|
72
|
+
### Parameters
|
73
|
+
|
74
|
+
| Name | Type | Description | Notes |
|
75
|
+
| ---- | ---- | ----------- | ----- |
|
76
|
+
| **create_identity** | [**CreateIdentity**](CreateIdentity.md) | | [optional] |
|
58
77
|
|
59
78
|
### Return type
|
60
79
|
|
@@ -72,38 +91,55 @@ No authorization required
|
|
72
91
|
|
73
92
|
## create_recovery_link
|
74
93
|
|
75
|
-
> RecoveryLink create_recovery_link(opts)
|
94
|
+
> <RecoveryLink> create_recovery_link(opts)
|
76
95
|
|
77
96
|
Create a Recovery Link
|
78
97
|
|
79
98
|
This endpoint creates a recovery link which should be given to the user in order for them to recover (or activate) their account.
|
80
99
|
|
81
|
-
###
|
100
|
+
### Examples
|
82
101
|
|
83
102
|
```ruby
|
84
|
-
|
103
|
+
require 'time'
|
85
104
|
require 'ory-kratos-client'
|
86
105
|
|
87
106
|
api_instance = OryHydraClient::AdminApi.new
|
88
107
|
opts = {
|
89
|
-
|
108
|
+
create_recovery_link: OryHydraClient::CreateRecoveryLink.new({identity_id: 'identity_id_example'}) # CreateRecoveryLink |
|
90
109
|
}
|
91
110
|
|
92
111
|
begin
|
93
|
-
#Create a Recovery Link
|
112
|
+
# Create a Recovery Link
|
94
113
|
result = api_instance.create_recovery_link(opts)
|
95
114
|
p result
|
96
115
|
rescue OryHydraClient::ApiError => e
|
97
|
-
puts "
|
116
|
+
puts "Error when calling AdminApi->create_recovery_link: #{e}"
|
98
117
|
end
|
99
118
|
```
|
100
119
|
|
101
|
-
|
120
|
+
#### Using the create_recovery_link_with_http_info variant
|
121
|
+
|
122
|
+
This returns an Array which contains the response data, status code and headers.
|
123
|
+
|
124
|
+
> <Array(<RecoveryLink>, Integer, Hash)> create_recovery_link_with_http_info(opts)
|
125
|
+
|
126
|
+
```ruby
|
127
|
+
begin
|
128
|
+
# Create a Recovery Link
|
129
|
+
data, status_code, headers = api_instance.create_recovery_link_with_http_info(opts)
|
130
|
+
p status_code # => 2xx
|
131
|
+
p headers # => { ... }
|
132
|
+
p data # => <RecoveryLink>
|
133
|
+
rescue OryHydraClient::ApiError => e
|
134
|
+
puts "Error when calling AdminApi->create_recovery_link_with_http_info: #{e}"
|
135
|
+
end
|
136
|
+
```
|
102
137
|
|
138
|
+
### Parameters
|
103
139
|
|
104
|
-
Name | Type | Description
|
105
|
-
|
106
|
-
**
|
140
|
+
| Name | Type | Description | Notes |
|
141
|
+
| ---- | ---- | ----------- | ----- |
|
142
|
+
| **create_recovery_link** | [**CreateRecoveryLink**](CreateRecoveryLink.md) | | [optional] |
|
107
143
|
|
108
144
|
### Return type
|
109
145
|
|
@@ -125,31 +161,48 @@ No authorization required
|
|
125
161
|
|
126
162
|
Delete an Identity
|
127
163
|
|
128
|
-
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).
|
129
165
|
|
130
|
-
###
|
166
|
+
### Examples
|
131
167
|
|
132
168
|
```ruby
|
133
|
-
|
169
|
+
require 'time'
|
134
170
|
require 'ory-kratos-client'
|
135
171
|
|
136
172
|
api_instance = OryHydraClient::AdminApi.new
|
137
173
|
id = 'id_example' # String | ID is the identity's ID.
|
138
174
|
|
139
175
|
begin
|
140
|
-
#Delete an Identity
|
176
|
+
# Delete an Identity
|
141
177
|
api_instance.delete_identity(id)
|
142
178
|
rescue OryHydraClient::ApiError => e
|
143
|
-
puts "
|
179
|
+
puts "Error when calling AdminApi->delete_identity: #{e}"
|
144
180
|
end
|
145
181
|
```
|
146
182
|
|
147
|
-
|
183
|
+
#### Using the delete_identity_with_http_info variant
|
148
184
|
|
185
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
149
186
|
|
150
|
-
|
151
|
-
|
152
|
-
|
187
|
+
> <Array(nil, Integer, Hash)> delete_identity_with_http_info(id)
|
188
|
+
|
189
|
+
```ruby
|
190
|
+
begin
|
191
|
+
# Delete an Identity
|
192
|
+
data, status_code, headers = api_instance.delete_identity_with_http_info(id)
|
193
|
+
p status_code # => 2xx
|
194
|
+
p headers # => { ... }
|
195
|
+
p data # => nil
|
196
|
+
rescue OryHydraClient::ApiError => e
|
197
|
+
puts "Error when calling AdminApi->delete_identity_with_http_info: #{e}"
|
198
|
+
end
|
199
|
+
```
|
200
|
+
|
201
|
+
### Parameters
|
202
|
+
|
203
|
+
| Name | Type | Description | Notes |
|
204
|
+
| ---- | ---- | ----------- | ----- |
|
205
|
+
| **id** | **String** | ID is the identity's ID. | |
|
153
206
|
|
154
207
|
### Return type
|
155
208
|
|
@@ -167,36 +220,53 @@ No authorization required
|
|
167
220
|
|
168
221
|
## get_identity
|
169
222
|
|
170
|
-
> Identity get_identity(id)
|
223
|
+
> <Identity> get_identity(id)
|
171
224
|
|
172
225
|
Get an Identity
|
173
226
|
|
174
|
-
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).
|
175
228
|
|
176
|
-
###
|
229
|
+
### Examples
|
177
230
|
|
178
231
|
```ruby
|
179
|
-
|
232
|
+
require 'time'
|
180
233
|
require 'ory-kratos-client'
|
181
234
|
|
182
235
|
api_instance = OryHydraClient::AdminApi.new
|
183
236
|
id = 'id_example' # String | ID must be set to the ID of identity you want to get
|
184
237
|
|
185
238
|
begin
|
186
|
-
#Get an Identity
|
239
|
+
# Get an Identity
|
187
240
|
result = api_instance.get_identity(id)
|
188
241
|
p result
|
189
242
|
rescue OryHydraClient::ApiError => e
|
190
|
-
puts "
|
243
|
+
puts "Error when calling AdminApi->get_identity: #{e}"
|
191
244
|
end
|
192
245
|
```
|
193
246
|
|
194
|
-
|
247
|
+
#### Using the get_identity_with_http_info variant
|
195
248
|
|
249
|
+
This returns an Array which contains the response data, status code and headers.
|
196
250
|
|
197
|
-
|
198
|
-
|
199
|
-
|
251
|
+
> <Array(<Identity>, Integer, Hash)> get_identity_with_http_info(id)
|
252
|
+
|
253
|
+
```ruby
|
254
|
+
begin
|
255
|
+
# Get an Identity
|
256
|
+
data, status_code, headers = api_instance.get_identity_with_http_info(id)
|
257
|
+
p status_code # => 2xx
|
258
|
+
p headers # => { ... }
|
259
|
+
p data # => <Identity>
|
260
|
+
rescue OryHydraClient::ApiError => e
|
261
|
+
puts "Error when calling AdminApi->get_identity_with_http_info: #{e}"
|
262
|
+
end
|
263
|
+
```
|
264
|
+
|
265
|
+
### Parameters
|
266
|
+
|
267
|
+
| Name | Type | Description | Notes |
|
268
|
+
| ---- | ---- | ----------- | ----- |
|
269
|
+
| **id** | **String** | ID must be set to the ID of identity you want to get | |
|
200
270
|
|
201
271
|
### Return type
|
202
272
|
|
@@ -220,29 +290,47 @@ No authorization required
|
|
220
290
|
|
221
291
|
Get a Traits Schema Definition
|
222
292
|
|
223
|
-
###
|
293
|
+
### Examples
|
224
294
|
|
225
295
|
```ruby
|
226
|
-
|
296
|
+
require 'time'
|
227
297
|
require 'ory-kratos-client'
|
228
298
|
|
229
299
|
api_instance = OryHydraClient::AdminApi.new
|
230
300
|
id = 'id_example' # String | ID must be set to the ID of schema you want to get
|
231
301
|
|
232
302
|
begin
|
303
|
+
|
233
304
|
result = api_instance.get_schema(id)
|
234
305
|
p result
|
235
306
|
rescue OryHydraClient::ApiError => e
|
236
|
-
puts "
|
307
|
+
puts "Error when calling AdminApi->get_schema: #{e}"
|
237
308
|
end
|
238
309
|
```
|
239
310
|
|
240
|
-
|
311
|
+
#### Using the get_schema_with_http_info variant
|
312
|
+
|
313
|
+
This returns an Array which contains the response data, status code and headers.
|
241
314
|
|
315
|
+
> <Array(Object, Integer, Hash)> get_schema_with_http_info(id)
|
316
|
+
|
317
|
+
```ruby
|
318
|
+
begin
|
319
|
+
|
320
|
+
data, status_code, headers = api_instance.get_schema_with_http_info(id)
|
321
|
+
p status_code # => 2xx
|
322
|
+
p headers # => { ... }
|
323
|
+
p data # => Object
|
324
|
+
rescue OryHydraClient::ApiError => e
|
325
|
+
puts "Error when calling AdminApi->get_schema_with_http_info: #{e}"
|
326
|
+
end
|
327
|
+
```
|
328
|
+
|
329
|
+
### Parameters
|
242
330
|
|
243
|
-
Name | Type | Description
|
244
|
-
|
245
|
-
**id** | **String
|
331
|
+
| Name | Type | Description | Notes |
|
332
|
+
| ---- | ---- | ----------- | ----- |
|
333
|
+
| **id** | **String** | ID must be set to the ID of schema you want to get | |
|
246
334
|
|
247
335
|
### Return type
|
248
336
|
|
@@ -260,36 +348,53 @@ No authorization required
|
|
260
348
|
|
261
349
|
## get_self_service_error
|
262
350
|
|
263
|
-
> ErrorContainer get_self_service_error(error)
|
351
|
+
> <ErrorContainer> get_self_service_error(error)
|
264
352
|
|
265
353
|
Get User-Facing Self-Service Errors
|
266
354
|
|
267
|
-
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).
|
268
356
|
|
269
|
-
###
|
357
|
+
### Examples
|
270
358
|
|
271
359
|
```ruby
|
272
|
-
|
360
|
+
require 'time'
|
273
361
|
require 'ory-kratos-client'
|
274
362
|
|
275
363
|
api_instance = OryHydraClient::AdminApi.new
|
276
364
|
error = 'error_example' # String | Error is the container's ID
|
277
365
|
|
278
366
|
begin
|
279
|
-
#Get User-Facing Self-Service Errors
|
367
|
+
# Get User-Facing Self-Service Errors
|
280
368
|
result = api_instance.get_self_service_error(error)
|
281
369
|
p result
|
282
370
|
rescue OryHydraClient::ApiError => e
|
283
|
-
puts "
|
371
|
+
puts "Error when calling AdminApi->get_self_service_error: #{e}"
|
284
372
|
end
|
285
373
|
```
|
286
374
|
|
287
|
-
|
375
|
+
#### Using the get_self_service_error_with_http_info variant
|
376
|
+
|
377
|
+
This returns an Array which contains the response data, status code and headers.
|
378
|
+
|
379
|
+
> <Array(<ErrorContainer>, Integer, Hash)> get_self_service_error_with_http_info(error)
|
380
|
+
|
381
|
+
```ruby
|
382
|
+
begin
|
383
|
+
# Get User-Facing Self-Service Errors
|
384
|
+
data, status_code, headers = api_instance.get_self_service_error_with_http_info(error)
|
385
|
+
p status_code # => 2xx
|
386
|
+
p headers # => { ... }
|
387
|
+
p data # => <ErrorContainer>
|
388
|
+
rescue OryHydraClient::ApiError => e
|
389
|
+
puts "Error when calling AdminApi->get_self_service_error_with_http_info: #{e}"
|
390
|
+
end
|
391
|
+
```
|
288
392
|
|
393
|
+
### Parameters
|
289
394
|
|
290
|
-
Name | Type | Description
|
291
|
-
|
292
|
-
**error** | **String
|
395
|
+
| Name | Type | Description | Notes |
|
396
|
+
| ---- | ---- | ----------- | ----- |
|
397
|
+
| **error** | **String** | Error is the container's ID | |
|
293
398
|
|
294
399
|
### Return type
|
295
400
|
|
@@ -307,36 +412,53 @@ No authorization required
|
|
307
412
|
|
308
413
|
## get_self_service_login_flow
|
309
414
|
|
310
|
-
> LoginFlow get_self_service_login_flow(id)
|
415
|
+
> <LoginFlow> get_self_service_login_flow(id)
|
311
416
|
|
312
417
|
Get Login Flow
|
313
418
|
|
314
|
-
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).
|
315
420
|
|
316
|
-
###
|
421
|
+
### Examples
|
317
422
|
|
318
423
|
```ruby
|
319
|
-
|
424
|
+
require 'time'
|
320
425
|
require 'ory-kratos-client'
|
321
426
|
|
322
427
|
api_instance = OryHydraClient::AdminApi.new
|
323
428
|
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`).
|
324
429
|
|
325
430
|
begin
|
326
|
-
#Get Login Flow
|
431
|
+
# Get Login Flow
|
327
432
|
result = api_instance.get_self_service_login_flow(id)
|
328
433
|
p result
|
329
434
|
rescue OryHydraClient::ApiError => e
|
330
|
-
puts "
|
435
|
+
puts "Error when calling AdminApi->get_self_service_login_flow: #{e}"
|
331
436
|
end
|
332
437
|
```
|
333
438
|
|
334
|
-
|
439
|
+
#### Using the get_self_service_login_flow_with_http_info variant
|
335
440
|
|
441
|
+
This returns an Array which contains the response data, status code and headers.
|
336
442
|
|
337
|
-
|
338
|
-
|
339
|
-
|
443
|
+
> <Array(<LoginFlow>, Integer, Hash)> get_self_service_login_flow_with_http_info(id)
|
444
|
+
|
445
|
+
```ruby
|
446
|
+
begin
|
447
|
+
# Get Login Flow
|
448
|
+
data, status_code, headers = api_instance.get_self_service_login_flow_with_http_info(id)
|
449
|
+
p status_code # => 2xx
|
450
|
+
p headers # => { ... }
|
451
|
+
p data # => <LoginFlow>
|
452
|
+
rescue OryHydraClient::ApiError => e
|
453
|
+
puts "Error when calling AdminApi->get_self_service_login_flow_with_http_info: #{e}"
|
454
|
+
end
|
455
|
+
```
|
456
|
+
|
457
|
+
### Parameters
|
458
|
+
|
459
|
+
| Name | Type | Description | Notes |
|
460
|
+
| ---- | ---- | ----------- | ----- |
|
461
|
+
| **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`). | |
|
340
462
|
|
341
463
|
### Return type
|
342
464
|
|
@@ -354,36 +476,53 @@ No authorization required
|
|
354
476
|
|
355
477
|
## get_self_service_recovery_flow
|
356
478
|
|
357
|
-
> RecoveryFlow get_self_service_recovery_flow(id)
|
479
|
+
> <RecoveryFlow> get_self_service_recovery_flow(id)
|
358
480
|
|
359
481
|
Get information about a recovery flow
|
360
482
|
|
361
|
-
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).
|
362
484
|
|
363
|
-
###
|
485
|
+
### Examples
|
364
486
|
|
365
487
|
```ruby
|
366
|
-
|
488
|
+
require 'time'
|
367
489
|
require 'ory-kratos-client'
|
368
490
|
|
369
491
|
api_instance = OryHydraClient::AdminApi.new
|
370
492
|
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`).
|
371
493
|
|
372
494
|
begin
|
373
|
-
#Get information about a recovery flow
|
495
|
+
# Get information about a recovery flow
|
374
496
|
result = api_instance.get_self_service_recovery_flow(id)
|
375
497
|
p result
|
376
498
|
rescue OryHydraClient::ApiError => e
|
377
|
-
puts "
|
499
|
+
puts "Error when calling AdminApi->get_self_service_recovery_flow: #{e}"
|
378
500
|
end
|
379
501
|
```
|
380
502
|
|
381
|
-
|
503
|
+
#### Using the get_self_service_recovery_flow_with_http_info variant
|
382
504
|
|
505
|
+
This returns an Array which contains the response data, status code and headers.
|
383
506
|
|
384
|
-
|
385
|
-
|
386
|
-
|
507
|
+
> <Array(<RecoveryFlow>, Integer, Hash)> get_self_service_recovery_flow_with_http_info(id)
|
508
|
+
|
509
|
+
```ruby
|
510
|
+
begin
|
511
|
+
# Get information about a recovery flow
|
512
|
+
data, status_code, headers = api_instance.get_self_service_recovery_flow_with_http_info(id)
|
513
|
+
p status_code # => 2xx
|
514
|
+
p headers # => { ... }
|
515
|
+
p data # => <RecoveryFlow>
|
516
|
+
rescue OryHydraClient::ApiError => e
|
517
|
+
puts "Error when calling AdminApi->get_self_service_recovery_flow_with_http_info: #{e}"
|
518
|
+
end
|
519
|
+
```
|
520
|
+
|
521
|
+
### Parameters
|
522
|
+
|
523
|
+
| Name | Type | Description | Notes |
|
524
|
+
| ---- | ---- | ----------- | ----- |
|
525
|
+
| **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`). | |
|
387
526
|
|
388
527
|
### Return type
|
389
528
|
|
@@ -401,36 +540,53 @@ No authorization required
|
|
401
540
|
|
402
541
|
## get_self_service_registration_flow
|
403
542
|
|
404
|
-
> RegistrationFlow get_self_service_registration_flow(id)
|
543
|
+
> <RegistrationFlow> get_self_service_registration_flow(id)
|
405
544
|
|
406
545
|
Get Registration Flow
|
407
546
|
|
408
|
-
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).
|
409
548
|
|
410
|
-
###
|
549
|
+
### Examples
|
411
550
|
|
412
551
|
```ruby
|
413
|
-
|
552
|
+
require 'time'
|
414
553
|
require 'ory-kratos-client'
|
415
554
|
|
416
555
|
api_instance = OryHydraClient::AdminApi.new
|
417
556
|
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`).
|
418
557
|
|
419
558
|
begin
|
420
|
-
#Get Registration Flow
|
559
|
+
# Get Registration Flow
|
421
560
|
result = api_instance.get_self_service_registration_flow(id)
|
422
561
|
p result
|
423
562
|
rescue OryHydraClient::ApiError => e
|
424
|
-
puts "
|
563
|
+
puts "Error when calling AdminApi->get_self_service_registration_flow: #{e}"
|
425
564
|
end
|
426
565
|
```
|
427
566
|
|
428
|
-
|
567
|
+
#### Using the get_self_service_registration_flow_with_http_info variant
|
429
568
|
|
569
|
+
This returns an Array which contains the response data, status code and headers.
|
430
570
|
|
431
|
-
|
432
|
-
|
433
|
-
|
571
|
+
> <Array(<RegistrationFlow>, Integer, Hash)> get_self_service_registration_flow_with_http_info(id)
|
572
|
+
|
573
|
+
```ruby
|
574
|
+
begin
|
575
|
+
# Get Registration Flow
|
576
|
+
data, status_code, headers = api_instance.get_self_service_registration_flow_with_http_info(id)
|
577
|
+
p status_code # => 2xx
|
578
|
+
p headers # => { ... }
|
579
|
+
p data # => <RegistrationFlow>
|
580
|
+
rescue OryHydraClient::ApiError => e
|
581
|
+
puts "Error when calling AdminApi->get_self_service_registration_flow_with_http_info: #{e}"
|
582
|
+
end
|
583
|
+
```
|
584
|
+
|
585
|
+
### Parameters
|
586
|
+
|
587
|
+
| Name | Type | Description | Notes |
|
588
|
+
| ---- | ---- | ----------- | ----- |
|
589
|
+
| **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`). | |
|
434
590
|
|
435
591
|
### Return type
|
436
592
|
|
@@ -448,43 +604,60 @@ No authorization required
|
|
448
604
|
|
449
605
|
## get_self_service_settings_flow
|
450
606
|
|
451
|
-
> SettingsFlow get_self_service_settings_flow(id)
|
607
|
+
> <SettingsFlow> get_self_service_settings_flow(id)
|
452
608
|
|
453
609
|
Get Settings Flow
|
454
610
|
|
455
|
-
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).
|
456
612
|
|
457
|
-
###
|
613
|
+
### Examples
|
458
614
|
|
459
615
|
```ruby
|
460
|
-
|
616
|
+
require 'time'
|
461
617
|
require 'ory-kratos-client'
|
462
618
|
# setup authorization
|
463
619
|
OryHydraClient.configure do |config|
|
464
620
|
# Configure API key authorization: sessionToken
|
465
|
-
config.api_key['
|
621
|
+
config.api_key['sessionToken'] = 'YOUR API KEY'
|
466
622
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
467
|
-
#config.api_key_prefix['
|
623
|
+
# config.api_key_prefix['sessionToken'] = 'Bearer'
|
468
624
|
end
|
469
625
|
|
470
626
|
api_instance = OryHydraClient::AdminApi.new
|
471
627
|
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`).
|
472
628
|
|
473
629
|
begin
|
474
|
-
#Get Settings Flow
|
630
|
+
# Get Settings Flow
|
475
631
|
result = api_instance.get_self_service_settings_flow(id)
|
476
632
|
p result
|
477
633
|
rescue OryHydraClient::ApiError => e
|
478
|
-
puts "
|
634
|
+
puts "Error when calling AdminApi->get_self_service_settings_flow: #{e}"
|
479
635
|
end
|
480
636
|
```
|
481
637
|
|
482
|
-
|
638
|
+
#### Using the get_self_service_settings_flow_with_http_info variant
|
639
|
+
|
640
|
+
This returns an Array which contains the response data, status code and headers.
|
641
|
+
|
642
|
+
> <Array(<SettingsFlow>, Integer, Hash)> get_self_service_settings_flow_with_http_info(id)
|
643
|
+
|
644
|
+
```ruby
|
645
|
+
begin
|
646
|
+
# Get Settings Flow
|
647
|
+
data, status_code, headers = api_instance.get_self_service_settings_flow_with_http_info(id)
|
648
|
+
p status_code # => 2xx
|
649
|
+
p headers # => { ... }
|
650
|
+
p data # => <SettingsFlow>
|
651
|
+
rescue OryHydraClient::ApiError => e
|
652
|
+
puts "Error when calling AdminApi->get_self_service_settings_flow_with_http_info: #{e}"
|
653
|
+
end
|
654
|
+
```
|
483
655
|
|
656
|
+
### Parameters
|
484
657
|
|
485
|
-
Name | Type | Description
|
486
|
-
|
487
|
-
**id** | **String
|
658
|
+
| Name | Type | Description | Notes |
|
659
|
+
| ---- | ---- | ----------- | ----- |
|
660
|
+
| **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`). | |
|
488
661
|
|
489
662
|
### Return type
|
490
663
|
|
@@ -502,36 +675,53 @@ Name | Type | Description | Notes
|
|
502
675
|
|
503
676
|
## get_self_service_verification_flow
|
504
677
|
|
505
|
-
> VerificationFlow get_self_service_verification_flow(id)
|
678
|
+
> <VerificationFlow> get_self_service_verification_flow(id)
|
506
679
|
|
507
680
|
Get Verification Flow
|
508
681
|
|
509
|
-
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).
|
510
683
|
|
511
|
-
###
|
684
|
+
### Examples
|
512
685
|
|
513
686
|
```ruby
|
514
|
-
|
687
|
+
require 'time'
|
515
688
|
require 'ory-kratos-client'
|
516
689
|
|
517
690
|
api_instance = OryHydraClient::AdminApi.new
|
518
691
|
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`).
|
519
692
|
|
520
693
|
begin
|
521
|
-
#Get Verification Flow
|
694
|
+
# Get Verification Flow
|
522
695
|
result = api_instance.get_self_service_verification_flow(id)
|
523
696
|
p result
|
524
697
|
rescue OryHydraClient::ApiError => e
|
525
|
-
puts "
|
698
|
+
puts "Error when calling AdminApi->get_self_service_verification_flow: #{e}"
|
526
699
|
end
|
527
700
|
```
|
528
701
|
|
529
|
-
|
702
|
+
#### Using the get_self_service_verification_flow_with_http_info variant
|
530
703
|
|
704
|
+
This returns an Array which contains the response data, status code and headers.
|
531
705
|
|
532
|
-
|
533
|
-
|
534
|
-
|
706
|
+
> <Array(<VerificationFlow>, Integer, Hash)> get_self_service_verification_flow_with_http_info(id)
|
707
|
+
|
708
|
+
```ruby
|
709
|
+
begin
|
710
|
+
# Get Verification Flow
|
711
|
+
data, status_code, headers = api_instance.get_self_service_verification_flow_with_http_info(id)
|
712
|
+
p status_code # => 2xx
|
713
|
+
p headers # => { ... }
|
714
|
+
p data # => <VerificationFlow>
|
715
|
+
rescue OryHydraClient::ApiError => e
|
716
|
+
puts "Error when calling AdminApi->get_self_service_verification_flow_with_http_info: #{e}"
|
717
|
+
end
|
718
|
+
```
|
719
|
+
|
720
|
+
### Parameters
|
721
|
+
|
722
|
+
| Name | Type | Description | Notes |
|
723
|
+
| ---- | ---- | ----------- | ----- |
|
724
|
+
| **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`). | |
|
535
725
|
|
536
726
|
### Return type
|
537
727
|
|
@@ -547,42 +737,242 @@ No authorization required
|
|
547
737
|
- **Accept**: application/json
|
548
738
|
|
549
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
|
+
|
550
923
|
## list_identities
|
551
924
|
|
552
|
-
> Array
|
925
|
+
> <Array<Identity>> list_identities(opts)
|
553
926
|
|
554
927
|
List Identities
|
555
928
|
|
556
|
-
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).
|
557
930
|
|
558
|
-
###
|
931
|
+
### Examples
|
559
932
|
|
560
933
|
```ruby
|
561
|
-
|
934
|
+
require 'time'
|
562
935
|
require 'ory-kratos-client'
|
563
936
|
|
564
937
|
api_instance = OryHydraClient::AdminApi.new
|
565
938
|
opts = {
|
566
|
-
per_page:
|
567
|
-
page:
|
939
|
+
per_page: 789, # Integer | Items per Page This is the number of items per page.
|
940
|
+
page: 789 # Integer | Pagination Page
|
568
941
|
}
|
569
942
|
|
570
943
|
begin
|
571
|
-
#List Identities
|
944
|
+
# List Identities
|
572
945
|
result = api_instance.list_identities(opts)
|
573
946
|
p result
|
574
947
|
rescue OryHydraClient::ApiError => e
|
575
|
-
puts "
|
948
|
+
puts "Error when calling AdminApi->list_identities: #{e}"
|
576
949
|
end
|
577
950
|
```
|
578
951
|
|
579
|
-
|
952
|
+
#### Using the list_identities_with_http_info variant
|
580
953
|
|
954
|
+
This returns an Array which contains the response data, status code and headers.
|
581
955
|
|
582
|
-
|
583
|
-
|
584
|
-
|
585
|
-
|
956
|
+
> <Array(<Array<Identity>>, Integer, Hash)> list_identities_with_http_info(opts)
|
957
|
+
|
958
|
+
```ruby
|
959
|
+
begin
|
960
|
+
# List Identities
|
961
|
+
data, status_code, headers = api_instance.list_identities_with_http_info(opts)
|
962
|
+
p status_code # => 2xx
|
963
|
+
p headers # => { ... }
|
964
|
+
p data # => <Array<Identity>>
|
965
|
+
rescue OryHydraClient::ApiError => e
|
966
|
+
puts "Error when calling AdminApi->list_identities_with_http_info: #{e}"
|
967
|
+
end
|
968
|
+
```
|
969
|
+
|
970
|
+
### Parameters
|
971
|
+
|
972
|
+
| Name | Type | Description | Notes |
|
973
|
+
| ---- | ---- | ----------- | ----- |
|
974
|
+
| **per_page** | **Integer** | Items per Page This is the number of items per page. | [optional][default to 100] |
|
975
|
+
| **page** | **Integer** | Pagination Page | [optional][default to 0] |
|
586
976
|
|
587
977
|
### Return type
|
588
978
|
|
@@ -606,19 +996,37 @@ Get snapshot metrics from the Hydra service. If you're using k8s, you can then a
|
|
606
996
|
|
607
997
|
``` metadata: annotations: prometheus.io/port: \"4434\" prometheus.io/path: \"/metrics/prometheus\" ```
|
608
998
|
|
609
|
-
###
|
999
|
+
### Examples
|
610
1000
|
|
611
1001
|
```ruby
|
612
|
-
|
1002
|
+
require 'time'
|
613
1003
|
require 'ory-kratos-client'
|
614
1004
|
|
615
1005
|
api_instance = OryHydraClient::AdminApi.new
|
616
1006
|
|
617
1007
|
begin
|
618
|
-
#Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
|
1008
|
+
# Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
|
619
1009
|
api_instance.prometheus
|
620
1010
|
rescue OryHydraClient::ApiError => e
|
621
|
-
puts "
|
1011
|
+
puts "Error when calling AdminApi->prometheus: #{e}"
|
1012
|
+
end
|
1013
|
+
```
|
1014
|
+
|
1015
|
+
#### Using the prometheus_with_http_info variant
|
1016
|
+
|
1017
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1018
|
+
|
1019
|
+
> <Array(nil, Integer, Hash)> prometheus_with_http_info
|
1020
|
+
|
1021
|
+
```ruby
|
1022
|
+
begin
|
1023
|
+
# Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
|
1024
|
+
data, status_code, headers = api_instance.prometheus_with_http_info
|
1025
|
+
p status_code # => 2xx
|
1026
|
+
p headers # => { ... }
|
1027
|
+
p data # => nil
|
1028
|
+
rescue OryHydraClient::ApiError => e
|
1029
|
+
puts "Error when calling AdminApi->prometheus_with_http_info: #{e}"
|
622
1030
|
end
|
623
1031
|
```
|
624
1032
|
|
@@ -642,40 +1050,57 @@ No authorization required
|
|
642
1050
|
|
643
1051
|
## update_identity
|
644
1052
|
|
645
|
-
> Identity update_identity(id, opts)
|
1053
|
+
> <Identity> update_identity(id, opts)
|
646
1054
|
|
647
1055
|
Update an Identity
|
648
1056
|
|
649
|
-
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).
|
650
1058
|
|
651
|
-
###
|
1059
|
+
### Examples
|
652
1060
|
|
653
1061
|
```ruby
|
654
|
-
|
1062
|
+
require 'time'
|
655
1063
|
require 'ory-kratos-client'
|
656
1064
|
|
657
1065
|
api_instance = OryHydraClient::AdminApi.new
|
658
1066
|
id = 'id_example' # String | ID must be set to the ID of identity you want to update
|
659
1067
|
opts = {
|
660
|
-
|
1068
|
+
update_identity: OryHydraClient::UpdateIdentity.new({traits: 3.56}) # UpdateIdentity |
|
661
1069
|
}
|
662
1070
|
|
663
1071
|
begin
|
664
|
-
#Update an Identity
|
1072
|
+
# Update an Identity
|
665
1073
|
result = api_instance.update_identity(id, opts)
|
666
1074
|
p result
|
667
1075
|
rescue OryHydraClient::ApiError => e
|
668
|
-
puts "
|
1076
|
+
puts "Error when calling AdminApi->update_identity: #{e}"
|
669
1077
|
end
|
670
1078
|
```
|
671
1079
|
|
672
|
-
|
1080
|
+
#### Using the update_identity_with_http_info variant
|
1081
|
+
|
1082
|
+
This returns an Array which contains the response data, status code and headers.
|
673
1083
|
|
1084
|
+
> <Array(<Identity>, Integer, Hash)> update_identity_with_http_info(id, opts)
|
1085
|
+
|
1086
|
+
```ruby
|
1087
|
+
begin
|
1088
|
+
# Update an Identity
|
1089
|
+
data, status_code, headers = api_instance.update_identity_with_http_info(id, opts)
|
1090
|
+
p status_code # => 2xx
|
1091
|
+
p headers # => { ... }
|
1092
|
+
p data # => <Identity>
|
1093
|
+
rescue OryHydraClient::ApiError => e
|
1094
|
+
puts "Error when calling AdminApi->update_identity_with_http_info: #{e}"
|
1095
|
+
end
|
1096
|
+
```
|
1097
|
+
|
1098
|
+
### Parameters
|
674
1099
|
|
675
|
-
Name | Type | Description
|
676
|
-
|
677
|
-
**id** | **String
|
678
|
-
**
|
1100
|
+
| Name | Type | Description | Notes |
|
1101
|
+
| ---- | ---- | ----------- | ----- |
|
1102
|
+
| **id** | **String** | ID must be set to the ID of identity you want to update | |
|
1103
|
+
| **update_identity** | [**UpdateIdentity**](UpdateIdentity.md) | | [optional] |
|
679
1104
|
|
680
1105
|
### Return type
|
681
1106
|
|