ory-kratos-client 0.3.0.alpha1 → 0.5.3.alpha1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (148) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/README.md +84 -54
  4. data/docs/AdminApi.md +244 -86
  5. data/docs/CommonApi.md +53 -5
  6. data/docs/CompleteSelfServiceLoginFlowWithPasswordMethod.md +21 -0
  7. data/docs/CompleteSelfServiceRecoveryFlowWithLinkMethod.md +19 -0
  8. data/docs/CompleteSelfServiceSettingsFlowWithPasswordMethod.md +19 -0
  9. data/docs/CompleteSelfServiceVerificationFlowWithLinkMethod.md +19 -0
  10. data/docs/CreateIdentity.md +19 -0
  11. data/docs/CreateRecoveryLink.md +19 -0
  12. data/docs/ErrorContainer.md +2 -2
  13. data/docs/Form.md +2 -2
  14. data/docs/FormField.md +3 -3
  15. data/docs/GenericErrorPayload.md +1 -1
  16. data/docs/Identity.md +9 -7
  17. data/docs/LoginFlow.md +33 -0
  18. data/docs/LoginFlowMethod.md +19 -0
  19. data/docs/LoginFlowMethodConfig.md +25 -0
  20. data/docs/LoginRequest.md +2 -0
  21. data/docs/LoginRequestMethodConfig.md +2 -2
  22. data/docs/LoginViaApiResponse.md +19 -0
  23. data/docs/Message.md +23 -0
  24. data/docs/PublicApi.md +689 -157
  25. data/docs/RecoveryAddress.md +21 -0
  26. data/docs/RecoveryFlow.md +33 -0
  27. data/docs/RecoveryFlowMethod.md +19 -0
  28. data/docs/RecoveryFlowMethodConfig.md +23 -0
  29. data/docs/RecoveryLink.md +19 -0
  30. data/docs/RecoveryRequest.md +31 -0
  31. data/docs/RecoveryRequestMethod.md +19 -0
  32. data/docs/RegistrationFlow.md +31 -0
  33. data/docs/RegistrationFlowMethod.md +19 -0
  34. data/docs/RegistrationFlowMethodConfig.md +25 -0
  35. data/docs/RegistrationRequest.md +2 -0
  36. data/docs/RegistrationRequestMethodConfig.md +2 -2
  37. data/docs/RegistrationViaApiResponse.md +21 -0
  38. data/docs/RequestMethodConfig.md +2 -2
  39. data/docs/RevokeSession.md +17 -0
  40. data/docs/Session.md +6 -4
  41. data/docs/SettingsFlow.md +35 -0
  42. data/docs/SettingsFlowMethod.md +19 -0
  43. data/docs/SettingsFlowMethodConfig.md +23 -0
  44. data/docs/SettingsRequest.md +4 -2
  45. data/docs/SettingsViaApiResponse.md +19 -0
  46. data/docs/UpdateIdentity.md +19 -0
  47. data/docs/VerifiableAddress.md +3 -3
  48. data/docs/VerificationFlow.md +33 -0
  49. data/docs/VerificationFlowMethod.md +19 -0
  50. data/docs/VerificationFlowMethodConfig.md +23 -0
  51. data/docs/VerificationRequest.md +2 -0
  52. data/lib/ory-kratos-client.rb +31 -17
  53. data/lib/ory-kratos-client/api/admin_api.rb +321 -130
  54. data/lib/ory-kratos-client/api/common_api.rb +73 -10
  55. data/lib/ory-kratos-client/api/health_api.rb +2 -2
  56. data/lib/ory-kratos-client/api/public_api.rb +830 -236
  57. data/lib/ory-kratos-client/api/version_api.rb +2 -2
  58. data/lib/ory-kratos-client/api_client.rb +10 -7
  59. data/lib/ory-kratos-client/api_error.rb +2 -2
  60. data/lib/ory-kratos-client/configuration.rb +9 -2
  61. data/lib/ory-kratos-client/models/complete_self_service_browser_settings_strategy_profile_flow_payload.rb +2 -2
  62. data/lib/ory-kratos-client/models/complete_self_service_login_flow_with_password_method.rb +227 -0
  63. data/lib/ory-kratos-client/models/complete_self_service_recovery_flow_with_link_method.rb +217 -0
  64. data/lib/ory-kratos-client/models/complete_self_service_settings_flow_with_password_method.rb +222 -0
  65. data/lib/ory-kratos-client/models/complete_self_service_verification_flow_with_link_method.rb +217 -0
  66. data/lib/ory-kratos-client/models/create_identity.rb +227 -0
  67. data/lib/ory-kratos-client/models/create_recovery_link.rb +238 -0
  68. data/lib/ory-kratos-client/models/error_container.rb +13 -2
  69. data/lib/ory-kratos-client/models/form.rb +14 -15
  70. data/lib/ory-kratos-client/models/form_field.rb +11 -11
  71. data/lib/ory-kratos-client/models/generic_error.rb +2 -2
  72. data/lib/ory-kratos-client/models/generic_error_payload.rb +4 -6
  73. data/lib/ory-kratos-client/models/health_not_ready_status.rb +2 -2
  74. data/lib/ory-kratos-client/models/health_status.rb +2 -2
  75. data/lib/ory-kratos-client/models/identity.rb +53 -35
  76. data/lib/ory-kratos-client/models/login_flow.rb +315 -0
  77. data/lib/ory-kratos-client/models/login_flow_method.rb +226 -0
  78. data/lib/ory-kratos-client/models/login_flow_method_config.rb +267 -0
  79. data/lib/ory-kratos-client/models/login_request.rb +14 -3
  80. data/lib/ory-kratos-client/models/login_request_method.rb +2 -2
  81. data/lib/ory-kratos-client/models/login_request_method_config.rb +14 -15
  82. data/lib/ory-kratos-client/models/login_via_api_response.rb +227 -0
  83. data/lib/ory-kratos-client/models/message.rb +234 -0
  84. data/lib/ory-kratos-client/models/provider_credentials_config.rb +2 -2
  85. data/lib/ory-kratos-client/models/recovery_address.rb +239 -0
  86. data/lib/ory-kratos-client/models/recovery_flow.rb +319 -0
  87. data/lib/ory-kratos-client/models/recovery_flow_method.rb +226 -0
  88. data/lib/ory-kratos-client/models/recovery_flow_method_config.rb +255 -0
  89. data/lib/ory-kratos-client/models/recovery_link.rb +222 -0
  90. data/lib/ory-kratos-client/models/recovery_request.rb +309 -0
  91. data/lib/ory-kratos-client/models/recovery_request_method.rb +216 -0
  92. data/lib/ory-kratos-client/models/registration_flow.rb +304 -0
  93. data/lib/ory-kratos-client/models/registration_flow_method.rb +226 -0
  94. data/lib/ory-kratos-client/models/registration_flow_method_config.rb +267 -0
  95. data/lib/ory-kratos-client/models/registration_request.rb +14 -3
  96. data/lib/ory-kratos-client/models/registration_request_method.rb +2 -2
  97. data/lib/ory-kratos-client/models/registration_request_method_config.rb +14 -15
  98. data/lib/ory-kratos-client/models/registration_via_api_response.rb +236 -0
  99. data/lib/ory-kratos-client/models/request_method_config.rb +14 -15
  100. data/lib/ory-kratos-client/models/revoke_session.rb +212 -0
  101. data/lib/ory-kratos-client/models/session.rb +29 -20
  102. data/lib/ory-kratos-client/models/settings_flow.rb +333 -0
  103. data/lib/ory-kratos-client/models/settings_flow_method.rb +226 -0
  104. data/lib/ory-kratos-client/models/settings_flow_method_config.rb +255 -0
  105. data/lib/ory-kratos-client/models/settings_request.rb +23 -13
  106. data/lib/ory-kratos-client/models/settings_request_method.rb +2 -2
  107. data/lib/ory-kratos-client/models/settings_via_api_response.rb +226 -0
  108. data/lib/ory-kratos-client/models/update_identity.rb +222 -0
  109. data/lib/ory-kratos-client/models/verifiable_address.rb +17 -17
  110. data/lib/ory-kratos-client/models/verification_flow.rb +299 -0
  111. data/lib/ory-kratos-client/models/verification_flow_method.rb +226 -0
  112. data/lib/ory-kratos-client/models/verification_flow_method_config.rb +255 -0
  113. data/lib/ory-kratos-client/models/verification_request.rb +14 -3
  114. data/lib/ory-kratos-client/models/version.rb +2 -2
  115. data/lib/ory-kratos-client/version.rb +3 -3
  116. data/ory-kratos-client.gemspec +2 -2
  117. data/spec/models/complete_self_service_login_flow_with_password_method_spec.rb +53 -0
  118. data/spec/models/complete_self_service_recovery_flow_with_link_method_spec.rb +47 -0
  119. data/spec/models/complete_self_service_settings_flow_with_password_method_spec.rb +47 -0
  120. data/spec/models/complete_self_service_verification_flow_with_link_method_spec.rb +47 -0
  121. data/spec/models/create_identity_spec.rb +47 -0
  122. data/spec/models/create_recovery_link_spec.rb +47 -0
  123. data/spec/models/login_flow_method_config_spec.rb +65 -0
  124. data/spec/models/login_flow_method_spec.rb +47 -0
  125. data/spec/models/login_flow_spec.rb +89 -0
  126. data/spec/models/login_via_api_response_spec.rb +47 -0
  127. data/spec/models/message_spec.rb +59 -0
  128. data/spec/models/recovery_address_spec.rb +53 -0
  129. data/spec/models/recovery_flow_method_config_spec.rb +59 -0
  130. data/spec/models/recovery_flow_method_spec.rb +47 -0
  131. data/spec/models/recovery_flow_spec.rb +89 -0
  132. data/spec/models/recovery_link_spec.rb +47 -0
  133. data/spec/models/recovery_request_method_spec.rb +47 -0
  134. data/spec/models/recovery_request_spec.rb +83 -0
  135. data/spec/models/registration_flow_method_config_spec.rb +65 -0
  136. data/spec/models/registration_flow_method_spec.rb +47 -0
  137. data/spec/models/registration_flow_spec.rb +83 -0
  138. data/spec/models/registration_via_api_response_spec.rb +53 -0
  139. data/spec/models/revoke_session_spec.rb +41 -0
  140. data/spec/models/settings_flow_method_config_spec.rb +59 -0
  141. data/spec/models/settings_flow_method_spec.rb +47 -0
  142. data/spec/models/settings_flow_spec.rb +95 -0
  143. data/spec/models/settings_via_api_response_spec.rb +47 -0
  144. data/spec/models/update_identity_spec.rb +47 -0
  145. data/spec/models/verification_flow_method_config_spec.rb +59 -0
  146. data/spec/models/verification_flow_method_spec.rb +47 -0
  147. data/spec/models/verification_flow_spec.rb +89 -0
  148. metadata +147 -23
@@ -9,9 +9,10 @@ Name | Type | Description | Notes
9
9
  **id** | **String** | |
10
10
  **identity** | [**Identity**](Identity.md) | |
11
11
  **issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. |
12
+ **messages** | [**Array<Message>**](Message.md) | | [optional]
12
13
  **methods** | [**Hash<String, SettingsRequestMethod>**](SettingsRequestMethod.md) | Methods contains context for all enabled registration methods. If a registration request has been processed, but for example the password is incorrect, this will contain error messages. |
13
14
  **request_url** | **String** | RequestURL is the initial URL that was requested from ORY Kratos. It can be used to forward information contained in the URL's path or query for example. |
14
- **update_successful** | **Boolean** | UpdateSuccessful, if true, indicates that the settings request has been updated successfully with the provided data. Done will stay true when repeatedly checking. If set to true, done will revert back to false only when a request with invalid (e.g. \"please use a valid phone number\") data was sent. |
15
+ **state** | **String** | |
15
16
 
16
17
  ## Code Sample
17
18
 
@@ -23,9 +24,10 @@ instance = OryHydraClient::SettingsRequest.new(active: null,
23
24
  id: null,
24
25
  identity: null,
25
26
  issued_at: null,
27
+ messages: null,
26
28
  methods: null,
27
29
  request_url: null,
28
- update_successful: null)
30
+ state: null)
29
31
  ```
30
32
 
31
33
 
@@ -0,0 +1,19 @@
1
+ # OryHydraClient::SettingsViaApiResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **flow** | [**SettingsFlow**](SettingsFlow.md) | |
8
+ **identity** | [**Identity**](Identity.md) | |
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'OryHydraClient'
14
+
15
+ instance = OryHydraClient::SettingsViaApiResponse.new(flow: null,
16
+ identity: null)
17
+ ```
18
+
19
+
@@ -0,0 +1,19 @@
1
+ # OryHydraClient::UpdateIdentity
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **schema_id** | **String** | SchemaID is the ID of the JSON Schema to be used for validating the identity's traits. If set will update the Identity's SchemaID. | [optional]
8
+ **traits** | [**Object**](.md) | Traits represent an identity's traits. The identity is able to create, modify, and delete traits in a self-service manner. The input will always be validated against the JSON Schema defined in `schema_id`. |
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'OryHydraClient'
14
+
15
+ instance = OryHydraClient::UpdateIdentity.new(schema_id: null,
16
+ traits: null)
17
+ ```
18
+
19
+
@@ -4,8 +4,8 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **expires_at** | **DateTime** | |
8
7
  **id** | **String** | |
8
+ **status** | **String** | |
9
9
  **value** | **String** | |
10
10
  **verified** | **Boolean** | |
11
11
  **verified_at** | **DateTime** | | [optional]
@@ -16,8 +16,8 @@ Name | Type | Description | Notes
16
16
  ```ruby
17
17
  require 'OryHydraClient'
18
18
 
19
- instance = OryHydraClient::VerifiableAddress.new(expires_at: null,
20
- id: null,
19
+ instance = OryHydraClient::VerifiableAddress.new(id: null,
20
+ status: null,
21
21
  value: null,
22
22
  verified: null,
23
23
  verified_at: null,
@@ -0,0 +1,33 @@
1
+ # OryHydraClient::VerificationFlow
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **active** | **String** | Active, if set, contains the registration method that is being used. It is initially not set. | [optional]
8
+ **expires_at** | **DateTime** | ExpiresAt is the time (UTC) when the request expires. If the user still wishes to verify the address, a new request has to be initiated. | [optional]
9
+ **id** | **String** | | [optional]
10
+ **issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. | [optional]
11
+ **messages** | [**Array<Message>**](Message.md) | | [optional]
12
+ **methods** | [**Hash<String, VerificationFlowMethod>**](VerificationFlowMethod.md) | Methods contains context for all account verification methods. If a registration request has been processed, but for example the password is incorrect, this will contain error messages. |
13
+ **request_url** | **String** | RequestURL is the initial URL that was requested from ORY Kratos. It can be used to forward information contained in the URL's path or query for example. | [optional]
14
+ **state** | **String** | |
15
+ **type** | **String** | The flow type can either be `api` or `browser`. | [optional]
16
+
17
+ ## Code Sample
18
+
19
+ ```ruby
20
+ require 'OryHydraClient'
21
+
22
+ instance = OryHydraClient::VerificationFlow.new(active: null,
23
+ expires_at: null,
24
+ id: null,
25
+ issued_at: null,
26
+ messages: null,
27
+ methods: null,
28
+ request_url: null,
29
+ state: null,
30
+ type: null)
31
+ ```
32
+
33
+
@@ -0,0 +1,19 @@
1
+ # OryHydraClient::VerificationFlowMethod
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **config** | [**VerificationFlowMethodConfig**](VerificationFlowMethodConfig.md) | |
8
+ **method** | **String** | Method contains the request credentials type. |
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'OryHydraClient'
14
+
15
+ instance = OryHydraClient::VerificationFlowMethod.new(config: null,
16
+ method: null)
17
+ ```
18
+
19
+
@@ -0,0 +1,23 @@
1
+ # OryHydraClient::VerificationFlowMethodConfig
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **action** | **String** | Action should be used as the form action URL `<form action=\"{{ .Action }}\" method=\"post\">`. |
8
+ **fields** | [**Array<FormField>**](FormField.md) | Fields contains multiple fields |
9
+ **messages** | [**Array<Message>**](Message.md) | | [optional]
10
+ **method** | **String** | Method is the form method (e.g. POST) |
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'OryHydraClient'
16
+
17
+ instance = OryHydraClient::VerificationFlowMethodConfig.new(action: null,
18
+ fields: null,
19
+ messages: null,
20
+ method: null)
21
+ ```
22
+
23
+
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
8
8
  **form** | [**Form**](Form.md) | | [optional]
9
9
  **id** | **String** | | [optional]
10
10
  **issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. | [optional]
11
+ **messages** | [**Array<Message>**](Message.md) | | [optional]
11
12
  **request_url** | **String** | RequestURL is the initial URL that was requested from ORY Kratos. It can be used to forward information contained in the URL's path or query for example. | [optional]
12
13
  **success** | **Boolean** | Success, if true, implies that the request was completed successfully. | [optional]
13
14
  **via** | **String** | | [optional]
@@ -21,6 +22,7 @@ instance = OryHydraClient::VerificationRequest.new(expires_at: null,
21
22
  form: null,
22
23
  id: null,
23
24
  issued_at: null,
25
+ messages: null,
24
26
  request_url: null,
25
27
  success: null,
26
28
  via: null)
@@ -3,10 +3,10 @@
3
3
 
4
4
  #Welcome to the ORY Kratos HTTP API documentation!
5
5
 
6
- The version of the OpenAPI document: latest
6
+ The version of the OpenAPI document: v0.5.3-alpha.1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.3
9
+ OpenAPI Generator version: 4.3.1
10
10
 
11
11
  =end
12
12
 
@@ -17,34 +17,48 @@ require 'ory-kratos-client/version'
17
17
  require 'ory-kratos-client/configuration'
18
18
 
19
19
  # Models
20
- require 'ory-kratos-client/models/complete_self_service_browser_settings_strategy_profile_flow_payload'
21
- require 'ory-kratos-client/models/error'
20
+ require 'ory-kratos-client/models/complete_self_service_login_flow_with_password_method'
21
+ require 'ory-kratos-client/models/complete_self_service_recovery_flow_with_link_method'
22
+ require 'ory-kratos-client/models/complete_self_service_settings_flow_with_password_method'
23
+ require 'ory-kratos-client/models/complete_self_service_verification_flow_with_link_method'
24
+ require 'ory-kratos-client/models/create_identity'
25
+ require 'ory-kratos-client/models/create_recovery_link'
22
26
  require 'ory-kratos-client/models/error_container'
23
- require 'ory-kratos-client/models/form'
24
27
  require 'ory-kratos-client/models/form_field'
25
28
  require 'ory-kratos-client/models/generic_error'
26
29
  require 'ory-kratos-client/models/generic_error_payload'
27
30
  require 'ory-kratos-client/models/health_not_ready_status'
28
31
  require 'ory-kratos-client/models/health_status'
29
32
  require 'ory-kratos-client/models/identity'
30
- require 'ory-kratos-client/models/login_request'
31
- require 'ory-kratos-client/models/login_request_method'
32
- require 'ory-kratos-client/models/login_request_method_config'
33
- require 'ory-kratos-client/models/provider_credentials_config'
34
- require 'ory-kratos-client/models/registration_request'
35
- require 'ory-kratos-client/models/registration_request_method'
36
- require 'ory-kratos-client/models/registration_request_method_config'
37
- require 'ory-kratos-client/models/request_method_config'
33
+ require 'ory-kratos-client/models/login_flow'
34
+ require 'ory-kratos-client/models/login_flow_method'
35
+ require 'ory-kratos-client/models/login_flow_method_config'
36
+ require 'ory-kratos-client/models/login_via_api_response'
37
+ require 'ory-kratos-client/models/message'
38
+ require 'ory-kratos-client/models/recovery_address'
39
+ require 'ory-kratos-client/models/recovery_flow'
40
+ require 'ory-kratos-client/models/recovery_flow_method'
41
+ require 'ory-kratos-client/models/recovery_flow_method_config'
42
+ require 'ory-kratos-client/models/recovery_link'
43
+ require 'ory-kratos-client/models/registration_flow'
44
+ require 'ory-kratos-client/models/registration_flow_method'
45
+ require 'ory-kratos-client/models/registration_flow_method_config'
46
+ require 'ory-kratos-client/models/registration_via_api_response'
47
+ require 'ory-kratos-client/models/revoke_session'
38
48
  require 'ory-kratos-client/models/session'
39
- require 'ory-kratos-client/models/settings_request'
40
- require 'ory-kratos-client/models/settings_request_method'
49
+ require 'ory-kratos-client/models/settings_flow'
50
+ require 'ory-kratos-client/models/settings_flow_method'
51
+ require 'ory-kratos-client/models/settings_flow_method_config'
52
+ require 'ory-kratos-client/models/settings_via_api_response'
53
+ require 'ory-kratos-client/models/update_identity'
41
54
  require 'ory-kratos-client/models/verifiable_address'
42
- require 'ory-kratos-client/models/verification_request'
55
+ require 'ory-kratos-client/models/verification_flow'
56
+ require 'ory-kratos-client/models/verification_flow_method'
57
+ require 'ory-kratos-client/models/verification_flow_method_config'
43
58
  require 'ory-kratos-client/models/version'
44
59
 
45
60
  # APIs
46
61
  require 'ory-kratos-client/api/admin_api'
47
- require 'ory-kratos-client/api/common_api'
48
62
  require 'ory-kratos-client/api/health_api'
49
63
  require 'ory-kratos-client/api/public_api'
50
64
  require 'ory-kratos-client/api/version_api'
@@ -3,10 +3,10 @@
3
3
 
4
4
  #Welcome to the ORY Kratos HTTP API documentation!
5
5
 
6
- The version of the OpenAPI document: latest
6
+ The version of the OpenAPI document: v0.5.3-alpha.1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.3
9
+ OpenAPI Generator version: 4.3.1
10
10
 
11
11
  =end
12
12
 
@@ -19,29 +19,25 @@ module OryHydraClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Create an identity
22
+ # Create an Identity
23
23
  # 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).
24
- # @param body [Identity]
25
24
  # @param [Hash] opts the optional parameters
25
+ # @option opts [CreateIdentity] :body
26
26
  # @return [Identity]
27
- def create_identity(body, opts = {})
28
- data, _status_code, _headers = create_identity_with_http_info(body, opts)
27
+ def create_identity(opts = {})
28
+ data, _status_code, _headers = create_identity_with_http_info(opts)
29
29
  data
30
30
  end
31
31
 
32
- # Create an identity
32
+ # Create an Identity
33
33
  # 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).
34
- # @param body [Identity]
35
34
  # @param [Hash] opts the optional parameters
35
+ # @option opts [CreateIdentity] :body
36
36
  # @return [Array<(Identity, Integer, Hash)>] Identity data, response status code and response headers
37
- def create_identity_with_http_info(body, opts = {})
37
+ def create_identity_with_http_info(opts = {})
38
38
  if @api_client.config.debugging
39
39
  @api_client.config.logger.debug 'Calling API: AdminApi.create_identity ...'
40
40
  end
41
- # verify the required parameter 'body' is set
42
- if @api_client.config.client_side_validation && body.nil?
43
- fail ArgumentError, "Missing the required parameter 'body' when calling AdminApi.create_identity"
44
- end
45
41
  # resource path
46
42
  local_var_path = '/identities'
47
43
 
@@ -59,7 +55,7 @@ module OryHydraClient
59
55
  form_params = opts[:form_params] || {}
60
56
 
61
57
  # http body (model)
62
- post_body = opts[:body] || @api_client.object_to_http_body(body)
58
+ post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])
63
59
 
64
60
  # return_type
65
61
  return_type = opts[:return_type] || 'Identity'
@@ -83,8 +79,68 @@ module OryHydraClient
83
79
  return data, status_code, headers
84
80
  end
85
81
 
86
- # Delete an identity
87
- # 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).
82
+ # Create a Recovery Link
83
+ # This endpoint creates a recovery link which should be given to the user in order for them to recover (or activate) their account.
84
+ # @param [Hash] opts the optional parameters
85
+ # @option opts [CreateRecoveryLink] :body
86
+ # @return [RecoveryLink]
87
+ def create_recovery_link(opts = {})
88
+ data, _status_code, _headers = create_recovery_link_with_http_info(opts)
89
+ data
90
+ end
91
+
92
+ # Create a Recovery Link
93
+ # This endpoint creates a recovery link which should be given to the user in order for them to recover (or activate) their account.
94
+ # @param [Hash] opts the optional parameters
95
+ # @option opts [CreateRecoveryLink] :body
96
+ # @return [Array<(RecoveryLink, Integer, Hash)>] RecoveryLink data, response status code and response headers
97
+ def create_recovery_link_with_http_info(opts = {})
98
+ if @api_client.config.debugging
99
+ @api_client.config.logger.debug 'Calling API: AdminApi.create_recovery_link ...'
100
+ end
101
+ # resource path
102
+ local_var_path = '/recovery/link'
103
+
104
+ # query parameters
105
+ query_params = opts[:query_params] || {}
106
+
107
+ # header parameters
108
+ header_params = opts[:header_params] || {}
109
+ # HTTP header 'Accept' (if needed)
110
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
111
+ # HTTP header 'Content-Type'
112
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
113
+
114
+ # form parameters
115
+ form_params = opts[:form_params] || {}
116
+
117
+ # http body (model)
118
+ post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])
119
+
120
+ # return_type
121
+ return_type = opts[:return_type] || 'RecoveryLink'
122
+
123
+ # auth_names
124
+ auth_names = opts[:auth_names] || []
125
+
126
+ new_options = opts.merge(
127
+ :header_params => header_params,
128
+ :query_params => query_params,
129
+ :form_params => form_params,
130
+ :body => post_body,
131
+ :auth_names => auth_names,
132
+ :return_type => return_type
133
+ )
134
+
135
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
136
+ if @api_client.config.debugging
137
+ @api_client.config.logger.debug "API called: AdminApi#create_recovery_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
138
+ end
139
+ return data, status_code, headers
140
+ end
141
+
142
+ # Delete an Identity
143
+ # 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).
88
144
  # @param id [String] ID is the identity&#39;s ID.
89
145
  # @param [Hash] opts the optional parameters
90
146
  # @return [nil]
@@ -93,8 +149,8 @@ module OryHydraClient
93
149
  nil
94
150
  end
95
151
 
96
- # Delete an identity
97
- # This endpoint deletes an identity. This can not be undone. Learn how identities work in [ORY Kratos&#39; User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
152
+ # Delete an Identity
153
+ # 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&#39; User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
98
154
  # @param id [String] ID is the identity&#39;s ID.
99
155
  # @param [Hash] opts the optional parameters
100
156
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -145,7 +201,7 @@ module OryHydraClient
145
201
  return data, status_code, headers
146
202
  end
147
203
 
148
- # Get an identity
204
+ # Get an Identity
149
205
  # Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
150
206
  # @param id [String] ID must be set to the ID of identity you want to get
151
207
  # @param [Hash] opts the optional parameters
@@ -155,7 +211,7 @@ module OryHydraClient
155
211
  data
156
212
  end
157
213
 
158
- # Get an identity
214
+ # Get an Identity
159
215
  # Learn how identities work in [ORY Kratos&#39; User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
160
216
  # @param id [String] ID must be set to the ID of identity you want to get
161
217
  # @param [Hash] opts the optional parameters
@@ -207,7 +263,7 @@ module OryHydraClient
207
263
  return data, status_code, headers
208
264
  end
209
265
 
210
- # Get a traits schema definition
266
+ # Get a Traits Schema Definition
211
267
  # @param id [String] ID must be set to the ID of schema you want to get
212
268
  # @param [Hash] opts the optional parameters
213
269
  # @return [Object]
@@ -216,7 +272,7 @@ module OryHydraClient
216
272
  data
217
273
  end
218
274
 
219
- # Get a traits schema definition
275
+ # Get a Traits Schema Definition
220
276
  # @param id [String] ID must be set to the ID of schema you want to get
221
277
  # @param [Hash] opts the optional parameters
222
278
  # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
@@ -267,35 +323,35 @@ module OryHydraClient
267
323
  return data, status_code, headers
268
324
  end
269
325
 
270
- # Get the request context of browser-based login user flows
271
- # 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).
272
- # @param request [String] Request is the Login Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/login?request&#x3D;abcde&#x60;).
326
+ # Get User-Facing Self-Service Errors
327
+ # 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).
328
+ # @param error [String] Error is the container&#39;s ID
273
329
  # @param [Hash] opts the optional parameters
274
- # @return [LoginRequest]
275
- def get_self_service_browser_login_request(request, opts = {})
276
- data, _status_code, _headers = get_self_service_browser_login_request_with_http_info(request, opts)
330
+ # @return [ErrorContainer]
331
+ def get_self_service_error(error, opts = {})
332
+ data, _status_code, _headers = get_self_service_error_with_http_info(error, opts)
277
333
  data
278
334
  end
279
335
 
280
- # Get the request context of browser-based login user flows
281
- # This endpoint returns a login request&#39;s context with, for example, error details and other information. When accessing this endpoint through ORY Kratos&#39; 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).
282
- # @param request [String] Request is the Login Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/login?request&#x3D;abcde&#x60;).
336
+ # Get User-Facing Self-Service Errors
337
+ # 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: &#x60;?error&#x3D;stub:500&#x60; - 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).
338
+ # @param error [String] Error is the container&#39;s ID
283
339
  # @param [Hash] opts the optional parameters
284
- # @return [Array<(LoginRequest, Integer, Hash)>] LoginRequest data, response status code and response headers
285
- def get_self_service_browser_login_request_with_http_info(request, opts = {})
340
+ # @return [Array<(ErrorContainer, Integer, Hash)>] ErrorContainer data, response status code and response headers
341
+ def get_self_service_error_with_http_info(error, opts = {})
286
342
  if @api_client.config.debugging
287
- @api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_browser_login_request ...'
343
+ @api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_error ...'
288
344
  end
289
- # verify the required parameter 'request' is set
290
- if @api_client.config.client_side_validation && request.nil?
291
- fail ArgumentError, "Missing the required parameter 'request' when calling AdminApi.get_self_service_browser_login_request"
345
+ # verify the required parameter 'error' is set
346
+ if @api_client.config.client_side_validation && error.nil?
347
+ fail ArgumentError, "Missing the required parameter 'error' when calling AdminApi.get_self_service_error"
292
348
  end
293
349
  # resource path
294
- local_var_path = '/self-service/browser/flows/requests/login'
350
+ local_var_path = '/self-service/errors'
295
351
 
296
352
  # query parameters
297
353
  query_params = opts[:query_params] || {}
298
- query_params[:'request'] = request
354
+ query_params[:'error'] = error
299
355
 
300
356
  # header parameters
301
357
  header_params = opts[:header_params] || {}
@@ -309,7 +365,7 @@ module OryHydraClient
309
365
  post_body = opts[:body]
310
366
 
311
367
  # return_type
312
- return_type = opts[:return_type] || 'LoginRequest'
368
+ return_type = opts[:return_type] || 'ErrorContainer'
313
369
 
314
370
  # auth_names
315
371
  auth_names = opts[:auth_names] || []
@@ -325,40 +381,40 @@ module OryHydraClient
325
381
 
326
382
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
327
383
  if @api_client.config.debugging
328
- @api_client.config.logger.debug "API called: AdminApi#get_self_service_browser_login_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
384
+ @api_client.config.logger.debug "API called: AdminApi#get_self_service_error\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
329
385
  end
330
386
  return data, status_code, headers
331
387
  end
332
388
 
333
- # Get the request context of browser-based registration user flows
334
- # 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).
335
- # @param request [String] Request is the Registration Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/registration?request&#x3D;abcde&#x60;).
389
+ # Get Login Flow
390
+ # 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).
391
+ # @param id [String] The Login Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/login?flow&#x3D;abcde&#x60;).
336
392
  # @param [Hash] opts the optional parameters
337
- # @return [RegistrationRequest]
338
- def get_self_service_browser_registration_request(request, opts = {})
339
- data, _status_code, _headers = get_self_service_browser_registration_request_with_http_info(request, opts)
393
+ # @return [LoginFlow]
394
+ def get_self_service_login_flow(id, opts = {})
395
+ data, _status_code, _headers = get_self_service_login_flow_with_http_info(id, opts)
340
396
  data
341
397
  end
342
398
 
343
- # Get the request context of browser-based registration user flows
344
- # This endpoint returns a registration request&#39;s context with, for example, error details and other information. When accessing this endpoint through ORY Kratos&#39; 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).
345
- # @param request [String] Request is the Registration Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/registration?request&#x3D;abcde&#x60;).
399
+ # Get Login Flow
400
+ # This endpoint returns a login flow&#39;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).
401
+ # @param id [String] The Login Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/login?flow&#x3D;abcde&#x60;).
346
402
  # @param [Hash] opts the optional parameters
347
- # @return [Array<(RegistrationRequest, Integer, Hash)>] RegistrationRequest data, response status code and response headers
348
- def get_self_service_browser_registration_request_with_http_info(request, opts = {})
403
+ # @return [Array<(LoginFlow, Integer, Hash)>] LoginFlow data, response status code and response headers
404
+ def get_self_service_login_flow_with_http_info(id, opts = {})
349
405
  if @api_client.config.debugging
350
- @api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_browser_registration_request ...'
406
+ @api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_login_flow ...'
351
407
  end
352
- # verify the required parameter 'request' is set
353
- if @api_client.config.client_side_validation && request.nil?
354
- fail ArgumentError, "Missing the required parameter 'request' when calling AdminApi.get_self_service_browser_registration_request"
408
+ # verify the required parameter 'id' is set
409
+ if @api_client.config.client_side_validation && id.nil?
410
+ fail ArgumentError, "Missing the required parameter 'id' when calling AdminApi.get_self_service_login_flow"
355
411
  end
356
412
  # resource path
357
- local_var_path = '/self-service/browser/flows/requests/registration'
413
+ local_var_path = '/self-service/login/flows'
358
414
 
359
415
  # query parameters
360
416
  query_params = opts[:query_params] || {}
361
- query_params[:'request'] = request
417
+ query_params[:'id'] = id
362
418
 
363
419
  # header parameters
364
420
  header_params = opts[:header_params] || {}
@@ -372,7 +428,7 @@ module OryHydraClient
372
428
  post_body = opts[:body]
373
429
 
374
430
  # return_type
375
- return_type = opts[:return_type] || 'RegistrationRequest'
431
+ return_type = opts[:return_type] || 'LoginFlow'
376
432
 
377
433
  # auth_names
378
434
  auth_names = opts[:auth_names] || []
@@ -388,40 +444,40 @@ module OryHydraClient
388
444
 
389
445
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
390
446
  if @api_client.config.debugging
391
- @api_client.config.logger.debug "API called: AdminApi#get_self_service_browser_registration_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
447
+ @api_client.config.logger.debug "API called: AdminApi#get_self_service_login_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
392
448
  end
393
449
  return data, status_code, headers
394
450
  end
395
451
 
396
- # Get the request context of browser-based settings flows
397
- # 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).
398
- # @param request [String] Request is the Login Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/login?request&#x3D;abcde&#x60;).
452
+ # Get information about a recovery flow
453
+ # 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).
454
+ # @param id [String] The Flow ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/recovery?flow&#x3D;abcde&#x60;).
399
455
  # @param [Hash] opts the optional parameters
400
- # @return [SettingsRequest]
401
- def get_self_service_browser_settings_request(request, opts = {})
402
- data, _status_code, _headers = get_self_service_browser_settings_request_with_http_info(request, opts)
456
+ # @return [RecoveryFlow]
457
+ def get_self_service_recovery_flow(id, opts = {})
458
+ data, _status_code, _headers = get_self_service_recovery_flow_with_http_info(id, opts)
403
459
  data
404
460
  end
405
461
 
406
- # Get the request context of browser-based settings flows
407
- # When accessing this endpoint through ORY Kratos&#39; 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 &amp; Profile Management Documentation](../self-service/flows/user-settings).
408
- # @param request [String] Request is the Login Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/login?request&#x3D;abcde&#x60;).
462
+ # Get information about a recovery flow
463
+ # This endpoint returns a recovery flow&#39;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).
464
+ # @param id [String] The Flow ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/recovery?flow&#x3D;abcde&#x60;).
409
465
  # @param [Hash] opts the optional parameters
410
- # @return [Array<(SettingsRequest, Integer, Hash)>] SettingsRequest data, response status code and response headers
411
- def get_self_service_browser_settings_request_with_http_info(request, opts = {})
466
+ # @return [Array<(RecoveryFlow, Integer, Hash)>] RecoveryFlow data, response status code and response headers
467
+ def get_self_service_recovery_flow_with_http_info(id, opts = {})
412
468
  if @api_client.config.debugging
413
- @api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_browser_settings_request ...'
469
+ @api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_recovery_flow ...'
414
470
  end
415
- # verify the required parameter 'request' is set
416
- if @api_client.config.client_side_validation && request.nil?
417
- fail ArgumentError, "Missing the required parameter 'request' when calling AdminApi.get_self_service_browser_settings_request"
471
+ # verify the required parameter 'id' is set
472
+ if @api_client.config.client_side_validation && id.nil?
473
+ fail ArgumentError, "Missing the required parameter 'id' when calling AdminApi.get_self_service_recovery_flow"
418
474
  end
419
475
  # resource path
420
- local_var_path = '/self-service/browser/flows/requests/settings'
476
+ local_var_path = '/self-service/recovery/flows'
421
477
 
422
478
  # query parameters
423
479
  query_params = opts[:query_params] || {}
424
- query_params[:'request'] = request
480
+ query_params[:'id'] = id
425
481
 
426
482
  # header parameters
427
483
  header_params = opts[:header_params] || {}
@@ -435,7 +491,7 @@ module OryHydraClient
435
491
  post_body = opts[:body]
436
492
 
437
493
  # return_type
438
- return_type = opts[:return_type] || 'SettingsRequest'
494
+ return_type = opts[:return_type] || 'RecoveryFlow'
439
495
 
440
496
  # auth_names
441
497
  auth_names = opts[:auth_names] || []
@@ -451,36 +507,40 @@ module OryHydraClient
451
507
 
452
508
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
453
509
  if @api_client.config.debugging
454
- @api_client.config.logger.debug "API called: AdminApi#get_self_service_browser_settings_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
510
+ @api_client.config.logger.debug "API called: AdminApi#get_self_service_recovery_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
455
511
  end
456
512
  return data, status_code, headers
457
513
  end
458
514
 
459
- # Get user-facing self-service errors
460
- # 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).
515
+ # Get Registration Flow
516
+ # 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).
517
+ # @param id [String] The Registration Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/registration?flow&#x3D;abcde&#x60;).
461
518
  # @param [Hash] opts the optional parameters
462
- # @option opts [String] :error
463
- # @return [ErrorContainer]
464
- def get_self_service_error(opts = {})
465
- data, _status_code, _headers = get_self_service_error_with_http_info(opts)
519
+ # @return [RegistrationFlow]
520
+ def get_self_service_registration_flow(id, opts = {})
521
+ data, _status_code, _headers = get_self_service_registration_flow_with_http_info(id, opts)
466
522
  data
467
523
  end
468
524
 
469
- # Get user-facing self-service errors
470
- # This endpoint returns the error associated with a user-facing self service errors. When accessing this endpoint through ORY Kratos&#39; 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).
525
+ # Get Registration Flow
526
+ # This endpoint returns a registration flow&#39;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).
527
+ # @param id [String] The Registration Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/registration?flow&#x3D;abcde&#x60;).
471
528
  # @param [Hash] opts the optional parameters
472
- # @option opts [String] :error
473
- # @return [Array<(ErrorContainer, Integer, Hash)>] ErrorContainer data, response status code and response headers
474
- def get_self_service_error_with_http_info(opts = {})
529
+ # @return [Array<(RegistrationFlow, Integer, Hash)>] RegistrationFlow data, response status code and response headers
530
+ def get_self_service_registration_flow_with_http_info(id, opts = {})
475
531
  if @api_client.config.debugging
476
- @api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_error ...'
532
+ @api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_registration_flow ...'
533
+ end
534
+ # verify the required parameter 'id' is set
535
+ if @api_client.config.client_side_validation && id.nil?
536
+ fail ArgumentError, "Missing the required parameter 'id' when calling AdminApi.get_self_service_registration_flow"
477
537
  end
478
538
  # resource path
479
- local_var_path = '/self-service/errors'
539
+ local_var_path = '/self-service/registration/flows'
480
540
 
481
541
  # query parameters
482
542
  query_params = opts[:query_params] || {}
483
- query_params[:'error'] = opts[:'error'] if !opts[:'error'].nil?
543
+ query_params[:'id'] = id
484
544
 
485
545
  # header parameters
486
546
  header_params = opts[:header_params] || {}
@@ -494,7 +554,7 @@ module OryHydraClient
494
554
  post_body = opts[:body]
495
555
 
496
556
  # return_type
497
- return_type = opts[:return_type] || 'ErrorContainer'
557
+ return_type = opts[:return_type] || 'RegistrationFlow'
498
558
 
499
559
  # auth_names
500
560
  auth_names = opts[:auth_names] || []
@@ -510,40 +570,103 @@ module OryHydraClient
510
570
 
511
571
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
512
572
  if @api_client.config.debugging
513
- @api_client.config.logger.debug "API called: AdminApi#get_self_service_error\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
573
+ @api_client.config.logger.debug "API called: AdminApi#get_self_service_registration_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
574
+ end
575
+ return data, status_code, headers
576
+ end
577
+
578
+ # Get Settings Flow
579
+ # 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).
580
+ # @param id [String] ID is the Settings Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/settings?flow&#x3D;abcde&#x60;).
581
+ # @param [Hash] opts the optional parameters
582
+ # @return [SettingsFlow]
583
+ def get_self_service_settings_flow(id, opts = {})
584
+ data, _status_code, _headers = get_self_service_settings_flow_with_http_info(id, opts)
585
+ data
586
+ end
587
+
588
+ # Get Settings Flow
589
+ # When accessing this endpoint through ORY Kratos&#39; 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&#39; Admin API. More information can be found at [ORY Kratos User Settings &amp; Profile Management Documentation](../self-service/flows/user-settings).
590
+ # @param id [String] ID is the Settings Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/settings?flow&#x3D;abcde&#x60;).
591
+ # @param [Hash] opts the optional parameters
592
+ # @return [Array<(SettingsFlow, Integer, Hash)>] SettingsFlow data, response status code and response headers
593
+ def get_self_service_settings_flow_with_http_info(id, opts = {})
594
+ if @api_client.config.debugging
595
+ @api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_settings_flow ...'
596
+ end
597
+ # verify the required parameter 'id' is set
598
+ if @api_client.config.client_side_validation && id.nil?
599
+ fail ArgumentError, "Missing the required parameter 'id' when calling AdminApi.get_self_service_settings_flow"
600
+ end
601
+ # resource path
602
+ local_var_path = '/self-service/settings/flows'
603
+
604
+ # query parameters
605
+ query_params = opts[:query_params] || {}
606
+ query_params[:'id'] = id
607
+
608
+ # header parameters
609
+ header_params = opts[:header_params] || {}
610
+ # HTTP header 'Accept' (if needed)
611
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
612
+
613
+ # form parameters
614
+ form_params = opts[:form_params] || {}
615
+
616
+ # http body (model)
617
+ post_body = opts[:body]
618
+
619
+ # return_type
620
+ return_type = opts[:return_type] || 'SettingsFlow'
621
+
622
+ # auth_names
623
+ auth_names = opts[:auth_names] || ['sessionToken']
624
+
625
+ new_options = opts.merge(
626
+ :header_params => header_params,
627
+ :query_params => query_params,
628
+ :form_params => form_params,
629
+ :body => post_body,
630
+ :auth_names => auth_names,
631
+ :return_type => return_type
632
+ )
633
+
634
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
635
+ if @api_client.config.debugging
636
+ @api_client.config.logger.debug "API called: AdminApi#get_self_service_settings_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
514
637
  end
515
638
  return data, status_code, headers
516
639
  end
517
640
 
518
- # Get the request context of browser-based verification flows
519
- # 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).
520
- # @param request [String] Request is the Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/verify?request&#x3D;abcde&#x60;).
641
+ # Get Verification Flow
642
+ # 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).
643
+ # @param id [String] The Flow ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/verification?flow&#x3D;abcde&#x60;).
521
644
  # @param [Hash] opts the optional parameters
522
- # @return [VerificationRequest]
523
- def get_self_service_verification_request(request, opts = {})
524
- data, _status_code, _headers = get_self_service_verification_request_with_http_info(request, opts)
645
+ # @return [VerificationFlow]
646
+ def get_self_service_verification_flow(id, opts = {})
647
+ data, _status_code, _headers = get_self_service_verification_flow_with_http_info(id, opts)
525
648
  data
526
649
  end
527
650
 
528
- # Get the request context of browser-based verification flows
529
- # When accessing this endpoint through ORY Kratos&#39; 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).
530
- # @param request [String] Request is the Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/verify?request&#x3D;abcde&#x60;).
651
+ # Get Verification Flow
652
+ # This endpoint returns a verification flow&#39;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).
653
+ # @param id [String] The Flow ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/verification?flow&#x3D;abcde&#x60;).
531
654
  # @param [Hash] opts the optional parameters
532
- # @return [Array<(VerificationRequest, Integer, Hash)>] VerificationRequest data, response status code and response headers
533
- def get_self_service_verification_request_with_http_info(request, opts = {})
655
+ # @return [Array<(VerificationFlow, Integer, Hash)>] VerificationFlow data, response status code and response headers
656
+ def get_self_service_verification_flow_with_http_info(id, opts = {})
534
657
  if @api_client.config.debugging
535
- @api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_verification_request ...'
658
+ @api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_verification_flow ...'
536
659
  end
537
- # verify the required parameter 'request' is set
538
- if @api_client.config.client_side_validation && request.nil?
539
- fail ArgumentError, "Missing the required parameter 'request' when calling AdminApi.get_self_service_verification_request"
660
+ # verify the required parameter 'id' is set
661
+ if @api_client.config.client_side_validation && id.nil?
662
+ fail ArgumentError, "Missing the required parameter 'id' when calling AdminApi.get_self_service_verification_flow"
540
663
  end
541
664
  # resource path
542
- local_var_path = '/self-service/browser/flows/requests/verification'
665
+ local_var_path = '/self-service/verification/flows'
543
666
 
544
667
  # query parameters
545
668
  query_params = opts[:query_params] || {}
546
- query_params[:'request'] = request
669
+ query_params[:'id'] = id
547
670
 
548
671
  # header parameters
549
672
  header_params = opts[:header_params] || {}
@@ -557,7 +680,7 @@ module OryHydraClient
557
680
  post_body = opts[:body]
558
681
 
559
682
  # return_type
560
- return_type = opts[:return_type] || 'VerificationRequest'
683
+ return_type = opts[:return_type] || 'VerificationFlow'
561
684
 
562
685
  # auth_names
563
686
  auth_names = opts[:auth_names] || []
@@ -573,33 +696,51 @@ module OryHydraClient
573
696
 
574
697
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
575
698
  if @api_client.config.debugging
576
- @api_client.config.logger.debug "API called: AdminApi#get_self_service_verification_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
699
+ @api_client.config.logger.debug "API called: AdminApi#get_self_service_verification_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
577
700
  end
578
701
  return data, status_code, headers
579
702
  end
580
703
 
581
- # List all identities in the system
582
- # 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).
704
+ # List Identities
705
+ # 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).
583
706
  # @param [Hash] opts the optional parameters
707
+ # @option opts [Integer] :per_page Items per Page This is the number of items per page. (default to 100)
708
+ # @option opts [Integer] :page Pagination Page (default to 0)
584
709
  # @return [Array<Identity>]
585
710
  def list_identities(opts = {})
586
711
  data, _status_code, _headers = list_identities_with_http_info(opts)
587
712
  data
588
713
  end
589
714
 
590
- # List all identities in the system
591
- # This endpoint returns a login request&#39;s context with, for example, error details and other information. Learn how identities work in [ORY Kratos&#39; User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
715
+ # List Identities
716
+ # Lists all identities. Does not support search at the moment. Learn how identities work in [ORY Kratos&#39; User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
592
717
  # @param [Hash] opts the optional parameters
718
+ # @option opts [Integer] :per_page Items per Page This is the number of items per page.
719
+ # @option opts [Integer] :page Pagination Page
593
720
  # @return [Array<(Array<Identity>, Integer, Hash)>] Array<Identity> data, response status code and response headers
594
721
  def list_identities_with_http_info(opts = {})
595
722
  if @api_client.config.debugging
596
723
  @api_client.config.logger.debug 'Calling API: AdminApi.list_identities ...'
597
724
  end
725
+ if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 500
726
+ fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling AdminApi.list_identities, must be smaller than or equal to 500.'
727
+ end
728
+
729
+ if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
730
+ fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling AdminApi.list_identities, must be greater than or equal to 1.'
731
+ end
732
+
733
+ if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
734
+ fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AdminApi.list_identities, must be greater than or equal to 0.'
735
+ end
736
+
598
737
  # resource path
599
738
  local_var_path = '/identities'
600
739
 
601
740
  # query parameters
602
741
  query_params = opts[:query_params] || {}
742
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
743
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
603
744
 
604
745
  # header parameters
605
746
  header_params = opts[:header_params] || {}
@@ -634,24 +775,78 @@ module OryHydraClient
634
775
  return data, status_code, headers
635
776
  end
636
777
 
637
- # Update an identity
778
+ # Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
779
+ # ``` metadata: annotations: prometheus.io/port: \"4434\" prometheus.io/path: \"/metrics/prometheus\" ```
780
+ # @param [Hash] opts the optional parameters
781
+ # @return [nil]
782
+ def prometheus(opts = {})
783
+ prometheus_with_http_info(opts)
784
+ nil
785
+ end
786
+
787
+ # Get snapshot metrics from the Hydra service. If you&#39;re using k8s, you can then add annotations to your deployment like so:
788
+ # &#x60;&#x60;&#x60; metadata: annotations: prometheus.io/port: \&quot;4434\&quot; prometheus.io/path: \&quot;/metrics/prometheus\&quot; &#x60;&#x60;&#x60;
789
+ # @param [Hash] opts the optional parameters
790
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
791
+ def prometheus_with_http_info(opts = {})
792
+ if @api_client.config.debugging
793
+ @api_client.config.logger.debug 'Calling API: AdminApi.prometheus ...'
794
+ end
795
+ # resource path
796
+ local_var_path = '/metrics/prometheus'
797
+
798
+ # query parameters
799
+ query_params = opts[:query_params] || {}
800
+
801
+ # header parameters
802
+ header_params = opts[:header_params] || {}
803
+
804
+ # form parameters
805
+ form_params = opts[:form_params] || {}
806
+
807
+ # http body (model)
808
+ post_body = opts[:body]
809
+
810
+ # return_type
811
+ return_type = opts[:return_type]
812
+
813
+ # auth_names
814
+ auth_names = opts[:auth_names] || []
815
+
816
+ new_options = opts.merge(
817
+ :header_params => header_params,
818
+ :query_params => query_params,
819
+ :form_params => form_params,
820
+ :body => post_body,
821
+ :auth_names => auth_names,
822
+ :return_type => return_type
823
+ )
824
+
825
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
826
+ if @api_client.config.debugging
827
+ @api_client.config.logger.debug "API called: AdminApi#prometheus\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
828
+ end
829
+ return data, status_code, headers
830
+ end
831
+
832
+ # Update an Identity
638
833
  # 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).
639
834
  # @param id [String] ID must be set to the ID of identity you want to update
640
- # @param body [Identity]
641
835
  # @param [Hash] opts the optional parameters
836
+ # @option opts [UpdateIdentity] :body
642
837
  # @return [Identity]
643
- def update_identity(id, body, opts = {})
644
- data, _status_code, _headers = update_identity_with_http_info(id, body, opts)
838
+ def update_identity(id, opts = {})
839
+ data, _status_code, _headers = update_identity_with_http_info(id, opts)
645
840
  data
646
841
  end
647
842
 
648
- # Update an identity
843
+ # Update an Identity
649
844
  # This endpoint updates an identity. It is NOT possible to set an identity&#39;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&#39; User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
650
845
  # @param id [String] ID must be set to the ID of identity you want to update
651
- # @param body [Identity]
652
846
  # @param [Hash] opts the optional parameters
847
+ # @option opts [UpdateIdentity] :body
653
848
  # @return [Array<(Identity, Integer, Hash)>] Identity data, response status code and response headers
654
- def update_identity_with_http_info(id, body, opts = {})
849
+ def update_identity_with_http_info(id, opts = {})
655
850
  if @api_client.config.debugging
656
851
  @api_client.config.logger.debug 'Calling API: AdminApi.update_identity ...'
657
852
  end
@@ -659,10 +854,6 @@ module OryHydraClient
659
854
  if @api_client.config.client_side_validation && id.nil?
660
855
  fail ArgumentError, "Missing the required parameter 'id' when calling AdminApi.update_identity"
661
856
  end
662
- # verify the required parameter 'body' is set
663
- if @api_client.config.client_side_validation && body.nil?
664
- fail ArgumentError, "Missing the required parameter 'body' when calling AdminApi.update_identity"
665
- end
666
857
  # resource path
667
858
  local_var_path = '/identities/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
668
859
 
@@ -680,7 +871,7 @@ module OryHydraClient
680
871
  form_params = opts[:form_params] || {}
681
872
 
682
873
  # http body (model)
683
- post_body = opts[:body] || @api_client.object_to_http_body(body)
874
+ post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])
684
875
 
685
876
  # return_type
686
877
  return_type = opts[:return_type] || 'Identity'