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

Sign up to get free protection for your applications and to get access to all the features.
Files changed (113) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +82 -60
  3. data/docs/AdminApi.md +208 -98
  4. data/docs/CompleteSelfServiceLoginFlowWithPasswordMethod.md +21 -0
  5. data/docs/CompleteSelfServiceRecoveryFlowWithLinkMethod.md +19 -0
  6. data/docs/CompleteSelfServiceSettingsFlowWithPasswordMethod.md +19 -0
  7. data/docs/CompleteSelfServiceVerificationFlowWithLinkMethod.md +19 -0
  8. data/docs/CreateIdentity.md +19 -0
  9. data/docs/CreateRecoveryLink.md +19 -0
  10. data/docs/ErrorContainer.md +2 -2
  11. data/docs/Identity.md +1 -1
  12. data/docs/LoginFlow.md +33 -0
  13. data/docs/LoginFlowMethod.md +19 -0
  14. data/docs/LoginFlowMethodConfig.md +25 -0
  15. data/docs/LoginViaApiResponse.md +19 -0
  16. data/docs/Message.md +1 -1
  17. data/docs/PublicApi.md +589 -197
  18. data/docs/RecoveryFlow.md +33 -0
  19. data/docs/RecoveryFlowMethod.md +19 -0
  20. data/docs/RecoveryFlowMethodConfig.md +23 -0
  21. data/docs/RecoveryLink.md +19 -0
  22. data/docs/RegistrationFlow.md +31 -0
  23. data/docs/RegistrationFlowMethod.md +19 -0
  24. data/docs/RegistrationFlowMethodConfig.md +25 -0
  25. data/docs/RegistrationViaApiResponse.md +21 -0
  26. data/docs/RevokeSession.md +17 -0
  27. data/docs/Session.md +6 -4
  28. data/docs/SettingsFlow.md +35 -0
  29. data/docs/SettingsFlowMethod.md +19 -0
  30. data/docs/SettingsFlowMethodConfig.md +23 -0
  31. data/docs/SettingsViaApiResponse.md +19 -0
  32. data/docs/UpdateIdentity.md +19 -0
  33. data/docs/VerifiableAddress.md +3 -3
  34. data/docs/VerificationFlow.md +33 -0
  35. data/docs/VerificationFlowMethod.md +19 -0
  36. data/docs/VerificationFlowMethodConfig.md +23 -0
  37. data/lib/ory-kratos-client.rb +28 -17
  38. data/lib/ory-kratos-client/api/admin_api.rb +277 -149
  39. data/lib/ory-kratos-client/api/health_api.rb +1 -1
  40. data/lib/ory-kratos-client/api/public_api.rb +713 -297
  41. data/lib/ory-kratos-client/api/version_api.rb +1 -1
  42. data/lib/ory-kratos-client/api_client.rb +2 -1
  43. data/lib/ory-kratos-client/api_error.rb +1 -1
  44. data/lib/ory-kratos-client/configuration.rb +8 -1
  45. data/lib/ory-kratos-client/models/complete_self_service_login_flow_with_password_method.rb +227 -0
  46. data/lib/ory-kratos-client/models/complete_self_service_recovery_flow_with_link_method.rb +217 -0
  47. data/lib/ory-kratos-client/models/complete_self_service_settings_flow_with_password_method.rb +222 -0
  48. data/lib/ory-kratos-client/models/complete_self_service_verification_flow_with_link_method.rb +217 -0
  49. data/lib/ory-kratos-client/models/create_identity.rb +227 -0
  50. data/lib/ory-kratos-client/models/create_recovery_link.rb +238 -0
  51. data/lib/ory-kratos-client/models/error_container.rb +12 -1
  52. data/lib/ory-kratos-client/models/form_field.rb +1 -1
  53. data/lib/ory-kratos-client/models/generic_error.rb +1 -1
  54. data/lib/ory-kratos-client/models/generic_error_payload.rb +1 -1
  55. data/lib/ory-kratos-client/models/health_not_ready_status.rb +1 -1
  56. data/lib/ory-kratos-client/models/health_status.rb +1 -1
  57. data/lib/ory-kratos-client/models/identity.rb +6 -1
  58. data/lib/ory-kratos-client/models/login_flow.rb +315 -0
  59. data/lib/ory-kratos-client/models/login_flow_method.rb +226 -0
  60. data/lib/ory-kratos-client/models/login_flow_method_config.rb +267 -0
  61. data/lib/ory-kratos-client/models/login_via_api_response.rb +227 -0
  62. data/lib/ory-kratos-client/models/message.rb +2 -1
  63. data/lib/ory-kratos-client/models/recovery_address.rb +1 -1
  64. data/lib/ory-kratos-client/models/recovery_flow.rb +319 -0
  65. data/lib/ory-kratos-client/models/recovery_flow_method.rb +226 -0
  66. data/lib/ory-kratos-client/models/recovery_flow_method_config.rb +255 -0
  67. data/lib/ory-kratos-client/models/recovery_link.rb +222 -0
  68. data/lib/ory-kratos-client/models/registration_flow.rb +304 -0
  69. data/lib/ory-kratos-client/models/registration_flow_method.rb +226 -0
  70. data/lib/ory-kratos-client/models/registration_flow_method_config.rb +267 -0
  71. data/lib/ory-kratos-client/models/registration_via_api_response.rb +236 -0
  72. data/lib/ory-kratos-client/models/revoke_session.rb +212 -0
  73. data/lib/ory-kratos-client/models/session.rb +28 -19
  74. data/lib/ory-kratos-client/models/settings_flow.rb +333 -0
  75. data/lib/ory-kratos-client/models/settings_flow_method.rb +226 -0
  76. data/lib/ory-kratos-client/models/settings_flow_method_config.rb +255 -0
  77. data/lib/ory-kratos-client/models/settings_via_api_response.rb +226 -0
  78. data/lib/ory-kratos-client/models/update_identity.rb +222 -0
  79. data/lib/ory-kratos-client/models/verifiable_address.rb +16 -16
  80. data/lib/ory-kratos-client/models/verification_flow.rb +299 -0
  81. data/lib/ory-kratos-client/models/verification_flow_method.rb +226 -0
  82. data/lib/ory-kratos-client/models/verification_flow_method_config.rb +255 -0
  83. data/lib/ory-kratos-client/models/version.rb +1 -1
  84. data/lib/ory-kratos-client/version.rb +2 -2
  85. data/ory-kratos-client.gemspec +1 -1
  86. data/spec/models/complete_self_service_login_flow_with_password_method_spec.rb +53 -0
  87. data/spec/models/complete_self_service_recovery_flow_with_link_method_spec.rb +47 -0
  88. data/spec/models/complete_self_service_settings_flow_with_password_method_spec.rb +47 -0
  89. data/spec/models/complete_self_service_verification_flow_with_link_method_spec.rb +47 -0
  90. data/spec/models/create_identity_spec.rb +47 -0
  91. data/spec/models/create_recovery_link_spec.rb +47 -0
  92. data/spec/models/login_flow_method_config_spec.rb +65 -0
  93. data/spec/models/login_flow_method_spec.rb +47 -0
  94. data/spec/models/login_flow_spec.rb +89 -0
  95. data/spec/models/login_via_api_response_spec.rb +47 -0
  96. data/spec/models/recovery_flow_method_config_spec.rb +59 -0
  97. data/spec/models/recovery_flow_method_spec.rb +47 -0
  98. data/spec/models/recovery_flow_spec.rb +89 -0
  99. data/spec/models/recovery_link_spec.rb +47 -0
  100. data/spec/models/registration_flow_method_config_spec.rb +65 -0
  101. data/spec/models/registration_flow_method_spec.rb +47 -0
  102. data/spec/models/registration_flow_spec.rb +83 -0
  103. data/spec/models/registration_via_api_response_spec.rb +53 -0
  104. data/spec/models/revoke_session_spec.rb +41 -0
  105. data/spec/models/settings_flow_method_config_spec.rb +59 -0
  106. data/spec/models/settings_flow_method_spec.rb +47 -0
  107. data/spec/models/settings_flow_spec.rb +95 -0
  108. data/spec/models/settings_via_api_response_spec.rb +47 -0
  109. data/spec/models/update_identity_spec.rb +47 -0
  110. data/spec/models/verification_flow_method_config_spec.rb +59 -0
  111. data/spec/models/verification_flow_method_spec.rb +47 -0
  112. data/spec/models/verification_flow_spec.rb +89 -0
  113. metadata +133 -25
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a80384485d9c789723bfebb1208bd95ac304e49c2b48065f3df2d9f0a12fcd61
4
- data.tar.gz: 9b46a2c9dfb7f397ac4ac0be992e09ea9b419234851a9bc6274168f06a293425
3
+ metadata.gz: 0bc4dabbbc60dee930b3c5ebcb9678bb4b7b257dc21aabf257fb7b055948e22e
4
+ data.tar.gz: f4a0cb9a19bff3deaa3101d6a006072dacf1338fe9d4872ae59ac253ae8cd382
5
5
  SHA512:
6
- metadata.gz: 98eb5eecfc598572526b52cf4cc3512eb65025f0bd7d146a2603b256501c96628a2a523dee93d793de4a7756eb4a8c19af6593540b5900423e16fc99093ae826
7
- data.tar.gz: a7e3656b4af77df060ad9c7fc182eb0eba51d60a8664098ef53ef556dfd119b8579fa08578ea5e5524355c9db657a755c41c18c36e8ad55cad10f84c8a9ffeb0
6
+ metadata.gz: 30205eefc9dee93241c1559d0533ea7b3808672f5f8230dffc656125653cc56ae8e4147005dd4dc173722064433a3437b72afb6a2654937e12dd156bceba86ac
7
+ data.tar.gz: 59c665edccbfd55a1e79bb38ad627072a191bd83b9c6fb8773de1285dda3eabf140b40bcc240e328d52a7e5a8887e3efa81affc94ffa3040d5f09f4072fa61f2
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: v0.4.6-alpha.1
10
- - Package version: v0.4.6-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.4.6-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.4.6-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.4.6-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,82 +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
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
81
84
  *OryHydraClient::AdminApi* | [**get_schema**](docs/AdminApi.md#get_schema) | **GET** /schemas/{id} |
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
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
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
86
- *OryHydraClient::AdminApi* | [**get_self_service_error**](docs/AdminApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
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
88
- *OryHydraClient::AdminApi* | [**list_identities**](docs/AdminApi.md#list_identities) | **GET** /identities | List all identities in the system
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} |
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
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
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
95
- *OryHydraClient::CommonApi* | [**get_self_service_error**](docs/CommonApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
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
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
97
94
  *OryHydraClient::HealthApi* | [**is_instance_alive**](docs/HealthApi.md#is_instance_alive) | **GET** /health/alive | Check alive status
98
95
  *OryHydraClient::HealthApi* | [**is_instance_ready**](docs/HealthApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status
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
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
104
103
  *OryHydraClient::PublicApi* | [**get_schema**](docs/PublicApi.md#get_schema) | **GET** /schemas/{id} |
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
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
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
109
- *OryHydraClient::PublicApi* | [**get_self_service_error**](docs/PublicApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
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
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
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
112
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
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
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
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
118
- *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
119
123
  *OryHydraClient::VersionApi* | [**get_version**](docs/VersionApi.md#get_version) | **GET** /version | Get service version
120
124
 
121
125
 
122
126
  ## Documentation for Models
123
127
 
124
- - [OryHydraClient::CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload](docs/CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload.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)
125
134
  - [OryHydraClient::ErrorContainer](docs/ErrorContainer.md)
126
- - [OryHydraClient::Form](docs/Form.md)
127
135
  - [OryHydraClient::FormField](docs/FormField.md)
128
136
  - [OryHydraClient::GenericError](docs/GenericError.md)
129
137
  - [OryHydraClient::GenericErrorPayload](docs/GenericErrorPayload.md)
130
138
  - [OryHydraClient::HealthNotReadyStatus](docs/HealthNotReadyStatus.md)
131
139
  - [OryHydraClient::HealthStatus](docs/HealthStatus.md)
132
140
  - [OryHydraClient::Identity](docs/Identity.md)
133
- - [OryHydraClient::LoginRequest](docs/LoginRequest.md)
134
- - [OryHydraClient::LoginRequestMethod](docs/LoginRequestMethod.md)
135
- - [OryHydraClient::LoginRequestMethodConfig](docs/LoginRequestMethodConfig.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)
136
145
  - [OryHydraClient::Message](docs/Message.md)
137
- - [OryHydraClient::ProviderCredentialsConfig](docs/ProviderCredentialsConfig.md)
138
146
  - [OryHydraClient::RecoveryAddress](docs/RecoveryAddress.md)
139
- - [OryHydraClient::RecoveryRequest](docs/RecoveryRequest.md)
140
- - [OryHydraClient::RecoveryRequestMethod](docs/RecoveryRequestMethod.md)
141
- - [OryHydraClient::RegistrationRequest](docs/RegistrationRequest.md)
142
- - [OryHydraClient::RegistrationRequestMethod](docs/RegistrationRequestMethod.md)
143
- - [OryHydraClient::RegistrationRequestMethodConfig](docs/RegistrationRequestMethodConfig.md)
144
- - [OryHydraClient::RequestMethodConfig](docs/RequestMethodConfig.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)
145
156
  - [OryHydraClient::Session](docs/Session.md)
146
- - [OryHydraClient::SettingsRequest](docs/SettingsRequest.md)
147
- - [OryHydraClient::SettingsRequestMethod](docs/SettingsRequestMethod.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)
148
162
  - [OryHydraClient::VerifiableAddress](docs/VerifiableAddress.md)
149
- - [OryHydraClient::VerificationRequest](docs/VerificationRequest.md)
163
+ - [OryHydraClient::VerificationFlow](docs/VerificationFlow.md)
164
+ - [OryHydraClient::VerificationFlowMethod](docs/VerificationFlowMethod.md)
165
+ - [OryHydraClient::VerificationFlowMethodConfig](docs/VerificationFlowMethodConfig.md)
150
166
  - [OryHydraClient::Version](docs/Version.md)
151
167
 
152
168
 
153
169
  ## Documentation for Authorization
154
170
 
155
- 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
156
178
 
@@ -4,26 +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
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
10
11
  [**get_schema**](AdminApi.md#get_schema) | **GET** /schemas/{id} |
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
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
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
15
- [**get_self_service_error**](AdminApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
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
17
- [**list_identities**](AdminApi.md#list_identities) | **GET** /identities | List all identities in the system
18
- [**update_identity**](AdminApi.md#update_identity) | **PUT** /identities/{id} | Update an identity
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
19
21
 
20
22
 
21
23
 
22
24
  ## create_identity
23
25
 
24
- > Identity create_identity(body)
26
+ > Identity create_identity(opts)
25
27
 
26
- Create an identity
28
+ Create an Identity
27
29
 
28
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).
29
31
 
@@ -34,11 +36,13 @@ This endpoint creates an identity. It is NOT possible to set an identity's crede
34
36
  require 'ory-kratos-client'
35
37
 
36
38
  api_instance = OryHydraClient::AdminApi.new
37
- body = OryHydraClient::Identity.new # Identity |
39
+ opts = {
40
+ body: OryHydraClient::CreateIdentity.new # CreateIdentity |
41
+ }
38
42
 
39
43
  begin
40
- #Create an identity
41
- result = api_instance.create_identity(body)
44
+ #Create an Identity
45
+ result = api_instance.create_identity(opts)
42
46
  p result
43
47
  rescue OryHydraClient::ApiError => e
44
48
  puts "Exception when calling AdminApi->create_identity: #{e}"
@@ -50,7 +54,7 @@ end
50
54
 
51
55
  Name | Type | Description | Notes
52
56
  ------------- | ------------- | ------------- | -------------
53
- **body** | [**Identity**](Identity.md)| |
57
+ **body** | [**CreateIdentity**](CreateIdentity.md)| | [optional]
54
58
 
55
59
  ### Return type
56
60
 
@@ -66,13 +70,62 @@ No authorization required
66
70
  - **Accept**: application/json
67
71
 
68
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
+
69
122
  ## delete_identity
70
123
 
71
124
  > delete_identity(id)
72
125
 
73
- Delete an identity
126
+ Delete an Identity
74
127
 
75
- 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).
76
129
 
77
130
  ### Example
78
131
 
@@ -84,7 +137,7 @@ api_instance = OryHydraClient::AdminApi.new
84
137
  id = 'id_example' # String | ID is the identity's ID.
85
138
 
86
139
  begin
87
- #Delete an identity
140
+ #Delete an Identity
88
141
  api_instance.delete_identity(id)
89
142
  rescue OryHydraClient::ApiError => e
90
143
  puts "Exception when calling AdminApi->delete_identity: #{e}"
@@ -116,7 +169,7 @@ No authorization required
116
169
 
117
170
  > Identity get_identity(id)
118
171
 
119
- Get an identity
172
+ Get an Identity
120
173
 
121
174
  Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
122
175
 
@@ -130,7 +183,7 @@ api_instance = OryHydraClient::AdminApi.new
130
183
  id = 'id_example' # String | ID must be set to the ID of identity you want to get
131
184
 
132
185
  begin
133
- #Get an identity
186
+ #Get an Identity
134
187
  result = api_instance.get_identity(id)
135
188
  p result
136
189
  rescue OryHydraClient::ApiError => e
@@ -165,7 +218,7 @@ No authorization required
165
218
 
166
219
 
167
220
 
168
- Get a traits schema definition
221
+ Get a Traits Schema Definition
169
222
 
170
223
  ### Example
171
224
 
@@ -205,13 +258,13 @@ No authorization required
205
258
  - **Accept**: application/json
206
259
 
207
260
 
208
- ## get_self_service_browser_login_request
261
+ ## get_self_service_error
209
262
 
210
- > LoginRequest get_self_service_browser_login_request(request)
263
+ > ErrorContainer get_self_service_error(error)
211
264
 
212
- Get the request context of browser-based login user flows
265
+ Get User-Facing Self-Service Errors
213
266
 
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).
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).
215
268
 
216
269
  ### Example
217
270
 
@@ -220,14 +273,14 @@ This endpoint returns a login request's context with, for example, error details
220
273
  require 'ory-kratos-client'
221
274
 
222
275
  api_instance = OryHydraClient::AdminApi.new
223
- 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
224
277
 
225
278
  begin
226
- #Get the request context of browser-based login user flows
227
- result = api_instance.get_self_service_browser_login_request(request)
279
+ #Get User-Facing Self-Service Errors
280
+ result = api_instance.get_self_service_error(error)
228
281
  p result
229
282
  rescue OryHydraClient::ApiError => e
230
- puts "Exception when calling AdminApi->get_self_service_browser_login_request: #{e}"
283
+ puts "Exception when calling AdminApi->get_self_service_error: #{e}"
231
284
  end
232
285
  ```
233
286
 
@@ -236,11 +289,11 @@ end
236
289
 
237
290
  Name | Type | Description | Notes
238
291
  ------------- | ------------- | ------------- | -------------
239
- **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 |
240
293
 
241
294
  ### Return type
242
295
 
243
- [**LoginRequest**](LoginRequest.md)
296
+ [**ErrorContainer**](ErrorContainer.md)
244
297
 
245
298
  ### Authorization
246
299
 
@@ -252,13 +305,13 @@ No authorization required
252
305
  - **Accept**: application/json
253
306
 
254
307
 
255
- ## get_self_service_browser_recovery_request
308
+ ## get_self_service_login_flow
256
309
 
257
- > RecoveryRequest get_self_service_browser_recovery_request(request)
310
+ > LoginFlow get_self_service_login_flow(id)
258
311
 
259
- Get the request context of browser-based recovery flows
312
+ Get Login Flow
260
313
 
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).
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).
262
315
 
263
316
  ### Example
264
317
 
@@ -267,14 +320,14 @@ When accessing this endpoint through ORY Kratos' Public API, ensure that cookies
267
320
  require 'ory-kratos-client'
268
321
 
269
322
  api_instance = OryHydraClient::AdminApi.new
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`).
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`).
271
324
 
272
325
  begin
273
- #Get the request context of browser-based recovery flows
274
- result = api_instance.get_self_service_browser_recovery_request(request)
326
+ #Get Login Flow
327
+ result = api_instance.get_self_service_login_flow(id)
275
328
  p result
276
329
  rescue OryHydraClient::ApiError => e
277
- puts "Exception when calling AdminApi->get_self_service_browser_recovery_request: #{e}"
330
+ puts "Exception when calling AdminApi->get_self_service_login_flow: #{e}"
278
331
  end
279
332
  ```
280
333
 
@@ -283,11 +336,11 @@ end
283
336
 
284
337
  Name | Type | Description | Notes
285
338
  ------------- | ------------- | ------------- | -------------
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`). |
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`). |
287
340
 
288
341
  ### Return type
289
342
 
290
- [**RecoveryRequest**](RecoveryRequest.md)
343
+ [**LoginFlow**](LoginFlow.md)
291
344
 
292
345
  ### Authorization
293
346
 
@@ -299,13 +352,13 @@ No authorization required
299
352
  - **Accept**: application/json
300
353
 
301
354
 
302
- ## get_self_service_browser_registration_request
355
+ ## get_self_service_recovery_flow
303
356
 
304
- > RegistrationRequest get_self_service_browser_registration_request(request)
357
+ > RecoveryFlow get_self_service_recovery_flow(id)
305
358
 
306
- Get the request context of browser-based registration user flows
359
+ Get information about a recovery flow
307
360
 
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).
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).
309
362
 
310
363
  ### Example
311
364
 
@@ -314,14 +367,14 @@ This endpoint returns a registration request's context with, for example, error
314
367
  require 'ory-kratos-client'
315
368
 
316
369
  api_instance = OryHydraClient::AdminApi.new
317
- 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`).
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`).
318
371
 
319
372
  begin
320
- #Get the request context of browser-based registration user flows
321
- result = api_instance.get_self_service_browser_registration_request(request)
373
+ #Get information about a recovery flow
374
+ result = api_instance.get_self_service_recovery_flow(id)
322
375
  p result
323
376
  rescue OryHydraClient::ApiError => e
324
- puts "Exception when calling AdminApi->get_self_service_browser_registration_request: #{e}"
377
+ puts "Exception when calling AdminApi->get_self_service_recovery_flow: #{e}"
325
378
  end
326
379
  ```
327
380
 
@@ -330,11 +383,11 @@ end
330
383
 
331
384
  Name | Type | Description | Notes
332
385
  ------------- | ------------- | ------------- | -------------
333
- **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`). |
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`). |
334
387
 
335
388
  ### Return type
336
389
 
337
- [**RegistrationRequest**](RegistrationRequest.md)
390
+ [**RecoveryFlow**](RecoveryFlow.md)
338
391
 
339
392
  ### Authorization
340
393
 
@@ -346,13 +399,13 @@ No authorization required
346
399
  - **Accept**: application/json
347
400
 
348
401
 
349
- ## get_self_service_browser_settings_request
402
+ ## get_self_service_registration_flow
350
403
 
351
- > SettingsRequest get_self_service_browser_settings_request(request)
404
+ > RegistrationFlow get_self_service_registration_flow(id)
352
405
 
353
- Get the request context of browser-based settings flows
406
+ Get Registration Flow
354
407
 
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).
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).
356
409
 
357
410
  ### Example
358
411
 
@@ -361,14 +414,14 @@ When accessing this endpoint through ORY Kratos' Public API, ensure that cookies
361
414
  require 'ory-kratos-client'
362
415
 
363
416
  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`).
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`).
365
418
 
366
419
  begin
367
- #Get the request context of browser-based settings flows
368
- result = api_instance.get_self_service_browser_settings_request(request)
420
+ #Get Registration Flow
421
+ result = api_instance.get_self_service_registration_flow(id)
369
422
  p result
370
423
  rescue OryHydraClient::ApiError => e
371
- puts "Exception when calling AdminApi->get_self_service_browser_settings_request: #{e}"
424
+ puts "Exception when calling AdminApi->get_self_service_registration_flow: #{e}"
372
425
  end
373
426
  ```
374
427
 
@@ -377,11 +430,11 @@ end
377
430
 
378
431
  Name | Type | Description | Notes
379
432
  ------------- | ------------- | ------------- | -------------
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`). |
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`). |
381
434
 
382
435
  ### Return type
383
436
 
384
- [**SettingsRequest**](SettingsRequest.md)
437
+ [**RegistrationFlow**](RegistrationFlow.md)
385
438
 
386
439
  ### Authorization
387
440
 
@@ -393,31 +446,36 @@ No authorization required
393
446
  - **Accept**: application/json
394
447
 
395
448
 
396
- ## get_self_service_error
449
+ ## get_self_service_settings_flow
397
450
 
398
- > ErrorContainer get_self_service_error(opts)
451
+ > SettingsFlow get_self_service_settings_flow(id)
399
452
 
400
- Get user-facing self-service errors
453
+ Get Settings Flow
401
454
 
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).
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).
403
456
 
404
457
  ### Example
405
458
 
406
459
  ```ruby
407
460
  # load the gem
408
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
409
469
 
410
470
  api_instance = OryHydraClient::AdminApi.new
411
- opts = {
412
- error: 'error_example' # String |
413
- }
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`).
414
472
 
415
473
  begin
416
- #Get user-facing self-service errors
417
- result = api_instance.get_self_service_error(opts)
474
+ #Get Settings Flow
475
+ result = api_instance.get_self_service_settings_flow(id)
418
476
  p result
419
477
  rescue OryHydraClient::ApiError => e
420
- puts "Exception when calling AdminApi->get_self_service_error: #{e}"
478
+ puts "Exception when calling AdminApi->get_self_service_settings_flow: #{e}"
421
479
  end
422
480
  ```
423
481
 
@@ -426,15 +484,15 @@ end
426
484
 
427
485
  Name | Type | Description | Notes
428
486
  ------------- | ------------- | ------------- | -------------
429
- **error** | **String**| | [optional]
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`). |
430
488
 
431
489
  ### Return type
432
490
 
433
- [**ErrorContainer**](ErrorContainer.md)
491
+ [**SettingsFlow**](SettingsFlow.md)
434
492
 
435
493
  ### Authorization
436
494
 
437
- No authorization required
495
+ [sessionToken](../README.md#sessionToken)
438
496
 
439
497
  ### HTTP request headers
440
498
 
@@ -442,13 +500,13 @@ No authorization required
442
500
  - **Accept**: application/json
443
501
 
444
502
 
445
- ## get_self_service_verification_request
503
+ ## get_self_service_verification_flow
446
504
 
447
- > VerificationRequest get_self_service_verification_request(request)
505
+ > VerificationFlow get_self_service_verification_flow(id)
448
506
 
449
- Get the request context of browser-based verification flows
507
+ Get Verification Flow
450
508
 
451
- 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).
452
510
 
453
511
  ### Example
454
512
 
@@ -457,14 +515,14 @@ When accessing this endpoint through ORY Kratos' Public API, ensure that cookies
457
515
  require 'ory-kratos-client'
458
516
 
459
517
  api_instance = OryHydraClient::AdminApi.new
460
- 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`).
461
519
 
462
520
  begin
463
- #Get the request context of browser-based verification flows
464
- result = api_instance.get_self_service_verification_request(request)
521
+ #Get Verification Flow
522
+ result = api_instance.get_self_service_verification_flow(id)
465
523
  p result
466
524
  rescue OryHydraClient::ApiError => e
467
- puts "Exception when calling AdminApi->get_self_service_verification_request: #{e}"
525
+ puts "Exception when calling AdminApi->get_self_service_verification_flow: #{e}"
468
526
  end
469
527
  ```
470
528
 
@@ -473,11 +531,11 @@ end
473
531
 
474
532
  Name | Type | Description | Notes
475
533
  ------------- | ------------- | ------------- | -------------
476
- **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`). |
477
535
 
478
536
  ### Return type
479
537
 
480
- [**VerificationRequest**](VerificationRequest.md)
538
+ [**VerificationFlow**](VerificationFlow.md)
481
539
 
482
540
  ### Authorization
483
541
 
@@ -491,11 +549,11 @@ No authorization required
491
549
 
492
550
  ## list_identities
493
551
 
494
- > Array<Identity> list_identities
552
+ > Array<Identity> list_identities(opts)
495
553
 
496
- List all identities in the system
554
+ List Identities
497
555
 
498
- 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).
499
557
 
500
558
  ### Example
501
559
 
@@ -504,10 +562,14 @@ This endpoint returns a login request's context with, for example, error details
504
562
  require 'ory-kratos-client'
505
563
 
506
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
+ }
507
569
 
508
570
  begin
509
- #List all identities in the system
510
- result = api_instance.list_identities
571
+ #List Identities
572
+ result = api_instance.list_identities(opts)
511
573
  p result
512
574
  rescue OryHydraClient::ApiError => e
513
575
  puts "Exception when calling AdminApi->list_identities: #{e}"
@@ -516,7 +578,11 @@ end
516
578
 
517
579
  ### Parameters
518
580
 
519
- 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]
520
586
 
521
587
  ### Return type
522
588
 
@@ -532,11 +598,53 @@ No authorization required
532
598
  - **Accept**: application/json
533
599
 
534
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
+
535
643
  ## update_identity
536
644
 
537
- > Identity update_identity(id, body)
645
+ > Identity update_identity(id, opts)
538
646
 
539
- Update an identity
647
+ Update an Identity
540
648
 
541
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).
542
650
 
@@ -548,11 +656,13 @@ require 'ory-kratos-client'
548
656
 
549
657
  api_instance = OryHydraClient::AdminApi.new
550
658
  id = 'id_example' # String | ID must be set to the ID of identity you want to update
551
- body = OryHydraClient::Identity.new # Identity |
659
+ opts = {
660
+ body: OryHydraClient::UpdateIdentity.new # UpdateIdentity |
661
+ }
552
662
 
553
663
  begin
554
- #Update an identity
555
- result = api_instance.update_identity(id, body)
664
+ #Update an Identity
665
+ result = api_instance.update_identity(id, opts)
556
666
  p result
557
667
  rescue OryHydraClient::ApiError => e
558
668
  puts "Exception when calling AdminApi->update_identity: #{e}"
@@ -565,7 +675,7 @@ end
565
675
  Name | Type | Description | Notes
566
676
  ------------- | ------------- | ------------- | -------------
567
677
  **id** | **String**| ID must be set to the ID of identity you want to update |
568
- **body** | [**Identity**](Identity.md)| |
678
+ **body** | [**UpdateIdentity**](UpdateIdentity.md)| | [optional]
569
679
 
570
680
  ### Return type
571
681