ory-kratos-client 0.1.1.alpha1 → 0.5.0.alpha1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (156) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/README.md +86 -48
  4. data/docs/AdminApi.md +290 -85
  5. data/docs/CommonApi.md +111 -16
  6. data/docs/CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload.md +19 -0
  7. data/docs/CompleteSelfServiceLoginFlowWithPasswordMethod.md +21 -0
  8. data/docs/CompleteSelfServiceRecoveryFlowWithLinkMethod.md +19 -0
  9. data/docs/CompleteSelfServiceSettingsFlowWithPasswordMethod.md +19 -0
  10. data/docs/CompleteSelfServiceVerificationFlowWithLinkMethod.md +19 -0
  11. data/docs/CreateIdentity.md +19 -0
  12. data/docs/CreateRecoveryLink.md +19 -0
  13. data/docs/ErrorContainer.md +2 -2
  14. data/docs/Form.md +3 -3
  15. data/docs/FormField.md +8 -8
  16. data/docs/GenericErrorPayload.md +1 -1
  17. data/docs/Identity.md +9 -7
  18. data/docs/LoginFlow.md +33 -0
  19. data/docs/LoginFlowMethod.md +19 -0
  20. data/docs/LoginFlowMethodConfig.md +25 -0
  21. data/docs/LoginRequest.md +4 -0
  22. data/docs/LoginRequestMethodConfig.md +3 -3
  23. data/docs/LoginViaApiResponse.md +19 -0
  24. data/docs/Message.md +23 -0
  25. data/docs/ProviderCredentialsConfig.md +19 -0
  26. data/docs/PublicApi.md +806 -141
  27. data/docs/RecoveryAddress.md +21 -0
  28. data/docs/RecoveryFlow.md +33 -0
  29. data/docs/RecoveryFlowMethod.md +19 -0
  30. data/docs/RecoveryFlowMethodConfig.md +23 -0
  31. data/docs/RecoveryLink.md +19 -0
  32. data/docs/RecoveryRequest.md +31 -0
  33. data/docs/RecoveryRequestMethod.md +19 -0
  34. data/docs/RegistrationFlow.md +31 -0
  35. data/docs/RegistrationFlowMethod.md +19 -0
  36. data/docs/RegistrationFlowMethodConfig.md +25 -0
  37. data/docs/RegistrationRequest.md +3 -1
  38. data/docs/RegistrationRequestMethodConfig.md +3 -3
  39. data/docs/RegistrationViaApiResponse.md +21 -0
  40. data/docs/RequestMethodConfig.md +23 -0
  41. data/docs/RevokeSession.md +17 -0
  42. data/docs/Session.md +6 -4
  43. data/docs/SettingsFlow.md +35 -0
  44. data/docs/SettingsFlowMethod.md +19 -0
  45. data/docs/SettingsFlowMethodConfig.md +23 -0
  46. data/docs/SettingsRequest.md +33 -0
  47. data/docs/SettingsRequestMethod.md +19 -0
  48. data/docs/SettingsViaApiResponse.md +19 -0
  49. data/docs/UpdateIdentity.md +19 -0
  50. data/docs/VerifiableAddress.md +4 -4
  51. data/docs/VerificationFlow.md +33 -0
  52. data/docs/VerificationFlowMethod.md +19 -0
  53. data/docs/VerificationFlowMethodConfig.md +23 -0
  54. data/docs/VerificationRequest.md +3 -1
  55. data/lib/ory-kratos-client.rb +31 -14
  56. data/lib/ory-kratos-client/api/admin_api.rb +379 -128
  57. data/lib/ory-kratos-client/api/common_api.rb +150 -27
  58. data/lib/ory-kratos-client/api/health_api.rb +2 -2
  59. data/lib/ory-kratos-client/api/public_api.rb +1000 -234
  60. data/lib/ory-kratos-client/api/version_api.rb +2 -2
  61. data/lib/ory-kratos-client/api_client.rb +10 -7
  62. data/lib/ory-kratos-client/api_error.rb +2 -2
  63. data/lib/ory-kratos-client/configuration.rb +9 -2
  64. data/lib/ory-kratos-client/models/complete_self_service_browser_settings_strategy_profile_flow_payload.rb +222 -0
  65. data/lib/ory-kratos-client/models/complete_self_service_login_flow_with_password_method.rb +227 -0
  66. data/lib/ory-kratos-client/models/complete_self_service_recovery_flow_with_link_method.rb +217 -0
  67. data/lib/ory-kratos-client/models/complete_self_service_settings_flow_with_password_method.rb +222 -0
  68. data/lib/ory-kratos-client/models/complete_self_service_verification_flow_with_link_method.rb +217 -0
  69. data/lib/ory-kratos-client/models/create_identity.rb +227 -0
  70. data/lib/ory-kratos-client/models/create_recovery_link.rb +238 -0
  71. data/lib/ory-kratos-client/models/error_container.rb +13 -2
  72. data/lib/ory-kratos-client/models/form.rb +15 -16
  73. data/lib/ory-kratos-client/models/form_field.rb +16 -22
  74. data/lib/ory-kratos-client/models/generic_error.rb +2 -2
  75. data/lib/ory-kratos-client/models/generic_error_payload.rb +4 -7
  76. data/lib/ory-kratos-client/models/health_not_ready_status.rb +2 -2
  77. data/lib/ory-kratos-client/models/health_status.rb +2 -2
  78. data/lib/ory-kratos-client/models/identity.rb +53 -35
  79. data/lib/ory-kratos-client/models/login_flow.rb +315 -0
  80. data/lib/ory-kratos-client/models/login_flow_method.rb +226 -0
  81. data/lib/ory-kratos-client/models/login_flow_method_config.rb +267 -0
  82. data/lib/ory-kratos-client/models/login_request.rb +24 -3
  83. data/lib/ory-kratos-client/models/login_request_method.rb +2 -2
  84. data/lib/ory-kratos-client/models/login_request_method_config.rb +15 -16
  85. data/lib/ory-kratos-client/models/login_via_api_response.rb +227 -0
  86. data/lib/ory-kratos-client/models/message.rb +234 -0
  87. data/lib/ory-kratos-client/models/provider_credentials_config.rb +215 -0
  88. data/lib/ory-kratos-client/models/recovery_address.rb +239 -0
  89. data/lib/ory-kratos-client/models/recovery_flow.rb +319 -0
  90. data/lib/ory-kratos-client/models/recovery_flow_method.rb +226 -0
  91. data/lib/ory-kratos-client/models/recovery_flow_method_config.rb +255 -0
  92. data/lib/ory-kratos-client/models/recovery_link.rb +222 -0
  93. data/lib/ory-kratos-client/models/recovery_request.rb +309 -0
  94. data/lib/ory-kratos-client/models/recovery_request_method.rb +216 -0
  95. data/lib/ory-kratos-client/models/registration_flow.rb +304 -0
  96. data/lib/ory-kratos-client/models/registration_flow_method.rb +226 -0
  97. data/lib/ory-kratos-client/models/registration_flow_method_config.rb +267 -0
  98. data/lib/ory-kratos-client/models/registration_request.rb +14 -8
  99. data/lib/ory-kratos-client/models/registration_request_method.rb +2 -2
  100. data/lib/ory-kratos-client/models/registration_request_method_config.rb +15 -16
  101. data/lib/ory-kratos-client/models/registration_via_api_response.rb +236 -0
  102. data/lib/ory-kratos-client/models/request_method_config.rb +255 -0
  103. data/lib/ory-kratos-client/models/revoke_session.rb +212 -0
  104. data/lib/ory-kratos-client/models/session.rb +29 -20
  105. data/lib/ory-kratos-client/models/settings_flow.rb +333 -0
  106. data/lib/ory-kratos-client/models/settings_flow_method.rb +226 -0
  107. data/lib/ory-kratos-client/models/settings_flow_method_config.rb +255 -0
  108. data/lib/ory-kratos-client/models/settings_request.rb +323 -0
  109. data/lib/ory-kratos-client/models/settings_request_method.rb +216 -0
  110. data/lib/ory-kratos-client/models/settings_via_api_response.rb +226 -0
  111. data/lib/ory-kratos-client/models/update_identity.rb +222 -0
  112. data/lib/ory-kratos-client/models/verifiable_address.rb +17 -22
  113. data/lib/ory-kratos-client/models/verification_flow.rb +299 -0
  114. data/lib/ory-kratos-client/models/verification_flow_method.rb +226 -0
  115. data/lib/ory-kratos-client/models/verification_flow_method_config.rb +255 -0
  116. data/lib/ory-kratos-client/models/verification_request.rb +15 -4
  117. data/lib/ory-kratos-client/models/version.rb +2 -2
  118. data/lib/ory-kratos-client/version.rb +3 -3
  119. data/ory-kratos-client.gemspec +2 -2
  120. data/spec/models/complete_self_service_browser_settings_strategy_profile_flow_payload_spec.rb +47 -0
  121. data/spec/models/complete_self_service_login_flow_with_password_method_spec.rb +53 -0
  122. data/spec/models/complete_self_service_recovery_flow_with_link_method_spec.rb +47 -0
  123. data/spec/models/complete_self_service_settings_flow_with_password_method_spec.rb +47 -0
  124. data/spec/models/complete_self_service_verification_flow_with_link_method_spec.rb +47 -0
  125. data/spec/models/create_identity_spec.rb +47 -0
  126. data/spec/models/create_recovery_link_spec.rb +47 -0
  127. data/spec/models/login_flow_method_config_spec.rb +65 -0
  128. data/spec/models/login_flow_method_spec.rb +47 -0
  129. data/spec/models/login_flow_spec.rb +89 -0
  130. data/spec/models/login_via_api_response_spec.rb +47 -0
  131. data/spec/models/message_spec.rb +59 -0
  132. data/spec/models/provider_credentials_config_spec.rb +47 -0
  133. data/spec/models/recovery_address_spec.rb +53 -0
  134. data/spec/models/recovery_flow_method_config_spec.rb +59 -0
  135. data/spec/models/recovery_flow_method_spec.rb +47 -0
  136. data/spec/models/recovery_flow_spec.rb +89 -0
  137. data/spec/models/recovery_link_spec.rb +47 -0
  138. data/spec/models/recovery_request_method_spec.rb +47 -0
  139. data/spec/models/recovery_request_spec.rb +83 -0
  140. data/spec/models/registration_flow_method_config_spec.rb +65 -0
  141. data/spec/models/registration_flow_method_spec.rb +47 -0
  142. data/spec/models/registration_flow_spec.rb +83 -0
  143. data/spec/models/registration_via_api_response_spec.rb +53 -0
  144. data/spec/models/request_method_config_spec.rb +59 -0
  145. data/spec/models/revoke_session_spec.rb +41 -0
  146. data/spec/models/settings_flow_method_config_spec.rb +59 -0
  147. data/spec/models/settings_flow_method_spec.rb +47 -0
  148. data/spec/models/settings_flow_spec.rb +95 -0
  149. data/spec/models/settings_request_method_spec.rb +47 -0
  150. data/spec/models/settings_request_spec.rb +83 -0
  151. data/spec/models/settings_via_api_response_spec.rb +47 -0
  152. data/spec/models/update_identity_spec.rb +47 -0
  153. data/spec/models/verification_flow_method_config_spec.rb +59 -0
  154. data/spec/models/verification_flow_method_spec.rb +47 -0
  155. data/spec/models/verification_flow_spec.rb +89 -0
  156. metadata +161 -17
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8a26e5161bcc964bfaaa7a7ad99583e7c6ea5952b7e722db0d73895058852f75
4
- data.tar.gz: 95e2dfd04d08b9a7ade38a1cf3b2951e0b1c2ab4c165596c076c7c867c0e6293
3
+ metadata.gz: 0bc4dabbbc60dee930b3c5ebcb9678bb4b7b257dc21aabf257fb7b055948e22e
4
+ data.tar.gz: f4a0cb9a19bff3deaa3101d6a006072dacf1338fe9d4872ae59ac253ae8cd382
5
5
  SHA512:
6
- metadata.gz: a6e6e5983467c053bcce0c79c18bc778c3b8e7031ecc202a3ebda3a3217ba1ba09acb902011cc0d41e15adbcbfc921f91055117345413cb6214d2351b13fcfbc
7
- data.tar.gz: 2e0dac6d7a4a9a02e91c6463219e362dd6de5067168cf66544216a38cea233048871819ee122960a99be7725238a098531e6e459cd33652bb02f968ffc22f996
6
+ metadata.gz: 30205eefc9dee93241c1559d0533ea7b3808672f5f8230dffc656125653cc56ae8e4147005dd4dc173722064433a3437b72afb6a2654937e12dd156bceba86ac
7
+ data.tar.gz: 59c665edccbfd55a1e79bb38ad627072a191bd83b9c6fb8773de1285dda3eabf140b40bcc240e328d52a7e5a8887e3efa81affc94ffa3040d5f09f4072fa61f2
data/Gemfile CHANGED
@@ -3,7 +3,7 @@ source 'https://rubygems.org'
3
3
  gemspec
4
4
 
5
5
  group :development, :test do
6
- gem 'rake', '~> 12.0.0'
6
+ gem 'rake', '~> 13.0.1'
7
7
  gem 'pry-byebug'
8
8
  gem 'rubocop', '~> 0.66.0'
9
9
  end
data/README.md CHANGED
@@ -6,8 +6,8 @@ Welcome to the ORY Kratos HTTP API documentation!
6
6
 
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
- - API version: latest
10
- - Package version: v0.1.1-alpha.1
9
+ - API version: v0.5.0-alpha.1
10
+ - Package version: v0.5.0-alpha.1
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
 
13
13
  ## Installation
@@ -23,16 +23,16 @@ gem build ory-kratos-client.gemspec
23
23
  Then either install the gem locally:
24
24
 
25
25
  ```shell
26
- gem install ./ory-kratos-client-v0.1.1-alpha.1.gem
26
+ gem install ./ory-kratos-client-v0.5.0-alpha.1.gem
27
27
  ```
28
28
 
29
- (for development, run `gem install --dev ./ory-kratos-client-v0.1.1-alpha.1.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./ory-kratos-client-v0.5.0-alpha.1.gem` to install the development dependencies)
30
30
 
31
31
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
32
32
 
33
33
  Finally add this to the Gemfile:
34
34
 
35
- gem 'ory-kratos-client', '~> v0.1.1-alpha.1'
35
+ gem 'ory-kratos-client', '~> v0.5.0-alpha.1'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -57,11 +57,13 @@ Please follow the [installation](#installation) procedure and then run the follo
57
57
  require 'ory-kratos-client'
58
58
 
59
59
  api_instance = OryHydraClient::AdminApi.new
60
- body = OryHydraClient::Identity.new # Identity |
60
+ opts = {
61
+ body: OryHydraClient::CreateIdentity.new # CreateIdentity |
62
+ }
61
63
 
62
64
  begin
63
- #Create an identity
64
- result = api_instance.create_identity(body)
65
+ #Create an Identity
66
+ result = api_instance.create_identity(opts)
65
67
  p result
66
68
  rescue OryHydraClient::ApiError => e
67
69
  puts "Exception when calling AdminApi->create_identity: #{e}"
@@ -75,66 +77,102 @@ All URIs are relative to *http://localhost*
75
77
 
76
78
  Class | Method | HTTP request | Description
77
79
  ------------ | ------------- | ------------- | -------------
78
- *OryHydraClient::AdminApi* | [**create_identity**](docs/AdminApi.md#create_identity) | **POST** /identities | Create an identity
79
- *OryHydraClient::AdminApi* | [**delete_identity**](docs/AdminApi.md#delete_identity) | **DELETE** /identities/{id} | Delete an identity
80
- *OryHydraClient::AdminApi* | [**get_identity**](docs/AdminApi.md#get_identity) | **GET** /identities/{id} | Get an identity
81
- *OryHydraClient::AdminApi* | [**get_self_service_browser_login_request**](docs/AdminApi.md#get_self_service_browser_login_request) | **GET** /self-service/browser/flows/requests/login | Get the request context of browser-based login user flows
82
- *OryHydraClient::AdminApi* | [**get_self_service_browser_profile_management_request**](docs/AdminApi.md#get_self_service_browser_profile_management_request) | **GET** /self-service/browser/flows/requests/profile | Get the request context of browser-based profile management flows
83
- *OryHydraClient::AdminApi* | [**get_self_service_browser_registration_request**](docs/AdminApi.md#get_self_service_browser_registration_request) | **GET** /self-service/browser/flows/requests/registration | Get the request context of browser-based registration user flows
84
- *OryHydraClient::AdminApi* | [**get_self_service_error**](docs/AdminApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
85
- *OryHydraClient::AdminApi* | [**get_self_service_verification_request**](docs/AdminApi.md#get_self_service_verification_request) | **GET** /self-service/browser/flows/requests/verification | Get the request context of browser-based verification flows
86
- *OryHydraClient::AdminApi* | [**list_identities**](docs/AdminApi.md#list_identities) | **GET** /identities | List all identities in the system
87
- *OryHydraClient::AdminApi* | [**update_identity**](docs/AdminApi.md#update_identity) | **PUT** /identities/{id} | Update an identity
88
- *OryHydraClient::CommonApi* | [**get_self_service_browser_login_request**](docs/CommonApi.md#get_self_service_browser_login_request) | **GET** /self-service/browser/flows/requests/login | Get the request context of browser-based login user flows
89
- *OryHydraClient::CommonApi* | [**get_self_service_browser_profile_management_request**](docs/CommonApi.md#get_self_service_browser_profile_management_request) | **GET** /self-service/browser/flows/requests/profile | Get the request context of browser-based profile management flows
90
- *OryHydraClient::CommonApi* | [**get_self_service_browser_registration_request**](docs/CommonApi.md#get_self_service_browser_registration_request) | **GET** /self-service/browser/flows/requests/registration | Get the request context of browser-based registration user flows
91
- *OryHydraClient::CommonApi* | [**get_self_service_error**](docs/CommonApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
92
- *OryHydraClient::CommonApi* | [**get_self_service_verification_request**](docs/CommonApi.md#get_self_service_verification_request) | **GET** /self-service/browser/flows/requests/verification | Get the request context of browser-based verification flows
80
+ *OryHydraClient::AdminApi* | [**create_identity**](docs/AdminApi.md#create_identity) | **POST** /identities | Create an Identity
81
+ *OryHydraClient::AdminApi* | [**create_recovery_link**](docs/AdminApi.md#create_recovery_link) | **POST** /recovery/link | Create a Recovery Link
82
+ *OryHydraClient::AdminApi* | [**delete_identity**](docs/AdminApi.md#delete_identity) | **DELETE** /identities/{id} | Delete an Identity
83
+ *OryHydraClient::AdminApi* | [**get_identity**](docs/AdminApi.md#get_identity) | **GET** /identities/{id} | Get an Identity
84
+ *OryHydraClient::AdminApi* | [**get_schema**](docs/AdminApi.md#get_schema) | **GET** /schemas/{id} |
85
+ *OryHydraClient::AdminApi* | [**get_self_service_error**](docs/AdminApi.md#get_self_service_error) | **GET** /self-service/errors | Get User-Facing Self-Service Errors
86
+ *OryHydraClient::AdminApi* | [**get_self_service_login_flow**](docs/AdminApi.md#get_self_service_login_flow) | **GET** /self-service/login/flows | Get Login Flow
87
+ *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
88
+ *OryHydraClient::AdminApi* | [**get_self_service_registration_flow**](docs/AdminApi.md#get_self_service_registration_flow) | **GET** /self-service/registration/flows | Get Registration Flow
89
+ *OryHydraClient::AdminApi* | [**get_self_service_settings_flow**](docs/AdminApi.md#get_self_service_settings_flow) | **GET** /self-service/settings/flows | Get Settings Flow
90
+ *OryHydraClient::AdminApi* | [**get_self_service_verification_flow**](docs/AdminApi.md#get_self_service_verification_flow) | **GET** /self-service/verification/flows | Get Verification Flow
91
+ *OryHydraClient::AdminApi* | [**list_identities**](docs/AdminApi.md#list_identities) | **GET** /identities | List Identities
92
+ *OryHydraClient::AdminApi* | [**prometheus**](docs/AdminApi.md#prometheus) | **GET** /metrics/prometheus | Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
93
+ *OryHydraClient::AdminApi* | [**update_identity**](docs/AdminApi.md#update_identity) | **PUT** /identities/{id} | Update an Identity
93
94
  *OryHydraClient::HealthApi* | [**is_instance_alive**](docs/HealthApi.md#is_instance_alive) | **GET** /health/alive | Check alive status
94
95
  *OryHydraClient::HealthApi* | [**is_instance_ready**](docs/HealthApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status
95
- *OryHydraClient::PublicApi* | [**complete_self_service_browser_profile_management_flow**](docs/PublicApi.md#complete_self_service_browser_profile_management_flow) | **POST** /self-service/browser/flows/profile/update | Complete the browser-based profile management flows
96
- *OryHydraClient::PublicApi* | [**complete_self_service_browser_verification_flow**](docs/PublicApi.md#complete_self_service_browser_verification_flow) | **POST** /self-service/browser/flows/verification/{via}/complete | Complete the browser-based profile management flows
97
- *OryHydraClient::PublicApi* | [**get_self_service_browser_login_request**](docs/PublicApi.md#get_self_service_browser_login_request) | **GET** /self-service/browser/flows/requests/login | Get the request context of browser-based login user flows
98
- *OryHydraClient::PublicApi* | [**get_self_service_browser_profile_management_request**](docs/PublicApi.md#get_self_service_browser_profile_management_request) | **GET** /self-service/browser/flows/requests/profile | Get the request context of browser-based profile management flows
99
- *OryHydraClient::PublicApi* | [**get_self_service_browser_registration_request**](docs/PublicApi.md#get_self_service_browser_registration_request) | **GET** /self-service/browser/flows/requests/registration | Get the request context of browser-based registration user flows
100
- *OryHydraClient::PublicApi* | [**get_self_service_error**](docs/PublicApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
101
- *OryHydraClient::PublicApi* | [**get_self_service_verification_request**](docs/PublicApi.md#get_self_service_verification_request) | **GET** /self-service/browser/flows/requests/verification | Get the request context of browser-based verification flows
102
- *OryHydraClient::PublicApi* | [**initialize_self_service_browser_login_flow**](docs/PublicApi.md#initialize_self_service_browser_login_flow) | **GET** /self-service/browser/flows/login | Initialize browser-based login user flow
96
+ *OryHydraClient::PublicApi* | [**complete_self_service_browser_settings_oidc_settings_flow**](docs/PublicApi.md#complete_self_service_browser_settings_oidc_settings_flow) | **POST** /self-service/browser/flows/registration/strategies/oidc/settings/connections | Complete the Browser-Based Settings Flow for the OpenID Connect Strategy
97
+ *OryHydraClient::PublicApi* | [**complete_self_service_login_flow_with_password_method**](docs/PublicApi.md#complete_self_service_login_flow_with_password_method) | **POST** /self-service/login/methods/password | Complete Login Flow with Username/Email Password Method
98
+ *OryHydraClient::PublicApi* | [**complete_self_service_recovery_flow_with_link_method**](docs/PublicApi.md#complete_self_service_recovery_flow_with_link_method) | **POST** /self-service/recovery/methods/link | Complete Recovery Flow with Link Method
99
+ *OryHydraClient::PublicApi* | [**complete_self_service_registration_flow_with_password_method**](docs/PublicApi.md#complete_self_service_registration_flow_with_password_method) | **POST** /self-service/registration/methods/password | Complete Registration Flow with Username/Email Password Method
100
+ *OryHydraClient::PublicApi* | [**complete_self_service_settings_flow_with_password_method**](docs/PublicApi.md#complete_self_service_settings_flow_with_password_method) | **POST** /self-service/settings/methods/password | Complete Settings Flow with Username/Email Password Method
101
+ *OryHydraClient::PublicApi* | [**complete_self_service_settings_flow_with_profile_method**](docs/PublicApi.md#complete_self_service_settings_flow_with_profile_method) | **POST** /self-service/settings/methods/profile | Complete Settings Flow with Profile Method
102
+ *OryHydraClient::PublicApi* | [**complete_self_service_verification_flow_with_link_method**](docs/PublicApi.md#complete_self_service_verification_flow_with_link_method) | **POST** /self-service/verification/methods/link | Complete Verification Flow with Link Method
103
+ *OryHydraClient::PublicApi* | [**get_schema**](docs/PublicApi.md#get_schema) | **GET** /schemas/{id} |
104
+ *OryHydraClient::PublicApi* | [**get_self_service_error**](docs/PublicApi.md#get_self_service_error) | **GET** /self-service/errors | Get User-Facing Self-Service Errors
105
+ *OryHydraClient::PublicApi* | [**get_self_service_login_flow**](docs/PublicApi.md#get_self_service_login_flow) | **GET** /self-service/login/flows | Get Login Flow
106
+ *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
107
+ *OryHydraClient::PublicApi* | [**get_self_service_registration_flow**](docs/PublicApi.md#get_self_service_registration_flow) | **GET** /self-service/registration/flows | Get Registration Flow
108
+ *OryHydraClient::PublicApi* | [**get_self_service_settings_flow**](docs/PublicApi.md#get_self_service_settings_flow) | **GET** /self-service/settings/flows | Get Settings Flow
109
+ *OryHydraClient::PublicApi* | [**get_self_service_verification_flow**](docs/PublicApi.md#get_self_service_verification_flow) | **GET** /self-service/verification/flows | Get Verification Flow
103
110
  *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
104
- *OryHydraClient::PublicApi* | [**initialize_self_service_browser_registration_flow**](docs/PublicApi.md#initialize_self_service_browser_registration_flow) | **GET** /self-service/browser/flows/registration | Initialize browser-based registration user flow
105
- *OryHydraClient::PublicApi* | [**initialize_self_service_browser_verification_flow**](docs/PublicApi.md#initialize_self_service_browser_verification_flow) | **GET** /self-service/browser/flows/verification/init/{via} | Initialize browser-based verification flow
106
- *OryHydraClient::PublicApi* | [**initialize_self_service_profile_management_flow**](docs/PublicApi.md#initialize_self_service_profile_management_flow) | **GET** /self-service/browser/flows/profile | Initialize browser-based profile management flow
107
- *OryHydraClient::PublicApi* | [**self_service_browser_verify**](docs/PublicApi.md#self_service_browser_verify) | **GET** /self-service/browser/flows/verification/{via}/confirm/{code} | Complete the browser-based verification flows
108
- *OryHydraClient::PublicApi* | [**whoami**](docs/PublicApi.md#whoami) | **GET** /sessions/whoami | Check who the current HTTP session belongs to
111
+ *OryHydraClient::PublicApi* | [**initialize_self_service_login_via_api_flow**](docs/PublicApi.md#initialize_self_service_login_via_api_flow) | **GET** /self-service/login/api | Initialize Login Flow for API clients
112
+ *OryHydraClient::PublicApi* | [**initialize_self_service_login_via_browser_flow**](docs/PublicApi.md#initialize_self_service_login_via_browser_flow) | **GET** /self-service/login/browser | Initialize Login Flow for browsers
113
+ *OryHydraClient::PublicApi* | [**initialize_self_service_recovery_via_api_flow**](docs/PublicApi.md#initialize_self_service_recovery_via_api_flow) | **GET** /self-service/recovery/api | Initialize Recovery Flow for API Clients
114
+ *OryHydraClient::PublicApi* | [**initialize_self_service_recovery_via_browser_flow**](docs/PublicApi.md#initialize_self_service_recovery_via_browser_flow) | **GET** /self-service/recovery/browser | Initialize Recovery Flow for Browser Clients
115
+ *OryHydraClient::PublicApi* | [**initialize_self_service_registration_via_api_flow**](docs/PublicApi.md#initialize_self_service_registration_via_api_flow) | **GET** /self-service/registration/api | Initialize Registration Flow for API clients
116
+ *OryHydraClient::PublicApi* | [**initialize_self_service_registration_via_browser_flow**](docs/PublicApi.md#initialize_self_service_registration_via_browser_flow) | **GET** /self-service/registration/browser | Initialize Registration Flow for browsers
117
+ *OryHydraClient::PublicApi* | [**initialize_self_service_settings_via_api_flow**](docs/PublicApi.md#initialize_self_service_settings_via_api_flow) | **GET** /self-service/settings/api | Initialize Settings Flow for API Clients
118
+ *OryHydraClient::PublicApi* | [**initialize_self_service_settings_via_browser_flow**](docs/PublicApi.md#initialize_self_service_settings_via_browser_flow) | **GET** /self-service/settings/browser/flows | Initialize Settings Flow for Browsers
119
+ *OryHydraClient::PublicApi* | [**initialize_self_service_verification_via_api_flow**](docs/PublicApi.md#initialize_self_service_verification_via_api_flow) | **GET** /self-service/verification/api | Initialize Verification Flow for API Clients
120
+ *OryHydraClient::PublicApi* | [**initialize_self_service_verification_via_browser_flow**](docs/PublicApi.md#initialize_self_service_verification_via_browser_flow) | **GET** /self-service/verification/browser | Initialize Verification Flow for Browser Clients
121
+ *OryHydraClient::PublicApi* | [**revoke_session**](docs/PublicApi.md#revoke_session) | **DELETE** /sessions | Revoke and Invalidate a Session
122
+ *OryHydraClient::PublicApi* | [**whoami**](docs/PublicApi.md#whoami) | **GET** /sessions/whoami | Check Who the Current HTTP Session Belongs To
109
123
  *OryHydraClient::VersionApi* | [**get_version**](docs/VersionApi.md#get_version) | **GET** /version | Get service version
110
124
 
111
125
 
112
126
  ## Documentation for Models
113
127
 
114
- - [OryHydraClient::CompleteSelfServiceBrowserProfileManagementFlowPayload](docs/CompleteSelfServiceBrowserProfileManagementFlowPayload.md)
115
- - [OryHydraClient::Error](docs/Error.md)
128
+ - [OryHydraClient::CompleteSelfServiceLoginFlowWithPasswordMethod](docs/CompleteSelfServiceLoginFlowWithPasswordMethod.md)
129
+ - [OryHydraClient::CompleteSelfServiceRecoveryFlowWithLinkMethod](docs/CompleteSelfServiceRecoveryFlowWithLinkMethod.md)
130
+ - [OryHydraClient::CompleteSelfServiceSettingsFlowWithPasswordMethod](docs/CompleteSelfServiceSettingsFlowWithPasswordMethod.md)
131
+ - [OryHydraClient::CompleteSelfServiceVerificationFlowWithLinkMethod](docs/CompleteSelfServiceVerificationFlowWithLinkMethod.md)
132
+ - [OryHydraClient::CreateIdentity](docs/CreateIdentity.md)
133
+ - [OryHydraClient::CreateRecoveryLink](docs/CreateRecoveryLink.md)
116
134
  - [OryHydraClient::ErrorContainer](docs/ErrorContainer.md)
117
- - [OryHydraClient::Form](docs/Form.md)
118
135
  - [OryHydraClient::FormField](docs/FormField.md)
119
136
  - [OryHydraClient::GenericError](docs/GenericError.md)
120
137
  - [OryHydraClient::GenericErrorPayload](docs/GenericErrorPayload.md)
121
138
  - [OryHydraClient::HealthNotReadyStatus](docs/HealthNotReadyStatus.md)
122
139
  - [OryHydraClient::HealthStatus](docs/HealthStatus.md)
123
140
  - [OryHydraClient::Identity](docs/Identity.md)
124
- - [OryHydraClient::LoginRequest](docs/LoginRequest.md)
125
- - [OryHydraClient::LoginRequestMethod](docs/LoginRequestMethod.md)
126
- - [OryHydraClient::LoginRequestMethodConfig](docs/LoginRequestMethodConfig.md)
127
- - [OryHydraClient::ProfileManagementRequest](docs/ProfileManagementRequest.md)
128
- - [OryHydraClient::RegistrationRequest](docs/RegistrationRequest.md)
129
- - [OryHydraClient::RegistrationRequestMethod](docs/RegistrationRequestMethod.md)
130
- - [OryHydraClient::RegistrationRequestMethodConfig](docs/RegistrationRequestMethodConfig.md)
141
+ - [OryHydraClient::LoginFlow](docs/LoginFlow.md)
142
+ - [OryHydraClient::LoginFlowMethod](docs/LoginFlowMethod.md)
143
+ - [OryHydraClient::LoginFlowMethodConfig](docs/LoginFlowMethodConfig.md)
144
+ - [OryHydraClient::LoginViaApiResponse](docs/LoginViaApiResponse.md)
145
+ - [OryHydraClient::Message](docs/Message.md)
146
+ - [OryHydraClient::RecoveryAddress](docs/RecoveryAddress.md)
147
+ - [OryHydraClient::RecoveryFlow](docs/RecoveryFlow.md)
148
+ - [OryHydraClient::RecoveryFlowMethod](docs/RecoveryFlowMethod.md)
149
+ - [OryHydraClient::RecoveryFlowMethodConfig](docs/RecoveryFlowMethodConfig.md)
150
+ - [OryHydraClient::RecoveryLink](docs/RecoveryLink.md)
151
+ - [OryHydraClient::RegistrationFlow](docs/RegistrationFlow.md)
152
+ - [OryHydraClient::RegistrationFlowMethod](docs/RegistrationFlowMethod.md)
153
+ - [OryHydraClient::RegistrationFlowMethodConfig](docs/RegistrationFlowMethodConfig.md)
154
+ - [OryHydraClient::RegistrationViaApiResponse](docs/RegistrationViaApiResponse.md)
155
+ - [OryHydraClient::RevokeSession](docs/RevokeSession.md)
131
156
  - [OryHydraClient::Session](docs/Session.md)
157
+ - [OryHydraClient::SettingsFlow](docs/SettingsFlow.md)
158
+ - [OryHydraClient::SettingsFlowMethod](docs/SettingsFlowMethod.md)
159
+ - [OryHydraClient::SettingsFlowMethodConfig](docs/SettingsFlowMethodConfig.md)
160
+ - [OryHydraClient::SettingsViaApiResponse](docs/SettingsViaApiResponse.md)
161
+ - [OryHydraClient::UpdateIdentity](docs/UpdateIdentity.md)
132
162
  - [OryHydraClient::VerifiableAddress](docs/VerifiableAddress.md)
133
- - [OryHydraClient::VerificationRequest](docs/VerificationRequest.md)
163
+ - [OryHydraClient::VerificationFlow](docs/VerificationFlow.md)
164
+ - [OryHydraClient::VerificationFlowMethod](docs/VerificationFlowMethod.md)
165
+ - [OryHydraClient::VerificationFlowMethodConfig](docs/VerificationFlowMethodConfig.md)
134
166
  - [OryHydraClient::Version](docs/Version.md)
135
167
 
136
168
 
137
169
  ## Documentation for Authorization
138
170
 
139
- All endpoints do not require authorization.
171
+
172
+ ### sessionToken
173
+
174
+
175
+ - **Type**: API key
176
+ - **API key parameter name**: X-Session-Token
177
+ - **Location**: HTTP header
140
178
 
@@ -4,24 +4,28 @@ All URIs are relative to *http://localhost*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**create_identity**](AdminApi.md#create_identity) | **POST** /identities | Create an identity
8
- [**delete_identity**](AdminApi.md#delete_identity) | **DELETE** /identities/{id} | Delete an identity
9
- [**get_identity**](AdminApi.md#get_identity) | **GET** /identities/{id} | Get an identity
10
- [**get_self_service_browser_login_request**](AdminApi.md#get_self_service_browser_login_request) | **GET** /self-service/browser/flows/requests/login | Get the request context of browser-based login user flows
11
- [**get_self_service_browser_profile_management_request**](AdminApi.md#get_self_service_browser_profile_management_request) | **GET** /self-service/browser/flows/requests/profile | Get the request context of browser-based profile management flows
12
- [**get_self_service_browser_registration_request**](AdminApi.md#get_self_service_browser_registration_request) | **GET** /self-service/browser/flows/requests/registration | Get the request context of browser-based registration user flows
13
- [**get_self_service_error**](AdminApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
14
- [**get_self_service_verification_request**](AdminApi.md#get_self_service_verification_request) | **GET** /self-service/browser/flows/requests/verification | Get the request context of browser-based verification flows
15
- [**list_identities**](AdminApi.md#list_identities) | **GET** /identities | List all identities in the system
16
- [**update_identity**](AdminApi.md#update_identity) | **PUT** /identities/{id} | Update an identity
7
+ [**create_identity**](AdminApi.md#create_identity) | **POST** /identities | Create an Identity
8
+ [**create_recovery_link**](AdminApi.md#create_recovery_link) | **POST** /recovery/link | Create a Recovery Link
9
+ [**delete_identity**](AdminApi.md#delete_identity) | **DELETE** /identities/{id} | Delete an Identity
10
+ [**get_identity**](AdminApi.md#get_identity) | **GET** /identities/{id} | Get an Identity
11
+ [**get_schema**](AdminApi.md#get_schema) | **GET** /schemas/{id} |
12
+ [**get_self_service_error**](AdminApi.md#get_self_service_error) | **GET** /self-service/errors | Get User-Facing Self-Service Errors
13
+ [**get_self_service_login_flow**](AdminApi.md#get_self_service_login_flow) | **GET** /self-service/login/flows | Get Login Flow
14
+ [**get_self_service_recovery_flow**](AdminApi.md#get_self_service_recovery_flow) | **GET** /self-service/recovery/flows | Get information about a recovery flow
15
+ [**get_self_service_registration_flow**](AdminApi.md#get_self_service_registration_flow) | **GET** /self-service/registration/flows | Get Registration Flow
16
+ [**get_self_service_settings_flow**](AdminApi.md#get_self_service_settings_flow) | **GET** /self-service/settings/flows | Get Settings Flow
17
+ [**get_self_service_verification_flow**](AdminApi.md#get_self_service_verification_flow) | **GET** /self-service/verification/flows | Get Verification Flow
18
+ [**list_identities**](AdminApi.md#list_identities) | **GET** /identities | List Identities
19
+ [**prometheus**](AdminApi.md#prometheus) | **GET** /metrics/prometheus | Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
20
+ [**update_identity**](AdminApi.md#update_identity) | **PUT** /identities/{id} | Update an Identity
17
21
 
18
22
 
19
23
 
20
24
  ## create_identity
21
25
 
22
- > Identity create_identity(body)
26
+ > Identity create_identity(opts)
23
27
 
24
- Create an identity
28
+ Create an Identity
25
29
 
26
30
  This endpoint creates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future. Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
27
31
 
@@ -32,11 +36,13 @@ This endpoint creates an identity. It is NOT possible to set an identity's crede
32
36
  require 'ory-kratos-client'
33
37
 
34
38
  api_instance = OryHydraClient::AdminApi.new
35
- body = OryHydraClient::Identity.new # Identity |
39
+ opts = {
40
+ body: OryHydraClient::CreateIdentity.new # CreateIdentity |
41
+ }
36
42
 
37
43
  begin
38
- #Create an identity
39
- result = api_instance.create_identity(body)
44
+ #Create an Identity
45
+ result = api_instance.create_identity(opts)
40
46
  p result
41
47
  rescue OryHydraClient::ApiError => e
42
48
  puts "Exception when calling AdminApi->create_identity: #{e}"
@@ -48,7 +54,7 @@ end
48
54
 
49
55
  Name | Type | Description | Notes
50
56
  ------------- | ------------- | ------------- | -------------
51
- **body** | [**Identity**](Identity.md)| |
57
+ **body** | [**CreateIdentity**](CreateIdentity.md)| | [optional]
52
58
 
53
59
  ### Return type
54
60
 
@@ -64,13 +70,62 @@ No authorization required
64
70
  - **Accept**: application/json
65
71
 
66
72
 
73
+ ## create_recovery_link
74
+
75
+ > RecoveryLink create_recovery_link(opts)
76
+
77
+ Create a Recovery Link
78
+
79
+ This endpoint creates a recovery link which should be given to the user in order for them to recover (or activate) their account.
80
+
81
+ ### Example
82
+
83
+ ```ruby
84
+ # load the gem
85
+ require 'ory-kratos-client'
86
+
87
+ api_instance = OryHydraClient::AdminApi.new
88
+ opts = {
89
+ body: OryHydraClient::CreateRecoveryLink.new # CreateRecoveryLink |
90
+ }
91
+
92
+ begin
93
+ #Create a Recovery Link
94
+ result = api_instance.create_recovery_link(opts)
95
+ p result
96
+ rescue OryHydraClient::ApiError => e
97
+ puts "Exception when calling AdminApi->create_recovery_link: #{e}"
98
+ end
99
+ ```
100
+
101
+ ### Parameters
102
+
103
+
104
+ Name | Type | Description | Notes
105
+ ------------- | ------------- | ------------- | -------------
106
+ **body** | [**CreateRecoveryLink**](CreateRecoveryLink.md)| | [optional]
107
+
108
+ ### Return type
109
+
110
+ [**RecoveryLink**](RecoveryLink.md)
111
+
112
+ ### Authorization
113
+
114
+ No authorization required
115
+
116
+ ### HTTP request headers
117
+
118
+ - **Content-Type**: application/json
119
+ - **Accept**: application/json
120
+
121
+
67
122
  ## delete_identity
68
123
 
69
124
  > delete_identity(id)
70
125
 
71
- Delete an identity
126
+ Delete an Identity
72
127
 
73
- This endpoint deletes an identity. This can not be undone. Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
128
+ Calling this endpoint irrecoverably and permanently deletes the identity given its ID. This action can not be undone. This endpoint returns 204 when the identity was deleted or when the identity was not found, in which case it is assumed that is has been deleted already. Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
74
129
 
75
130
  ### Example
76
131
 
@@ -82,7 +137,7 @@ api_instance = OryHydraClient::AdminApi.new
82
137
  id = 'id_example' # String | ID is the identity's ID.
83
138
 
84
139
  begin
85
- #Delete an identity
140
+ #Delete an Identity
86
141
  api_instance.delete_identity(id)
87
142
  rescue OryHydraClient::ApiError => e
88
143
  puts "Exception when calling AdminApi->delete_identity: #{e}"
@@ -114,7 +169,7 @@ No authorization required
114
169
 
115
170
  > Identity get_identity(id)
116
171
 
117
- Get an identity
172
+ Get an Identity
118
173
 
119
174
  Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
120
175
 
@@ -128,7 +183,7 @@ api_instance = OryHydraClient::AdminApi.new
128
183
  id = 'id_example' # String | ID must be set to the ID of identity you want to get
129
184
 
130
185
  begin
131
- #Get an identity
186
+ #Get an Identity
132
187
  result = api_instance.get_identity(id)
133
188
  p result
134
189
  rescue OryHydraClient::ApiError => e
@@ -157,13 +212,13 @@ No authorization required
157
212
  - **Accept**: application/json
158
213
 
159
214
 
160
- ## get_self_service_browser_login_request
215
+ ## get_schema
216
+
217
+ > Object get_schema(id)
161
218
 
162
- > LoginRequest get_self_service_browser_login_request(request)
163
219
 
164
- Get the request context of browser-based login user flows
165
220
 
166
- This endpoint returns a login request's context with, for example, error details and other information. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
221
+ Get a Traits Schema Definition
167
222
 
168
223
  ### Example
169
224
 
@@ -172,14 +227,13 @@ This endpoint returns a login request's context with, for example, error details
172
227
  require 'ory-kratos-client'
173
228
 
174
229
  api_instance = OryHydraClient::AdminApi.new
175
- request = 'request_example' # String | Request is the Login Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/login?request=abcde`).
230
+ id = 'id_example' # String | ID must be set to the ID of schema you want to get
176
231
 
177
232
  begin
178
- #Get the request context of browser-based login user flows
179
- result = api_instance.get_self_service_browser_login_request(request)
233
+ result = api_instance.get_schema(id)
180
234
  p result
181
235
  rescue OryHydraClient::ApiError => e
182
- puts "Exception when calling AdminApi->get_self_service_browser_login_request: #{e}"
236
+ puts "Exception when calling AdminApi->get_schema: #{e}"
183
237
  end
184
238
  ```
185
239
 
@@ -188,11 +242,11 @@ end
188
242
 
189
243
  Name | Type | Description | Notes
190
244
  ------------- | ------------- | ------------- | -------------
191
- **request** | **String**| Request is the Login Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/login?request=abcde`). |
245
+ **id** | **String**| ID must be set to the ID of schema you want to get |
192
246
 
193
247
  ### Return type
194
248
 
195
- [**LoginRequest**](LoginRequest.md)
249
+ **Object**
196
250
 
197
251
  ### Authorization
198
252
 
@@ -204,13 +258,13 @@ No authorization required
204
258
  - **Accept**: application/json
205
259
 
206
260
 
207
- ## get_self_service_browser_profile_management_request
261
+ ## get_self_service_error
208
262
 
209
- > ProfileManagementRequest get_self_service_browser_profile_management_request(request)
263
+ > ErrorContainer get_self_service_error(error)
210
264
 
211
- Get the request context of browser-based profile management flows
265
+ Get User-Facing Self-Service Errors
212
266
 
213
- When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos Profile Management Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-profile-management).
267
+ This endpoint returns the error associated with a user-facing self service errors. This endpoint supports stub values to help you implement the error UI: `?error=stub:500` - returns a stub 500 (Internal Server Error) error. More information can be found at [ORY Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
214
268
 
215
269
  ### Example
216
270
 
@@ -219,14 +273,14 @@ When accessing this endpoint through ORY Kratos' Public API, ensure that cookies
219
273
  require 'ory-kratos-client'
220
274
 
221
275
  api_instance = OryHydraClient::AdminApi.new
222
- request = 'request_example' # String | Request is the Login Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/login?request=abcde`).
276
+ error = 'error_example' # String | Error is the container's ID
223
277
 
224
278
  begin
225
- #Get the request context of browser-based profile management flows
226
- result = api_instance.get_self_service_browser_profile_management_request(request)
279
+ #Get User-Facing Self-Service Errors
280
+ result = api_instance.get_self_service_error(error)
227
281
  p result
228
282
  rescue OryHydraClient::ApiError => e
229
- puts "Exception when calling AdminApi->get_self_service_browser_profile_management_request: #{e}"
283
+ puts "Exception when calling AdminApi->get_self_service_error: #{e}"
230
284
  end
231
285
  ```
232
286
 
@@ -235,11 +289,11 @@ end
235
289
 
236
290
  Name | Type | Description | Notes
237
291
  ------------- | ------------- | ------------- | -------------
238
- **request** | **String**| Request is the Login Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/login?request=abcde`). |
292
+ **error** | **String**| Error is the container's ID |
239
293
 
240
294
  ### Return type
241
295
 
242
- [**ProfileManagementRequest**](ProfileManagementRequest.md)
296
+ [**ErrorContainer**](ErrorContainer.md)
243
297
 
244
298
  ### Authorization
245
299
 
@@ -251,13 +305,13 @@ No authorization required
251
305
  - **Accept**: application/json
252
306
 
253
307
 
254
- ## get_self_service_browser_registration_request
308
+ ## get_self_service_login_flow
255
309
 
256
- > RegistrationRequest get_self_service_browser_registration_request(request)
310
+ > LoginFlow get_self_service_login_flow(id)
257
311
 
258
- Get the request context of browser-based registration user flows
312
+ Get Login Flow
259
313
 
260
- This endpoint returns a registration request's context with, for example, error details and other information. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
314
+ This endpoint returns a login flow's context with, for example, error details and other information. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
261
315
 
262
316
  ### Example
263
317
 
@@ -266,14 +320,14 @@ This endpoint returns a registration request's context with, for example, error
266
320
  require 'ory-kratos-client'
267
321
 
268
322
  api_instance = OryHydraClient::AdminApi.new
269
- request = 'request_example' # String | Request is the Registration Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/registration?request=abcde`).
323
+ id = 'id_example' # String | The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`).
270
324
 
271
325
  begin
272
- #Get the request context of browser-based registration user flows
273
- result = api_instance.get_self_service_browser_registration_request(request)
326
+ #Get Login Flow
327
+ result = api_instance.get_self_service_login_flow(id)
274
328
  p result
275
329
  rescue OryHydraClient::ApiError => e
276
- puts "Exception when calling AdminApi->get_self_service_browser_registration_request: #{e}"
330
+ puts "Exception when calling AdminApi->get_self_service_login_flow: #{e}"
277
331
  end
278
332
  ```
279
333
 
@@ -282,11 +336,11 @@ end
282
336
 
283
337
  Name | Type | Description | Notes
284
338
  ------------- | ------------- | ------------- | -------------
285
- **request** | **String**| Request is the Registration Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/registration?request=abcde`). |
339
+ **id** | **String**| The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`). |
286
340
 
287
341
  ### Return type
288
342
 
289
- [**RegistrationRequest**](RegistrationRequest.md)
343
+ [**LoginFlow**](LoginFlow.md)
290
344
 
291
345
  ### Authorization
292
346
 
@@ -298,13 +352,13 @@ No authorization required
298
352
  - **Accept**: application/json
299
353
 
300
354
 
301
- ## get_self_service_error
355
+ ## get_self_service_recovery_flow
302
356
 
303
- > ErrorContainer get_self_service_error(opts)
357
+ > RecoveryFlow get_self_service_recovery_flow(id)
304
358
 
305
- Get user-facing self-service errors
359
+ Get information about a recovery flow
306
360
 
307
- This endpoint returns the error associated with a user-facing self service errors. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks. More information can be found at [ORY Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
361
+ This endpoint returns a recovery flow's context with, for example, error details and other information. More information can be found at [ORY Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
308
362
 
309
363
  ### Example
310
364
 
@@ -313,16 +367,14 @@ This endpoint returns the error associated with a user-facing self service error
313
367
  require 'ory-kratos-client'
314
368
 
315
369
  api_instance = OryHydraClient::AdminApi.new
316
- opts = {
317
- id: 'id_example' # String |
318
- }
370
+ id = 'id_example' # String | The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`).
319
371
 
320
372
  begin
321
- #Get user-facing self-service errors
322
- result = api_instance.get_self_service_error(opts)
373
+ #Get information about a recovery flow
374
+ result = api_instance.get_self_service_recovery_flow(id)
323
375
  p result
324
376
  rescue OryHydraClient::ApiError => e
325
- puts "Exception when calling AdminApi->get_self_service_error: #{e}"
377
+ puts "Exception when calling AdminApi->get_self_service_recovery_flow: #{e}"
326
378
  end
327
379
  ```
328
380
 
@@ -331,11 +383,58 @@ end
331
383
 
332
384
  Name | Type | Description | Notes
333
385
  ------------- | ------------- | ------------- | -------------
334
- **id** | **String**| | [optional]
386
+ **id** | **String**| The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`). |
335
387
 
336
388
  ### Return type
337
389
 
338
- [**ErrorContainer**](ErrorContainer.md)
390
+ [**RecoveryFlow**](RecoveryFlow.md)
391
+
392
+ ### Authorization
393
+
394
+ No authorization required
395
+
396
+ ### HTTP request headers
397
+
398
+ - **Content-Type**: Not defined
399
+ - **Accept**: application/json
400
+
401
+
402
+ ## get_self_service_registration_flow
403
+
404
+ > RegistrationFlow get_self_service_registration_flow(id)
405
+
406
+ Get Registration Flow
407
+
408
+ This endpoint returns a registration flow's context with, for example, error details and other information. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
409
+
410
+ ### Example
411
+
412
+ ```ruby
413
+ # load the gem
414
+ require 'ory-kratos-client'
415
+
416
+ api_instance = OryHydraClient::AdminApi.new
417
+ id = 'id_example' # String | The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`).
418
+
419
+ begin
420
+ #Get Registration Flow
421
+ result = api_instance.get_self_service_registration_flow(id)
422
+ p result
423
+ rescue OryHydraClient::ApiError => e
424
+ puts "Exception when calling AdminApi->get_self_service_registration_flow: #{e}"
425
+ end
426
+ ```
427
+
428
+ ### Parameters
429
+
430
+
431
+ Name | Type | Description | Notes
432
+ ------------- | ------------- | ------------- | -------------
433
+ **id** | **String**| The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`). |
434
+
435
+ ### Return type
436
+
437
+ [**RegistrationFlow**](RegistrationFlow.md)
339
438
 
340
439
  ### Authorization
341
440
 
@@ -347,13 +446,67 @@ No authorization required
347
446
  - **Accept**: application/json
348
447
 
349
448
 
350
- ## get_self_service_verification_request
449
+ ## get_self_service_settings_flow
450
+
451
+ > SettingsFlow get_self_service_settings_flow(id)
452
+
453
+ Get Settings Flow
454
+
455
+ When accessing this endpoint through ORY Kratos' Public API you must ensure that either the ORY Kratos Session Cookie or the ORY Kratos Session Token are set. The public endpoint does not return 404 status codes but instead 403 or 500 to improve data privacy. You can access this endpoint without credentials when using ORY Kratos' Admin API. More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
456
+
457
+ ### Example
458
+
459
+ ```ruby
460
+ # load the gem
461
+ require 'ory-kratos-client'
462
+ # setup authorization
463
+ OryHydraClient.configure do |config|
464
+ # Configure API key authorization: sessionToken
465
+ config.api_key['X-Session-Token'] = 'YOUR API KEY'
466
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
467
+ #config.api_key_prefix['X-Session-Token'] = 'Bearer'
468
+ end
469
+
470
+ api_instance = OryHydraClient::AdminApi.new
471
+ id = 'id_example' # String | ID is the Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`).
472
+
473
+ begin
474
+ #Get Settings Flow
475
+ result = api_instance.get_self_service_settings_flow(id)
476
+ p result
477
+ rescue OryHydraClient::ApiError => e
478
+ puts "Exception when calling AdminApi->get_self_service_settings_flow: #{e}"
479
+ end
480
+ ```
481
+
482
+ ### Parameters
483
+
484
+
485
+ Name | Type | Description | Notes
486
+ ------------- | ------------- | ------------- | -------------
487
+ **id** | **String**| ID is the Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`). |
488
+
489
+ ### Return type
490
+
491
+ [**SettingsFlow**](SettingsFlow.md)
492
+
493
+ ### Authorization
494
+
495
+ [sessionToken](../README.md#sessionToken)
496
+
497
+ ### HTTP request headers
498
+
499
+ - **Content-Type**: Not defined
500
+ - **Accept**: application/json
501
+
502
+
503
+ ## get_self_service_verification_flow
351
504
 
352
- > VerificationRequest get_self_service_verification_request(request)
505
+ > VerificationFlow get_self_service_verification_flow(id)
353
506
 
354
- Get the request context of browser-based verification flows
507
+ Get Verification Flow
355
508
 
356
- When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
509
+ This endpoint returns a verification flow's context with, for example, error details and other information. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
357
510
 
358
511
  ### Example
359
512
 
@@ -362,14 +515,14 @@ When accessing this endpoint through ORY Kratos' Public API, ensure that cookies
362
515
  require 'ory-kratos-client'
363
516
 
364
517
  api_instance = OryHydraClient::AdminApi.new
365
- request = 'request_example' # String | Request is the Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verify?request=abcde`).
518
+ id = 'id_example' # String | The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`).
366
519
 
367
520
  begin
368
- #Get the request context of browser-based verification flows
369
- result = api_instance.get_self_service_verification_request(request)
521
+ #Get Verification Flow
522
+ result = api_instance.get_self_service_verification_flow(id)
370
523
  p result
371
524
  rescue OryHydraClient::ApiError => e
372
- puts "Exception when calling AdminApi->get_self_service_verification_request: #{e}"
525
+ puts "Exception when calling AdminApi->get_self_service_verification_flow: #{e}"
373
526
  end
374
527
  ```
375
528
 
@@ -378,11 +531,11 @@ end
378
531
 
379
532
  Name | Type | Description | Notes
380
533
  ------------- | ------------- | ------------- | -------------
381
- **request** | **String**| Request is the Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verify?request=abcde`). |
534
+ **id** | **String**| The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`). |
382
535
 
383
536
  ### Return type
384
537
 
385
- [**VerificationRequest**](VerificationRequest.md)
538
+ [**VerificationFlow**](VerificationFlow.md)
386
539
 
387
540
  ### Authorization
388
541
 
@@ -396,11 +549,11 @@ No authorization required
396
549
 
397
550
  ## list_identities
398
551
 
399
- > Array<Identity> list_identities
552
+ > Array<Identity> list_identities(opts)
400
553
 
401
- List all identities in the system
554
+ List Identities
402
555
 
403
- This endpoint returns a login request's context with, for example, error details and other information. Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
556
+ Lists all identities. Does not support search at the moment. Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
404
557
 
405
558
  ### Example
406
559
 
@@ -409,10 +562,14 @@ This endpoint returns a login request's context with, for example, error details
409
562
  require 'ory-kratos-client'
410
563
 
411
564
  api_instance = OryHydraClient::AdminApi.new
565
+ opts = {
566
+ per_page: 100, # Integer | Items per Page This is the number of items per page.
567
+ page: 0 # Integer | Pagination Page
568
+ }
412
569
 
413
570
  begin
414
- #List all identities in the system
415
- result = api_instance.list_identities
571
+ #List Identities
572
+ result = api_instance.list_identities(opts)
416
573
  p result
417
574
  rescue OryHydraClient::ApiError => e
418
575
  puts "Exception when calling AdminApi->list_identities: #{e}"
@@ -421,7 +578,11 @@ end
421
578
 
422
579
  ### Parameters
423
580
 
424
- This endpoint does not need any parameter.
581
+
582
+ Name | Type | Description | Notes
583
+ ------------- | ------------- | ------------- | -------------
584
+ **per_page** | **Integer**| Items per Page This is the number of items per page. | [optional] [default to 100]
585
+ **page** | **Integer**| Pagination Page | [optional] [default to 0]
425
586
 
426
587
  ### Return type
427
588
 
@@ -437,11 +598,53 @@ No authorization required
437
598
  - **Accept**: application/json
438
599
 
439
600
 
601
+ ## prometheus
602
+
603
+ > prometheus
604
+
605
+ Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
606
+
607
+ ``` metadata: annotations: prometheus.io/port: \"4434\" prometheus.io/path: \"/metrics/prometheus\" ```
608
+
609
+ ### Example
610
+
611
+ ```ruby
612
+ # load the gem
613
+ require 'ory-kratos-client'
614
+
615
+ api_instance = OryHydraClient::AdminApi.new
616
+
617
+ begin
618
+ #Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
619
+ api_instance.prometheus
620
+ rescue OryHydraClient::ApiError => e
621
+ puts "Exception when calling AdminApi->prometheus: #{e}"
622
+ end
623
+ ```
624
+
625
+ ### Parameters
626
+
627
+ This endpoint does not need any parameter.
628
+
629
+ ### Return type
630
+
631
+ nil (empty response body)
632
+
633
+ ### Authorization
634
+
635
+ No authorization required
636
+
637
+ ### HTTP request headers
638
+
639
+ - **Content-Type**: Not defined
640
+ - **Accept**: Not defined
641
+
642
+
440
643
  ## update_identity
441
644
 
442
- > Identity update_identity(id, body)
645
+ > Identity update_identity(id, opts)
443
646
 
444
- Update an identity
647
+ Update an Identity
445
648
 
446
649
  This endpoint updates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future. The full identity payload (except credentials) is expected. This endpoint does not support patching. Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
447
650
 
@@ -453,11 +656,13 @@ require 'ory-kratos-client'
453
656
 
454
657
  api_instance = OryHydraClient::AdminApi.new
455
658
  id = 'id_example' # String | ID must be set to the ID of identity you want to update
456
- body = OryHydraClient::Identity.new # Identity |
659
+ opts = {
660
+ body: OryHydraClient::UpdateIdentity.new # UpdateIdentity |
661
+ }
457
662
 
458
663
  begin
459
- #Update an identity
460
- result = api_instance.update_identity(id, body)
664
+ #Update an Identity
665
+ result = api_instance.update_identity(id, opts)
461
666
  p result
462
667
  rescue OryHydraClient::ApiError => e
463
668
  puts "Exception when calling AdminApi->update_identity: #{e}"
@@ -470,7 +675,7 @@ end
470
675
  Name | Type | Description | Notes
471
676
  ------------- | ------------- | ------------- | -------------
472
677
  **id** | **String**| ID must be set to the ID of identity you want to update |
473
- **body** | [**Identity**](Identity.md)| |
678
+ **body** | [**UpdateIdentity**](UpdateIdentity.md)| | [optional]
474
679
 
475
680
  ### Return type
476
681