ory-kratos-client 0.6.3.alpha1 → 0.7.0.alpha1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (169) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +78 -92
  3. data/docs/AdminCreateIdentityBody.md +20 -0
  4. data/docs/AdminCreateSelfServiceRecoveryLinkBody.md +20 -0
  5. data/docs/AdminUpdateIdentityBody.md +22 -0
  6. data/docs/Identity.md +6 -0
  7. data/docs/MetadataApi.md +254 -0
  8. data/docs/SelfServiceError.md +24 -0
  9. data/docs/SelfServiceLoginFlow.md +36 -0
  10. data/docs/SelfServiceLogoutUrl.md +18 -0
  11. data/docs/SelfServiceRecoveryFlow.md +32 -0
  12. data/docs/SelfServiceRecoveryFlowState.md +15 -0
  13. data/docs/SelfServiceRecoveryLink.md +20 -0
  14. data/docs/SelfServiceRegistrationFlow.md +30 -0
  15. data/docs/SelfServiceSettingsFlow.md +34 -0
  16. data/docs/SelfServiceSettingsFlowState.md +15 -0
  17. data/docs/SelfServiceVerificationFlow.md +32 -0
  18. data/docs/SelfServiceVerificationFlowState.md +15 -0
  19. data/docs/Session.md +4 -4
  20. data/docs/SubmitSelfServiceLoginFlowBody.md +76 -0
  21. data/docs/SubmitSelfServiceLoginFlowWithOidcMethodBody.md +22 -0
  22. data/docs/SubmitSelfServiceLoginFlowWithPasswordMethodBody.md +24 -0
  23. data/docs/SubmitSelfServiceLogoutFlowWithoutBrowserBody.md +18 -0
  24. data/docs/SubmitSelfServiceRecoveryFlowBody.md +75 -0
  25. data/docs/SubmitSelfServiceRecoveryFlowWithLinkMethodBody.md +22 -0
  26. data/docs/SubmitSelfServiceRegistrationFlowBody.md +76 -0
  27. data/docs/SubmitSelfServiceRegistrationFlowWithOidcMethodBody.md +22 -0
  28. data/docs/SubmitSelfServiceRegistrationFlowWithPasswordMethodBody.md +24 -0
  29. data/docs/SubmitSelfServiceSettingsFlowBody.md +79 -0
  30. data/docs/SubmitSelfServiceSettingsFlowWithOidcMethodBody.md +24 -0
  31. data/docs/SubmitSelfServiceSettingsFlowWithPasswordMethodBody.md +22 -0
  32. data/docs/SubmitSelfServiceSettingsFlowWithProfileMethodBody.md +22 -0
  33. data/docs/SubmitSelfServiceVerificationFlowBody.md +75 -0
  34. data/docs/SubmitSelfServiceVerificationFlowWithLinkMethodBody.md +22 -0
  35. data/docs/SuccessfulSelfServiceLoginWithoutBrowser.md +20 -0
  36. data/docs/SuccessfulSelfServiceRegistrationWithoutBrowser.md +22 -0
  37. data/docs/SuccessfulSelfServiceSettingsWithoutBrowser.md +20 -0
  38. data/docs/UiNodeInputAttributes.md +1 -1
  39. data/docs/V0alpha1Api.md +2167 -0
  40. data/lib/ory-kratos-client.rb +35 -28
  41. data/lib/ory-kratos-client/api/metadata_api.rb +248 -0
  42. data/lib/ory-kratos-client/api/v0alpha1_api.rb +2054 -0
  43. data/lib/ory-kratos-client/api_client.rb +1 -1
  44. data/lib/ory-kratos-client/api_error.rb +1 -1
  45. data/lib/ory-kratos-client/configuration.rb +2 -16
  46. data/lib/ory-kratos-client/models/admin_create_identity_body.rb +239 -0
  47. data/lib/ory-kratos-client/models/admin_create_self_service_recovery_link_body.rb +250 -0
  48. data/lib/ory-kratos-client/models/admin_update_identity_body.rb +245 -0
  49. data/lib/ory-kratos-client/models/authenticate_ok_body.rb +1 -1
  50. data/lib/ory-kratos-client/models/container_change_response_item.rb +1 -1
  51. data/lib/ory-kratos-client/models/container_create_created_body.rb +1 -1
  52. data/lib/ory-kratos-client/models/container_top_ok_body.rb +1 -1
  53. data/lib/ory-kratos-client/models/container_update_ok_body.rb +1 -1
  54. data/lib/ory-kratos-client/models/container_wait_ok_body.rb +1 -1
  55. data/lib/ory-kratos-client/models/container_wait_ok_body_error.rb +1 -1
  56. data/lib/ory-kratos-client/models/error_response.rb +1 -1
  57. data/lib/ory-kratos-client/models/generic_error.rb +1 -1
  58. data/lib/ory-kratos-client/models/graph_driver_data.rb +1 -1
  59. data/lib/ory-kratos-client/models/health_not_ready_status.rb +1 -1
  60. data/lib/ory-kratos-client/models/health_status.rb +1 -1
  61. data/lib/ory-kratos-client/models/id_response.rb +1 -1
  62. data/lib/ory-kratos-client/models/identity.rb +34 -2
  63. data/lib/ory-kratos-client/models/identity_credentials.rb +1 -1
  64. data/lib/ory-kratos-client/models/image_delete_response_item.rb +1 -1
  65. data/lib/ory-kratos-client/models/image_summary.rb +1 -1
  66. data/lib/ory-kratos-client/models/inline_response200.rb +1 -1
  67. data/lib/ory-kratos-client/models/inline_response2001.rb +1 -1
  68. data/lib/ory-kratos-client/models/inline_response503.rb +1 -1
  69. data/lib/ory-kratos-client/models/json_error.rb +1 -1
  70. data/lib/ory-kratos-client/models/meta.rb +1 -1
  71. data/lib/ory-kratos-client/models/plugin.rb +1 -1
  72. data/lib/ory-kratos-client/models/plugin_config.rb +1 -1
  73. data/lib/ory-kratos-client/models/plugin_config_args.rb +1 -1
  74. data/lib/ory-kratos-client/models/plugin_config_interface.rb +1 -1
  75. data/lib/ory-kratos-client/models/plugin_config_linux.rb +1 -1
  76. data/lib/ory-kratos-client/models/plugin_config_network.rb +1 -1
  77. data/lib/ory-kratos-client/models/plugin_config_rootfs.rb +1 -1
  78. data/lib/ory-kratos-client/models/plugin_config_user.rb +1 -1
  79. data/lib/ory-kratos-client/models/plugin_device.rb +1 -1
  80. data/lib/ory-kratos-client/models/plugin_env.rb +1 -1
  81. data/lib/ory-kratos-client/models/plugin_interface_type.rb +1 -1
  82. data/lib/ory-kratos-client/models/plugin_mount.rb +1 -1
  83. data/lib/ory-kratos-client/models/plugin_settings.rb +1 -1
  84. data/lib/ory-kratos-client/models/port.rb +1 -1
  85. data/lib/ory-kratos-client/models/recovery_address.rb +1 -1
  86. data/lib/ory-kratos-client/models/self_service_error.rb +252 -0
  87. data/lib/ory-kratos-client/models/self_service_login_flow.rb +338 -0
  88. data/lib/ory-kratos-client/models/self_service_logout_url.rb +219 -0
  89. data/lib/ory-kratos-client/models/self_service_recovery_flow.rb +317 -0
  90. data/lib/ory-kratos-client/models/self_service_recovery_flow_state.rb +38 -0
  91. data/lib/ory-kratos-client/models/self_service_recovery_link.rb +234 -0
  92. data/lib/ory-kratos-client/models/self_service_registration_flow.rb +302 -0
  93. data/lib/ory-kratos-client/models/self_service_settings_flow.rb +331 -0
  94. data/lib/ory-kratos-client/models/self_service_settings_flow_state.rb +37 -0
  95. data/lib/ory-kratos-client/models/self_service_verification_flow.rb +307 -0
  96. data/lib/ory-kratos-client/models/self_service_verification_flow_state.rb +38 -0
  97. data/lib/ory-kratos-client/models/service_update_response.rb +1 -1
  98. data/lib/ory-kratos-client/models/session.rb +6 -16
  99. data/lib/ory-kratos-client/models/settings_profile_form_config.rb +1 -1
  100. data/lib/ory-kratos-client/models/submit_self_service_login_flow_body.rb +54 -0
  101. data/lib/ory-kratos-client/models/submit_self_service_login_flow_with_oidc_method_body.rb +250 -0
  102. data/lib/ory-kratos-client/models/submit_self_service_login_flow_with_password_method_body.rb +298 -0
  103. data/lib/ory-kratos-client/models/submit_self_service_logout_flow_without_browser_body.rb +225 -0
  104. data/lib/ory-kratos-client/models/submit_self_service_recovery_flow_body.rb +53 -0
  105. data/lib/ory-kratos-client/models/submit_self_service_recovery_flow_with_link_method_body.rb +283 -0
  106. data/lib/ory-kratos-client/models/submit_self_service_registration_flow_body.rb +54 -0
  107. data/lib/ory-kratos-client/models/submit_self_service_registration_flow_with_oidc_method_body.rb +250 -0
  108. data/lib/ory-kratos-client/models/submit_self_service_registration_flow_with_password_method_body.rb +299 -0
  109. data/lib/ory-kratos-client/models/submit_self_service_settings_flow_body.rb +56 -0
  110. data/lib/ory-kratos-client/models/submit_self_service_settings_flow_with_oidc_method_body.rb +255 -0
  111. data/lib/ory-kratos-client/models/submit_self_service_settings_flow_with_password_method_body.rb +283 -0
  112. data/lib/ory-kratos-client/models/submit_self_service_settings_flow_with_profile_method_body.rb +250 -0
  113. data/lib/ory-kratos-client/models/submit_self_service_verification_flow_body.rb +54 -0
  114. data/lib/ory-kratos-client/models/submit_self_service_verification_flow_with_link_method_body.rb +283 -0
  115. data/lib/ory-kratos-client/models/successful_self_service_login_without_browser.rb +234 -0
  116. data/lib/ory-kratos-client/models/successful_self_service_registration_without_browser.rb +243 -0
  117. data/lib/ory-kratos-client/models/successful_self_service_settings_without_browser.rb +238 -0
  118. data/lib/ory-kratos-client/models/ui_container.rb +1 -1
  119. data/lib/ory-kratos-client/models/ui_node.rb +1 -1
  120. data/lib/ory-kratos-client/models/ui_node_anchor_attributes.rb +1 -1
  121. data/lib/ory-kratos-client/models/ui_node_attributes.rb +1 -1
  122. data/lib/ory-kratos-client/models/ui_node_image_attributes.rb +1 -1
  123. data/lib/ory-kratos-client/models/ui_node_input_attributes.rb +4 -2
  124. data/lib/ory-kratos-client/models/ui_node_text_attributes.rb +1 -1
  125. data/lib/ory-kratos-client/models/ui_text.rb +1 -1
  126. data/lib/ory-kratos-client/models/verifiable_identity_address.rb +1 -1
  127. data/lib/ory-kratos-client/models/version.rb +1 -1
  128. data/lib/ory-kratos-client/models/volume.rb +1 -1
  129. data/lib/ory-kratos-client/models/volume_usage_data.rb +1 -1
  130. data/lib/ory-kratos-client/version.rb +2 -2
  131. data/ory-kratos-client.gemspec +1 -1
  132. data/spec/api/metadata_api_spec.rb +79 -0
  133. data/spec/api/v0alpha1_api_spec.rb +429 -0
  134. data/spec/api_client_spec.rb +1 -1
  135. data/spec/configuration_spec.rb +1 -1
  136. data/spec/models/admin_create_identity_body_spec.rb +40 -0
  137. data/spec/models/admin_create_self_service_recovery_link_body_spec.rb +40 -0
  138. data/spec/models/admin_update_identity_body_spec.rb +46 -0
  139. data/spec/models/self_service_error_spec.rb +52 -0
  140. data/spec/models/self_service_login_flow_spec.rb +88 -0
  141. data/spec/models/self_service_logout_url_spec.rb +34 -0
  142. data/spec/models/self_service_recovery_flow_spec.rb +76 -0
  143. data/spec/models/self_service_recovery_flow_state_spec.rb +28 -0
  144. data/spec/models/self_service_recovery_link_spec.rb +40 -0
  145. data/spec/models/self_service_registration_flow_spec.rb +70 -0
  146. data/spec/models/self_service_settings_flow_spec.rb +82 -0
  147. data/spec/models/self_service_settings_flow_state_spec.rb +28 -0
  148. data/spec/models/self_service_verification_flow_spec.rb +76 -0
  149. data/spec/models/self_service_verification_flow_state_spec.rb +28 -0
  150. data/spec/models/submit_self_service_login_flow_body_spec.rb +43 -0
  151. data/spec/models/submit_self_service_login_flow_with_oidc_method_body_spec.rb +46 -0
  152. data/spec/models/submit_self_service_login_flow_with_password_method_body_spec.rb +56 -0
  153. data/spec/models/submit_self_service_logout_flow_without_browser_body_spec.rb +34 -0
  154. data/spec/models/submit_self_service_recovery_flow_body_spec.rb +43 -0
  155. data/spec/models/submit_self_service_recovery_flow_with_link_method_body_spec.rb +50 -0
  156. data/spec/models/submit_self_service_registration_flow_body_spec.rb +43 -0
  157. data/spec/models/submit_self_service_registration_flow_with_oidc_method_body_spec.rb +46 -0
  158. data/spec/models/submit_self_service_registration_flow_with_password_method_body_spec.rb +56 -0
  159. data/spec/models/submit_self_service_settings_flow_body_spec.rb +43 -0
  160. data/spec/models/submit_self_service_settings_flow_with_oidc_method_body_spec.rb +52 -0
  161. data/spec/models/submit_self_service_settings_flow_with_password_method_body_spec.rb +50 -0
  162. data/spec/models/submit_self_service_settings_flow_with_profile_method_body_spec.rb +46 -0
  163. data/spec/models/submit_self_service_verification_flow_body_spec.rb +43 -0
  164. data/spec/models/submit_self_service_verification_flow_with_link_method_body_spec.rb +50 -0
  165. data/spec/models/successful_self_service_login_without_browser_spec.rb +40 -0
  166. data/spec/models/successful_self_service_registration_without_browser_spec.rb +46 -0
  167. data/spec/models/successful_self_service_settings_without_browser_spec.rb +40 -0
  168. data/spec/spec_helper.rb +1 -1
  169. metadata +141 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 39ffb82f353c1b16fb66fd48728c1b99eef437e402a7b89eb035826b9d07833e
4
- data.tar.gz: b18ef070af01a9868d5139042225c11fe7763b17d82782350a28daba910c6a60
3
+ metadata.gz: e1b628c41a084235279797aab92d28bc2f99ee7fcfe7d0f22011f58639c375e5
4
+ data.tar.gz: 8521978a621e0407de4d3fca6e53b9961271f1f9745fe5cf0617398651384573
5
5
  SHA512:
6
- metadata.gz: 2b32a8b227c22531f06513c06006898b6edc74074c67447a2de27ce4c8a45e4c56f0e52b42de53a313ff5b0aad5cf3018d3f16472c1b71d7cf7a38d1597cbced
7
- data.tar.gz: 2f953b302d9815ba5a7ce2cd22b77beeb2dc618f0198fccfdd589a6d95a52c02c822165768a4b3677e9d47822e3833e59496fe0f8accb7003c3088f8c7ef5392
6
+ metadata.gz: f963902d0187439bd8997544b5f8a6ecb073119c2e30b1ff0e357d55ef8d130815115e89e598cdcae25b42ce9b05a0b69e29796d88a8edc7b7a6380d019435dd
7
+ data.tar.gz: 8f05d9f71ca4865066798ac711c6b623956122f1eee695dc5cb26de3b02a20a2289d8cb4d92c08bc295892ff24c059483d3550799d50ec54a23931af77add047
data/README.md CHANGED
@@ -11,8 +11,8 @@ technology capable of authorizing incoming requests.
11
11
 
12
12
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
13
13
 
14
- - API version: v0.6.3-alpha.1
15
- - Package version: v0.6.3-alpha.1
14
+ - API version: v0.7.0-alpha.1
15
+ - Package version: v0.7.0-alpha.1
16
16
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
17
17
 
18
18
  ## Installation
@@ -28,16 +28,16 @@ gem build ory-kratos-client.gemspec
28
28
  Then either install the gem locally:
29
29
 
30
30
  ```shell
31
- gem install ./ory-kratos-client-v0.6.3-alpha.1.gem
31
+ gem install ./ory-kratos-client-v0.7.0-alpha.1.gem
32
32
  ```
33
33
 
34
- (for development, run `gem install --dev ./ory-kratos-client-v0.6.3-alpha.1.gem` to install the development dependencies)
34
+ (for development, run `gem install --dev ./ory-kratos-client-v0.7.0-alpha.1.gem` to install the development dependencies)
35
35
 
36
36
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
37
37
 
38
38
  Finally add this to the Gemfile:
39
39
 
40
- gem 'ory-kratos-client', '~> v0.6.3-alpha.1'
40
+ gem 'ory-kratos-client', '~> v0.7.0-alpha.1'
41
41
 
42
42
  ### Install from Git
43
43
 
@@ -61,17 +61,14 @@ Please follow the [installation](#installation) procedure and then run the follo
61
61
  # Load the gem
62
62
  require 'ory-kratos-client'
63
63
 
64
- api_instance = OryHydraClient::AdminApi.new
65
- opts = {
66
- create_identity: OryHydraClient::CreateIdentity.new({schema_id: 'schema_id_example', traits: 3.56}) # CreateIdentity |
67
- }
64
+ api_instance = OryHydraClient::MetadataApi.new
68
65
 
69
66
  begin
70
- #Create an Identity
71
- result = api_instance.create_identity(opts)
67
+ #Return Running Software Version.
68
+ result = api_instance.get_version
72
69
  p result
73
70
  rescue OryHydraClient::ApiError => e
74
- puts "Exception when calling AdminApi->create_identity: #{e}"
71
+ puts "Exception when calling MetadataApi->get_version: #{e}"
75
72
  end
76
73
 
77
74
  ```
@@ -82,53 +79,49 @@ All URIs are relative to *http://localhost*
82
79
 
83
80
  Class | Method | HTTP request | Description
84
81
  ------------ | ------------- | ------------- | -------------
85
- *OryHydraClient::AdminApi* | [**create_identity**](docs/AdminApi.md#create_identity) | **POST** /identities | Create an Identity
86
- *OryHydraClient::AdminApi* | [**create_recovery_link**](docs/AdminApi.md#create_recovery_link) | **POST** /recovery/link | Create a Recovery Link
87
- *OryHydraClient::AdminApi* | [**delete_identity**](docs/AdminApi.md#delete_identity) | **DELETE** /identities/{id} | Delete an Identity
88
- *OryHydraClient::AdminApi* | [**get_identity**](docs/AdminApi.md#get_identity) | **GET** /identities/{id} | Get an Identity
89
- *OryHydraClient::AdminApi* | [**get_schema**](docs/AdminApi.md#get_schema) | **GET** /schemas/{id} |
90
- *OryHydraClient::AdminApi* | [**get_self_service_error**](docs/AdminApi.md#get_self_service_error) | **GET** /self-service/errors | Get User-Facing Self-Service Errors
91
- *OryHydraClient::AdminApi* | [**get_self_service_login_flow**](docs/AdminApi.md#get_self_service_login_flow) | **GET** /self-service/login/flows | Get Login Flow
92
- *OryHydraClient::AdminApi* | [**get_self_service_recovery_flow**](docs/AdminApi.md#get_self_service_recovery_flow) | **GET** /self-service/recovery/flows | Get information about a recovery flow
93
- *OryHydraClient::AdminApi* | [**get_self_service_registration_flow**](docs/AdminApi.md#get_self_service_registration_flow) | **GET** /self-service/registration/flows | Get Registration Flow
94
- *OryHydraClient::AdminApi* | [**get_self_service_settings_flow**](docs/AdminApi.md#get_self_service_settings_flow) | **GET** /self-service/settings/flows | Get Settings Flow
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
99
- *OryHydraClient::AdminApi* | [**list_identities**](docs/AdminApi.md#list_identities) | **GET** /identities | List Identities
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:
101
- *OryHydraClient::AdminApi* | [**update_identity**](docs/AdminApi.md#update_identity) | **PUT** /identities/{id} | Update an Identity
102
- *OryHydraClient::PublicApi* | [**get_schema**](docs/PublicApi.md#get_schema) | **GET** /schemas/{id} |
103
- *OryHydraClient::PublicApi* | [**get_self_service_error**](docs/PublicApi.md#get_self_service_error) | **GET** /self-service/errors | Get User-Facing Self-Service Errors
104
- *OryHydraClient::PublicApi* | [**get_self_service_login_flow**](docs/PublicApi.md#get_self_service_login_flow) | **GET** /self-service/login/flows | Get Login Flow
105
- *OryHydraClient::PublicApi* | [**get_self_service_recovery_flow**](docs/PublicApi.md#get_self_service_recovery_flow) | **GET** /self-service/recovery/flows | Get information about a recovery flow
106
- *OryHydraClient::PublicApi* | [**get_self_service_registration_flow**](docs/PublicApi.md#get_self_service_registration_flow) | **GET** /self-service/registration/flows | Get Registration Flow
107
- *OryHydraClient::PublicApi* | [**get_self_service_settings_flow**](docs/PublicApi.md#get_self_service_settings_flow) | **GET** /self-service/settings/flows | Get Settings Flow
108
- *OryHydraClient::PublicApi* | [**get_self_service_verification_flow**](docs/PublicApi.md#get_self_service_verification_flow) | **GET** /self-service/verification/flows | Get Verification Flow
109
- *OryHydraClient::PublicApi* | [**initialize_self_service_browser_logout_flow**](docs/PublicApi.md#initialize_self_service_browser_logout_flow) | **GET** /self-service/browser/flows/logout | Initialize Browser-Based Logout User Flow
110
- *OryHydraClient::PublicApi* | [**initialize_self_service_login_for_browsers**](docs/PublicApi.md#initialize_self_service_login_for_browsers) | **GET** /self-service/login/browser | Initialize Login Flow for browsers
111
- *OryHydraClient::PublicApi* | [**initialize_self_service_login_for_native_apps**](docs/PublicApi.md#initialize_self_service_login_for_native_apps) | **GET** /self-service/login/api | Initialize Login Flow for Native Apps and API clients
112
- *OryHydraClient::PublicApi* | [**initialize_self_service_recovery_for_browsers**](docs/PublicApi.md#initialize_self_service_recovery_for_browsers) | **GET** /self-service/recovery/browser | Initialize Recovery Flow for Browser Clients
113
- *OryHydraClient::PublicApi* | [**initialize_self_service_recovery_for_native_apps**](docs/PublicApi.md#initialize_self_service_recovery_for_native_apps) | **GET** /self-service/recovery/api | Initialize Recovery Flow for Native Apps and API clients
114
- *OryHydraClient::PublicApi* | [**initialize_self_service_registration_for_browsers**](docs/PublicApi.md#initialize_self_service_registration_for_browsers) | **GET** /self-service/registration/browser | Initialize Registration Flow for browsers
115
- *OryHydraClient::PublicApi* | [**initialize_self_service_registration_for_native_apps**](docs/PublicApi.md#initialize_self_service_registration_for_native_apps) | **GET** /self-service/registration/api | Initialize Registration Flow for Native Apps and API clients
116
- *OryHydraClient::PublicApi* | [**initialize_self_service_settings_for_browsers**](docs/PublicApi.md#initialize_self_service_settings_for_browsers) | **GET** /self-service/settings/browser | Initialize Settings Flow for Browsers
117
- *OryHydraClient::PublicApi* | [**initialize_self_service_settings_for_native_apps**](docs/PublicApi.md#initialize_self_service_settings_for_native_apps) | **GET** /self-service/settings/api | Initialize Settings Flow for Native Apps and API clients
118
- *OryHydraClient::PublicApi* | [**initialize_self_service_verification_for_browsers**](docs/PublicApi.md#initialize_self_service_verification_for_browsers) | **GET** /self-service/verification/browser | Initialize Verification Flow for Browser Clients
119
- *OryHydraClient::PublicApi* | [**initialize_self_service_verification_for_native_apps**](docs/PublicApi.md#initialize_self_service_verification_for_native_apps) | **GET** /self-service/verification/api | Initialize Verification Flow for Native Apps and API clients
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
127
- *OryHydraClient::PublicApi* | [**to_session**](docs/PublicApi.md#to_session) | **GET** /sessions/whoami | Check Who the Current HTTP Session Belongs To
82
+ *OryHydraClient::MetadataApi* | [**get_version**](docs/MetadataApi.md#get_version) | **GET** /version | Return Running Software Version.
83
+ *OryHydraClient::MetadataApi* | [**is_alive**](docs/MetadataApi.md#is_alive) | **GET** /health/alive | Check HTTP Server Status
84
+ *OryHydraClient::MetadataApi* | [**is_ready**](docs/MetadataApi.md#is_ready) | **GET** /health/ready | Check HTTP Server and Database Status
85
+ *OryHydraClient::MetadataApi* | [**prometheus**](docs/MetadataApi.md#prometheus) | **GET** /metrics/prometheus | Get snapshot metrics from the service. If you're using k8s, you can then add annotations to your deployment like so:
86
+ *OryHydraClient::V0alpha1Api* | [**admin_create_identity**](docs/V0alpha1Api.md#admin_create_identity) | **POST** /identities | Create an Identity
87
+ *OryHydraClient::V0alpha1Api* | [**admin_create_self_service_recovery_link**](docs/V0alpha1Api.md#admin_create_self_service_recovery_link) | **POST** /recovery/link | Create a Recovery Link
88
+ *OryHydraClient::V0alpha1Api* | [**admin_delete_identity**](docs/V0alpha1Api.md#admin_delete_identity) | **DELETE** /identities/{id} | Delete an Identity
89
+ *OryHydraClient::V0alpha1Api* | [**admin_get_identity**](docs/V0alpha1Api.md#admin_get_identity) | **GET** /identities/{id} | Get an Identity
90
+ *OryHydraClient::V0alpha1Api* | [**admin_list_identities**](docs/V0alpha1Api.md#admin_list_identities) | **GET** /identities | List Identities
91
+ *OryHydraClient::V0alpha1Api* | [**admin_update_identity**](docs/V0alpha1Api.md#admin_update_identity) | **PUT** /identities/{id} | Update an Identity
92
+ *OryHydraClient::V0alpha1Api* | [**create_self_service_logout_flow_url_for_browsers**](docs/V0alpha1Api.md#create_self_service_logout_flow_url_for_browsers) | **GET** /self-service/logout/browser | Create a Logout URL for Browsers
93
+ *OryHydraClient::V0alpha1Api* | [**get_json_schema**](docs/V0alpha1Api.md#get_json_schema) | **GET** /schemas/{id} |
94
+ *OryHydraClient::V0alpha1Api* | [**get_self_service_error**](docs/V0alpha1Api.md#get_self_service_error) | **GET** /self-service/errors | Get Self-Service Errors
95
+ *OryHydraClient::V0alpha1Api* | [**get_self_service_login_flow**](docs/V0alpha1Api.md#get_self_service_login_flow) | **GET** /self-service/login/flows | Get Login Flow
96
+ *OryHydraClient::V0alpha1Api* | [**get_self_service_recovery_flow**](docs/V0alpha1Api.md#get_self_service_recovery_flow) | **GET** /self-service/recovery/flows | Get Recovery Flow
97
+ *OryHydraClient::V0alpha1Api* | [**get_self_service_registration_flow**](docs/V0alpha1Api.md#get_self_service_registration_flow) | **GET** /self-service/registration/flows | Get Registration Flow
98
+ *OryHydraClient::V0alpha1Api* | [**get_self_service_settings_flow**](docs/V0alpha1Api.md#get_self_service_settings_flow) | **GET** /self-service/settings/flows | Get Settings Flow
99
+ *OryHydraClient::V0alpha1Api* | [**get_self_service_verification_flow**](docs/V0alpha1Api.md#get_self_service_verification_flow) | **GET** /self-service/verification/flows | Get Verification Flow
100
+ *OryHydraClient::V0alpha1Api* | [**initialize_self_service_login_flow_for_browsers**](docs/V0alpha1Api.md#initialize_self_service_login_flow_for_browsers) | **GET** /self-service/login/browser | Initialize Login Flow for Browsers
101
+ *OryHydraClient::V0alpha1Api* | [**initialize_self_service_login_flow_without_browser**](docs/V0alpha1Api.md#initialize_self_service_login_flow_without_browser) | **GET** /self-service/login/api | Initialize Login Flow for APIs, Services, Apps, ...
102
+ *OryHydraClient::V0alpha1Api* | [**initialize_self_service_recovery_flow_for_browsers**](docs/V0alpha1Api.md#initialize_self_service_recovery_flow_for_browsers) | **GET** /self-service/recovery/browser | Initialize Recovery Flow for Browsers
103
+ *OryHydraClient::V0alpha1Api* | [**initialize_self_service_recovery_flow_without_browser**](docs/V0alpha1Api.md#initialize_self_service_recovery_flow_without_browser) | **GET** /self-service/recovery/api | Initialize Recovery Flow for APIs, Services, Apps, ...
104
+ *OryHydraClient::V0alpha1Api* | [**initialize_self_service_registration_flow_for_browsers**](docs/V0alpha1Api.md#initialize_self_service_registration_flow_for_browsers) | **GET** /self-service/registration/browser | Initialize Registration Flow for Browsers
105
+ *OryHydraClient::V0alpha1Api* | [**initialize_self_service_registration_flow_without_browser**](docs/V0alpha1Api.md#initialize_self_service_registration_flow_without_browser) | **GET** /self-service/registration/api | Initialize Registration Flow for APIs, Services, Apps, ...
106
+ *OryHydraClient::V0alpha1Api* | [**initialize_self_service_settings_flow_for_browsers**](docs/V0alpha1Api.md#initialize_self_service_settings_flow_for_browsers) | **GET** /self-service/settings/browser | Initialize Settings Flow for Browsers
107
+ *OryHydraClient::V0alpha1Api* | [**initialize_self_service_settings_flow_without_browser**](docs/V0alpha1Api.md#initialize_self_service_settings_flow_without_browser) | **GET** /self-service/settings/api | Initialize Settings Flow for APIs, Services, Apps, ...
108
+ *OryHydraClient::V0alpha1Api* | [**initialize_self_service_verification_flow_for_browsers**](docs/V0alpha1Api.md#initialize_self_service_verification_flow_for_browsers) | **GET** /self-service/verification/browser | Initialize Verification Flow for Browser Clients
109
+ *OryHydraClient::V0alpha1Api* | [**initialize_self_service_verification_flow_without_browser**](docs/V0alpha1Api.md#initialize_self_service_verification_flow_without_browser) | **GET** /self-service/verification/api | Initialize Verification Flow for APIs, Services, Apps, ...
110
+ *OryHydraClient::V0alpha1Api* | [**submit_self_service_login_flow**](docs/V0alpha1Api.md#submit_self_service_login_flow) | **POST** /self-service/login | Submit a Login Flow
111
+ *OryHydraClient::V0alpha1Api* | [**submit_self_service_logout_flow**](docs/V0alpha1Api.md#submit_self_service_logout_flow) | **GET** /self-service/logout | Complete Self-Service Logout
112
+ *OryHydraClient::V0alpha1Api* | [**submit_self_service_logout_flow_without_browser**](docs/V0alpha1Api.md#submit_self_service_logout_flow_without_browser) | **DELETE** /self-service/logout/api | Perform Logout for APIs, Services, Apps, ...
113
+ *OryHydraClient::V0alpha1Api* | [**submit_self_service_recovery_flow**](docs/V0alpha1Api.md#submit_self_service_recovery_flow) | **POST** /self-service/recovery | Complete Recovery Flow
114
+ *OryHydraClient::V0alpha1Api* | [**submit_self_service_registration_flow**](docs/V0alpha1Api.md#submit_self_service_registration_flow) | **POST** /self-service/registration | Submit a Registration Flow
115
+ *OryHydraClient::V0alpha1Api* | [**submit_self_service_settings_flow**](docs/V0alpha1Api.md#submit_self_service_settings_flow) | **POST** /self-service/settings | Complete Settings Flow
116
+ *OryHydraClient::V0alpha1Api* | [**submit_self_service_verification_flow**](docs/V0alpha1Api.md#submit_self_service_verification_flow) | **POST** /self-service/verification | Complete Verification Flow
117
+ *OryHydraClient::V0alpha1Api* | [**to_session**](docs/V0alpha1Api.md#to_session) | **GET** /sessions/whoami | Check Who the Current HTTP Session Belongs To
128
118
 
129
119
 
130
120
  ## Documentation for Models
131
121
 
122
+ - [OryHydraClient::AdminCreateIdentityBody](docs/AdminCreateIdentityBody.md)
123
+ - [OryHydraClient::AdminCreateSelfServiceRecoveryLinkBody](docs/AdminCreateSelfServiceRecoveryLinkBody.md)
124
+ - [OryHydraClient::AdminUpdateIdentityBody](docs/AdminUpdateIdentityBody.md)
132
125
  - [OryHydraClient::AuthenticateOKBody](docs/AuthenticateOKBody.md)
133
126
  - [OryHydraClient::ContainerChangeResponseItem](docs/ContainerChangeResponseItem.md)
134
127
  - [OryHydraClient::ContainerCreateCreatedBody](docs/ContainerCreateCreatedBody.md)
@@ -136,8 +129,6 @@ Class | Method | HTTP request | Description
136
129
  - [OryHydraClient::ContainerUpdateOKBody](docs/ContainerUpdateOKBody.md)
137
130
  - [OryHydraClient::ContainerWaitOKBody](docs/ContainerWaitOKBody.md)
138
131
  - [OryHydraClient::ContainerWaitOKBodyError](docs/ContainerWaitOKBodyError.md)
139
- - [OryHydraClient::CreateIdentity](docs/CreateIdentity.md)
140
- - [OryHydraClient::CreateRecoveryLink](docs/CreateRecoveryLink.md)
141
132
  - [OryHydraClient::ErrorResponse](docs/ErrorResponse.md)
142
133
  - [OryHydraClient::GenericError](docs/GenericError.md)
143
134
  - [OryHydraClient::GraphDriverData](docs/GraphDriverData.md)
@@ -152,8 +143,6 @@ Class | Method | HTTP request | Description
152
143
  - [OryHydraClient::InlineResponse2001](docs/InlineResponse2001.md)
153
144
  - [OryHydraClient::InlineResponse503](docs/InlineResponse503.md)
154
145
  - [OryHydraClient::JsonError](docs/JsonError.md)
155
- - [OryHydraClient::LoginFlow](docs/LoginFlow.md)
156
- - [OryHydraClient::LoginViaApiResponse](docs/LoginViaApiResponse.md)
157
146
  - [OryHydraClient::Meta](docs/Meta.md)
158
147
  - [OryHydraClient::Plugin](docs/Plugin.md)
159
148
  - [OryHydraClient::PluginConfig](docs/PluginConfig.md)
@@ -170,39 +159,47 @@ Class | Method | HTTP request | Description
170
159
  - [OryHydraClient::PluginSettings](docs/PluginSettings.md)
171
160
  - [OryHydraClient::Port](docs/Port.md)
172
161
  - [OryHydraClient::RecoveryAddress](docs/RecoveryAddress.md)
173
- - [OryHydraClient::RecoveryFlow](docs/RecoveryFlow.md)
174
- - [OryHydraClient::RecoveryLink](docs/RecoveryLink.md)
175
- - [OryHydraClient::RegistrationFlow](docs/RegistrationFlow.md)
176
- - [OryHydraClient::RegistrationViaApiResponse](docs/RegistrationViaApiResponse.md)
177
- - [OryHydraClient::RevokeSession](docs/RevokeSession.md)
178
- - [OryHydraClient::SelfServiceErrorContainer](docs/SelfServiceErrorContainer.md)
162
+ - [OryHydraClient::SelfServiceError](docs/SelfServiceError.md)
163
+ - [OryHydraClient::SelfServiceLoginFlow](docs/SelfServiceLoginFlow.md)
164
+ - [OryHydraClient::SelfServiceLogoutUrl](docs/SelfServiceLogoutUrl.md)
165
+ - [OryHydraClient::SelfServiceRecoveryFlow](docs/SelfServiceRecoveryFlow.md)
166
+ - [OryHydraClient::SelfServiceRecoveryFlowState](docs/SelfServiceRecoveryFlowState.md)
167
+ - [OryHydraClient::SelfServiceRecoveryLink](docs/SelfServiceRecoveryLink.md)
168
+ - [OryHydraClient::SelfServiceRegistrationFlow](docs/SelfServiceRegistrationFlow.md)
169
+ - [OryHydraClient::SelfServiceSettingsFlow](docs/SelfServiceSettingsFlow.md)
170
+ - [OryHydraClient::SelfServiceSettingsFlowState](docs/SelfServiceSettingsFlowState.md)
171
+ - [OryHydraClient::SelfServiceVerificationFlow](docs/SelfServiceVerificationFlow.md)
172
+ - [OryHydraClient::SelfServiceVerificationFlowState](docs/SelfServiceVerificationFlowState.md)
179
173
  - [OryHydraClient::ServiceUpdateResponse](docs/ServiceUpdateResponse.md)
180
174
  - [OryHydraClient::Session](docs/Session.md)
181
- - [OryHydraClient::SettingsFlow](docs/SettingsFlow.md)
182
175
  - [OryHydraClient::SettingsProfileFormConfig](docs/SettingsProfileFormConfig.md)
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)
176
+ - [OryHydraClient::SubmitSelfServiceLoginFlowBody](docs/SubmitSelfServiceLoginFlowBody.md)
177
+ - [OryHydraClient::SubmitSelfServiceLoginFlowWithOidcMethodBody](docs/SubmitSelfServiceLoginFlowWithOidcMethodBody.md)
178
+ - [OryHydraClient::SubmitSelfServiceLoginFlowWithPasswordMethodBody](docs/SubmitSelfServiceLoginFlowWithPasswordMethodBody.md)
179
+ - [OryHydraClient::SubmitSelfServiceLogoutFlowWithoutBrowserBody](docs/SubmitSelfServiceLogoutFlowWithoutBrowserBody.md)
180
+ - [OryHydraClient::SubmitSelfServiceRecoveryFlowBody](docs/SubmitSelfServiceRecoveryFlowBody.md)
181
+ - [OryHydraClient::SubmitSelfServiceRecoveryFlowWithLinkMethodBody](docs/SubmitSelfServiceRecoveryFlowWithLinkMethodBody.md)
182
+ - [OryHydraClient::SubmitSelfServiceRegistrationFlowBody](docs/SubmitSelfServiceRegistrationFlowBody.md)
183
+ - [OryHydraClient::SubmitSelfServiceRegistrationFlowWithOidcMethodBody](docs/SubmitSelfServiceRegistrationFlowWithOidcMethodBody.md)
184
+ - [OryHydraClient::SubmitSelfServiceRegistrationFlowWithPasswordMethodBody](docs/SubmitSelfServiceRegistrationFlowWithPasswordMethodBody.md)
185
+ - [OryHydraClient::SubmitSelfServiceSettingsFlowBody](docs/SubmitSelfServiceSettingsFlowBody.md)
186
+ - [OryHydraClient::SubmitSelfServiceSettingsFlowWithOidcMethodBody](docs/SubmitSelfServiceSettingsFlowWithOidcMethodBody.md)
187
+ - [OryHydraClient::SubmitSelfServiceSettingsFlowWithPasswordMethodBody](docs/SubmitSelfServiceSettingsFlowWithPasswordMethodBody.md)
188
+ - [OryHydraClient::SubmitSelfServiceSettingsFlowWithProfileMethodBody](docs/SubmitSelfServiceSettingsFlowWithProfileMethodBody.md)
189
+ - [OryHydraClient::SubmitSelfServiceVerificationFlowBody](docs/SubmitSelfServiceVerificationFlowBody.md)
190
+ - [OryHydraClient::SubmitSelfServiceVerificationFlowWithLinkMethodBody](docs/SubmitSelfServiceVerificationFlowWithLinkMethodBody.md)
191
+ - [OryHydraClient::SuccessfulSelfServiceLoginWithoutBrowser](docs/SuccessfulSelfServiceLoginWithoutBrowser.md)
192
+ - [OryHydraClient::SuccessfulSelfServiceRegistrationWithoutBrowser](docs/SuccessfulSelfServiceRegistrationWithoutBrowser.md)
193
+ - [OryHydraClient::SuccessfulSelfServiceSettingsWithoutBrowser](docs/SuccessfulSelfServiceSettingsWithoutBrowser.md)
194
194
  - [OryHydraClient::UiContainer](docs/UiContainer.md)
195
195
  - [OryHydraClient::UiNode](docs/UiNode.md)
196
196
  - [OryHydraClient::UiNodeAnchorAttributes](docs/UiNodeAnchorAttributes.md)
197
197
  - [OryHydraClient::UiNodeAttributes](docs/UiNodeAttributes.md)
198
198
  - [OryHydraClient::UiNodeImageAttributes](docs/UiNodeImageAttributes.md)
199
199
  - [OryHydraClient::UiNodeInputAttributes](docs/UiNodeInputAttributes.md)
200
- - [OryHydraClient::UiNodeInputAttributesValue](docs/UiNodeInputAttributesValue.md)
201
200
  - [OryHydraClient::UiNodeTextAttributes](docs/UiNodeTextAttributes.md)
202
201
  - [OryHydraClient::UiText](docs/UiText.md)
203
- - [OryHydraClient::UpdateIdentity](docs/UpdateIdentity.md)
204
202
  - [OryHydraClient::VerifiableIdentityAddress](docs/VerifiableIdentityAddress.md)
205
- - [OryHydraClient::VerificationFlow](docs/VerificationFlow.md)
206
203
  - [OryHydraClient::Version](docs/Version.md)
207
204
  - [OryHydraClient::Volume](docs/Volume.md)
208
205
  - [OryHydraClient::VolumeUsageData](docs/VolumeUsageData.md)
@@ -211,18 +208,7 @@ Class | Method | HTTP request | Description
211
208
  ## Documentation for Authorization
212
209
 
213
210
 
214
- ### oryToken
215
-
216
- - **Type**: Bearer authentication
217
-
218
- ### sessionCookie
219
-
220
-
221
- - **Type**: API key
222
- - **API key parameter name**: ory_kratos_session
223
- - **Location**:
224
-
225
- ### sessionToken
211
+ ### oryAccessToken
226
212
 
227
213
  - **Type**: Bearer authentication
228
214
 
@@ -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-kratos-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-kratos-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** | [**AnyType**](.md) | State is the identity's state. | |
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-kratos-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** | [**AnyType**](.md) | State is the identity's state. | |
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-kratos-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
@@ -0,0 +1,254 @@
1
+ # OryHydraClient::MetadataApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**get_version**](MetadataApi.md#get_version) | **GET** /version | Return Running Software Version. |
8
+ | [**is_alive**](MetadataApi.md#is_alive) | **GET** /health/alive | Check HTTP Server Status |
9
+ | [**is_ready**](MetadataApi.md#is_ready) | **GET** /health/ready | Check HTTP Server and Database Status |
10
+ | [**prometheus**](MetadataApi.md#prometheus) | **GET** /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-kratos-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-kratos-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-kratos-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-kratos-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
+