ory-kratos-client 0.5.1.alpha1 → 0.5.5.alpha3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (98) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +7 -7
  3. data/docs/AdminApi.md +382 -143
  4. data/docs/CompleteSelfServiceLoginFlowWithPasswordMethod.md +12 -11
  5. data/docs/CompleteSelfServiceRecoveryFlowWithLinkMethod.md +10 -9
  6. data/docs/CompleteSelfServiceSettingsFlowWithPasswordMethod.md +10 -9
  7. data/docs/CompleteSelfServiceVerificationFlowWithLinkMethod.md +10 -9
  8. data/docs/CreateIdentity.md +10 -9
  9. data/docs/CreateRecoveryLink.md +10 -9
  10. data/docs/ErrorContainer.md +10 -9
  11. data/docs/FormField.md +20 -19
  12. data/docs/GenericError.md +8 -7
  13. data/docs/GenericErrorPayload.md +20 -19
  14. data/docs/HealthApi.md +50 -15
  15. data/docs/HealthNotReadyStatus.md +8 -7
  16. data/docs/HealthStatus.md +8 -7
  17. data/docs/Identity.md +18 -17
  18. data/docs/LoginFlow.md +24 -23
  19. data/docs/LoginFlowMethod.md +10 -9
  20. data/docs/LoginFlowMethodConfig.md +16 -15
  21. data/docs/LoginViaApiResponse.md +10 -9
  22. data/docs/Message.md +14 -13
  23. data/docs/PublicApi.md +707 -237
  24. data/docs/RecoveryAddress.md +12 -11
  25. data/docs/RecoveryFlow.md +24 -23
  26. data/docs/RecoveryFlowMethod.md +10 -9
  27. data/docs/RecoveryFlowMethodConfig.md +14 -13
  28. data/docs/RecoveryLink.md +10 -9
  29. data/docs/RegistrationFlow.md +22 -21
  30. data/docs/RegistrationFlowMethod.md +10 -9
  31. data/docs/RegistrationFlowMethodConfig.md +16 -15
  32. data/docs/RegistrationViaApiResponse.md +12 -11
  33. data/docs/RevokeSession.md +8 -7
  34. data/docs/Session.md +18 -17
  35. data/docs/SettingsFlow.md +26 -25
  36. data/docs/SettingsFlowMethod.md +10 -9
  37. data/docs/SettingsFlowMethodConfig.md +14 -13
  38. data/docs/SettingsViaApiResponse.md +10 -9
  39. data/docs/UpdateIdentity.md +10 -9
  40. data/docs/VerifiableAddress.md +18 -17
  41. data/docs/VerificationFlow.md +24 -23
  42. data/docs/VerificationFlowMethod.md +10 -9
  43. data/docs/VerificationFlowMethodConfig.md +14 -13
  44. data/docs/Version.md +8 -7
  45. data/docs/VersionApi.md +26 -9
  46. data/lib/ory-kratos-client.rb +2 -2
  47. data/lib/ory-kratos-client/api/admin_api.rb +58 -44
  48. data/lib/ory-kratos-client/api/health_api.rb +10 -8
  49. data/lib/ory-kratos-client/api/public_api.rb +113 -86
  50. data/lib/ory-kratos-client/api/version_api.rb +6 -5
  51. data/lib/ory-kratos-client/api_client.rb +50 -48
  52. data/lib/ory-kratos-client/api_error.rb +2 -2
  53. data/lib/ory-kratos-client/configuration.rb +34 -7
  54. data/lib/ory-kratos-client/models/complete_self_service_login_flow_with_password_method.rb +20 -8
  55. data/lib/ory-kratos-client/models/complete_self_service_recovery_flow_with_link_method.rb +20 -8
  56. data/lib/ory-kratos-client/models/complete_self_service_settings_flow_with_password_method.rb +20 -8
  57. data/lib/ory-kratos-client/models/complete_self_service_verification_flow_with_link_method.rb +20 -8
  58. data/lib/ory-kratos-client/models/create_identity.rb +20 -8
  59. data/lib/ory-kratos-client/models/create_recovery_link.rb +20 -8
  60. data/lib/ory-kratos-client/models/error_container.rb +20 -8
  61. data/lib/ory-kratos-client/models/form_field.rb +20 -8
  62. data/lib/ory-kratos-client/models/generic_error.rb +20 -8
  63. data/lib/ory-kratos-client/models/generic_error_payload.rb +20 -8
  64. data/lib/ory-kratos-client/models/health_not_ready_status.rb +20 -8
  65. data/lib/ory-kratos-client/models/health_status.rb +20 -8
  66. data/lib/ory-kratos-client/models/identity.rb +20 -8
  67. data/lib/ory-kratos-client/models/login_flow.rb +22 -10
  68. data/lib/ory-kratos-client/models/login_flow_method.rb +20 -8
  69. data/lib/ory-kratos-client/models/login_flow_method_config.rb +20 -8
  70. data/lib/ory-kratos-client/models/login_via_api_response.rb +20 -8
  71. data/lib/ory-kratos-client/models/message.rb +20 -8
  72. data/lib/ory-kratos-client/models/recovery_address.rb +20 -8
  73. data/lib/ory-kratos-client/models/recovery_flow.rb +22 -10
  74. data/lib/ory-kratos-client/models/recovery_flow_method.rb +20 -8
  75. data/lib/ory-kratos-client/models/recovery_flow_method_config.rb +20 -8
  76. data/lib/ory-kratos-client/models/recovery_link.rb +21 -9
  77. data/lib/ory-kratos-client/models/registration_flow.rb +22 -10
  78. data/lib/ory-kratos-client/models/registration_flow_method.rb +20 -8
  79. data/lib/ory-kratos-client/models/registration_flow_method_config.rb +20 -8
  80. data/lib/ory-kratos-client/models/registration_via_api_response.rb +20 -8
  81. data/lib/ory-kratos-client/models/revoke_session.rb +20 -8
  82. data/lib/ory-kratos-client/models/session.rb +23 -11
  83. data/lib/ory-kratos-client/models/settings_flow.rb +22 -10
  84. data/lib/ory-kratos-client/models/settings_flow_method.rb +20 -8
  85. data/lib/ory-kratos-client/models/settings_flow_method_config.rb +20 -8
  86. data/lib/ory-kratos-client/models/settings_via_api_response.rb +20 -8
  87. data/lib/ory-kratos-client/models/update_identity.rb +20 -8
  88. data/lib/ory-kratos-client/models/verifiable_address.rb +21 -9
  89. data/lib/ory-kratos-client/models/verification_flow.rb +22 -10
  90. data/lib/ory-kratos-client/models/verification_flow_method.rb +20 -8
  91. data/lib/ory-kratos-client/models/verification_flow_method_config.rb +20 -8
  92. data/lib/ory-kratos-client/models/version.rb +20 -8
  93. data/lib/ory-kratos-client/version.rb +3 -3
  94. data/ory-kratos-client.gemspec +4 -5
  95. data/spec/api_client_spec.rb +3 -3
  96. data/spec/configuration_spec.rb +2 -2
  97. data/spec/spec_helper.rb +2 -2
  98. metadata +50 -70
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 50e734aacd74297b7cdc6543e956bd5a8136af247c16fcfa8bd1601531075985
4
- data.tar.gz: d21e1fdfb4380142018c03205401856e96715cafabb740459b70af387ffbbcd9
3
+ metadata.gz: a8cdbb0123909c9f9a23ad704ded8d008e2d16ba4c827daebc92af08d6d98955
4
+ data.tar.gz: e8e2032c182615ec7a3c2965799602503ca4609073219223f3f90a904e189b74
5
5
  SHA512:
6
- metadata.gz: b226e7d534a6dfaf0b91fde83fdcea9ae836b8c6a05a88b77e5b58ad119e06f8c52beeb67e39eeb058630429ed28368ad340ce1f7c37713c5e459f090a88d8e6
7
- data.tar.gz: ba03b573fe85adea274d63f11a5313b7917816b298c07f5558d6883e425a948f18dc27d26456e88a0716a0e8e6c5c7e1d4e2a656db1b370a82b7ad789806872b
6
+ metadata.gz: 202ac1b671a27ffe0d5f21224f287b461c8ba9416fa0def10c6c56fe8c1479c18b73028c0f3073305b602973c81f71299b6f4783aae5b65be20cb467a08afeb8
7
+ data.tar.gz: 8ca671ae18f87fb65be3fd701d8bd25ac4ba4733a2ea7fc8d2002a3b80b425e1ae373096b63d0030b1e64bce94d1f71b159d1fb7c47f08a8b65e5cc7552cca49
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.5.1-alpha.1
10
- - Package version: v0.5.1-alpha.1
9
+ - API version: v0.5.5-alpha.3
10
+ - Package version: v0.5.5-alpha.3
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.5.1-alpha.1.gem
26
+ gem install ./ory-kratos-client-v0.5.5-alpha.3.gem
27
27
  ```
28
28
 
29
- (for development, run `gem install --dev ./ory-kratos-client-v0.5.1-alpha.1.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./ory-kratos-client-v0.5.5-alpha.3.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.5.1-alpha.1'
35
+ gem 'ory-kratos-client', '~> v0.5.5-alpha.3'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -58,7 +58,7 @@ require 'ory-kratos-client'
58
58
 
59
59
  api_instance = OryHydraClient::AdminApi.new
60
60
  opts = {
61
- body: OryHydraClient::CreateIdentity.new # CreateIdentity |
61
+ body: OryHydraClient::CreateIdentity.new({schema_id: 'schema_id_example', traits: 3.56}) # CreateIdentity |
62
62
  }
63
63
 
64
64
  begin
@@ -115,7 +115,7 @@ Class | Method | HTTP request | Description
115
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
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
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
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 | Initialize Settings Flow for Browsers
119
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
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
121
  *OryHydraClient::PublicApi* | [**revoke_session**](docs/PublicApi.md#revoke_session) | **DELETE** /sessions | Revoke and Invalidate a Session
data/docs/AdminApi.md CHANGED
@@ -2,59 +2,75 @@
2
2
 
3
3
  All URIs are relative to *http://localhost*
4
4
 
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**create_identity**](AdminApi.md#create_identity) | **POST** /identities | Create an Identity
8
- [**create_recovery_link**](AdminApi.md#create_recovery_link) | **POST** /recovery/link | Create a Recovery Link
9
- [**delete_identity**](AdminApi.md#delete_identity) | **DELETE** /identities/{id} | Delete an Identity
10
- [**get_identity**](AdminApi.md#get_identity) | **GET** /identities/{id} | Get an Identity
11
- [**get_schema**](AdminApi.md#get_schema) | **GET** /schemas/{id} |
12
- [**get_self_service_error**](AdminApi.md#get_self_service_error) | **GET** /self-service/errors | Get User-Facing Self-Service Errors
13
- [**get_self_service_login_flow**](AdminApi.md#get_self_service_login_flow) | **GET** /self-service/login/flows | Get Login Flow
14
- [**get_self_service_recovery_flow**](AdminApi.md#get_self_service_recovery_flow) | **GET** /self-service/recovery/flows | Get information about a recovery flow
15
- [**get_self_service_registration_flow**](AdminApi.md#get_self_service_registration_flow) | **GET** /self-service/registration/flows | Get Registration Flow
16
- [**get_self_service_settings_flow**](AdminApi.md#get_self_service_settings_flow) | **GET** /self-service/settings/flows | Get Settings Flow
17
- [**get_self_service_verification_flow**](AdminApi.md#get_self_service_verification_flow) | **GET** /self-service/verification/flows | Get Verification Flow
18
- [**list_identities**](AdminApi.md#list_identities) | **GET** /identities | List Identities
19
- [**prometheus**](AdminApi.md#prometheus) | **GET** /metrics/prometheus | Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
20
- [**update_identity**](AdminApi.md#update_identity) | **PUT** /identities/{id} | Update an Identity
21
-
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_identity**](AdminApi.md#create_identity) | **POST** /identities | Create an Identity |
8
+ | [**create_recovery_link**](AdminApi.md#create_recovery_link) | **POST** /recovery/link | Create a Recovery Link |
9
+ | [**delete_identity**](AdminApi.md#delete_identity) | **DELETE** /identities/{id} | Delete an Identity |
10
+ | [**get_identity**](AdminApi.md#get_identity) | **GET** /identities/{id} | Get an Identity |
11
+ | [**get_schema**](AdminApi.md#get_schema) | **GET** /schemas/{id} | |
12
+ | [**get_self_service_error**](AdminApi.md#get_self_service_error) | **GET** /self-service/errors | Get User-Facing Self-Service Errors |
13
+ | [**get_self_service_login_flow**](AdminApi.md#get_self_service_login_flow) | **GET** /self-service/login/flows | Get Login Flow |
14
+ | [**get_self_service_recovery_flow**](AdminApi.md#get_self_service_recovery_flow) | **GET** /self-service/recovery/flows | Get information about a recovery flow |
15
+ | [**get_self_service_registration_flow**](AdminApi.md#get_self_service_registration_flow) | **GET** /self-service/registration/flows | Get Registration Flow |
16
+ | [**get_self_service_settings_flow**](AdminApi.md#get_self_service_settings_flow) | **GET** /self-service/settings/flows | Get Settings Flow |
17
+ | [**get_self_service_verification_flow**](AdminApi.md#get_self_service_verification_flow) | **GET** /self-service/verification/flows | Get Verification Flow |
18
+ | [**list_identities**](AdminApi.md#list_identities) | **GET** /identities | List Identities |
19
+ | [**prometheus**](AdminApi.md#prometheus) | **GET** /metrics/prometheus | Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so: |
20
+ | [**update_identity**](AdminApi.md#update_identity) | **PUT** /identities/{id} | Update an Identity |
22
21
 
23
22
 
24
23
  ## create_identity
25
24
 
26
- > Identity create_identity(opts)
25
+ > <Identity> create_identity(opts)
27
26
 
28
27
  Create an Identity
29
28
 
30
29
  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).
31
30
 
32
- ### Example
31
+ ### Examples
33
32
 
34
33
  ```ruby
35
- # load the gem
34
+ require 'time'
36
35
  require 'ory-kratos-client'
37
36
 
38
37
  api_instance = OryHydraClient::AdminApi.new
39
38
  opts = {
40
- body: OryHydraClient::CreateIdentity.new # CreateIdentity |
39
+ body: OryHydraClient::CreateIdentity.new({schema_id: 'schema_id_example', traits: 3.56}) # CreateIdentity |
41
40
  }
42
41
 
43
42
  begin
44
- #Create an Identity
43
+ # Create an Identity
45
44
  result = api_instance.create_identity(opts)
46
45
  p result
47
46
  rescue OryHydraClient::ApiError => e
48
- puts "Exception when calling AdminApi->create_identity: #{e}"
47
+ puts "Error when calling AdminApi->create_identity: #{e}"
49
48
  end
50
49
  ```
51
50
 
52
- ### Parameters
51
+ #### Using the create_identity_with_http_info variant
52
+
53
+ This returns an Array which contains the response data, status code and headers.
54
+
55
+ > <Array(<Identity>, Integer, Hash)> create_identity_with_http_info(opts)
56
+
57
+ ```ruby
58
+ begin
59
+ # Create an Identity
60
+ data, status_code, headers = api_instance.create_identity_with_http_info(opts)
61
+ p status_code # => 2xx
62
+ p headers # => { ... }
63
+ p data # => <Identity>
64
+ rescue OryHydraClient::ApiError => e
65
+ puts "Error when calling AdminApi->create_identity_with_http_info: #{e}"
66
+ end
67
+ ```
53
68
 
69
+ ### Parameters
54
70
 
55
- Name | Type | Description | Notes
56
- ------------- | ------------- | ------------- | -------------
57
- **body** | [**CreateIdentity**](CreateIdentity.md)| | [optional]
71
+ | Name | Type | Description | Notes |
72
+ | ---- | ---- | ----------- | ----- |
73
+ | **body** | [**CreateIdentity**](CreateIdentity.md) | | [optional] |
58
74
 
59
75
  ### Return type
60
76
 
@@ -72,38 +88,55 @@ No authorization required
72
88
 
73
89
  ## create_recovery_link
74
90
 
75
- > RecoveryLink create_recovery_link(opts)
91
+ > <RecoveryLink> create_recovery_link(opts)
76
92
 
77
93
  Create a Recovery Link
78
94
 
79
95
  This endpoint creates a recovery link which should be given to the user in order for them to recover (or activate) their account.
80
96
 
81
- ### Example
97
+ ### Examples
82
98
 
83
99
  ```ruby
84
- # load the gem
100
+ require 'time'
85
101
  require 'ory-kratos-client'
86
102
 
87
103
  api_instance = OryHydraClient::AdminApi.new
88
104
  opts = {
89
- body: OryHydraClient::CreateRecoveryLink.new # CreateRecoveryLink |
105
+ body: OryHydraClient::CreateRecoveryLink.new({identity_id: 'identity_id_example'}) # CreateRecoveryLink |
90
106
  }
91
107
 
92
108
  begin
93
- #Create a Recovery Link
109
+ # Create a Recovery Link
94
110
  result = api_instance.create_recovery_link(opts)
95
111
  p result
96
112
  rescue OryHydraClient::ApiError => e
97
- puts "Exception when calling AdminApi->create_recovery_link: #{e}"
113
+ puts "Error when calling AdminApi->create_recovery_link: #{e}"
98
114
  end
99
115
  ```
100
116
 
101
- ### Parameters
117
+ #### Using the create_recovery_link_with_http_info variant
102
118
 
119
+ This returns an Array which contains the response data, status code and headers.
103
120
 
104
- Name | Type | Description | Notes
105
- ------------- | ------------- | ------------- | -------------
106
- **body** | [**CreateRecoveryLink**](CreateRecoveryLink.md)| | [optional]
121
+ > <Array(<RecoveryLink>, Integer, Hash)> create_recovery_link_with_http_info(opts)
122
+
123
+ ```ruby
124
+ begin
125
+ # Create a Recovery Link
126
+ data, status_code, headers = api_instance.create_recovery_link_with_http_info(opts)
127
+ p status_code # => 2xx
128
+ p headers # => { ... }
129
+ p data # => <RecoveryLink>
130
+ rescue OryHydraClient::ApiError => e
131
+ puts "Error when calling AdminApi->create_recovery_link_with_http_info: #{e}"
132
+ end
133
+ ```
134
+
135
+ ### Parameters
136
+
137
+ | Name | Type | Description | Notes |
138
+ | ---- | ---- | ----------- | ----- |
139
+ | **body** | [**CreateRecoveryLink**](CreateRecoveryLink.md) | | [optional] |
107
140
 
108
141
  ### Return type
109
142
 
@@ -127,29 +160,46 @@ Delete an Identity
127
160
 
128
161
  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).
129
162
 
130
- ### Example
163
+ ### Examples
131
164
 
132
165
  ```ruby
133
- # load the gem
166
+ require 'time'
134
167
  require 'ory-kratos-client'
135
168
 
136
169
  api_instance = OryHydraClient::AdminApi.new
137
170
  id = 'id_example' # String | ID is the identity's ID.
138
171
 
139
172
  begin
140
- #Delete an Identity
173
+ # Delete an Identity
141
174
  api_instance.delete_identity(id)
142
175
  rescue OryHydraClient::ApiError => e
143
- puts "Exception when calling AdminApi->delete_identity: #{e}"
176
+ puts "Error when calling AdminApi->delete_identity: #{e}"
144
177
  end
145
178
  ```
146
179
 
147
- ### Parameters
180
+ #### Using the delete_identity_with_http_info variant
148
181
 
182
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
149
183
 
150
- Name | Type | Description | Notes
151
- ------------- | ------------- | ------------- | -------------
152
- **id** | **String**| ID is the identity&#39;s ID. |
184
+ > <Array(nil, Integer, Hash)> delete_identity_with_http_info(id)
185
+
186
+ ```ruby
187
+ begin
188
+ # Delete an Identity
189
+ data, status_code, headers = api_instance.delete_identity_with_http_info(id)
190
+ p status_code # => 2xx
191
+ p headers # => { ... }
192
+ p data # => nil
193
+ rescue OryHydraClient::ApiError => e
194
+ puts "Error when calling AdminApi->delete_identity_with_http_info: #{e}"
195
+ end
196
+ ```
197
+
198
+ ### Parameters
199
+
200
+ | Name | Type | Description | Notes |
201
+ | ---- | ---- | ----------- | ----- |
202
+ | **id** | **String** | ID is the identity&#39;s ID. | |
153
203
 
154
204
  ### Return type
155
205
 
@@ -167,36 +217,53 @@ No authorization required
167
217
 
168
218
  ## get_identity
169
219
 
170
- > Identity get_identity(id)
220
+ > <Identity> get_identity(id)
171
221
 
172
222
  Get an Identity
173
223
 
174
224
  Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
175
225
 
176
- ### Example
226
+ ### Examples
177
227
 
178
228
  ```ruby
179
- # load the gem
229
+ require 'time'
180
230
  require 'ory-kratos-client'
181
231
 
182
232
  api_instance = OryHydraClient::AdminApi.new
183
233
  id = 'id_example' # String | ID must be set to the ID of identity you want to get
184
234
 
185
235
  begin
186
- #Get an Identity
236
+ # Get an Identity
187
237
  result = api_instance.get_identity(id)
188
238
  p result
189
239
  rescue OryHydraClient::ApiError => e
190
- puts "Exception when calling AdminApi->get_identity: #{e}"
240
+ puts "Error when calling AdminApi->get_identity: #{e}"
191
241
  end
192
242
  ```
193
243
 
194
- ### Parameters
244
+ #### Using the get_identity_with_http_info variant
245
+
246
+ This returns an Array which contains the response data, status code and headers.
247
+
248
+ > <Array(<Identity>, Integer, Hash)> get_identity_with_http_info(id)
249
+
250
+ ```ruby
251
+ begin
252
+ # Get an Identity
253
+ data, status_code, headers = api_instance.get_identity_with_http_info(id)
254
+ p status_code # => 2xx
255
+ p headers # => { ... }
256
+ p data # => <Identity>
257
+ rescue OryHydraClient::ApiError => e
258
+ puts "Error when calling AdminApi->get_identity_with_http_info: #{e}"
259
+ end
260
+ ```
195
261
 
262
+ ### Parameters
196
263
 
197
- Name | Type | Description | Notes
198
- ------------- | ------------- | ------------- | -------------
199
- **id** | **String**| ID must be set to the ID of identity you want to get |
264
+ | Name | Type | Description | Notes |
265
+ | ---- | ---- | ----------- | ----- |
266
+ | **id** | **String** | ID must be set to the ID of identity you want to get | |
200
267
 
201
268
  ### Return type
202
269
 
@@ -220,29 +287,47 @@ No authorization required
220
287
 
221
288
  Get a Traits Schema Definition
222
289
 
223
- ### Example
290
+ ### Examples
224
291
 
225
292
  ```ruby
226
- # load the gem
293
+ require 'time'
227
294
  require 'ory-kratos-client'
228
295
 
229
296
  api_instance = OryHydraClient::AdminApi.new
230
297
  id = 'id_example' # String | ID must be set to the ID of schema you want to get
231
298
 
232
299
  begin
300
+
233
301
  result = api_instance.get_schema(id)
234
302
  p result
235
303
  rescue OryHydraClient::ApiError => e
236
- puts "Exception when calling AdminApi->get_schema: #{e}"
304
+ puts "Error when calling AdminApi->get_schema: #{e}"
237
305
  end
238
306
  ```
239
307
 
240
- ### Parameters
308
+ #### Using the get_schema_with_http_info variant
309
+
310
+ This returns an Array which contains the response data, status code and headers.
311
+
312
+ > <Array(Object, Integer, Hash)> get_schema_with_http_info(id)
241
313
 
314
+ ```ruby
315
+ begin
316
+
317
+ data, status_code, headers = api_instance.get_schema_with_http_info(id)
318
+ p status_code # => 2xx
319
+ p headers # => { ... }
320
+ p data # => Object
321
+ rescue OryHydraClient::ApiError => e
322
+ puts "Error when calling AdminApi->get_schema_with_http_info: #{e}"
323
+ end
324
+ ```
242
325
 
243
- Name | Type | Description | Notes
244
- ------------- | ------------- | ------------- | -------------
245
- **id** | **String**| ID must be set to the ID of schema you want to get |
326
+ ### Parameters
327
+
328
+ | Name | Type | Description | Notes |
329
+ | ---- | ---- | ----------- | ----- |
330
+ | **id** | **String** | ID must be set to the ID of schema you want to get | |
246
331
 
247
332
  ### Return type
248
333
 
@@ -260,36 +345,53 @@ No authorization required
260
345
 
261
346
  ## get_self_service_error
262
347
 
263
- > ErrorContainer get_self_service_error(error)
348
+ > <ErrorContainer> get_self_service_error(error)
264
349
 
265
350
  Get User-Facing Self-Service Errors
266
351
 
267
352
  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).
268
353
 
269
- ### Example
354
+ ### Examples
270
355
 
271
356
  ```ruby
272
- # load the gem
357
+ require 'time'
273
358
  require 'ory-kratos-client'
274
359
 
275
360
  api_instance = OryHydraClient::AdminApi.new
276
361
  error = 'error_example' # String | Error is the container's ID
277
362
 
278
363
  begin
279
- #Get User-Facing Self-Service Errors
364
+ # Get User-Facing Self-Service Errors
280
365
  result = api_instance.get_self_service_error(error)
281
366
  p result
282
367
  rescue OryHydraClient::ApiError => e
283
- puts "Exception when calling AdminApi->get_self_service_error: #{e}"
368
+ puts "Error when calling AdminApi->get_self_service_error: #{e}"
284
369
  end
285
370
  ```
286
371
 
287
- ### Parameters
372
+ #### Using the get_self_service_error_with_http_info variant
288
373
 
374
+ This returns an Array which contains the response data, status code and headers.
289
375
 
290
- Name | Type | Description | Notes
291
- ------------- | ------------- | ------------- | -------------
292
- **error** | **String**| Error is the container&#39;s ID |
376
+ > <Array(<ErrorContainer>, Integer, Hash)> get_self_service_error_with_http_info(error)
377
+
378
+ ```ruby
379
+ begin
380
+ # Get User-Facing Self-Service Errors
381
+ data, status_code, headers = api_instance.get_self_service_error_with_http_info(error)
382
+ p status_code # => 2xx
383
+ p headers # => { ... }
384
+ p data # => <ErrorContainer>
385
+ rescue OryHydraClient::ApiError => e
386
+ puts "Error when calling AdminApi->get_self_service_error_with_http_info: #{e}"
387
+ end
388
+ ```
389
+
390
+ ### Parameters
391
+
392
+ | Name | Type | Description | Notes |
393
+ | ---- | ---- | ----------- | ----- |
394
+ | **error** | **String** | Error is the container&#39;s ID | |
293
395
 
294
396
  ### Return type
295
397
 
@@ -307,36 +409,53 @@ No authorization required
307
409
 
308
410
  ## get_self_service_login_flow
309
411
 
310
- > LoginFlow get_self_service_login_flow(id)
412
+ > <LoginFlow> get_self_service_login_flow(id)
311
413
 
312
414
  Get Login Flow
313
415
 
314
416
  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).
315
417
 
316
- ### Example
418
+ ### Examples
317
419
 
318
420
  ```ruby
319
- # load the gem
421
+ require 'time'
320
422
  require 'ory-kratos-client'
321
423
 
322
424
  api_instance = OryHydraClient::AdminApi.new
323
425
  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`).
324
426
 
325
427
  begin
326
- #Get Login Flow
428
+ # Get Login Flow
327
429
  result = api_instance.get_self_service_login_flow(id)
328
430
  p result
329
431
  rescue OryHydraClient::ApiError => e
330
- puts "Exception when calling AdminApi->get_self_service_login_flow: #{e}"
432
+ puts "Error when calling AdminApi->get_self_service_login_flow: #{e}"
331
433
  end
332
434
  ```
333
435
 
334
- ### Parameters
436
+ #### Using the get_self_service_login_flow_with_http_info variant
437
+
438
+ This returns an Array which contains the response data, status code and headers.
439
+
440
+ > <Array(<LoginFlow>, Integer, Hash)> get_self_service_login_flow_with_http_info(id)
441
+
442
+ ```ruby
443
+ begin
444
+ # Get Login Flow
445
+ data, status_code, headers = api_instance.get_self_service_login_flow_with_http_info(id)
446
+ p status_code # => 2xx
447
+ p headers # => { ... }
448
+ p data # => <LoginFlow>
449
+ rescue OryHydraClient::ApiError => e
450
+ puts "Error when calling AdminApi->get_self_service_login_flow_with_http_info: #{e}"
451
+ end
452
+ ```
335
453
 
454
+ ### Parameters
336
455
 
337
- Name | Type | Description | Notes
338
- ------------- | ------------- | ------------- | -------------
339
- **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;). |
456
+ | Name | Type | Description | Notes |
457
+ | ---- | ---- | ----------- | ----- |
458
+ | **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;). | |
340
459
 
341
460
  ### Return type
342
461
 
@@ -354,36 +473,53 @@ No authorization required
354
473
 
355
474
  ## get_self_service_recovery_flow
356
475
 
357
- > RecoveryFlow get_self_service_recovery_flow(id)
476
+ > <RecoveryFlow> get_self_service_recovery_flow(id)
358
477
 
359
478
  Get information about a recovery flow
360
479
 
361
480
  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).
362
481
 
363
- ### Example
482
+ ### Examples
364
483
 
365
484
  ```ruby
366
- # load the gem
485
+ require 'time'
367
486
  require 'ory-kratos-client'
368
487
 
369
488
  api_instance = OryHydraClient::AdminApi.new
370
489
  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`).
371
490
 
372
491
  begin
373
- #Get information about a recovery flow
492
+ # Get information about a recovery flow
374
493
  result = api_instance.get_self_service_recovery_flow(id)
375
494
  p result
376
495
  rescue OryHydraClient::ApiError => e
377
- puts "Exception when calling AdminApi->get_self_service_recovery_flow: #{e}"
496
+ puts "Error when calling AdminApi->get_self_service_recovery_flow: #{e}"
378
497
  end
379
498
  ```
380
499
 
381
- ### Parameters
500
+ #### Using the get_self_service_recovery_flow_with_http_info variant
501
+
502
+ This returns an Array which contains the response data, status code and headers.
503
+
504
+ > <Array(<RecoveryFlow>, Integer, Hash)> get_self_service_recovery_flow_with_http_info(id)
505
+
506
+ ```ruby
507
+ begin
508
+ # Get information about a recovery flow
509
+ data, status_code, headers = api_instance.get_self_service_recovery_flow_with_http_info(id)
510
+ p status_code # => 2xx
511
+ p headers # => { ... }
512
+ p data # => <RecoveryFlow>
513
+ rescue OryHydraClient::ApiError => e
514
+ puts "Error when calling AdminApi->get_self_service_recovery_flow_with_http_info: #{e}"
515
+ end
516
+ ```
382
517
 
518
+ ### Parameters
383
519
 
384
- Name | Type | Description | Notes
385
- ------------- | ------------- | ------------- | -------------
386
- **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;). |
520
+ | Name | Type | Description | Notes |
521
+ | ---- | ---- | ----------- | ----- |
522
+ | **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;). | |
387
523
 
388
524
  ### Return type
389
525
 
@@ -401,36 +537,53 @@ No authorization required
401
537
 
402
538
  ## get_self_service_registration_flow
403
539
 
404
- > RegistrationFlow get_self_service_registration_flow(id)
540
+ > <RegistrationFlow> get_self_service_registration_flow(id)
405
541
 
406
542
  Get Registration Flow
407
543
 
408
544
  This endpoint returns a registration flow's context with, for example, error details and other information. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
409
545
 
410
- ### Example
546
+ ### Examples
411
547
 
412
548
  ```ruby
413
- # load the gem
549
+ require 'time'
414
550
  require 'ory-kratos-client'
415
551
 
416
552
  api_instance = OryHydraClient::AdminApi.new
417
553
  id = 'id_example' # String | The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`).
418
554
 
419
555
  begin
420
- #Get Registration Flow
556
+ # Get Registration Flow
421
557
  result = api_instance.get_self_service_registration_flow(id)
422
558
  p result
423
559
  rescue OryHydraClient::ApiError => e
424
- puts "Exception when calling AdminApi->get_self_service_registration_flow: #{e}"
560
+ puts "Error when calling AdminApi->get_self_service_registration_flow: #{e}"
425
561
  end
426
562
  ```
427
563
 
428
- ### Parameters
564
+ #### Using the get_self_service_registration_flow_with_http_info variant
429
565
 
566
+ This returns an Array which contains the response data, status code and headers.
430
567
 
431
- Name | Type | Description | Notes
432
- ------------- | ------------- | ------------- | -------------
433
- **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;). |
568
+ > <Array(<RegistrationFlow>, Integer, Hash)> get_self_service_registration_flow_with_http_info(id)
569
+
570
+ ```ruby
571
+ begin
572
+ # Get Registration Flow
573
+ data, status_code, headers = api_instance.get_self_service_registration_flow_with_http_info(id)
574
+ p status_code # => 2xx
575
+ p headers # => { ... }
576
+ p data # => <RegistrationFlow>
577
+ rescue OryHydraClient::ApiError => e
578
+ puts "Error when calling AdminApi->get_self_service_registration_flow_with_http_info: #{e}"
579
+ end
580
+ ```
581
+
582
+ ### Parameters
583
+
584
+ | Name | Type | Description | Notes |
585
+ | ---- | ---- | ----------- | ----- |
586
+ | **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;). | |
434
587
 
435
588
  ### Return type
436
589
 
@@ -448,43 +601,60 @@ No authorization required
448
601
 
449
602
  ## get_self_service_settings_flow
450
603
 
451
- > SettingsFlow get_self_service_settings_flow(id)
604
+ > <SettingsFlow> get_self_service_settings_flow(id)
452
605
 
453
606
  Get Settings Flow
454
607
 
455
608
  When accessing this endpoint through ORY Kratos' Public API you must ensure that either the ORY Kratos Session Cookie or the ORY Kratos Session Token are set. The public endpoint does not return 404 status codes but instead 403 or 500 to improve data privacy. You can access this endpoint without credentials when using ORY Kratos' Admin API. More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
456
609
 
457
- ### Example
610
+ ### Examples
458
611
 
459
612
  ```ruby
460
- # load the gem
613
+ require 'time'
461
614
  require 'ory-kratos-client'
462
615
  # setup authorization
463
616
  OryHydraClient.configure do |config|
464
617
  # Configure API key authorization: sessionToken
465
618
  config.api_key['X-Session-Token'] = 'YOUR API KEY'
466
619
  # 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'
620
+ # config.api_key_prefix['X-Session-Token'] = 'Bearer'
468
621
  end
469
622
 
470
623
  api_instance = OryHydraClient::AdminApi.new
471
624
  id = 'id_example' # String | ID is the Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`).
472
625
 
473
626
  begin
474
- #Get Settings Flow
627
+ # Get Settings Flow
475
628
  result = api_instance.get_self_service_settings_flow(id)
476
629
  p result
477
630
  rescue OryHydraClient::ApiError => e
478
- puts "Exception when calling AdminApi->get_self_service_settings_flow: #{e}"
631
+ puts "Error when calling AdminApi->get_self_service_settings_flow: #{e}"
479
632
  end
480
633
  ```
481
634
 
482
- ### Parameters
635
+ #### Using the get_self_service_settings_flow_with_http_info variant
483
636
 
637
+ This returns an Array which contains the response data, status code and headers.
484
638
 
485
- Name | Type | Description | Notes
486
- ------------- | ------------- | ------------- | -------------
487
- **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;). |
639
+ > <Array(<SettingsFlow>, Integer, Hash)> get_self_service_settings_flow_with_http_info(id)
640
+
641
+ ```ruby
642
+ begin
643
+ # Get Settings Flow
644
+ data, status_code, headers = api_instance.get_self_service_settings_flow_with_http_info(id)
645
+ p status_code # => 2xx
646
+ p headers # => { ... }
647
+ p data # => <SettingsFlow>
648
+ rescue OryHydraClient::ApiError => e
649
+ puts "Error when calling AdminApi->get_self_service_settings_flow_with_http_info: #{e}"
650
+ end
651
+ ```
652
+
653
+ ### Parameters
654
+
655
+ | Name | Type | Description | Notes |
656
+ | ---- | ---- | ----------- | ----- |
657
+ | **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;). | |
488
658
 
489
659
  ### Return type
490
660
 
@@ -502,36 +672,53 @@ Name | Type | Description | Notes
502
672
 
503
673
  ## get_self_service_verification_flow
504
674
 
505
- > VerificationFlow get_self_service_verification_flow(id)
675
+ > <VerificationFlow> get_self_service_verification_flow(id)
506
676
 
507
677
  Get Verification Flow
508
678
 
509
679
  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).
510
680
 
511
- ### Example
681
+ ### Examples
512
682
 
513
683
  ```ruby
514
- # load the gem
684
+ require 'time'
515
685
  require 'ory-kratos-client'
516
686
 
517
687
  api_instance = OryHydraClient::AdminApi.new
518
688
  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`).
519
689
 
520
690
  begin
521
- #Get Verification Flow
691
+ # Get Verification Flow
522
692
  result = api_instance.get_self_service_verification_flow(id)
523
693
  p result
524
694
  rescue OryHydraClient::ApiError => e
525
- puts "Exception when calling AdminApi->get_self_service_verification_flow: #{e}"
695
+ puts "Error when calling AdminApi->get_self_service_verification_flow: #{e}"
526
696
  end
527
697
  ```
528
698
 
529
- ### Parameters
699
+ #### Using the get_self_service_verification_flow_with_http_info variant
700
+
701
+ This returns an Array which contains the response data, status code and headers.
702
+
703
+ > <Array(<VerificationFlow>, Integer, Hash)> get_self_service_verification_flow_with_http_info(id)
704
+
705
+ ```ruby
706
+ begin
707
+ # Get Verification Flow
708
+ data, status_code, headers = api_instance.get_self_service_verification_flow_with_http_info(id)
709
+ p status_code # => 2xx
710
+ p headers # => { ... }
711
+ p data # => <VerificationFlow>
712
+ rescue OryHydraClient::ApiError => e
713
+ puts "Error when calling AdminApi->get_self_service_verification_flow_with_http_info: #{e}"
714
+ end
715
+ ```
530
716
 
717
+ ### Parameters
531
718
 
532
- Name | Type | Description | Notes
533
- ------------- | ------------- | ------------- | -------------
534
- **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;). |
719
+ | Name | Type | Description | Notes |
720
+ | ---- | ---- | ----------- | ----- |
721
+ | **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;). | |
535
722
 
536
723
  ### Return type
537
724
 
@@ -549,40 +736,57 @@ No authorization required
549
736
 
550
737
  ## list_identities
551
738
 
552
- > Array&lt;Identity&gt; list_identities(opts)
739
+ > <Array<Identity>> list_identities(opts)
553
740
 
554
741
  List Identities
555
742
 
556
743
  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).
557
744
 
558
- ### Example
745
+ ### Examples
559
746
 
560
747
  ```ruby
561
- # load the gem
748
+ require 'time'
562
749
  require 'ory-kratos-client'
563
750
 
564
751
  api_instance = OryHydraClient::AdminApi.new
565
752
  opts = {
566
- per_page: 100, # Integer | Items per Page This is the number of items per page.
567
- page: 0 # Integer | Pagination Page
753
+ per_page: 789, # Integer | Items per Page This is the number of items per page.
754
+ page: 789 # Integer | Pagination Page
568
755
  }
569
756
 
570
757
  begin
571
- #List Identities
758
+ # List Identities
572
759
  result = api_instance.list_identities(opts)
573
760
  p result
574
761
  rescue OryHydraClient::ApiError => e
575
- puts "Exception when calling AdminApi->list_identities: #{e}"
762
+ puts "Error when calling AdminApi->list_identities: #{e}"
576
763
  end
577
764
  ```
578
765
 
579
- ### Parameters
766
+ #### Using the list_identities_with_http_info variant
767
+
768
+ This returns an Array which contains the response data, status code and headers.
769
+
770
+ > <Array(<Array<Identity>>, Integer, Hash)> list_identities_with_http_info(opts)
580
771
 
772
+ ```ruby
773
+ begin
774
+ # List Identities
775
+ data, status_code, headers = api_instance.list_identities_with_http_info(opts)
776
+ p status_code # => 2xx
777
+ p headers # => { ... }
778
+ p data # => <Array<Identity>>
779
+ rescue OryHydraClient::ApiError => e
780
+ puts "Error when calling AdminApi->list_identities_with_http_info: #{e}"
781
+ end
782
+ ```
581
783
 
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]
784
+ ### Parameters
785
+
786
+ | Name | Type | Description | Notes |
787
+ | ---- | ---- | ----------- | ----- |
788
+ | **per_page** | **Integer** | Items per Page This is the number of items per page. | [optional][default to 100] |
789
+ | **page** | **Integer** | Pagination Page | [optional][default to 0] |
586
790
 
587
791
  ### Return type
588
792
 
@@ -606,19 +810,37 @@ Get snapshot metrics from the Hydra service. If you're using k8s, you can then a
606
810
 
607
811
  ``` metadata: annotations: prometheus.io/port: \"4434\" prometheus.io/path: \"/metrics/prometheus\" ```
608
812
 
609
- ### Example
813
+ ### Examples
610
814
 
611
815
  ```ruby
612
- # load the gem
816
+ require 'time'
613
817
  require 'ory-kratos-client'
614
818
 
615
819
  api_instance = OryHydraClient::AdminApi.new
616
820
 
617
821
  begin
618
- #Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
822
+ # Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
619
823
  api_instance.prometheus
620
824
  rescue OryHydraClient::ApiError => e
621
- puts "Exception when calling AdminApi->prometheus: #{e}"
825
+ puts "Error when calling AdminApi->prometheus: #{e}"
826
+ end
827
+ ```
828
+
829
+ #### Using the prometheus_with_http_info variant
830
+
831
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
832
+
833
+ > <Array(nil, Integer, Hash)> prometheus_with_http_info
834
+
835
+ ```ruby
836
+ begin
837
+ # Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
838
+ data, status_code, headers = api_instance.prometheus_with_http_info
839
+ p status_code # => 2xx
840
+ p headers # => { ... }
841
+ p data # => nil
842
+ rescue OryHydraClient::ApiError => e
843
+ puts "Error when calling AdminApi->prometheus_with_http_info: #{e}"
622
844
  end
623
845
  ```
624
846
 
@@ -642,40 +864,57 @@ No authorization required
642
864
 
643
865
  ## update_identity
644
866
 
645
- > Identity update_identity(id, opts)
867
+ > <Identity> update_identity(id, opts)
646
868
 
647
869
  Update an Identity
648
870
 
649
871
  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).
650
872
 
651
- ### Example
873
+ ### Examples
652
874
 
653
875
  ```ruby
654
- # load the gem
876
+ require 'time'
655
877
  require 'ory-kratos-client'
656
878
 
657
879
  api_instance = OryHydraClient::AdminApi.new
658
880
  id = 'id_example' # String | ID must be set to the ID of identity you want to update
659
881
  opts = {
660
- body: OryHydraClient::UpdateIdentity.new # UpdateIdentity |
882
+ body: OryHydraClient::UpdateIdentity.new({traits: 3.56}) # UpdateIdentity |
661
883
  }
662
884
 
663
885
  begin
664
- #Update an Identity
886
+ # Update an Identity
665
887
  result = api_instance.update_identity(id, opts)
666
888
  p result
667
889
  rescue OryHydraClient::ApiError => e
668
- puts "Exception when calling AdminApi->update_identity: #{e}"
890
+ puts "Error when calling AdminApi->update_identity: #{e}"
669
891
  end
670
892
  ```
671
893
 
672
- ### Parameters
894
+ #### Using the update_identity_with_http_info variant
895
+
896
+ This returns an Array which contains the response data, status code and headers.
673
897
 
898
+ > <Array(<Identity>, Integer, Hash)> update_identity_with_http_info(id, opts)
899
+
900
+ ```ruby
901
+ begin
902
+ # Update an Identity
903
+ data, status_code, headers = api_instance.update_identity_with_http_info(id, opts)
904
+ p status_code # => 2xx
905
+ p headers # => { ... }
906
+ p data # => <Identity>
907
+ rescue OryHydraClient::ApiError => e
908
+ puts "Error when calling AdminApi->update_identity_with_http_info: #{e}"
909
+ end
910
+ ```
911
+
912
+ ### Parameters
674
913
 
675
- Name | Type | Description | Notes
676
- ------------- | ------------- | ------------- | -------------
677
- **id** | **String**| ID must be set to the ID of identity you want to update |
678
- **body** | [**UpdateIdentity**](UpdateIdentity.md)| | [optional]
914
+ | Name | Type | Description | Notes |
915
+ | ---- | ---- | ----------- | ----- |
916
+ | **id** | **String** | ID must be set to the ID of identity you want to update | |
917
+ | **body** | [**UpdateIdentity**](UpdateIdentity.md) | | [optional] |
679
918
 
680
919
  ### Return type
681
920