ory-client 0.0.1.alpha12 → 0.0.1.alpha16
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +79 -97
- data/docs/AdminCreateIdentityBody.md +20 -0
- data/docs/AdminCreateSelfServiceRecoveryLinkBody.md +20 -0
- data/docs/AdminUpdateIdentityBody.md +22 -0
- data/docs/Identity.md +6 -0
- data/docs/IdentityState.md +15 -0
- data/docs/MetadataApi.md +254 -0
- data/docs/SelfServiceError.md +24 -0
- data/docs/SelfServiceLoginFlow.md +36 -0
- data/docs/SelfServiceLogoutUrl.md +18 -0
- data/docs/SelfServiceRecoveryFlow.md +32 -0
- data/docs/SelfServiceRecoveryFlowState.md +15 -0
- data/docs/SelfServiceRecoveryLink.md +20 -0
- data/docs/SelfServiceRegistrationFlow.md +30 -0
- data/docs/SelfServiceSettingsFlow.md +34 -0
- data/docs/SelfServiceSettingsFlowState.md +15 -0
- data/docs/SelfServiceVerificationFlow.md +32 -0
- data/docs/SelfServiceVerificationFlowState.md +15 -0
- data/docs/Session.md +4 -4
- data/docs/SubmitSelfServiceLoginFlowBody.md +76 -0
- data/docs/SubmitSelfServiceLoginFlowWithOidcMethodBody.md +22 -0
- data/docs/SubmitSelfServiceLoginFlowWithPasswordMethodBody.md +24 -0
- data/docs/SubmitSelfServiceLogoutFlowWithoutBrowserBody.md +18 -0
- data/docs/SubmitSelfServiceRecoveryFlowBody.md +75 -0
- data/docs/SubmitSelfServiceRecoveryFlowWithLinkMethodBody.md +22 -0
- data/docs/SubmitSelfServiceRegistrationFlowBody.md +76 -0
- data/docs/SubmitSelfServiceRegistrationFlowWithOidcMethodBody.md +22 -0
- data/docs/SubmitSelfServiceRegistrationFlowWithPasswordMethodBody.md +24 -0
- data/docs/SubmitSelfServiceSettingsFlowBody.md +79 -0
- data/docs/SubmitSelfServiceSettingsFlowWithOidcMethodBody.md +24 -0
- data/docs/SubmitSelfServiceSettingsFlowWithPasswordMethodBody.md +22 -0
- data/docs/SubmitSelfServiceSettingsFlowWithProfileMethodBody.md +22 -0
- data/docs/SubmitSelfServiceVerificationFlowBody.md +75 -0
- data/docs/SubmitSelfServiceVerificationFlowWithLinkMethodBody.md +22 -0
- data/docs/SuccessfulSelfServiceLoginWithoutBrowser.md +20 -0
- data/docs/SuccessfulSelfServiceRegistrationWithoutBrowser.md +22 -0
- data/docs/SuccessfulSelfServiceSettingsWithoutBrowser.md +20 -0
- data/docs/V0alpha1Api.md +2172 -0
- data/lib/ory-client.rb +36 -26
- data/lib/ory-client/api/default_api.rb +1 -1
- data/lib/ory-client/api/metadata_api.rb +248 -0
- data/lib/ory-client/api/v0alpha1_api.rb +2054 -0
- data/lib/ory-client/api_client.rb +1 -1
- data/lib/ory-client/api_error.rb +1 -1
- data/lib/ory-client/configuration.rb +2 -16
- data/lib/ory-client/models/admin_create_identity_body.rb +239 -0
- data/lib/ory-client/models/admin_create_self_service_recovery_link_body.rb +250 -0
- data/lib/ory-client/models/admin_update_identity_body.rb +248 -0
- data/lib/ory-client/models/authenticate_ok_body.rb +1 -1
- data/lib/ory-client/models/container_change_response_item.rb +1 -1
- data/lib/ory-client/models/container_create_created_body.rb +1 -1
- data/lib/ory-client/models/container_top_ok_body.rb +1 -1
- data/lib/ory-client/models/container_update_ok_body.rb +1 -1
- data/lib/ory-client/models/container_wait_ok_body.rb +1 -1
- data/lib/ory-client/models/container_wait_ok_body_error.rb +1 -1
- data/lib/ory-client/models/create_identity.rb +1 -1
- data/lib/ory-client/models/create_recovery_link.rb +1 -1
- data/lib/ory-client/models/error_response.rb +1 -1
- data/lib/ory-client/models/generic_error.rb +1 -1
- data/lib/ory-client/models/graph_driver_data.rb +1 -1
- data/lib/ory-client/models/health_not_ready_status.rb +1 -1
- data/lib/ory-client/models/health_status.rb +1 -1
- data/lib/ory-client/models/id_response.rb +1 -1
- data/lib/ory-client/models/identity.rb +32 -2
- data/lib/ory-client/models/identity_credentials.rb +1 -1
- data/lib/ory-client/models/identity_state.rb +37 -0
- data/lib/ory-client/models/image_delete_response_item.rb +1 -1
- data/lib/ory-client/models/image_summary.rb +1 -1
- data/lib/ory-client/models/inline_response200.rb +1 -1
- data/lib/ory-client/models/inline_response2001.rb +1 -1
- data/lib/ory-client/models/inline_response503.rb +1 -1
- data/lib/ory-client/models/json_error.rb +1 -1
- data/lib/ory-client/models/login_flow.rb +1 -1
- data/lib/ory-client/models/login_via_api_response.rb +1 -1
- data/lib/ory-client/models/meta.rb +1 -1
- data/lib/ory-client/models/plugin.rb +1 -1
- data/lib/ory-client/models/plugin_config.rb +1 -1
- data/lib/ory-client/models/plugin_config_args.rb +1 -1
- data/lib/ory-client/models/plugin_config_interface.rb +1 -1
- data/lib/ory-client/models/plugin_config_linux.rb +1 -1
- data/lib/ory-client/models/plugin_config_network.rb +1 -1
- data/lib/ory-client/models/plugin_config_rootfs.rb +1 -1
- data/lib/ory-client/models/plugin_config_user.rb +1 -1
- data/lib/ory-client/models/plugin_device.rb +1 -1
- data/lib/ory-client/models/plugin_env.rb +1 -1
- data/lib/ory-client/models/plugin_interface_type.rb +1 -1
- data/lib/ory-client/models/plugin_mount.rb +1 -1
- data/lib/ory-client/models/plugin_settings.rb +1 -1
- data/lib/ory-client/models/port.rb +1 -1
- data/lib/ory-client/models/recovery_address.rb +1 -1
- data/lib/ory-client/models/recovery_flow.rb +1 -1
- data/lib/ory-client/models/recovery_link.rb +1 -1
- data/lib/ory-client/models/registration_flow.rb +1 -1
- data/lib/ory-client/models/registration_via_api_response.rb +1 -1
- data/lib/ory-client/models/revoke_session.rb +1 -1
- data/lib/ory-client/models/self_service_error.rb +252 -0
- data/lib/ory-client/models/self_service_error_container.rb +1 -1
- data/lib/ory-client/models/self_service_login_flow.rb +338 -0
- data/lib/ory-client/models/self_service_logout_url.rb +219 -0
- data/lib/ory-client/models/self_service_recovery_flow.rb +317 -0
- data/lib/ory-client/models/self_service_recovery_flow_state.rb +38 -0
- data/lib/ory-client/models/self_service_recovery_link.rb +234 -0
- data/lib/ory-client/models/self_service_registration_flow.rb +302 -0
- data/lib/ory-client/models/self_service_settings_flow.rb +331 -0
- data/lib/ory-client/models/self_service_settings_flow_state.rb +37 -0
- data/lib/ory-client/models/self_service_verification_flow.rb +307 -0
- data/lib/ory-client/models/self_service_verification_flow_state.rb +38 -0
- data/lib/ory-client/models/service_update_response.rb +1 -1
- data/lib/ory-client/models/session.rb +6 -16
- data/lib/ory-client/models/settings_flow.rb +1 -1
- data/lib/ory-client/models/settings_profile_form_config.rb +1 -1
- data/lib/ory-client/models/settings_via_api_response.rb +1 -1
- data/lib/ory-client/models/submit_self_service_browser_settings_oidc_flow_payload.rb +1 -1
- data/lib/ory-client/models/submit_self_service_login_flow.rb +1 -1
- data/lib/ory-client/models/submit_self_service_login_flow_body.rb +54 -0
- data/lib/ory-client/models/submit_self_service_login_flow_with_oidc_method_body.rb +250 -0
- data/lib/ory-client/models/submit_self_service_login_flow_with_password_method.rb +1 -1
- data/lib/ory-client/models/submit_self_service_login_flow_with_password_method_body.rb +298 -0
- data/lib/ory-client/models/submit_self_service_logout_flow_without_browser_body.rb +225 -0
- data/lib/ory-client/models/submit_self_service_recovery_flow_body.rb +53 -0
- data/lib/ory-client/models/submit_self_service_recovery_flow_with_link_method.rb +1 -1
- data/lib/ory-client/models/submit_self_service_recovery_flow_with_link_method_body.rb +283 -0
- data/lib/ory-client/models/submit_self_service_registration_flow.rb +1 -1
- data/lib/ory-client/models/submit_self_service_registration_flow_body.rb +54 -0
- data/lib/ory-client/models/submit_self_service_registration_flow_with_oidc_method_body.rb +250 -0
- data/lib/ory-client/models/submit_self_service_registration_flow_with_password_method.rb +1 -1
- data/lib/ory-client/models/submit_self_service_registration_flow_with_password_method_body.rb +299 -0
- data/lib/ory-client/models/submit_self_service_settings_flow.rb +1 -1
- data/lib/ory-client/models/submit_self_service_settings_flow_body.rb +56 -0
- data/lib/ory-client/models/submit_self_service_settings_flow_with_oidc_method_body.rb +255 -0
- data/lib/ory-client/models/submit_self_service_settings_flow_with_password_method.rb +1 -1
- data/lib/ory-client/models/submit_self_service_settings_flow_with_password_method_body.rb +283 -0
- data/lib/ory-client/models/submit_self_service_settings_flow_with_profile_method.rb +1 -1
- data/lib/ory-client/models/submit_self_service_settings_flow_with_profile_method_body.rb +250 -0
- data/lib/ory-client/models/submit_self_service_verification_flow_body.rb +54 -0
- data/lib/ory-client/models/submit_self_service_verification_flow_with_link_method.rb +1 -1
- data/lib/ory-client/models/submit_self_service_verification_flow_with_link_method_body.rb +283 -0
- data/lib/ory-client/models/successful_self_service_login_without_browser.rb +234 -0
- data/lib/ory-client/models/successful_self_service_registration_without_browser.rb +243 -0
- data/lib/ory-client/models/successful_self_service_settings_without_browser.rb +238 -0
- data/lib/ory-client/models/ui_container.rb +1 -1
- data/lib/ory-client/models/ui_node.rb +1 -1
- data/lib/ory-client/models/ui_node_anchor_attributes.rb +1 -1
- data/lib/ory-client/models/ui_node_attributes.rb +1 -1
- data/lib/ory-client/models/ui_node_image_attributes.rb +1 -1
- data/lib/ory-client/models/ui_node_input_attributes.rb +1 -1
- data/lib/ory-client/models/ui_node_text_attributes.rb +1 -1
- data/lib/ory-client/models/ui_text.rb +1 -1
- data/lib/ory-client/models/update_identity.rb +1 -1
- data/lib/ory-client/models/verifiable_identity_address.rb +1 -1
- data/lib/ory-client/models/verification_flow.rb +1 -1
- data/lib/ory-client/models/version.rb +1 -1
- data/lib/ory-client/models/volume.rb +1 -1
- data/lib/ory-client/models/volume_usage_data.rb +1 -1
- data/lib/ory-client/version.rb +2 -2
- data/ory-client.gemspec +1 -1
- data/spec/api/metadata_api_spec.rb +79 -0
- data/spec/api/v0alpha1_api_spec.rb +429 -0
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/admin_create_identity_body_spec.rb +40 -0
- data/spec/models/admin_create_self_service_recovery_link_body_spec.rb +40 -0
- data/spec/models/admin_update_identity_body_spec.rb +46 -0
- data/spec/models/identity_state_spec.rb +28 -0
- data/spec/models/self_service_error_spec.rb +52 -0
- data/spec/models/self_service_login_flow_spec.rb +88 -0
- data/spec/models/self_service_logout_url_spec.rb +34 -0
- data/spec/models/self_service_recovery_flow_spec.rb +76 -0
- data/spec/models/self_service_recovery_flow_state_spec.rb +28 -0
- data/spec/models/self_service_recovery_link_spec.rb +40 -0
- data/spec/models/self_service_registration_flow_spec.rb +70 -0
- data/spec/models/self_service_settings_flow_spec.rb +82 -0
- data/spec/models/self_service_settings_flow_state_spec.rb +28 -0
- data/spec/models/self_service_verification_flow_spec.rb +76 -0
- data/spec/models/self_service_verification_flow_state_spec.rb +28 -0
- data/spec/models/submit_self_service_login_flow_body_spec.rb +43 -0
- data/spec/models/submit_self_service_login_flow_with_oidc_method_body_spec.rb +46 -0
- data/spec/models/submit_self_service_login_flow_with_password_method_body_spec.rb +56 -0
- data/spec/models/submit_self_service_logout_flow_without_browser_body_spec.rb +34 -0
- data/spec/models/submit_self_service_recovery_flow_body_spec.rb +43 -0
- data/spec/models/submit_self_service_recovery_flow_with_link_method_body_spec.rb +50 -0
- data/spec/models/submit_self_service_registration_flow_body_spec.rb +43 -0
- data/spec/models/submit_self_service_registration_flow_with_oidc_method_body_spec.rb +46 -0
- data/spec/models/submit_self_service_registration_flow_with_password_method_body_spec.rb +56 -0
- data/spec/models/submit_self_service_settings_flow_body_spec.rb +43 -0
- data/spec/models/submit_self_service_settings_flow_with_oidc_method_body_spec.rb +52 -0
- data/spec/models/submit_self_service_settings_flow_with_password_method_body_spec.rb +50 -0
- data/spec/models/submit_self_service_settings_flow_with_profile_method_body_spec.rb +46 -0
- data/spec/models/submit_self_service_verification_flow_body_spec.rb +43 -0
- data/spec/models/submit_self_service_verification_flow_with_link_method_body_spec.rb +50 -0
- data/spec/models/successful_self_service_login_without_browser_spec.rb +40 -0
- data/spec/models/successful_self_service_registration_without_browser_spec.rb +46 -0
- data/spec/models/successful_self_service_settings_without_browser_spec.rb +40 -0
- data/spec/spec_helper.rb +1 -1
- metadata +142 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b1980d625675e1caf067391ba64dc9f3434eadc95025f4abe65a3427325d2964
|
4
|
+
data.tar.gz: 4a255533f09ebe5ae7076e54a4c9b4b9c29e53318f72e769373d18237b9abe60
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0ec824d3b50cf61ae946916b320e0c71b23f35722d30f783aa15d77a7764033ea0a4d043ef8b4d26eb3f484f724dfc80a7ea4f36dfcc1d2db48ca2e8a897c641
|
7
|
+
data.tar.gz: d212170e347e3b3bc464edceaabb3d91d9012af0796b4328f88740642b3a43770fecd26a85bbb3b95793a540f764e8ae46bda550ca6077153fcc6d891ce91d6d
|
data/README.md
CHANGED
@@ -8,8 +8,8 @@ with a valid Personal Access Token. Public APIs are mostly used in browsers.
|
|
8
8
|
|
9
9
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
10
10
|
|
11
|
-
- API version: v0.0.1-alpha.
|
12
|
-
- Package version: v0.0.1-alpha.
|
11
|
+
- API version: v0.0.1-alpha.16
|
12
|
+
- Package version: v0.0.1-alpha.16
|
13
13
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
14
14
|
|
15
15
|
## Installation
|
@@ -25,16 +25,16 @@ gem build ory-client.gemspec
|
|
25
25
|
Then either install the gem locally:
|
26
26
|
|
27
27
|
```shell
|
28
|
-
gem install ./ory-client-v0.0.1-alpha.
|
28
|
+
gem install ./ory-client-v0.0.1-alpha.16.gem
|
29
29
|
```
|
30
30
|
|
31
|
-
(for development, run `gem install --dev ./ory-client-v0.0.1-alpha.
|
31
|
+
(for development, run `gem install --dev ./ory-client-v0.0.1-alpha.16.gem` to install the development dependencies)
|
32
32
|
|
33
33
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
34
34
|
|
35
35
|
Finally add this to the Gemfile:
|
36
36
|
|
37
|
-
gem 'ory-client', '~> v0.0.1-alpha.
|
37
|
+
gem 'ory-client', '~> v0.0.1-alpha.16'
|
38
38
|
|
39
39
|
### Install from Git
|
40
40
|
|
@@ -58,23 +58,14 @@ Please follow the [installation](#installation) procedure and then run the follo
|
|
58
58
|
# Load the gem
|
59
59
|
require 'ory-client'
|
60
60
|
|
61
|
-
|
62
|
-
OryHydraClient.configure do |config|
|
63
|
-
# Configure Bearer authorization: oryToken
|
64
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
65
|
-
end
|
66
|
-
|
67
|
-
api_instance = OryHydraClient::DefaultApi.new
|
68
|
-
opts = {
|
69
|
-
create_identity: OryHydraClient::CreateIdentity.new({schema_id: 'schema_id_example', traits: 3.56}) # CreateIdentity |
|
70
|
-
}
|
61
|
+
api_instance = OryHydraClient::MetadataApi.new
|
71
62
|
|
72
63
|
begin
|
73
|
-
#
|
74
|
-
result = api_instance.
|
64
|
+
#Return Running Software Version.
|
65
|
+
result = api_instance.get_version
|
75
66
|
p result
|
76
67
|
rescue OryHydraClient::ApiError => e
|
77
|
-
puts "Exception when calling
|
68
|
+
puts "Exception when calling MetadataApi->get_version: #{e}"
|
78
69
|
end
|
79
70
|
|
80
71
|
```
|
@@ -85,53 +76,49 @@ All URIs are relative to *https://playground.projects.oryapis.com*
|
|
85
76
|
|
86
77
|
Class | Method | HTTP request | Description
|
87
78
|
------------ | ------------- | ------------- | -------------
|
88
|
-
*OryHydraClient::
|
89
|
-
*OryHydraClient::
|
90
|
-
*OryHydraClient::
|
91
|
-
*OryHydraClient::
|
92
|
-
*OryHydraClient::
|
93
|
-
*OryHydraClient::
|
94
|
-
*OryHydraClient::
|
95
|
-
*OryHydraClient::
|
96
|
-
*OryHydraClient::
|
97
|
-
*OryHydraClient::
|
98
|
-
*OryHydraClient::
|
99
|
-
*OryHydraClient::
|
100
|
-
*OryHydraClient::
|
101
|
-
*OryHydraClient::
|
102
|
-
*OryHydraClient::
|
103
|
-
*OryHydraClient::
|
104
|
-
*OryHydraClient::
|
105
|
-
*OryHydraClient::
|
106
|
-
*OryHydraClient::
|
107
|
-
*OryHydraClient::
|
108
|
-
*OryHydraClient::
|
109
|
-
*OryHydraClient::
|
110
|
-
*OryHydraClient::
|
111
|
-
*OryHydraClient::
|
112
|
-
*OryHydraClient::
|
113
|
-
*OryHydraClient::
|
114
|
-
*OryHydraClient::
|
115
|
-
*OryHydraClient::
|
116
|
-
*OryHydraClient::
|
117
|
-
*OryHydraClient::
|
118
|
-
*OryHydraClient::
|
119
|
-
*OryHydraClient::
|
120
|
-
*OryHydraClient::
|
121
|
-
*OryHydraClient::
|
122
|
-
*OryHydraClient::
|
123
|
-
*OryHydraClient::
|
124
|
-
*OryHydraClient::DefaultApi* | [**submit_self_service_recovery_flow**](docs/DefaultApi.md#submit_self_service_recovery_flow) | **POST** /api/kratos/public/self-service/recovery | Complete Recovery Flow
|
125
|
-
*OryHydraClient::DefaultApi* | [**submit_self_service_recovery_flow_with_link_method**](docs/DefaultApi.md#submit_self_service_recovery_flow_with_link_method) | **POST** /api/kratos/public/self-service/recovery/methods/link | Complete Recovery Flow with Link Method
|
126
|
-
*OryHydraClient::DefaultApi* | [**submit_self_service_registration_flow**](docs/DefaultApi.md#submit_self_service_registration_flow) | **POST** /api/kratos/public/self-service/registration | Submit a Registration Flow
|
127
|
-
*OryHydraClient::DefaultApi* | [**submit_self_service_settings_flow**](docs/DefaultApi.md#submit_self_service_settings_flow) | **POST** /api/kratos/public/self-service/settings | Complete Settings Flow
|
128
|
-
*OryHydraClient::DefaultApi* | [**submit_self_service_verification_flow**](docs/DefaultApi.md#submit_self_service_verification_flow) | **POST** /api/kratos/public/self-service/verification/flows | Complete Verification Flow
|
129
|
-
*OryHydraClient::DefaultApi* | [**to_session**](docs/DefaultApi.md#to_session) | **GET** /api/kratos/public/sessions/whoami | Check Who the Current HTTP Session Belongs To
|
130
|
-
*OryHydraClient::DefaultApi* | [**update_identity_admin**](docs/DefaultApi.md#update_identity_admin) | **PUT** /api/kratos/admin/identities/{id} | Update an Identity
|
79
|
+
*OryHydraClient::MetadataApi* | [**get_version**](docs/MetadataApi.md#get_version) | **GET** /api/kratos/public/version | Return Running Software Version.
|
80
|
+
*OryHydraClient::MetadataApi* | [**is_alive**](docs/MetadataApi.md#is_alive) | **GET** /api/kratos/public/health/alive | Check HTTP Server Status
|
81
|
+
*OryHydraClient::MetadataApi* | [**is_ready**](docs/MetadataApi.md#is_ready) | **GET** /api/kratos/public/health/ready | Check HTTP Server and Database Status
|
82
|
+
*OryHydraClient::MetadataApi* | [**prometheus**](docs/MetadataApi.md#prometheus) | **GET** /api/kratos/public/metrics/prometheus | Get snapshot metrics from the service. If you're using k8s, you can then add annotations to your deployment like so:
|
83
|
+
*OryHydraClient::V0alpha1Api* | [**admin_create_identity**](docs/V0alpha1Api.md#admin_create_identity) | **POST** /api/kratos/admin/identities | Create an Identity
|
84
|
+
*OryHydraClient::V0alpha1Api* | [**admin_create_self_service_recovery_link**](docs/V0alpha1Api.md#admin_create_self_service_recovery_link) | **POST** /api/kratos/admin/recovery/link | Create a Recovery Link
|
85
|
+
*OryHydraClient::V0alpha1Api* | [**admin_delete_identity**](docs/V0alpha1Api.md#admin_delete_identity) | **DELETE** /api/kratos/admin/identities/{id} | Delete an Identity
|
86
|
+
*OryHydraClient::V0alpha1Api* | [**admin_get_identity**](docs/V0alpha1Api.md#admin_get_identity) | **GET** /api/kratos/admin/identities/{id} | Get an Identity
|
87
|
+
*OryHydraClient::V0alpha1Api* | [**admin_list_identities**](docs/V0alpha1Api.md#admin_list_identities) | **GET** /api/kratos/admin/identities | List Identities
|
88
|
+
*OryHydraClient::V0alpha1Api* | [**admin_update_identity**](docs/V0alpha1Api.md#admin_update_identity) | **PUT** /api/kratos/admin/identities/{id} | Update an Identity
|
89
|
+
*OryHydraClient::V0alpha1Api* | [**create_self_service_logout_flow_url_for_browsers**](docs/V0alpha1Api.md#create_self_service_logout_flow_url_for_browsers) | **GET** /api/kratos/public/self-service/logout/browser | Create a Logout URL for Browsers
|
90
|
+
*OryHydraClient::V0alpha1Api* | [**get_json_schema**](docs/V0alpha1Api.md#get_json_schema) | **GET** /api/kratos/public/schemas/{id} |
|
91
|
+
*OryHydraClient::V0alpha1Api* | [**get_self_service_error**](docs/V0alpha1Api.md#get_self_service_error) | **GET** /api/kratos/public/self-service/errors | Get Self-Service Errors
|
92
|
+
*OryHydraClient::V0alpha1Api* | [**get_self_service_login_flow**](docs/V0alpha1Api.md#get_self_service_login_flow) | **GET** /api/kratos/public/self-service/login/flows | Get Login Flow
|
93
|
+
*OryHydraClient::V0alpha1Api* | [**get_self_service_recovery_flow**](docs/V0alpha1Api.md#get_self_service_recovery_flow) | **GET** /api/kratos/public/self-service/recovery/flows | Get Recovery Flow
|
94
|
+
*OryHydraClient::V0alpha1Api* | [**get_self_service_registration_flow**](docs/V0alpha1Api.md#get_self_service_registration_flow) | **GET** /api/kratos/public/self-service/registration/flows | Get Registration Flow
|
95
|
+
*OryHydraClient::V0alpha1Api* | [**get_self_service_settings_flow**](docs/V0alpha1Api.md#get_self_service_settings_flow) | **GET** /api/kratos/public/self-service/settings/flows | Get Settings Flow
|
96
|
+
*OryHydraClient::V0alpha1Api* | [**get_self_service_verification_flow**](docs/V0alpha1Api.md#get_self_service_verification_flow) | **GET** /api/kratos/public/self-service/verification/flows | Get Verification Flow
|
97
|
+
*OryHydraClient::V0alpha1Api* | [**initialize_self_service_login_flow_for_browsers**](docs/V0alpha1Api.md#initialize_self_service_login_flow_for_browsers) | **GET** /api/kratos/public/self-service/login/browser | Initialize Login Flow for Browsers
|
98
|
+
*OryHydraClient::V0alpha1Api* | [**initialize_self_service_login_flow_without_browser**](docs/V0alpha1Api.md#initialize_self_service_login_flow_without_browser) | **GET** /api/kratos/public/self-service/login/api | Initialize Login Flow for APIs, Services, Apps, ...
|
99
|
+
*OryHydraClient::V0alpha1Api* | [**initialize_self_service_recovery_flow_for_browsers**](docs/V0alpha1Api.md#initialize_self_service_recovery_flow_for_browsers) | **GET** /api/kratos/public/self-service/recovery/browser | Initialize Recovery Flow for Browsers
|
100
|
+
*OryHydraClient::V0alpha1Api* | [**initialize_self_service_recovery_flow_without_browser**](docs/V0alpha1Api.md#initialize_self_service_recovery_flow_without_browser) | **GET** /api/kratos/public/self-service/recovery/api | Initialize Recovery Flow for APIs, Services, Apps, ...
|
101
|
+
*OryHydraClient::V0alpha1Api* | [**initialize_self_service_registration_flow_for_browsers**](docs/V0alpha1Api.md#initialize_self_service_registration_flow_for_browsers) | **GET** /api/kratos/public/self-service/registration/browser | Initialize Registration Flow for Browsers
|
102
|
+
*OryHydraClient::V0alpha1Api* | [**initialize_self_service_registration_flow_without_browser**](docs/V0alpha1Api.md#initialize_self_service_registration_flow_without_browser) | **GET** /api/kratos/public/self-service/registration/api | Initialize Registration Flow for APIs, Services, Apps, ...
|
103
|
+
*OryHydraClient::V0alpha1Api* | [**initialize_self_service_settings_flow_for_browsers**](docs/V0alpha1Api.md#initialize_self_service_settings_flow_for_browsers) | **GET** /api/kratos/public/self-service/settings/browser | Initialize Settings Flow for Browsers
|
104
|
+
*OryHydraClient::V0alpha1Api* | [**initialize_self_service_settings_flow_without_browser**](docs/V0alpha1Api.md#initialize_self_service_settings_flow_without_browser) | **GET** /api/kratos/public/self-service/settings/api | Initialize Settings Flow for APIs, Services, Apps, ...
|
105
|
+
*OryHydraClient::V0alpha1Api* | [**initialize_self_service_verification_flow_for_browsers**](docs/V0alpha1Api.md#initialize_self_service_verification_flow_for_browsers) | **GET** /api/kratos/public/self-service/verification/browser | Initialize Verification Flow for Browser Clients
|
106
|
+
*OryHydraClient::V0alpha1Api* | [**initialize_self_service_verification_flow_without_browser**](docs/V0alpha1Api.md#initialize_self_service_verification_flow_without_browser) | **GET** /api/kratos/public/self-service/verification/api | Initialize Verification Flow for APIs, Services, Apps, ...
|
107
|
+
*OryHydraClient::V0alpha1Api* | [**submit_self_service_login_flow**](docs/V0alpha1Api.md#submit_self_service_login_flow) | **POST** /api/kratos/public/self-service/login | Submit a Login Flow
|
108
|
+
*OryHydraClient::V0alpha1Api* | [**submit_self_service_logout_flow**](docs/V0alpha1Api.md#submit_self_service_logout_flow) | **GET** /api/kratos/public/self-service/logout | Complete Self-Service Logout
|
109
|
+
*OryHydraClient::V0alpha1Api* | [**submit_self_service_logout_flow_without_browser**](docs/V0alpha1Api.md#submit_self_service_logout_flow_without_browser) | **DELETE** /api/kratos/public/self-service/logout/api | Perform Logout for APIs, Services, Apps, ...
|
110
|
+
*OryHydraClient::V0alpha1Api* | [**submit_self_service_recovery_flow**](docs/V0alpha1Api.md#submit_self_service_recovery_flow) | **POST** /api/kratos/public/self-service/recovery | Complete Recovery Flow
|
111
|
+
*OryHydraClient::V0alpha1Api* | [**submit_self_service_registration_flow**](docs/V0alpha1Api.md#submit_self_service_registration_flow) | **POST** /api/kratos/public/self-service/registration | Submit a Registration Flow
|
112
|
+
*OryHydraClient::V0alpha1Api* | [**submit_self_service_settings_flow**](docs/V0alpha1Api.md#submit_self_service_settings_flow) | **POST** /api/kratos/public/self-service/settings | Complete Settings Flow
|
113
|
+
*OryHydraClient::V0alpha1Api* | [**submit_self_service_verification_flow**](docs/V0alpha1Api.md#submit_self_service_verification_flow) | **POST** /api/kratos/public/self-service/verification | Complete Verification Flow
|
114
|
+
*OryHydraClient::V0alpha1Api* | [**to_session**](docs/V0alpha1Api.md#to_session) | **GET** /api/kratos/public/sessions/whoami | Check Who the Current HTTP Session Belongs To
|
131
115
|
|
132
116
|
|
133
117
|
## Documentation for Models
|
134
118
|
|
119
|
+
- [OryHydraClient::AdminCreateIdentityBody](docs/AdminCreateIdentityBody.md)
|
120
|
+
- [OryHydraClient::AdminCreateSelfServiceRecoveryLinkBody](docs/AdminCreateSelfServiceRecoveryLinkBody.md)
|
121
|
+
- [OryHydraClient::AdminUpdateIdentityBody](docs/AdminUpdateIdentityBody.md)
|
135
122
|
- [OryHydraClient::AuthenticateOKBody](docs/AuthenticateOKBody.md)
|
136
123
|
- [OryHydraClient::ContainerChangeResponseItem](docs/ContainerChangeResponseItem.md)
|
137
124
|
- [OryHydraClient::ContainerCreateCreatedBody](docs/ContainerCreateCreatedBody.md)
|
@@ -139,8 +126,6 @@ Class | Method | HTTP request | Description
|
|
139
126
|
- [OryHydraClient::ContainerUpdateOKBody](docs/ContainerUpdateOKBody.md)
|
140
127
|
- [OryHydraClient::ContainerWaitOKBody](docs/ContainerWaitOKBody.md)
|
141
128
|
- [OryHydraClient::ContainerWaitOKBodyError](docs/ContainerWaitOKBodyError.md)
|
142
|
-
- [OryHydraClient::CreateIdentity](docs/CreateIdentity.md)
|
143
|
-
- [OryHydraClient::CreateRecoveryLink](docs/CreateRecoveryLink.md)
|
144
129
|
- [OryHydraClient::ErrorResponse](docs/ErrorResponse.md)
|
145
130
|
- [OryHydraClient::GenericError](docs/GenericError.md)
|
146
131
|
- [OryHydraClient::GraphDriverData](docs/GraphDriverData.md)
|
@@ -149,14 +134,13 @@ Class | Method | HTTP request | Description
|
|
149
134
|
- [OryHydraClient::IdResponse](docs/IdResponse.md)
|
150
135
|
- [OryHydraClient::Identity](docs/Identity.md)
|
151
136
|
- [OryHydraClient::IdentityCredentials](docs/IdentityCredentials.md)
|
137
|
+
- [OryHydraClient::IdentityState](docs/IdentityState.md)
|
152
138
|
- [OryHydraClient::ImageDeleteResponseItem](docs/ImageDeleteResponseItem.md)
|
153
139
|
- [OryHydraClient::ImageSummary](docs/ImageSummary.md)
|
154
140
|
- [OryHydraClient::InlineResponse200](docs/InlineResponse200.md)
|
155
141
|
- [OryHydraClient::InlineResponse2001](docs/InlineResponse2001.md)
|
156
142
|
- [OryHydraClient::InlineResponse503](docs/InlineResponse503.md)
|
157
143
|
- [OryHydraClient::JsonError](docs/JsonError.md)
|
158
|
-
- [OryHydraClient::LoginFlow](docs/LoginFlow.md)
|
159
|
-
- [OryHydraClient::LoginViaApiResponse](docs/LoginViaApiResponse.md)
|
160
144
|
- [OryHydraClient::Meta](docs/Meta.md)
|
161
145
|
- [OryHydraClient::Plugin](docs/Plugin.md)
|
162
146
|
- [OryHydraClient::PluginConfig](docs/PluginConfig.md)
|
@@ -173,27 +157,38 @@ Class | Method | HTTP request | Description
|
|
173
157
|
- [OryHydraClient::PluginSettings](docs/PluginSettings.md)
|
174
158
|
- [OryHydraClient::Port](docs/Port.md)
|
175
159
|
- [OryHydraClient::RecoveryAddress](docs/RecoveryAddress.md)
|
176
|
-
- [OryHydraClient::
|
177
|
-
- [OryHydraClient::
|
178
|
-
- [OryHydraClient::
|
179
|
-
- [OryHydraClient::
|
180
|
-
- [OryHydraClient::
|
181
|
-
- [OryHydraClient::
|
160
|
+
- [OryHydraClient::SelfServiceError](docs/SelfServiceError.md)
|
161
|
+
- [OryHydraClient::SelfServiceLoginFlow](docs/SelfServiceLoginFlow.md)
|
162
|
+
- [OryHydraClient::SelfServiceLogoutUrl](docs/SelfServiceLogoutUrl.md)
|
163
|
+
- [OryHydraClient::SelfServiceRecoveryFlow](docs/SelfServiceRecoveryFlow.md)
|
164
|
+
- [OryHydraClient::SelfServiceRecoveryFlowState](docs/SelfServiceRecoveryFlowState.md)
|
165
|
+
- [OryHydraClient::SelfServiceRecoveryLink](docs/SelfServiceRecoveryLink.md)
|
166
|
+
- [OryHydraClient::SelfServiceRegistrationFlow](docs/SelfServiceRegistrationFlow.md)
|
167
|
+
- [OryHydraClient::SelfServiceSettingsFlow](docs/SelfServiceSettingsFlow.md)
|
168
|
+
- [OryHydraClient::SelfServiceSettingsFlowState](docs/SelfServiceSettingsFlowState.md)
|
169
|
+
- [OryHydraClient::SelfServiceVerificationFlow](docs/SelfServiceVerificationFlow.md)
|
170
|
+
- [OryHydraClient::SelfServiceVerificationFlowState](docs/SelfServiceVerificationFlowState.md)
|
182
171
|
- [OryHydraClient::ServiceUpdateResponse](docs/ServiceUpdateResponse.md)
|
183
172
|
- [OryHydraClient::Session](docs/Session.md)
|
184
|
-
- [OryHydraClient::SettingsFlow](docs/SettingsFlow.md)
|
185
173
|
- [OryHydraClient::SettingsProfileFormConfig](docs/SettingsProfileFormConfig.md)
|
186
|
-
- [OryHydraClient::
|
187
|
-
- [OryHydraClient::
|
188
|
-
- [OryHydraClient::
|
189
|
-
- [OryHydraClient::
|
190
|
-
- [OryHydraClient::
|
191
|
-
- [OryHydraClient::
|
192
|
-
- [OryHydraClient::
|
193
|
-
- [OryHydraClient::
|
194
|
-
- [OryHydraClient::
|
195
|
-
- [OryHydraClient::
|
196
|
-
- [OryHydraClient::
|
174
|
+
- [OryHydraClient::SubmitSelfServiceLoginFlowBody](docs/SubmitSelfServiceLoginFlowBody.md)
|
175
|
+
- [OryHydraClient::SubmitSelfServiceLoginFlowWithOidcMethodBody](docs/SubmitSelfServiceLoginFlowWithOidcMethodBody.md)
|
176
|
+
- [OryHydraClient::SubmitSelfServiceLoginFlowWithPasswordMethodBody](docs/SubmitSelfServiceLoginFlowWithPasswordMethodBody.md)
|
177
|
+
- [OryHydraClient::SubmitSelfServiceLogoutFlowWithoutBrowserBody](docs/SubmitSelfServiceLogoutFlowWithoutBrowserBody.md)
|
178
|
+
- [OryHydraClient::SubmitSelfServiceRecoveryFlowBody](docs/SubmitSelfServiceRecoveryFlowBody.md)
|
179
|
+
- [OryHydraClient::SubmitSelfServiceRecoveryFlowWithLinkMethodBody](docs/SubmitSelfServiceRecoveryFlowWithLinkMethodBody.md)
|
180
|
+
- [OryHydraClient::SubmitSelfServiceRegistrationFlowBody](docs/SubmitSelfServiceRegistrationFlowBody.md)
|
181
|
+
- [OryHydraClient::SubmitSelfServiceRegistrationFlowWithOidcMethodBody](docs/SubmitSelfServiceRegistrationFlowWithOidcMethodBody.md)
|
182
|
+
- [OryHydraClient::SubmitSelfServiceRegistrationFlowWithPasswordMethodBody](docs/SubmitSelfServiceRegistrationFlowWithPasswordMethodBody.md)
|
183
|
+
- [OryHydraClient::SubmitSelfServiceSettingsFlowBody](docs/SubmitSelfServiceSettingsFlowBody.md)
|
184
|
+
- [OryHydraClient::SubmitSelfServiceSettingsFlowWithOidcMethodBody](docs/SubmitSelfServiceSettingsFlowWithOidcMethodBody.md)
|
185
|
+
- [OryHydraClient::SubmitSelfServiceSettingsFlowWithPasswordMethodBody](docs/SubmitSelfServiceSettingsFlowWithPasswordMethodBody.md)
|
186
|
+
- [OryHydraClient::SubmitSelfServiceSettingsFlowWithProfileMethodBody](docs/SubmitSelfServiceSettingsFlowWithProfileMethodBody.md)
|
187
|
+
- [OryHydraClient::SubmitSelfServiceVerificationFlowBody](docs/SubmitSelfServiceVerificationFlowBody.md)
|
188
|
+
- [OryHydraClient::SubmitSelfServiceVerificationFlowWithLinkMethodBody](docs/SubmitSelfServiceVerificationFlowWithLinkMethodBody.md)
|
189
|
+
- [OryHydraClient::SuccessfulSelfServiceLoginWithoutBrowser](docs/SuccessfulSelfServiceLoginWithoutBrowser.md)
|
190
|
+
- [OryHydraClient::SuccessfulSelfServiceRegistrationWithoutBrowser](docs/SuccessfulSelfServiceRegistrationWithoutBrowser.md)
|
191
|
+
- [OryHydraClient::SuccessfulSelfServiceSettingsWithoutBrowser](docs/SuccessfulSelfServiceSettingsWithoutBrowser.md)
|
197
192
|
- [OryHydraClient::UiContainer](docs/UiContainer.md)
|
198
193
|
- [OryHydraClient::UiNode](docs/UiNode.md)
|
199
194
|
- [OryHydraClient::UiNodeAnchorAttributes](docs/UiNodeAnchorAttributes.md)
|
@@ -202,9 +197,7 @@ Class | Method | HTTP request | Description
|
|
202
197
|
- [OryHydraClient::UiNodeInputAttributes](docs/UiNodeInputAttributes.md)
|
203
198
|
- [OryHydraClient::UiNodeTextAttributes](docs/UiNodeTextAttributes.md)
|
204
199
|
- [OryHydraClient::UiText](docs/UiText.md)
|
205
|
-
- [OryHydraClient::UpdateIdentity](docs/UpdateIdentity.md)
|
206
200
|
- [OryHydraClient::VerifiableIdentityAddress](docs/VerifiableIdentityAddress.md)
|
207
|
-
- [OryHydraClient::VerificationFlow](docs/VerificationFlow.md)
|
208
201
|
- [OryHydraClient::Version](docs/Version.md)
|
209
202
|
- [OryHydraClient::Volume](docs/Volume.md)
|
210
203
|
- [OryHydraClient::VolumeUsageData](docs/VolumeUsageData.md)
|
@@ -213,18 +206,7 @@ Class | Method | HTTP request | Description
|
|
213
206
|
## Documentation for Authorization
|
214
207
|
|
215
208
|
|
216
|
-
###
|
217
|
-
|
218
|
-
- **Type**: Bearer authentication
|
219
|
-
|
220
|
-
### sessionCookie
|
221
|
-
|
222
|
-
|
223
|
-
- **Type**: API key
|
224
|
-
- **API key parameter name**: ory_kratos_session
|
225
|
-
- **Location**:
|
226
|
-
|
227
|
-
### sessionToken
|
209
|
+
### oryAccessToken
|
228
210
|
|
229
211
|
- **Type**: Bearer authentication
|
230
212
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# OryHydraClient::AdminCreateIdentityBody
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **schema_id** | **String** | SchemaID is the ID of the JSON Schema to be used for validating the identity's traits. | |
|
8
|
+
| **traits** | **Object** | Traits represent an identity's traits. The identity is able to create, modify, and delete traits in a self-service manner. The input will always be validated against the JSON Schema defined in `schema_url`. | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'ory-client'
|
14
|
+
|
15
|
+
instance = OryHydraClient::AdminCreateIdentityBody.new(
|
16
|
+
schema_id: null,
|
17
|
+
traits: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# OryHydraClient::AdminCreateSelfServiceRecoveryLinkBody
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **expires_in** | **String** | Link Expires In The recovery link will expire at that point in time. Defaults to the configuration value of `selfservice.flows.recovery.request_lifespan`. | [optional] |
|
8
|
+
| **identity_id** | **String** | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'ory-client'
|
14
|
+
|
15
|
+
instance = OryHydraClient::AdminCreateSelfServiceRecoveryLinkBody.new(
|
16
|
+
expires_in: null,
|
17
|
+
identity_id: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# OryHydraClient::AdminUpdateIdentityBody
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **schema_id** | **String** | SchemaID is the ID of the JSON Schema to be used for validating the identity's traits. If set will update the Identity's SchemaID. | [optional] |
|
8
|
+
| **state** | [**IdentityState**](IdentityState.md) | | |
|
9
|
+
| **traits** | **Object** | Traits represent an identity's traits. The identity is able to create, modify, and delete traits in a self-service manner. The input will always be validated against the JSON Schema defined in `schema_id`. | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'ory-client'
|
15
|
+
|
16
|
+
instance = OryHydraClient::AdminUpdateIdentityBody.new(
|
17
|
+
schema_id: null,
|
18
|
+
state: null,
|
19
|
+
traits: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/Identity.md
CHANGED
@@ -5,10 +5,13 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **created_at** | **Time** | CreatedAt is a helper struct field for gobuffalo.pop. | [optional] |
|
8
|
+
| **credentials** | [**Hash<String, IdentityCredentials>**](IdentityCredentials.md) | Credentials represents all credentials that can be used for authenticating this identity. | [optional] |
|
8
9
|
| **id** | **String** | | |
|
9
10
|
| **recovery_addresses** | [**Array<RecoveryAddress>**](RecoveryAddress.md) | RecoveryAddresses contains all the addresses that can be used to recover an identity. | [optional] |
|
10
11
|
| **schema_id** | **String** | SchemaID is the ID of the JSON Schema to be used for validating the identity's traits. | |
|
11
12
|
| **schema_url** | **String** | SchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from. format: url | |
|
13
|
+
| **state** | [**IdentityState**](IdentityState.md) | | [optional] |
|
14
|
+
| **state_changed_at** | **Time** | | [optional] |
|
12
15
|
| **traits** | [**AnyType**](.md) | Traits represent an identity's traits. The identity is able to create, modify, and delete traits in a self-service manner. The input will always be validated against the JSON Schema defined in `schema_url`. | |
|
13
16
|
| **updated_at** | **Time** | UpdatedAt is a helper struct field for gobuffalo.pop. | [optional] |
|
14
17
|
| **verifiable_addresses** | [**Array<VerifiableIdentityAddress>**](VerifiableIdentityAddress.md) | VerifiableAddresses contains all the addresses that can be verified by the user. | [optional] |
|
@@ -20,10 +23,13 @@ require 'ory-client'
|
|
20
23
|
|
21
24
|
instance = OryHydraClient::Identity.new(
|
22
25
|
created_at: null,
|
26
|
+
credentials: null,
|
23
27
|
id: null,
|
24
28
|
recovery_addresses: null,
|
25
29
|
schema_id: null,
|
26
30
|
schema_url: null,
|
31
|
+
state: null,
|
32
|
+
state_changed_at: null,
|
27
33
|
traits: null,
|
28
34
|
updated_at: null,
|
29
35
|
verifiable_addresses: null
|
data/docs/MetadataApi.md
ADDED
@@ -0,0 +1,254 @@
|
|
1
|
+
# OryHydraClient::MetadataApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://playground.projects.oryapis.com*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**get_version**](MetadataApi.md#get_version) | **GET** /api/kratos/public/version | Return Running Software Version. |
|
8
|
+
| [**is_alive**](MetadataApi.md#is_alive) | **GET** /api/kratos/public/health/alive | Check HTTP Server Status |
|
9
|
+
| [**is_ready**](MetadataApi.md#is_ready) | **GET** /api/kratos/public/health/ready | Check HTTP Server and Database Status |
|
10
|
+
| [**prometheus**](MetadataApi.md#prometheus) | **GET** /api/kratos/public/metrics/prometheus | Get snapshot metrics from the service. If you're using k8s, you can then add annotations to your deployment like so: |
|
11
|
+
|
12
|
+
|
13
|
+
## get_version
|
14
|
+
|
15
|
+
> <InlineResponse2001> get_version
|
16
|
+
|
17
|
+
Return Running Software Version.
|
18
|
+
|
19
|
+
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.
|
20
|
+
|
21
|
+
### Examples
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
require 'time'
|
25
|
+
require 'ory-client'
|
26
|
+
|
27
|
+
api_instance = OryHydraClient::MetadataApi.new
|
28
|
+
|
29
|
+
begin
|
30
|
+
# Return Running Software Version.
|
31
|
+
result = api_instance.get_version
|
32
|
+
p result
|
33
|
+
rescue OryHydraClient::ApiError => e
|
34
|
+
puts "Error when calling MetadataApi->get_version: #{e}"
|
35
|
+
end
|
36
|
+
```
|
37
|
+
|
38
|
+
#### Using the get_version_with_http_info variant
|
39
|
+
|
40
|
+
This returns an Array which contains the response data, status code and headers.
|
41
|
+
|
42
|
+
> <Array(<InlineResponse2001>, Integer, Hash)> get_version_with_http_info
|
43
|
+
|
44
|
+
```ruby
|
45
|
+
begin
|
46
|
+
# Return Running Software Version.
|
47
|
+
data, status_code, headers = api_instance.get_version_with_http_info
|
48
|
+
p status_code # => 2xx
|
49
|
+
p headers # => { ... }
|
50
|
+
p data # => <InlineResponse2001>
|
51
|
+
rescue OryHydraClient::ApiError => e
|
52
|
+
puts "Error when calling MetadataApi->get_version_with_http_info: #{e}"
|
53
|
+
end
|
54
|
+
```
|
55
|
+
|
56
|
+
### Parameters
|
57
|
+
|
58
|
+
This endpoint does not need any parameter.
|
59
|
+
|
60
|
+
### Return type
|
61
|
+
|
62
|
+
[**InlineResponse2001**](InlineResponse2001.md)
|
63
|
+
|
64
|
+
### Authorization
|
65
|
+
|
66
|
+
No authorization required
|
67
|
+
|
68
|
+
### HTTP request headers
|
69
|
+
|
70
|
+
- **Content-Type**: Not defined
|
71
|
+
- **Accept**: application/json
|
72
|
+
|
73
|
+
|
74
|
+
## is_alive
|
75
|
+
|
76
|
+
> <InlineResponse200> is_alive
|
77
|
+
|
78
|
+
Check HTTP Server Status
|
79
|
+
|
80
|
+
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.
|
81
|
+
|
82
|
+
### Examples
|
83
|
+
|
84
|
+
```ruby
|
85
|
+
require 'time'
|
86
|
+
require 'ory-client'
|
87
|
+
|
88
|
+
api_instance = OryHydraClient::MetadataApi.new
|
89
|
+
|
90
|
+
begin
|
91
|
+
# Check HTTP Server Status
|
92
|
+
result = api_instance.is_alive
|
93
|
+
p result
|
94
|
+
rescue OryHydraClient::ApiError => e
|
95
|
+
puts "Error when calling MetadataApi->is_alive: #{e}"
|
96
|
+
end
|
97
|
+
```
|
98
|
+
|
99
|
+
#### Using the is_alive_with_http_info variant
|
100
|
+
|
101
|
+
This returns an Array which contains the response data, status code and headers.
|
102
|
+
|
103
|
+
> <Array(<InlineResponse200>, Integer, Hash)> is_alive_with_http_info
|
104
|
+
|
105
|
+
```ruby
|
106
|
+
begin
|
107
|
+
# Check HTTP Server Status
|
108
|
+
data, status_code, headers = api_instance.is_alive_with_http_info
|
109
|
+
p status_code # => 2xx
|
110
|
+
p headers # => { ... }
|
111
|
+
p data # => <InlineResponse200>
|
112
|
+
rescue OryHydraClient::ApiError => e
|
113
|
+
puts "Error when calling MetadataApi->is_alive_with_http_info: #{e}"
|
114
|
+
end
|
115
|
+
```
|
116
|
+
|
117
|
+
### Parameters
|
118
|
+
|
119
|
+
This endpoint does not need any parameter.
|
120
|
+
|
121
|
+
### Return type
|
122
|
+
|
123
|
+
[**InlineResponse200**](InlineResponse200.md)
|
124
|
+
|
125
|
+
### Authorization
|
126
|
+
|
127
|
+
No authorization required
|
128
|
+
|
129
|
+
### HTTP request headers
|
130
|
+
|
131
|
+
- **Content-Type**: Not defined
|
132
|
+
- **Accept**: application/json
|
133
|
+
|
134
|
+
|
135
|
+
## is_ready
|
136
|
+
|
137
|
+
> <InlineResponse200> is_ready
|
138
|
+
|
139
|
+
Check HTTP Server and Database Status
|
140
|
+
|
141
|
+
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.
|
142
|
+
|
143
|
+
### Examples
|
144
|
+
|
145
|
+
```ruby
|
146
|
+
require 'time'
|
147
|
+
require 'ory-client'
|
148
|
+
|
149
|
+
api_instance = OryHydraClient::MetadataApi.new
|
150
|
+
|
151
|
+
begin
|
152
|
+
# Check HTTP Server and Database Status
|
153
|
+
result = api_instance.is_ready
|
154
|
+
p result
|
155
|
+
rescue OryHydraClient::ApiError => e
|
156
|
+
puts "Error when calling MetadataApi->is_ready: #{e}"
|
157
|
+
end
|
158
|
+
```
|
159
|
+
|
160
|
+
#### Using the is_ready_with_http_info variant
|
161
|
+
|
162
|
+
This returns an Array which contains the response data, status code and headers.
|
163
|
+
|
164
|
+
> <Array(<InlineResponse200>, Integer, Hash)> is_ready_with_http_info
|
165
|
+
|
166
|
+
```ruby
|
167
|
+
begin
|
168
|
+
# Check HTTP Server and Database Status
|
169
|
+
data, status_code, headers = api_instance.is_ready_with_http_info
|
170
|
+
p status_code # => 2xx
|
171
|
+
p headers # => { ... }
|
172
|
+
p data # => <InlineResponse200>
|
173
|
+
rescue OryHydraClient::ApiError => e
|
174
|
+
puts "Error when calling MetadataApi->is_ready_with_http_info: #{e}"
|
175
|
+
end
|
176
|
+
```
|
177
|
+
|
178
|
+
### Parameters
|
179
|
+
|
180
|
+
This endpoint does not need any parameter.
|
181
|
+
|
182
|
+
### Return type
|
183
|
+
|
184
|
+
[**InlineResponse200**](InlineResponse200.md)
|
185
|
+
|
186
|
+
### Authorization
|
187
|
+
|
188
|
+
No authorization required
|
189
|
+
|
190
|
+
### HTTP request headers
|
191
|
+
|
192
|
+
- **Content-Type**: Not defined
|
193
|
+
- **Accept**: application/json
|
194
|
+
|
195
|
+
|
196
|
+
## prometheus
|
197
|
+
|
198
|
+
> prometheus
|
199
|
+
|
200
|
+
Get snapshot metrics from the service. If you're using k8s, you can then add annotations to your deployment like so:
|
201
|
+
|
202
|
+
``` metadata: annotations: prometheus.io/port: \"4434\" prometheus.io/path: \"/metrics/prometheus\" ```
|
203
|
+
|
204
|
+
### Examples
|
205
|
+
|
206
|
+
```ruby
|
207
|
+
require 'time'
|
208
|
+
require 'ory-client'
|
209
|
+
|
210
|
+
api_instance = OryHydraClient::MetadataApi.new
|
211
|
+
|
212
|
+
begin
|
213
|
+
# Get snapshot metrics from the service. If you're using k8s, you can then add annotations to your deployment like so:
|
214
|
+
api_instance.prometheus
|
215
|
+
rescue OryHydraClient::ApiError => e
|
216
|
+
puts "Error when calling MetadataApi->prometheus: #{e}"
|
217
|
+
end
|
218
|
+
```
|
219
|
+
|
220
|
+
#### Using the prometheus_with_http_info variant
|
221
|
+
|
222
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
223
|
+
|
224
|
+
> <Array(nil, Integer, Hash)> prometheus_with_http_info
|
225
|
+
|
226
|
+
```ruby
|
227
|
+
begin
|
228
|
+
# Get snapshot metrics from the service. If you're using k8s, you can then add annotations to your deployment like so:
|
229
|
+
data, status_code, headers = api_instance.prometheus_with_http_info
|
230
|
+
p status_code # => 2xx
|
231
|
+
p headers # => { ... }
|
232
|
+
p data # => nil
|
233
|
+
rescue OryHydraClient::ApiError => e
|
234
|
+
puts "Error when calling MetadataApi->prometheus_with_http_info: #{e}"
|
235
|
+
end
|
236
|
+
```
|
237
|
+
|
238
|
+
### Parameters
|
239
|
+
|
240
|
+
This endpoint does not need any parameter.
|
241
|
+
|
242
|
+
### Return type
|
243
|
+
|
244
|
+
nil (empty response body)
|
245
|
+
|
246
|
+
### Authorization
|
247
|
+
|
248
|
+
No authorization required
|
249
|
+
|
250
|
+
### HTTP request headers
|
251
|
+
|
252
|
+
- **Content-Type**: Not defined
|
253
|
+
- **Accept**: Not defined
|
254
|
+
|