ory-kratos-client 0.4.6.alpha1 → 0.5.4.alpha1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +82 -60
- data/docs/AdminApi.md +208 -98
- data/docs/CompleteSelfServiceLoginFlowWithPasswordMethod.md +21 -0
- data/docs/CompleteSelfServiceRecoveryFlowWithLinkMethod.md +19 -0
- data/docs/CompleteSelfServiceSettingsFlowWithPasswordMethod.md +19 -0
- data/docs/CompleteSelfServiceVerificationFlowWithLinkMethod.md +19 -0
- data/docs/CreateIdentity.md +19 -0
- data/docs/CreateRecoveryLink.md +19 -0
- data/docs/ErrorContainer.md +2 -2
- data/docs/Identity.md +1 -1
- data/docs/LoginFlow.md +33 -0
- data/docs/LoginFlowMethod.md +19 -0
- data/docs/LoginFlowMethodConfig.md +25 -0
- data/docs/LoginViaApiResponse.md +19 -0
- data/docs/Message.md +1 -1
- data/docs/PublicApi.md +589 -197
- data/docs/RecoveryFlow.md +33 -0
- data/docs/RecoveryFlowMethod.md +19 -0
- data/docs/RecoveryFlowMethodConfig.md +23 -0
- data/docs/RecoveryLink.md +19 -0
- data/docs/RegistrationFlow.md +31 -0
- data/docs/RegistrationFlowMethod.md +19 -0
- data/docs/RegistrationFlowMethodConfig.md +25 -0
- data/docs/RegistrationViaApiResponse.md +21 -0
- data/docs/RevokeSession.md +17 -0
- data/docs/Session.md +6 -4
- data/docs/SettingsFlow.md +35 -0
- data/docs/SettingsFlowMethod.md +19 -0
- data/docs/SettingsFlowMethodConfig.md +23 -0
- data/docs/SettingsViaApiResponse.md +19 -0
- data/docs/UpdateIdentity.md +19 -0
- data/docs/VerifiableAddress.md +3 -3
- data/docs/VerificationFlow.md +33 -0
- data/docs/VerificationFlowMethod.md +19 -0
- data/docs/VerificationFlowMethodConfig.md +23 -0
- data/lib/ory-kratos-client.rb +28 -17
- data/lib/ory-kratos-client/api/admin_api.rb +277 -149
- data/lib/ory-kratos-client/api/health_api.rb +1 -1
- data/lib/ory-kratos-client/api/public_api.rb +713 -297
- data/lib/ory-kratos-client/api/version_api.rb +1 -1
- data/lib/ory-kratos-client/api_client.rb +2 -1
- data/lib/ory-kratos-client/api_error.rb +1 -1
- data/lib/ory-kratos-client/configuration.rb +8 -1
- data/lib/ory-kratos-client/models/complete_self_service_login_flow_with_password_method.rb +227 -0
- data/lib/ory-kratos-client/models/complete_self_service_recovery_flow_with_link_method.rb +217 -0
- data/lib/ory-kratos-client/models/complete_self_service_settings_flow_with_password_method.rb +222 -0
- data/lib/ory-kratos-client/models/complete_self_service_verification_flow_with_link_method.rb +217 -0
- data/lib/ory-kratos-client/models/create_identity.rb +227 -0
- data/lib/ory-kratos-client/models/create_recovery_link.rb +238 -0
- data/lib/ory-kratos-client/models/error_container.rb +12 -1
- data/lib/ory-kratos-client/models/form_field.rb +1 -1
- data/lib/ory-kratos-client/models/generic_error.rb +1 -1
- data/lib/ory-kratos-client/models/generic_error_payload.rb +1 -1
- data/lib/ory-kratos-client/models/health_not_ready_status.rb +1 -1
- data/lib/ory-kratos-client/models/health_status.rb +1 -1
- data/lib/ory-kratos-client/models/identity.rb +6 -1
- data/lib/ory-kratos-client/models/login_flow.rb +315 -0
- data/lib/ory-kratos-client/models/login_flow_method.rb +226 -0
- data/lib/ory-kratos-client/models/login_flow_method_config.rb +267 -0
- data/lib/ory-kratos-client/models/login_via_api_response.rb +227 -0
- data/lib/ory-kratos-client/models/message.rb +2 -1
- data/lib/ory-kratos-client/models/recovery_address.rb +1 -1
- data/lib/ory-kratos-client/models/recovery_flow.rb +319 -0
- data/lib/ory-kratos-client/models/recovery_flow_method.rb +226 -0
- data/lib/ory-kratos-client/models/recovery_flow_method_config.rb +255 -0
- data/lib/ory-kratos-client/models/recovery_link.rb +222 -0
- data/lib/ory-kratos-client/models/registration_flow.rb +304 -0
- data/lib/ory-kratos-client/models/registration_flow_method.rb +226 -0
- data/lib/ory-kratos-client/models/registration_flow_method_config.rb +267 -0
- data/lib/ory-kratos-client/models/registration_via_api_response.rb +236 -0
- data/lib/ory-kratos-client/models/revoke_session.rb +212 -0
- data/lib/ory-kratos-client/models/session.rb +28 -19
- data/lib/ory-kratos-client/models/settings_flow.rb +333 -0
- data/lib/ory-kratos-client/models/settings_flow_method.rb +226 -0
- data/lib/ory-kratos-client/models/settings_flow_method_config.rb +255 -0
- data/lib/ory-kratos-client/models/settings_via_api_response.rb +226 -0
- data/lib/ory-kratos-client/models/update_identity.rb +222 -0
- data/lib/ory-kratos-client/models/verifiable_address.rb +16 -16
- data/lib/ory-kratos-client/models/verification_flow.rb +299 -0
- data/lib/ory-kratos-client/models/verification_flow_method.rb +226 -0
- data/lib/ory-kratos-client/models/verification_flow_method_config.rb +255 -0
- data/lib/ory-kratos-client/models/version.rb +1 -1
- data/lib/ory-kratos-client/version.rb +2 -2
- data/ory-kratos-client.gemspec +1 -1
- data/spec/models/complete_self_service_login_flow_with_password_method_spec.rb +53 -0
- data/spec/models/complete_self_service_recovery_flow_with_link_method_spec.rb +47 -0
- data/spec/models/complete_self_service_settings_flow_with_password_method_spec.rb +47 -0
- data/spec/models/complete_self_service_verification_flow_with_link_method_spec.rb +47 -0
- data/spec/models/create_identity_spec.rb +47 -0
- data/spec/models/create_recovery_link_spec.rb +47 -0
- data/spec/models/login_flow_method_config_spec.rb +65 -0
- data/spec/models/login_flow_method_spec.rb +47 -0
- data/spec/models/login_flow_spec.rb +89 -0
- data/spec/models/login_via_api_response_spec.rb +47 -0
- data/spec/models/recovery_flow_method_config_spec.rb +59 -0
- data/spec/models/recovery_flow_method_spec.rb +47 -0
- data/spec/models/recovery_flow_spec.rb +89 -0
- data/spec/models/recovery_link_spec.rb +47 -0
- data/spec/models/registration_flow_method_config_spec.rb +65 -0
- data/spec/models/registration_flow_method_spec.rb +47 -0
- data/spec/models/registration_flow_spec.rb +83 -0
- data/spec/models/registration_via_api_response_spec.rb +53 -0
- data/spec/models/revoke_session_spec.rb +41 -0
- data/spec/models/settings_flow_method_config_spec.rb +59 -0
- data/spec/models/settings_flow_method_spec.rb +47 -0
- data/spec/models/settings_flow_spec.rb +95 -0
- data/spec/models/settings_via_api_response_spec.rb +47 -0
- data/spec/models/update_identity_spec.rb +47 -0
- data/spec/models/verification_flow_method_config_spec.rb +59 -0
- data/spec/models/verification_flow_method_spec.rb +47 -0
- data/spec/models/verification_flow_spec.rb +89 -0
- metadata +137 -29
@@ -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
|
+
|
data/lib/ory-kratos-client.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Welcome to the ORY Kratos HTTP API documentation!
|
5
5
|
|
6
|
-
The version of the OpenAPI document: v0.4
|
6
|
+
The version of the OpenAPI document: v0.5.4-alpha.1
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.3.1
|
@@ -17,37 +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/
|
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'
|
21
26
|
require 'ory-kratos-client/models/error_container'
|
22
|
-
require 'ory-kratos-client/models/form'
|
23
27
|
require 'ory-kratos-client/models/form_field'
|
24
28
|
require 'ory-kratos-client/models/generic_error'
|
25
29
|
require 'ory-kratos-client/models/generic_error_payload'
|
26
30
|
require 'ory-kratos-client/models/health_not_ready_status'
|
27
31
|
require 'ory-kratos-client/models/health_status'
|
28
32
|
require 'ory-kratos-client/models/identity'
|
29
|
-
require 'ory-kratos-client/models/
|
30
|
-
require 'ory-kratos-client/models/
|
31
|
-
require 'ory-kratos-client/models/
|
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'
|
32
37
|
require 'ory-kratos-client/models/message'
|
33
|
-
require 'ory-kratos-client/models/provider_credentials_config'
|
34
38
|
require 'ory-kratos-client/models/recovery_address'
|
35
|
-
require 'ory-kratos-client/models/
|
36
|
-
require 'ory-kratos-client/models/
|
37
|
-
require 'ory-kratos-client/models/
|
38
|
-
require 'ory-kratos-client/models/
|
39
|
-
require 'ory-kratos-client/models/
|
40
|
-
require 'ory-kratos-client/models/
|
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'
|
41
48
|
require 'ory-kratos-client/models/session'
|
42
|
-
require 'ory-kratos-client/models/
|
43
|
-
require 'ory-kratos-client/models/
|
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'
|
44
54
|
require 'ory-kratos-client/models/verifiable_address'
|
45
|
-
require 'ory-kratos-client/models/
|
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'
|
46
58
|
require 'ory-kratos-client/models/version'
|
47
59
|
|
48
60
|
# APIs
|
49
61
|
require 'ory-kratos-client/api/admin_api'
|
50
|
-
require 'ory-kratos-client/api/common_api'
|
51
62
|
require 'ory-kratos-client/api/health_api'
|
52
63
|
require 'ory-kratos-client/api/public_api'
|
53
64
|
require 'ory-kratos-client/api/version_api'
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Welcome to the ORY Kratos HTTP API documentation!
|
5
5
|
|
6
|
-
The version of the OpenAPI document: v0.4
|
6
|
+
The version of the OpenAPI document: v0.5.4-alpha.1
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.3.1
|
@@ -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
|
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(
|
28
|
-
data, _status_code, _headers = create_identity_with_http_info(
|
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
|
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(
|
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
|
-
#
|
87
|
-
# This endpoint
|
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'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
|
97
|
-
#
|
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' 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'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
|
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
|
214
|
+
# Get an Identity
|
159
215
|
# Learn how identities work in [ORY Kratos' 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
|
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
|
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
|
271
|
-
# This endpoint returns
|
272
|
-
# @param
|
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's ID
|
273
329
|
# @param [Hash] opts the optional parameters
|
274
|
-
# @return [
|
275
|
-
def
|
276
|
-
data, _status_code, _headers =
|
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
|
281
|
-
# This endpoint returns
|
282
|
-
# @param
|
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: `?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).
|
338
|
+
# @param error [String] Error is the container's ID
|
283
339
|
# @param [Hash] opts the optional parameters
|
284
|
-
# @return [Array<(
|
285
|
-
def
|
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.
|
343
|
+
@api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_error ...'
|
288
344
|
end
|
289
|
-
# verify the required parameter '
|
290
|
-
if @api_client.config.client_side_validation &&
|
291
|
-
fail ArgumentError, "Missing the required parameter '
|
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/
|
350
|
+
local_var_path = '/self-service/errors'
|
295
351
|
|
296
352
|
# query parameters
|
297
353
|
query_params = opts[:query_params] || {}
|
298
|
-
query_params[:'
|
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] || '
|
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#
|
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
|
334
|
-
#
|
335
|
-
# @param
|
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 `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`).
|
336
392
|
# @param [Hash] opts the optional parameters
|
337
|
-
# @return [
|
338
|
-
def
|
339
|
-
data, _status_code, _headers =
|
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
|
344
|
-
#
|
345
|
-
# @param
|
399
|
+
# Get Login Flow
|
400
|
+
# 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).
|
401
|
+
# @param id [String] The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`).
|
346
402
|
# @param [Hash] opts the optional parameters
|
347
|
-
# @return [Array<(
|
348
|
-
def
|
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.
|
406
|
+
@api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_login_flow ...'
|
351
407
|
end
|
352
|
-
# verify the required parameter '
|
353
|
-
if @api_client.config.client_side_validation &&
|
354
|
-
fail ArgumentError, "Missing the required parameter '
|
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/
|
413
|
+
local_var_path = '/self-service/login/flows'
|
358
414
|
|
359
415
|
# query parameters
|
360
416
|
query_params = opts[:query_params] || {}
|
361
|
-
query_params[:'
|
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] || '
|
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#
|
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
|
397
|
-
# This endpoint returns a
|
398
|
-
# @param
|
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 `request` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`).
|
399
455
|
# @param [Hash] opts the optional parameters
|
400
|
-
# @return [
|
401
|
-
def
|
402
|
-
data, _status_code, _headers =
|
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
|
407
|
-
# This endpoint returns a
|
408
|
-
# @param
|
462
|
+
# Get information about a recovery flow
|
463
|
+
# 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).
|
464
|
+
# @param id [String] The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`).
|
409
465
|
# @param [Hash] opts the optional parameters
|
410
|
-
# @return [Array<(
|
411
|
-
def
|
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.
|
469
|
+
@api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_recovery_flow ...'
|
414
470
|
end
|
415
|
-
# verify the required parameter '
|
416
|
-
if @api_client.config.client_side_validation &&
|
417
|
-
fail ArgumentError, "Missing the required parameter '
|
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/
|
476
|
+
local_var_path = '/self-service/recovery/flows'
|
421
477
|
|
422
478
|
# query parameters
|
423
479
|
query_params = opts[:query_params] || {}
|
424
|
-
query_params[:'
|
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] || '
|
494
|
+
return_type = opts[:return_type] || 'RecoveryFlow'
|
439
495
|
|
440
496
|
# auth_names
|
441
497
|
auth_names = opts[:auth_names] || []
|
@@ -451,40 +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#
|
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
|
460
|
-
#
|
461
|
-
# @param
|
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 `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`).
|
462
518
|
# @param [Hash] opts the optional parameters
|
463
|
-
# @return [
|
464
|
-
def
|
465
|
-
data, _status_code, _headers =
|
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
|
470
|
-
#
|
471
|
-
# @param
|
525
|
+
# Get Registration Flow
|
526
|
+
# 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).
|
527
|
+
# @param id [String] The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`).
|
472
528
|
# @param [Hash] opts the optional parameters
|
473
|
-
# @return [Array<(
|
474
|
-
def
|
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.
|
532
|
+
@api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_registration_flow ...'
|
477
533
|
end
|
478
|
-
# verify the required parameter '
|
479
|
-
if @api_client.config.client_side_validation &&
|
480
|
-
fail ArgumentError, "Missing the required parameter '
|
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"
|
481
537
|
end
|
482
538
|
# resource path
|
483
|
-
local_var_path = '/self-service/
|
539
|
+
local_var_path = '/self-service/registration/flows'
|
484
540
|
|
485
541
|
# query parameters
|
486
542
|
query_params = opts[:query_params] || {}
|
487
|
-
query_params[:'
|
543
|
+
query_params[:'id'] = id
|
488
544
|
|
489
545
|
# header parameters
|
490
546
|
header_params = opts[:header_params] || {}
|
@@ -498,7 +554,7 @@ module OryHydraClient
|
|
498
554
|
post_body = opts[:body]
|
499
555
|
|
500
556
|
# return_type
|
501
|
-
return_type = opts[:return_type] || '
|
557
|
+
return_type = opts[:return_type] || 'RegistrationFlow'
|
502
558
|
|
503
559
|
# auth_names
|
504
560
|
auth_names = opts[:auth_names] || []
|
@@ -514,36 +570,40 @@ module OryHydraClient
|
|
514
570
|
|
515
571
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
516
572
|
if @api_client.config.debugging
|
517
|
-
@api_client.config.logger.debug "API called: AdminApi#
|
573
|
+
@api_client.config.logger.debug "API called: AdminApi#get_self_service_registration_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
518
574
|
end
|
519
575
|
return data, status_code, headers
|
520
576
|
end
|
521
577
|
|
522
|
-
# Get
|
523
|
-
#
|
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 `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`).
|
524
581
|
# @param [Hash] opts the optional parameters
|
525
|
-
# @
|
526
|
-
|
527
|
-
|
528
|
-
data, _status_code, _headers = get_self_service_error_with_http_info(opts)
|
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)
|
529
585
|
data
|
530
586
|
end
|
531
587
|
|
532
|
-
# Get
|
533
|
-
#
|
588
|
+
# Get Settings Flow
|
589
|
+
# 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).
|
590
|
+
# @param id [String] ID is the Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`).
|
534
591
|
# @param [Hash] opts the optional parameters
|
535
|
-
# @
|
536
|
-
|
537
|
-
def get_self_service_error_with_http_info(opts = {})
|
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 = {})
|
538
594
|
if @api_client.config.debugging
|
539
|
-
@api_client.config.logger.debug 'Calling API: AdminApi.
|
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"
|
540
600
|
end
|
541
601
|
# resource path
|
542
|
-
local_var_path = '/self-service/
|
602
|
+
local_var_path = '/self-service/settings/flows'
|
543
603
|
|
544
604
|
# query parameters
|
545
605
|
query_params = opts[:query_params] || {}
|
546
|
-
query_params[:'
|
606
|
+
query_params[:'id'] = id
|
547
607
|
|
548
608
|
# header parameters
|
549
609
|
header_params = opts[:header_params] || {}
|
@@ -557,10 +617,10 @@ module OryHydraClient
|
|
557
617
|
post_body = opts[:body]
|
558
618
|
|
559
619
|
# return_type
|
560
|
-
return_type = opts[:return_type] || '
|
620
|
+
return_type = opts[:return_type] || 'SettingsFlow'
|
561
621
|
|
562
622
|
# auth_names
|
563
|
-
auth_names = opts[:auth_names] || []
|
623
|
+
auth_names = opts[:auth_names] || ['sessionToken']
|
564
624
|
|
565
625
|
new_options = opts.merge(
|
566
626
|
:header_params => header_params,
|
@@ -573,40 +633,40 @@ module OryHydraClient
|
|
573
633
|
|
574
634
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
575
635
|
if @api_client.config.debugging
|
576
|
-
@api_client.config.logger.debug "API called: AdminApi#
|
636
|
+
@api_client.config.logger.debug "API called: AdminApi#get_self_service_settings_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
577
637
|
end
|
578
638
|
return data, status_code, headers
|
579
639
|
end
|
580
640
|
|
581
|
-
# Get
|
582
|
-
#
|
583
|
-
# @param
|
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 `request` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`).
|
584
644
|
# @param [Hash] opts the optional parameters
|
585
|
-
# @return [
|
586
|
-
def
|
587
|
-
data, _status_code, _headers =
|
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)
|
588
648
|
data
|
589
649
|
end
|
590
650
|
|
591
|
-
# Get
|
592
|
-
#
|
593
|
-
# @param
|
651
|
+
# Get Verification Flow
|
652
|
+
# 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).
|
653
|
+
# @param id [String] The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`).
|
594
654
|
# @param [Hash] opts the optional parameters
|
595
|
-
# @return [Array<(
|
596
|
-
def
|
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 = {})
|
597
657
|
if @api_client.config.debugging
|
598
|
-
@api_client.config.logger.debug 'Calling API: AdminApi.
|
658
|
+
@api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_verification_flow ...'
|
599
659
|
end
|
600
|
-
# verify the required parameter '
|
601
|
-
if @api_client.config.client_side_validation &&
|
602
|
-
fail ArgumentError, "Missing the required parameter '
|
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"
|
603
663
|
end
|
604
664
|
# resource path
|
605
|
-
local_var_path = '/self-service/
|
665
|
+
local_var_path = '/self-service/verification/flows'
|
606
666
|
|
607
667
|
# query parameters
|
608
668
|
query_params = opts[:query_params] || {}
|
609
|
-
query_params[:'
|
669
|
+
query_params[:'id'] = id
|
610
670
|
|
611
671
|
# header parameters
|
612
672
|
header_params = opts[:header_params] || {}
|
@@ -620,7 +680,7 @@ module OryHydraClient
|
|
620
680
|
post_body = opts[:body]
|
621
681
|
|
622
682
|
# return_type
|
623
|
-
return_type = opts[:return_type] || '
|
683
|
+
return_type = opts[:return_type] || 'VerificationFlow'
|
624
684
|
|
625
685
|
# auth_names
|
626
686
|
auth_names = opts[:auth_names] || []
|
@@ -636,33 +696,51 @@ module OryHydraClient
|
|
636
696
|
|
637
697
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
638
698
|
if @api_client.config.debugging
|
639
|
-
@api_client.config.logger.debug "API called: AdminApi#
|
699
|
+
@api_client.config.logger.debug "API called: AdminApi#get_self_service_verification_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
640
700
|
end
|
641
701
|
return data, status_code, headers
|
642
702
|
end
|
643
703
|
|
644
|
-
# List
|
645
|
-
#
|
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).
|
646
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)
|
647
709
|
# @return [Array<Identity>]
|
648
710
|
def list_identities(opts = {})
|
649
711
|
data, _status_code, _headers = list_identities_with_http_info(opts)
|
650
712
|
data
|
651
713
|
end
|
652
714
|
|
653
|
-
# List
|
654
|
-
#
|
715
|
+
# List Identities
|
716
|
+
# 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).
|
655
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
|
656
720
|
# @return [Array<(Array<Identity>, Integer, Hash)>] Array<Identity> data, response status code and response headers
|
657
721
|
def list_identities_with_http_info(opts = {})
|
658
722
|
if @api_client.config.debugging
|
659
723
|
@api_client.config.logger.debug 'Calling API: AdminApi.list_identities ...'
|
660
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
|
+
|
661
737
|
# resource path
|
662
738
|
local_var_path = '/identities'
|
663
739
|
|
664
740
|
# query parameters
|
665
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?
|
666
744
|
|
667
745
|
# header parameters
|
668
746
|
header_params = opts[:header_params] || {}
|
@@ -697,24 +775,78 @@ module OryHydraClient
|
|
697
775
|
return data, status_code, headers
|
698
776
|
end
|
699
777
|
|
700
|
-
#
|
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're using k8s, you can then add annotations to your deployment like so:
|
788
|
+
# ``` metadata: annotations: prometheus.io/port: \"4434\" prometheus.io/path: \"/metrics/prometheus\" ```
|
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
|
701
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).
|
702
834
|
# @param id [String] ID must be set to the ID of identity you want to update
|
703
|
-
# @param body [Identity]
|
704
835
|
# @param [Hash] opts the optional parameters
|
836
|
+
# @option opts [UpdateIdentity] :body
|
705
837
|
# @return [Identity]
|
706
|
-
def update_identity(id,
|
707
|
-
data, _status_code, _headers = update_identity_with_http_info(id,
|
838
|
+
def update_identity(id, opts = {})
|
839
|
+
data, _status_code, _headers = update_identity_with_http_info(id, opts)
|
708
840
|
data
|
709
841
|
end
|
710
842
|
|
711
|
-
# Update an
|
843
|
+
# Update an Identity
|
712
844
|
# 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).
|
713
845
|
# @param id [String] ID must be set to the ID of identity you want to update
|
714
|
-
# @param body [Identity]
|
715
846
|
# @param [Hash] opts the optional parameters
|
847
|
+
# @option opts [UpdateIdentity] :body
|
716
848
|
# @return [Array<(Identity, Integer, Hash)>] Identity data, response status code and response headers
|
717
|
-
def update_identity_with_http_info(id,
|
849
|
+
def update_identity_with_http_info(id, opts = {})
|
718
850
|
if @api_client.config.debugging
|
719
851
|
@api_client.config.logger.debug 'Calling API: AdminApi.update_identity ...'
|
720
852
|
end
|
@@ -722,10 +854,6 @@ module OryHydraClient
|
|
722
854
|
if @api_client.config.client_side_validation && id.nil?
|
723
855
|
fail ArgumentError, "Missing the required parameter 'id' when calling AdminApi.update_identity"
|
724
856
|
end
|
725
|
-
# verify the required parameter 'body' is set
|
726
|
-
if @api_client.config.client_side_validation && body.nil?
|
727
|
-
fail ArgumentError, "Missing the required parameter 'body' when calling AdminApi.update_identity"
|
728
|
-
end
|
729
857
|
# resource path
|
730
858
|
local_var_path = '/identities/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
731
859
|
|
@@ -743,7 +871,7 @@ module OryHydraClient
|
|
743
871
|
form_params = opts[:form_params] || {}
|
744
872
|
|
745
873
|
# http body (model)
|
746
|
-
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
874
|
+
post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])
|
747
875
|
|
748
876
|
# return_type
|
749
877
|
return_type = opts[:return_type] || 'Identity'
|