ory-kratos-client 0.1.0.alpha6 → 0.4.6.alpha1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (73) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/README.md +31 -15
  4. data/docs/AdminApi.md +111 -16
  5. data/docs/CommonApi.md +111 -16
  6. data/docs/CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload.md +19 -0
  7. data/docs/Form.md +3 -3
  8. data/docs/FormField.md +8 -8
  9. data/docs/GenericErrorPayload.md +1 -1
  10. data/docs/Identity.md +9 -7
  11. data/docs/LoginRequest.md +4 -0
  12. data/docs/LoginRequestMethodConfig.md +3 -3
  13. data/docs/Message.md +23 -0
  14. data/docs/ProviderCredentialsConfig.md +19 -0
  15. data/docs/PublicApi.md +327 -50
  16. data/docs/RecoveryAddress.md +21 -0
  17. data/docs/RecoveryRequest.md +31 -0
  18. data/docs/RecoveryRequestMethod.md +19 -0
  19. data/docs/RegistrationRequest.md +3 -1
  20. data/docs/RegistrationRequestMethodConfig.md +3 -3
  21. data/docs/RequestMethodConfig.md +23 -0
  22. data/docs/SettingsRequest.md +33 -0
  23. data/docs/SettingsRequestMethod.md +19 -0
  24. data/docs/VerifiableAddress.md +1 -1
  25. data/docs/VerificationRequest.md +3 -1
  26. data/lib/ory-kratos-client.rb +11 -5
  27. data/lib/ory-kratos-client/api/admin_api.rb +150 -27
  28. data/lib/ory-kratos-client/api/common_api.rb +150 -27
  29. data/lib/ory-kratos-client/api/health_api.rb +2 -2
  30. data/lib/ory-kratos-client/api/public_api.rb +433 -71
  31. data/lib/ory-kratos-client/api/version_api.rb +2 -2
  32. data/lib/ory-kratos-client/api_client.rb +9 -7
  33. data/lib/ory-kratos-client/api_error.rb +2 -2
  34. data/lib/ory-kratos-client/configuration.rb +2 -2
  35. data/lib/ory-kratos-client/models/complete_self_service_browser_settings_strategy_profile_flow_payload.rb +222 -0
  36. data/lib/ory-kratos-client/models/error_container.rb +2 -2
  37. data/lib/ory-kratos-client/models/form.rb +15 -16
  38. data/lib/ory-kratos-client/models/form_field.rb +16 -22
  39. data/lib/ory-kratos-client/models/generic_error.rb +2 -2
  40. data/lib/ory-kratos-client/models/generic_error_payload.rb +4 -7
  41. data/lib/ory-kratos-client/models/health_not_ready_status.rb +2 -2
  42. data/lib/ory-kratos-client/models/health_status.rb +2 -2
  43. data/lib/ory-kratos-client/models/identity.rb +48 -35
  44. data/lib/ory-kratos-client/models/login_request.rb +24 -3
  45. data/lib/ory-kratos-client/models/login_request_method.rb +2 -2
  46. data/lib/ory-kratos-client/models/login_request_method_config.rb +15 -16
  47. data/lib/ory-kratos-client/models/message.rb +233 -0
  48. data/lib/ory-kratos-client/models/provider_credentials_config.rb +215 -0
  49. data/lib/ory-kratos-client/models/recovery_address.rb +239 -0
  50. data/lib/ory-kratos-client/models/recovery_request.rb +309 -0
  51. data/lib/ory-kratos-client/models/recovery_request_method.rb +216 -0
  52. data/lib/ory-kratos-client/models/registration_request.rb +14 -8
  53. data/lib/ory-kratos-client/models/registration_request_method.rb +2 -2
  54. data/lib/ory-kratos-client/models/registration_request_method_config.rb +15 -16
  55. data/lib/ory-kratos-client/models/request_method_config.rb +255 -0
  56. data/lib/ory-kratos-client/models/session.rb +2 -2
  57. data/lib/ory-kratos-client/models/settings_request.rb +323 -0
  58. data/lib/ory-kratos-client/models/settings_request_method.rb +216 -0
  59. data/lib/ory-kratos-client/models/verifiable_address.rb +2 -7
  60. data/lib/ory-kratos-client/models/verification_request.rb +15 -4
  61. data/lib/ory-kratos-client/models/version.rb +2 -2
  62. data/lib/ory-kratos-client/version.rb +3 -3
  63. data/ory-kratos-client.gemspec +2 -2
  64. data/spec/models/complete_self_service_browser_settings_strategy_profile_flow_payload_spec.rb +47 -0
  65. data/spec/models/message_spec.rb +59 -0
  66. data/spec/models/provider_credentials_config_spec.rb +47 -0
  67. data/spec/models/recovery_address_spec.rb +53 -0
  68. data/spec/models/recovery_request_method_spec.rb +47 -0
  69. data/spec/models/recovery_request_spec.rb +83 -0
  70. data/spec/models/request_method_config_spec.rb +59 -0
  71. data/spec/models/settings_request_method_spec.rb +47 -0
  72. data/spec/models/settings_request_spec.rb +83 -0
  73. metadata +55 -19
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 35721bdd1388e22b36f1c986b502e87ffb51ff21ba90f4d46ed24162df4e70d7
4
- data.tar.gz: e8d402dca0c629d4f0999b12536569a12f93fd2e7d7beea63d285c9a8a8f9b81
3
+ metadata.gz: a80384485d9c789723bfebb1208bd95ac304e49c2b48065f3df2d9f0a12fcd61
4
+ data.tar.gz: 9b46a2c9dfb7f397ac4ac0be992e09ea9b419234851a9bc6274168f06a293425
5
5
  SHA512:
6
- metadata.gz: 12a9ef39ce270eebd5210c3bdc0956f1fb80634a60cad964469d452e41c5e560539822c0284cc4308b42091b2fc4ec0ebee9e4e09ffcc2a0ccf6e8fd78b93e81
7
- data.tar.gz: 7816d5332cae05f8af5f4d8dcbe968e875cc4a497dd7c51989fae5ba1ccf0e5a6fa7d2abb2ee62b2fe5bae706d6e7beee589e863ad064dd5ee41ceadbc95e455
6
+ metadata.gz: 98eb5eecfc598572526b52cf4cc3512eb65025f0bd7d146a2603b256501c96628a2a523dee93d793de4a7756eb4a8c19af6593540b5900423e16fc99093ae826
7
+ data.tar.gz: a7e3656b4af77df060ad9c7fc182eb0eba51d60a8664098ef53ef556dfd119b8579fa08578ea5e5524355c9db657a755c41c18c36e8ad55cad10f84c8a9ffeb0
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.0-alpha.6
9
+ - API version: v0.4.6-alpha.1
10
+ - Package version: v0.4.6-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.0-alpha.6.gem
26
+ gem install ./ory-kratos-client-v0.4.6-alpha.1.gem
27
27
  ```
28
28
 
29
- (for development, run `gem install --dev ./ory-kratos-client-v0.1.0-alpha.6.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./ory-kratos-client-v0.4.6-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.0-alpha.6'
35
+ gem 'ory-kratos-client', '~> v0.4.6-alpha.1'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -78,41 +78,50 @@ Class | Method | HTTP request | Description
78
78
  *OryHydraClient::AdminApi* | [**create_identity**](docs/AdminApi.md#create_identity) | **POST** /identities | Create an identity
79
79
  *OryHydraClient::AdminApi* | [**delete_identity**](docs/AdminApi.md#delete_identity) | **DELETE** /identities/{id} | Delete an identity
80
80
  *OryHydraClient::AdminApi* | [**get_identity**](docs/AdminApi.md#get_identity) | **GET** /identities/{id} | Get an identity
81
+ *OryHydraClient::AdminApi* | [**get_schema**](docs/AdminApi.md#get_schema) | **GET** /schemas/{id} |
81
82
  *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_recovery_request**](docs/AdminApi.md#get_self_service_browser_recovery_request) | **GET** /self-service/browser/flows/requests/recovery | Get the request context of browser-based recovery flows
83
84
  *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
85
+ *OryHydraClient::AdminApi* | [**get_self_service_browser_settings_request**](docs/AdminApi.md#get_self_service_browser_settings_request) | **GET** /self-service/browser/flows/requests/settings | Get the request context of browser-based settings flows
84
86
  *OryHydraClient::AdminApi* | [**get_self_service_error**](docs/AdminApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
85
87
  *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
88
  *OryHydraClient::AdminApi* | [**list_identities**](docs/AdminApi.md#list_identities) | **GET** /identities | List all identities in the system
87
89
  *OryHydraClient::AdminApi* | [**update_identity**](docs/AdminApi.md#update_identity) | **PUT** /identities/{id} | Update an identity
90
+ *OryHydraClient::CommonApi* | [**get_schema**](docs/CommonApi.md#get_schema) | **GET** /schemas/{id} |
88
91
  *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
92
+ *OryHydraClient::CommonApi* | [**get_self_service_browser_recovery_request**](docs/CommonApi.md#get_self_service_browser_recovery_request) | **GET** /self-service/browser/flows/requests/recovery | Get the request context of browser-based recovery flows
90
93
  *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
94
+ *OryHydraClient::CommonApi* | [**get_self_service_browser_settings_request**](docs/CommonApi.md#get_self_service_browser_settings_request) | **GET** /self-service/browser/flows/requests/settings | Get the request context of browser-based settings flows
91
95
  *OryHydraClient::CommonApi* | [**get_self_service_error**](docs/CommonApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
92
96
  *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
93
97
  *OryHydraClient::HealthApi* | [**is_instance_alive**](docs/HealthApi.md#is_instance_alive) | **GET** /health/alive | Check alive status
94
98
  *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/complete | Complete the browser-based profile management flows
99
+ *OryHydraClient::PublicApi* | [**complete_self_service_browser_recovery_link_strategy_flow**](docs/PublicApi.md#complete_self_service_browser_recovery_link_strategy_flow) | **POST** /self-service/browser/flows/recovery/link | Complete the browser-based recovery flow using a recovery link
100
+ *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
101
+ *OryHydraClient::PublicApi* | [**complete_self_service_browser_settings_password_strategy_flow**](docs/PublicApi.md#complete_self_service_browser_settings_password_strategy_flow) | **POST** /self-service/browser/flows/settings/strategies/password | Complete the browser-based settings flow for the password strategy
102
+ *OryHydraClient::PublicApi* | [**complete_self_service_browser_settings_profile_strategy_flow**](docs/PublicApi.md#complete_self_service_browser_settings_profile_strategy_flow) | **POST** /self-service/browser/flows/settings/strategies/profile | Complete the browser-based settings flow for profile data
103
+ *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 verification flows
104
+ *OryHydraClient::PublicApi* | [**get_schema**](docs/PublicApi.md#get_schema) | **GET** /schemas/{id} |
97
105
  *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
106
+ *OryHydraClient::PublicApi* | [**get_self_service_browser_recovery_request**](docs/PublicApi.md#get_self_service_browser_recovery_request) | **GET** /self-service/browser/flows/requests/recovery | Get the request context of browser-based recovery flows
99
107
  *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
108
+ *OryHydraClient::PublicApi* | [**get_self_service_browser_settings_request**](docs/PublicApi.md#get_self_service_browser_settings_request) | **GET** /self-service/browser/flows/requests/settings | Get the request context of browser-based settings flows
100
109
  *OryHydraClient::PublicApi* | [**get_self_service_error**](docs/PublicApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
101
110
  *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
111
  *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
103
112
  *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
113
  *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
114
  *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/confirm/{code} | Complete the browser-based verification flows
115
+ *OryHydraClient::PublicApi* | [**initialize_self_service_recovery_flow**](docs/PublicApi.md#initialize_self_service_recovery_flow) | **GET** /self-service/browser/flows/recovery | Initialize browser-based account recovery flow
116
+ *OryHydraClient::PublicApi* | [**initialize_self_service_settings_flow**](docs/PublicApi.md#initialize_self_service_settings_flow) | **GET** /self-service/browser/flows/settings | Initialize browser-based settings flow
117
+ *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
118
  *OryHydraClient::PublicApi* | [**whoami**](docs/PublicApi.md#whoami) | **GET** /sessions/whoami | Check who the current HTTP session belongs to
109
119
  *OryHydraClient::VersionApi* | [**get_version**](docs/VersionApi.md#get_version) | **GET** /version | Get service version
110
120
 
111
121
 
112
122
  ## Documentation for Models
113
123
 
114
- - [OryHydraClient::CompleteSelfServiceBrowserProfileManagementFlowPayload](docs/CompleteSelfServiceBrowserProfileManagementFlowPayload.md)
115
- - [OryHydraClient::Error](docs/Error.md)
124
+ - [OryHydraClient::CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload](docs/CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload.md)
116
125
  - [OryHydraClient::ErrorContainer](docs/ErrorContainer.md)
117
126
  - [OryHydraClient::Form](docs/Form.md)
118
127
  - [OryHydraClient::FormField](docs/FormField.md)
@@ -124,11 +133,18 @@ Class | Method | HTTP request | Description
124
133
  - [OryHydraClient::LoginRequest](docs/LoginRequest.md)
125
134
  - [OryHydraClient::LoginRequestMethod](docs/LoginRequestMethod.md)
126
135
  - [OryHydraClient::LoginRequestMethodConfig](docs/LoginRequestMethodConfig.md)
127
- - [OryHydraClient::ProfileManagementRequest](docs/ProfileManagementRequest.md)
136
+ - [OryHydraClient::Message](docs/Message.md)
137
+ - [OryHydraClient::ProviderCredentialsConfig](docs/ProviderCredentialsConfig.md)
138
+ - [OryHydraClient::RecoveryAddress](docs/RecoveryAddress.md)
139
+ - [OryHydraClient::RecoveryRequest](docs/RecoveryRequest.md)
140
+ - [OryHydraClient::RecoveryRequestMethod](docs/RecoveryRequestMethod.md)
128
141
  - [OryHydraClient::RegistrationRequest](docs/RegistrationRequest.md)
129
142
  - [OryHydraClient::RegistrationRequestMethod](docs/RegistrationRequestMethod.md)
130
143
  - [OryHydraClient::RegistrationRequestMethodConfig](docs/RegistrationRequestMethodConfig.md)
144
+ - [OryHydraClient::RequestMethodConfig](docs/RequestMethodConfig.md)
131
145
  - [OryHydraClient::Session](docs/Session.md)
146
+ - [OryHydraClient::SettingsRequest](docs/SettingsRequest.md)
147
+ - [OryHydraClient::SettingsRequestMethod](docs/SettingsRequestMethod.md)
132
148
  - [OryHydraClient::VerifiableAddress](docs/VerifiableAddress.md)
133
149
  - [OryHydraClient::VerificationRequest](docs/VerificationRequest.md)
134
150
  - [OryHydraClient::Version](docs/Version.md)
data/docs/AdminApi.md CHANGED
@@ -7,9 +7,11 @@ Method | HTTP request | Description
7
7
  [**create_identity**](AdminApi.md#create_identity) | **POST** /identities | Create an identity
8
8
  [**delete_identity**](AdminApi.md#delete_identity) | **DELETE** /identities/{id} | Delete an identity
9
9
  [**get_identity**](AdminApi.md#get_identity) | **GET** /identities/{id} | Get an identity
10
+ [**get_schema**](AdminApi.md#get_schema) | **GET** /schemas/{id} |
10
11
  [**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_recovery_request**](AdminApi.md#get_self_service_browser_recovery_request) | **GET** /self-service/browser/flows/requests/recovery | Get the request context of browser-based recovery flows
12
13
  [**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
14
+ [**get_self_service_browser_settings_request**](AdminApi.md#get_self_service_browser_settings_request) | **GET** /self-service/browser/flows/requests/settings | Get the request context of browser-based settings flows
13
15
  [**get_self_service_error**](AdminApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
14
16
  [**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
17
  [**list_identities**](AdminApi.md#list_identities) | **GET** /identities | List all identities in the system
@@ -157,13 +159,59 @@ No authorization required
157
159
  - **Accept**: application/json
158
160
 
159
161
 
162
+ ## get_schema
163
+
164
+ > Object get_schema(id)
165
+
166
+
167
+
168
+ Get a traits schema definition
169
+
170
+ ### Example
171
+
172
+ ```ruby
173
+ # load the gem
174
+ require 'ory-kratos-client'
175
+
176
+ api_instance = OryHydraClient::AdminApi.new
177
+ id = 'id_example' # String | ID must be set to the ID of schema you want to get
178
+
179
+ begin
180
+ result = api_instance.get_schema(id)
181
+ p result
182
+ rescue OryHydraClient::ApiError => e
183
+ puts "Exception when calling AdminApi->get_schema: #{e}"
184
+ end
185
+ ```
186
+
187
+ ### Parameters
188
+
189
+
190
+ Name | Type | Description | Notes
191
+ ------------- | ------------- | ------------- | -------------
192
+ **id** | **String**| ID must be set to the ID of schema you want to get |
193
+
194
+ ### Return type
195
+
196
+ **Object**
197
+
198
+ ### Authorization
199
+
200
+ No authorization required
201
+
202
+ ### HTTP request headers
203
+
204
+ - **Content-Type**: Not defined
205
+ - **Accept**: application/json
206
+
207
+
160
208
  ## get_self_service_browser_login_request
161
209
 
162
210
  > LoginRequest get_self_service_browser_login_request(request)
163
211
 
164
212
  Get the request context of browser-based login user flows
165
213
 
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).
214
+ 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. 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).
167
215
 
168
216
  ### Example
169
217
 
@@ -204,13 +252,13 @@ No authorization required
204
252
  - **Accept**: application/json
205
253
 
206
254
 
207
- ## get_self_service_browser_profile_management_request
255
+ ## get_self_service_browser_recovery_request
208
256
 
209
- > ProfileManagementRequest get_self_service_browser_profile_management_request(request)
257
+ > RecoveryRequest get_self_service_browser_recovery_request(request)
210
258
 
211
- Get the request context of browser-based profile management flows
259
+ Get the request context of browser-based recovery flows
212
260
 
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).
261
+ 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 Account Recovery Documentation](../self-service/flows/password-reset-account-recovery).
214
262
 
215
263
  ### Example
216
264
 
@@ -219,14 +267,14 @@ When accessing this endpoint through ORY Kratos' Public API, ensure that cookies
219
267
  require 'ory-kratos-client'
220
268
 
221
269
  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`).
270
+ 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. `/recover?request=abcde`).
223
271
 
224
272
  begin
225
- #Get the request context of browser-based profile management flows
226
- result = api_instance.get_self_service_browser_profile_management_request(request)
273
+ #Get the request context of browser-based recovery flows
274
+ result = api_instance.get_self_service_browser_recovery_request(request)
227
275
  p result
228
276
  rescue OryHydraClient::ApiError => e
229
- puts "Exception when calling AdminApi->get_self_service_browser_profile_management_request: #{e}"
277
+ puts "Exception when calling AdminApi->get_self_service_browser_recovery_request: #{e}"
230
278
  end
231
279
  ```
232
280
 
@@ -235,11 +283,11 @@ end
235
283
 
236
284
  Name | Type | Description | Notes
237
285
  ------------- | ------------- | ------------- | -------------
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`). |
286
+ **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. `/recover?request=abcde`). |
239
287
 
240
288
  ### Return type
241
289
 
242
- [**ProfileManagementRequest**](ProfileManagementRequest.md)
290
+ [**RecoveryRequest**](RecoveryRequest.md)
243
291
 
244
292
  ### Authorization
245
293
 
@@ -257,7 +305,7 @@ No authorization required
257
305
 
258
306
  Get the request context of browser-based registration user flows
259
307
 
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).
308
+ 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. 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
309
 
262
310
  ### Example
263
311
 
@@ -298,13 +346,60 @@ No authorization required
298
346
  - **Accept**: application/json
299
347
 
300
348
 
349
+ ## get_self_service_browser_settings_request
350
+
351
+ > SettingsRequest get_self_service_browser_settings_request(request)
352
+
353
+ Get the request context of browser-based settings flows
354
+
355
+ 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 User Settings & Profile Management Documentation](../self-service/flows/user-settings).
356
+
357
+ ### Example
358
+
359
+ ```ruby
360
+ # load the gem
361
+ require 'ory-kratos-client'
362
+
363
+ api_instance = OryHydraClient::AdminApi.new
364
+ 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. `/settingss?request=abcde`).
365
+
366
+ begin
367
+ #Get the request context of browser-based settings flows
368
+ result = api_instance.get_self_service_browser_settings_request(request)
369
+ p result
370
+ rescue OryHydraClient::ApiError => e
371
+ puts "Exception when calling AdminApi->get_self_service_browser_settings_request: #{e}"
372
+ end
373
+ ```
374
+
375
+ ### Parameters
376
+
377
+
378
+ Name | Type | Description | Notes
379
+ ------------- | ------------- | ------------- | -------------
380
+ **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. `/settingss?request=abcde`). |
381
+
382
+ ### Return type
383
+
384
+ [**SettingsRequest**](SettingsRequest.md)
385
+
386
+ ### Authorization
387
+
388
+ No authorization required
389
+
390
+ ### HTTP request headers
391
+
392
+ - **Content-Type**: Not defined
393
+ - **Accept**: application/json
394
+
395
+
301
396
  ## get_self_service_error
302
397
 
303
398
  > ErrorContainer get_self_service_error(opts)
304
399
 
305
400
  Get user-facing self-service errors
306
401
 
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).
402
+ 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. 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).
308
403
 
309
404
  ### Example
310
405
 
@@ -314,7 +409,7 @@ require 'ory-kratos-client'
314
409
 
315
410
  api_instance = OryHydraClient::AdminApi.new
316
411
  opts = {
317
- id: 'id_example' # String |
412
+ error: 'error_example' # String |
318
413
  }
319
414
 
320
415
  begin
@@ -331,7 +426,7 @@ end
331
426
 
332
427
  Name | Type | Description | Notes
333
428
  ------------- | ------------- | ------------- | -------------
334
- **id** | **String**| | [optional]
429
+ **error** | **String**| | [optional]
335
430
 
336
431
  ### Return type
337
432
 
data/docs/CommonApi.md CHANGED
@@ -4,21 +4,69 @@ All URIs are relative to *http://localhost*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
+ [**get_schema**](CommonApi.md#get_schema) | **GET** /schemas/{id} |
7
8
  [**get_self_service_browser_login_request**](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
8
- [**get_self_service_browser_profile_management_request**](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
9
+ [**get_self_service_browser_recovery_request**](CommonApi.md#get_self_service_browser_recovery_request) | **GET** /self-service/browser/flows/requests/recovery | Get the request context of browser-based recovery flows
9
10
  [**get_self_service_browser_registration_request**](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
11
+ [**get_self_service_browser_settings_request**](CommonApi.md#get_self_service_browser_settings_request) | **GET** /self-service/browser/flows/requests/settings | Get the request context of browser-based settings flows
10
12
  [**get_self_service_error**](CommonApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
11
13
  [**get_self_service_verification_request**](CommonApi.md#get_self_service_verification_request) | **GET** /self-service/browser/flows/requests/verification | Get the request context of browser-based verification flows
12
14
 
13
15
 
14
16
 
17
+ ## get_schema
18
+
19
+ > Object get_schema(id)
20
+
21
+
22
+
23
+ Get a traits schema definition
24
+
25
+ ### Example
26
+
27
+ ```ruby
28
+ # load the gem
29
+ require 'ory-kratos-client'
30
+
31
+ api_instance = OryHydraClient::CommonApi.new
32
+ id = 'id_example' # String | ID must be set to the ID of schema you want to get
33
+
34
+ begin
35
+ result = api_instance.get_schema(id)
36
+ p result
37
+ rescue OryHydraClient::ApiError => e
38
+ puts "Exception when calling CommonApi->get_schema: #{e}"
39
+ end
40
+ ```
41
+
42
+ ### Parameters
43
+
44
+
45
+ Name | Type | Description | Notes
46
+ ------------- | ------------- | ------------- | -------------
47
+ **id** | **String**| ID must be set to the ID of schema you want to get |
48
+
49
+ ### Return type
50
+
51
+ **Object**
52
+
53
+ ### Authorization
54
+
55
+ No authorization required
56
+
57
+ ### HTTP request headers
58
+
59
+ - **Content-Type**: Not defined
60
+ - **Accept**: application/json
61
+
62
+
15
63
  ## get_self_service_browser_login_request
16
64
 
17
65
  > LoginRequest get_self_service_browser_login_request(request)
18
66
 
19
67
  Get the request context of browser-based login user flows
20
68
 
21
- 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).
69
+ 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. 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).
22
70
 
23
71
  ### Example
24
72
 
@@ -59,13 +107,13 @@ No authorization required
59
107
  - **Accept**: application/json
60
108
 
61
109
 
62
- ## get_self_service_browser_profile_management_request
110
+ ## get_self_service_browser_recovery_request
63
111
 
64
- > ProfileManagementRequest get_self_service_browser_profile_management_request(request)
112
+ > RecoveryRequest get_self_service_browser_recovery_request(request)
65
113
 
66
- Get the request context of browser-based profile management flows
114
+ Get the request context of browser-based recovery flows
67
115
 
68
- 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).
116
+ 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 Account Recovery Documentation](../self-service/flows/password-reset-account-recovery).
69
117
 
70
118
  ### Example
71
119
 
@@ -74,14 +122,14 @@ When accessing this endpoint through ORY Kratos' Public API, ensure that cookies
74
122
  require 'ory-kratos-client'
75
123
 
76
124
  api_instance = OryHydraClient::CommonApi.new
77
- 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`).
125
+ 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. `/recover?request=abcde`).
78
126
 
79
127
  begin
80
- #Get the request context of browser-based profile management flows
81
- result = api_instance.get_self_service_browser_profile_management_request(request)
128
+ #Get the request context of browser-based recovery flows
129
+ result = api_instance.get_self_service_browser_recovery_request(request)
82
130
  p result
83
131
  rescue OryHydraClient::ApiError => e
84
- puts "Exception when calling CommonApi->get_self_service_browser_profile_management_request: #{e}"
132
+ puts "Exception when calling CommonApi->get_self_service_browser_recovery_request: #{e}"
85
133
  end
86
134
  ```
87
135
 
@@ -90,11 +138,11 @@ end
90
138
 
91
139
  Name | Type | Description | Notes
92
140
  ------------- | ------------- | ------------- | -------------
93
- **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`). |
141
+ **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. `/recover?request=abcde`). |
94
142
 
95
143
  ### Return type
96
144
 
97
- [**ProfileManagementRequest**](ProfileManagementRequest.md)
145
+ [**RecoveryRequest**](RecoveryRequest.md)
98
146
 
99
147
  ### Authorization
100
148
 
@@ -112,7 +160,7 @@ No authorization required
112
160
 
113
161
  Get the request context of browser-based registration user flows
114
162
 
115
- 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).
163
+ 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. 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).
116
164
 
117
165
  ### Example
118
166
 
@@ -153,13 +201,60 @@ No authorization required
153
201
  - **Accept**: application/json
154
202
 
155
203
 
204
+ ## get_self_service_browser_settings_request
205
+
206
+ > SettingsRequest get_self_service_browser_settings_request(request)
207
+
208
+ Get the request context of browser-based settings flows
209
+
210
+ 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 User Settings & Profile Management Documentation](../self-service/flows/user-settings).
211
+
212
+ ### Example
213
+
214
+ ```ruby
215
+ # load the gem
216
+ require 'ory-kratos-client'
217
+
218
+ api_instance = OryHydraClient::CommonApi.new
219
+ 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. `/settingss?request=abcde`).
220
+
221
+ begin
222
+ #Get the request context of browser-based settings flows
223
+ result = api_instance.get_self_service_browser_settings_request(request)
224
+ p result
225
+ rescue OryHydraClient::ApiError => e
226
+ puts "Exception when calling CommonApi->get_self_service_browser_settings_request: #{e}"
227
+ end
228
+ ```
229
+
230
+ ### Parameters
231
+
232
+
233
+ Name | Type | Description | Notes
234
+ ------------- | ------------- | ------------- | -------------
235
+ **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. `/settingss?request=abcde`). |
236
+
237
+ ### Return type
238
+
239
+ [**SettingsRequest**](SettingsRequest.md)
240
+
241
+ ### Authorization
242
+
243
+ No authorization required
244
+
245
+ ### HTTP request headers
246
+
247
+ - **Content-Type**: Not defined
248
+ - **Accept**: application/json
249
+
250
+
156
251
  ## get_self_service_error
157
252
 
158
253
  > ErrorContainer get_self_service_error(opts)
159
254
 
160
255
  Get user-facing self-service errors
161
256
 
162
- 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).
257
+ 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. 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).
163
258
 
164
259
  ### Example
165
260
 
@@ -169,7 +264,7 @@ require 'ory-kratos-client'
169
264
 
170
265
  api_instance = OryHydraClient::CommonApi.new
171
266
  opts = {
172
- id: 'id_example' # String |
267
+ error: 'error_example' # String |
173
268
  }
174
269
 
175
270
  begin
@@ -186,7 +281,7 @@ end
186
281
 
187
282
  Name | Type | Description | Notes
188
283
  ------------- | ------------- | ------------- | -------------
189
- **id** | **String**| | [optional]
284
+ **error** | **String**| | [optional]
190
285
 
191
286
  ### Return type
192
287