ory-kratos-client 0.2.1.alpha1 → 0.5.2.alpha1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/README.md +84 -52
- data/docs/AdminApi.md +244 -86
- data/docs/CommonApi.md +54 -6
- 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/Form.md +2 -2
- data/docs/FormField.md +4 -4
- data/docs/GenericErrorPayload.md +1 -1
- data/docs/Identity.md +9 -7
- data/docs/LoginFlow.md +33 -0
- data/docs/LoginFlowMethod.md +19 -0
- data/docs/LoginFlowMethodConfig.md +25 -0
- data/docs/LoginRequest.md +2 -0
- data/docs/LoginRequestMethodConfig.md +2 -2
- data/docs/LoginViaApiResponse.md +19 -0
- data/docs/Message.md +23 -0
- data/docs/ProviderCredentialsConfig.md +19 -0
- data/docs/PublicApi.md +726 -151
- data/docs/RecoveryAddress.md +21 -0
- 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/RecoveryRequest.md +31 -0
- data/docs/RecoveryRequestMethod.md +19 -0
- data/docs/RegistrationFlow.md +31 -0
- data/docs/RegistrationFlowMethod.md +19 -0
- data/docs/RegistrationFlowMethodConfig.md +25 -0
- data/docs/RegistrationRequest.md +3 -1
- data/docs/RegistrationRequestMethodConfig.md +2 -2
- data/docs/RegistrationViaApiResponse.md +21 -0
- data/docs/RequestMethodConfig.md +2 -2
- 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/SettingsRequest.md +4 -2
- 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/docs/VerificationRequest.md +2 -0
- data/lib/ory-kratos-client.rb +31 -16
- data/lib/ory-kratos-client/api/admin_api.rb +321 -130
- data/lib/ory-kratos-client/api/common_api.rb +75 -12
- data/lib/ory-kratos-client/api/health_api.rb +2 -2
- data/lib/ory-kratos-client/api/public_api.rb +896 -246
- data/lib/ory-kratos-client/api/version_api.rb +2 -2
- data/lib/ory-kratos-client/api_client.rb +10 -7
- data/lib/ory-kratos-client/api_error.rb +2 -2
- data/lib/ory-kratos-client/configuration.rb +9 -2
- data/lib/ory-kratos-client/models/complete_self_service_browser_settings_strategy_profile_flow_payload.rb +2 -2
- 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 +13 -2
- data/lib/ory-kratos-client/models/form.rb +14 -15
- data/lib/ory-kratos-client/models/form_field.rb +11 -17
- data/lib/ory-kratos-client/models/generic_error.rb +2 -2
- data/lib/ory-kratos-client/models/generic_error_payload.rb +4 -6
- data/lib/ory-kratos-client/models/health_not_ready_status.rb +2 -2
- data/lib/ory-kratos-client/models/health_status.rb +2 -2
- data/lib/ory-kratos-client/models/identity.rb +53 -35
- 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_request.rb +14 -3
- data/lib/ory-kratos-client/models/login_request_method.rb +2 -2
- data/lib/ory-kratos-client/models/login_request_method_config.rb +14 -15
- data/lib/ory-kratos-client/models/login_via_api_response.rb +227 -0
- data/lib/ory-kratos-client/models/message.rb +234 -0
- data/lib/ory-kratos-client/models/provider_credentials_config.rb +215 -0
- data/lib/ory-kratos-client/models/recovery_address.rb +239 -0
- 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/recovery_request.rb +309 -0
- data/lib/ory-kratos-client/models/recovery_request_method.rb +216 -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_request.rb +14 -8
- data/lib/ory-kratos-client/models/registration_request_method.rb +2 -2
- data/lib/ory-kratos-client/models/registration_request_method_config.rb +14 -15
- data/lib/ory-kratos-client/models/registration_via_api_response.rb +236 -0
- data/lib/ory-kratos-client/models/request_method_config.rb +14 -15
- data/lib/ory-kratos-client/models/revoke_session.rb +212 -0
- data/lib/ory-kratos-client/models/session.rb +29 -20
- 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_request.rb +24 -14
- data/lib/ory-kratos-client/models/settings_request_method.rb +2 -2
- 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 +17 -17
- 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/verification_request.rb +14 -3
- data/lib/ory-kratos-client/models/version.rb +2 -2
- data/lib/ory-kratos-client/version.rb +3 -3
- data/ory-kratos-client.gemspec +2 -2
- 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/message_spec.rb +59 -0
- data/spec/models/provider_credentials_config_spec.rb +47 -0
- data/spec/models/recovery_address_spec.rb +53 -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/recovery_request_method_spec.rb +47 -0
- data/spec/models/recovery_request_spec.rb +83 -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 +150 -22
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9409f829ff0852ad2ce1c1cd8d89bce1d8f0ae38f35c3dfe1582e3b296728fc0
|
4
|
+
data.tar.gz: 12a18c1fb0c7d6254634e39fe23ae51bf2b9e9acb79bdc4643476f2048b79a25
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 81d0322c8868a4f19de26997cc6d62ef28ec57d530df34ea4821213fd711decb1c9722cc04a69396b377eed84019ea41927acd7dae4713d9fabeb9f239d879c8
|
7
|
+
data.tar.gz: c7cbd9e0ca58e6ef3a5a8754216df67f57d398e7f7dcacf93a5ae476f38fccf742ce02c69108be8bebe33985c36bb37a93049dcbd155f09dab4c75b1be275d01
|
data/Gemfile
CHANGED
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:
|
10
|
-
- Package version: v0.2
|
9
|
+
- API version: v0.5.2-alpha.1
|
10
|
+
- Package version: v0.5.2-alpha.1
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,16 +23,16 @@ gem build ory-kratos-client.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./ory-kratos-client-v0.2
|
26
|
+
gem install ./ory-kratos-client-v0.5.2-alpha.1.gem
|
27
27
|
```
|
28
28
|
|
29
|
-
(for development, run `gem install --dev ./ory-kratos-client-v0.2
|
29
|
+
(for development, run `gem install --dev ./ory-kratos-client-v0.5.2-alpha.1.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'ory-kratos-client', '~> v0.2
|
35
|
+
gem 'ory-kratos-client', '~> v0.5.2-alpha.1'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -57,11 +57,13 @@ Please follow the [installation](#installation) procedure and then run the follo
|
|
57
57
|
require 'ory-kratos-client'
|
58
58
|
|
59
59
|
api_instance = OryHydraClient::AdminApi.new
|
60
|
-
|
60
|
+
opts = {
|
61
|
+
body: OryHydraClient::CreateIdentity.new # CreateIdentity |
|
62
|
+
}
|
61
63
|
|
62
64
|
begin
|
63
|
-
#Create an
|
64
|
-
result = api_instance.create_identity(
|
65
|
+
#Create an Identity
|
66
|
+
result = api_instance.create_identity(opts)
|
65
67
|
p result
|
66
68
|
rescue OryHydraClient::ApiError => e
|
67
69
|
puts "Exception when calling AdminApi->create_identity: #{e}"
|
@@ -75,72 +77,102 @@ All URIs are relative to *http://localhost*
|
|
75
77
|
|
76
78
|
Class | Method | HTTP request | Description
|
77
79
|
------------ | ------------- | ------------- | -------------
|
78
|
-
*OryHydraClient::AdminApi* | [**create_identity**](docs/AdminApi.md#create_identity) | **POST** /identities | Create an
|
79
|
-
*OryHydraClient::AdminApi* | [**
|
80
|
-
*OryHydraClient::AdminApi* | [**
|
80
|
+
*OryHydraClient::AdminApi* | [**create_identity**](docs/AdminApi.md#create_identity) | **POST** /identities | Create an Identity
|
81
|
+
*OryHydraClient::AdminApi* | [**create_recovery_link**](docs/AdminApi.md#create_recovery_link) | **POST** /recovery/link | Create a Recovery Link
|
82
|
+
*OryHydraClient::AdminApi* | [**delete_identity**](docs/AdminApi.md#delete_identity) | **DELETE** /identities/{id} | Delete an Identity
|
83
|
+
*OryHydraClient::AdminApi* | [**get_identity**](docs/AdminApi.md#get_identity) | **GET** /identities/{id} | Get an Identity
|
81
84
|
*OryHydraClient::AdminApi* | [**get_schema**](docs/AdminApi.md#get_schema) | **GET** /schemas/{id} |
|
82
|
-
*OryHydraClient::AdminApi* | [**
|
83
|
-
*OryHydraClient::AdminApi* | [**
|
84
|
-
*OryHydraClient::AdminApi* | [**
|
85
|
-
*OryHydraClient::AdminApi* | [**
|
86
|
-
*OryHydraClient::AdminApi* | [**
|
87
|
-
*OryHydraClient::AdminApi* | [**
|
88
|
-
*OryHydraClient::AdminApi* | [**
|
89
|
-
*OryHydraClient::
|
90
|
-
*OryHydraClient::
|
91
|
-
*OryHydraClient::CommonApi* | [**get_self_service_browser_registration_request**](docs/CommonApi.md#get_self_service_browser_registration_request) | **GET** /self-service/browser/flows/requests/registration | Get the request context of browser-based registration user flows
|
92
|
-
*OryHydraClient::CommonApi* | [**get_self_service_browser_settings_request**](docs/CommonApi.md#get_self_service_browser_settings_request) | **GET** /self-service/browser/flows/requests/settings | Get the request context of browser-based settings flows
|
93
|
-
*OryHydraClient::CommonApi* | [**get_self_service_error**](docs/CommonApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
|
94
|
-
*OryHydraClient::CommonApi* | [**get_self_service_verification_request**](docs/CommonApi.md#get_self_service_verification_request) | **GET** /self-service/browser/flows/requests/verification | Get the request context of browser-based verification flows
|
85
|
+
*OryHydraClient::AdminApi* | [**get_self_service_error**](docs/AdminApi.md#get_self_service_error) | **GET** /self-service/errors | Get User-Facing Self-Service Errors
|
86
|
+
*OryHydraClient::AdminApi* | [**get_self_service_login_flow**](docs/AdminApi.md#get_self_service_login_flow) | **GET** /self-service/login/flows | Get Login Flow
|
87
|
+
*OryHydraClient::AdminApi* | [**get_self_service_recovery_flow**](docs/AdminApi.md#get_self_service_recovery_flow) | **GET** /self-service/recovery/flows | Get information about a recovery flow
|
88
|
+
*OryHydraClient::AdminApi* | [**get_self_service_registration_flow**](docs/AdminApi.md#get_self_service_registration_flow) | **GET** /self-service/registration/flows | Get Registration Flow
|
89
|
+
*OryHydraClient::AdminApi* | [**get_self_service_settings_flow**](docs/AdminApi.md#get_self_service_settings_flow) | **GET** /self-service/settings/flows | Get Settings Flow
|
90
|
+
*OryHydraClient::AdminApi* | [**get_self_service_verification_flow**](docs/AdminApi.md#get_self_service_verification_flow) | **GET** /self-service/verification/flows | Get Verification Flow
|
91
|
+
*OryHydraClient::AdminApi* | [**list_identities**](docs/AdminApi.md#list_identities) | **GET** /identities | List Identities
|
92
|
+
*OryHydraClient::AdminApi* | [**prometheus**](docs/AdminApi.md#prometheus) | **GET** /metrics/prometheus | Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
|
93
|
+
*OryHydraClient::AdminApi* | [**update_identity**](docs/AdminApi.md#update_identity) | **PUT** /identities/{id} | Update an Identity
|
95
94
|
*OryHydraClient::HealthApi* | [**is_instance_alive**](docs/HealthApi.md#is_instance_alive) | **GET** /health/alive | Check alive status
|
96
95
|
*OryHydraClient::HealthApi* | [**is_instance_ready**](docs/HealthApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status
|
97
|
-
*OryHydraClient::PublicApi* | [**
|
98
|
-
*OryHydraClient::PublicApi* | [**
|
99
|
-
*OryHydraClient::PublicApi* | [**
|
96
|
+
*OryHydraClient::PublicApi* | [**complete_self_service_browser_settings_oidc_settings_flow**](docs/PublicApi.md#complete_self_service_browser_settings_oidc_settings_flow) | **POST** /self-service/browser/flows/registration/strategies/oidc/settings/connections | Complete the Browser-Based Settings Flow for the OpenID Connect Strategy
|
97
|
+
*OryHydraClient::PublicApi* | [**complete_self_service_login_flow_with_password_method**](docs/PublicApi.md#complete_self_service_login_flow_with_password_method) | **POST** /self-service/login/methods/password | Complete Login Flow with Username/Email Password Method
|
98
|
+
*OryHydraClient::PublicApi* | [**complete_self_service_recovery_flow_with_link_method**](docs/PublicApi.md#complete_self_service_recovery_flow_with_link_method) | **POST** /self-service/recovery/methods/link | Complete Recovery Flow with Link Method
|
99
|
+
*OryHydraClient::PublicApi* | [**complete_self_service_registration_flow_with_password_method**](docs/PublicApi.md#complete_self_service_registration_flow_with_password_method) | **POST** /self-service/registration/methods/password | Complete Registration Flow with Username/Email Password Method
|
100
|
+
*OryHydraClient::PublicApi* | [**complete_self_service_settings_flow_with_password_method**](docs/PublicApi.md#complete_self_service_settings_flow_with_password_method) | **POST** /self-service/settings/methods/password | Complete Settings Flow with Username/Email Password Method
|
101
|
+
*OryHydraClient::PublicApi* | [**complete_self_service_settings_flow_with_profile_method**](docs/PublicApi.md#complete_self_service_settings_flow_with_profile_method) | **POST** /self-service/settings/methods/profile | Complete Settings Flow with Profile Method
|
102
|
+
*OryHydraClient::PublicApi* | [**complete_self_service_verification_flow_with_link_method**](docs/PublicApi.md#complete_self_service_verification_flow_with_link_method) | **POST** /self-service/verification/methods/link | Complete Verification Flow with Link Method
|
100
103
|
*OryHydraClient::PublicApi* | [**get_schema**](docs/PublicApi.md#get_schema) | **GET** /schemas/{id} |
|
101
|
-
*OryHydraClient::PublicApi* | [**
|
102
|
-
*OryHydraClient::PublicApi* | [**
|
103
|
-
*OryHydraClient::PublicApi* | [**
|
104
|
-
*OryHydraClient::PublicApi* | [**
|
105
|
-
*OryHydraClient::PublicApi* | [**
|
106
|
-
*OryHydraClient::PublicApi* | [**
|
104
|
+
*OryHydraClient::PublicApi* | [**get_self_service_error**](docs/PublicApi.md#get_self_service_error) | **GET** /self-service/errors | Get User-Facing Self-Service Errors
|
105
|
+
*OryHydraClient::PublicApi* | [**get_self_service_login_flow**](docs/PublicApi.md#get_self_service_login_flow) | **GET** /self-service/login/flows | Get Login Flow
|
106
|
+
*OryHydraClient::PublicApi* | [**get_self_service_recovery_flow**](docs/PublicApi.md#get_self_service_recovery_flow) | **GET** /self-service/recovery/flows | Get information about a recovery flow
|
107
|
+
*OryHydraClient::PublicApi* | [**get_self_service_registration_flow**](docs/PublicApi.md#get_self_service_registration_flow) | **GET** /self-service/registration/flows | Get Registration Flow
|
108
|
+
*OryHydraClient::PublicApi* | [**get_self_service_settings_flow**](docs/PublicApi.md#get_self_service_settings_flow) | **GET** /self-service/settings/flows | Get Settings Flow
|
109
|
+
*OryHydraClient::PublicApi* | [**get_self_service_verification_flow**](docs/PublicApi.md#get_self_service_verification_flow) | **GET** /self-service/verification/flows | Get Verification Flow
|
107
110
|
*OryHydraClient::PublicApi* | [**initialize_self_service_browser_logout_flow**](docs/PublicApi.md#initialize_self_service_browser_logout_flow) | **GET** /self-service/browser/flows/logout | Initialize Browser-Based Logout User Flow
|
108
|
-
*OryHydraClient::PublicApi* | [**
|
109
|
-
*OryHydraClient::PublicApi* | [**
|
110
|
-
*OryHydraClient::PublicApi* | [**
|
111
|
-
*OryHydraClient::PublicApi* | [**
|
112
|
-
*OryHydraClient::PublicApi* | [**
|
111
|
+
*OryHydraClient::PublicApi* | [**initialize_self_service_login_via_api_flow**](docs/PublicApi.md#initialize_self_service_login_via_api_flow) | **GET** /self-service/login/api | Initialize Login Flow for API clients
|
112
|
+
*OryHydraClient::PublicApi* | [**initialize_self_service_login_via_browser_flow**](docs/PublicApi.md#initialize_self_service_login_via_browser_flow) | **GET** /self-service/login/browser | Initialize Login Flow for browsers
|
113
|
+
*OryHydraClient::PublicApi* | [**initialize_self_service_recovery_via_api_flow**](docs/PublicApi.md#initialize_self_service_recovery_via_api_flow) | **GET** /self-service/recovery/api | Initialize Recovery Flow for API Clients
|
114
|
+
*OryHydraClient::PublicApi* | [**initialize_self_service_recovery_via_browser_flow**](docs/PublicApi.md#initialize_self_service_recovery_via_browser_flow) | **GET** /self-service/recovery/browser | Initialize Recovery Flow for Browser Clients
|
115
|
+
*OryHydraClient::PublicApi* | [**initialize_self_service_registration_via_api_flow**](docs/PublicApi.md#initialize_self_service_registration_via_api_flow) | **GET** /self-service/registration/api | Initialize Registration Flow for API clients
|
116
|
+
*OryHydraClient::PublicApi* | [**initialize_self_service_registration_via_browser_flow**](docs/PublicApi.md#initialize_self_service_registration_via_browser_flow) | **GET** /self-service/registration/browser | Initialize Registration Flow for browsers
|
117
|
+
*OryHydraClient::PublicApi* | [**initialize_self_service_settings_via_api_flow**](docs/PublicApi.md#initialize_self_service_settings_via_api_flow) | **GET** /self-service/settings/api | Initialize Settings Flow for API Clients
|
118
|
+
*OryHydraClient::PublicApi* | [**initialize_self_service_settings_via_browser_flow**](docs/PublicApi.md#initialize_self_service_settings_via_browser_flow) | **GET** /self-service/settings/browser/flows | Initialize Settings Flow for Browsers
|
119
|
+
*OryHydraClient::PublicApi* | [**initialize_self_service_verification_via_api_flow**](docs/PublicApi.md#initialize_self_service_verification_via_api_flow) | **GET** /self-service/verification/api | Initialize Verification Flow for API Clients
|
120
|
+
*OryHydraClient::PublicApi* | [**initialize_self_service_verification_via_browser_flow**](docs/PublicApi.md#initialize_self_service_verification_via_browser_flow) | **GET** /self-service/verification/browser | Initialize Verification Flow for Browser Clients
|
121
|
+
*OryHydraClient::PublicApi* | [**revoke_session**](docs/PublicApi.md#revoke_session) | **DELETE** /sessions | Revoke and Invalidate a Session
|
122
|
+
*OryHydraClient::PublicApi* | [**whoami**](docs/PublicApi.md#whoami) | **GET** /sessions/whoami | Check Who the Current HTTP Session Belongs To
|
113
123
|
*OryHydraClient::VersionApi* | [**get_version**](docs/VersionApi.md#get_version) | **GET** /version | Get service version
|
114
124
|
|
115
125
|
|
116
126
|
## Documentation for Models
|
117
127
|
|
118
|
-
- [OryHydraClient::
|
119
|
-
- [OryHydraClient::
|
128
|
+
- [OryHydraClient::CompleteSelfServiceLoginFlowWithPasswordMethod](docs/CompleteSelfServiceLoginFlowWithPasswordMethod.md)
|
129
|
+
- [OryHydraClient::CompleteSelfServiceRecoveryFlowWithLinkMethod](docs/CompleteSelfServiceRecoveryFlowWithLinkMethod.md)
|
130
|
+
- [OryHydraClient::CompleteSelfServiceSettingsFlowWithPasswordMethod](docs/CompleteSelfServiceSettingsFlowWithPasswordMethod.md)
|
131
|
+
- [OryHydraClient::CompleteSelfServiceVerificationFlowWithLinkMethod](docs/CompleteSelfServiceVerificationFlowWithLinkMethod.md)
|
132
|
+
- [OryHydraClient::CreateIdentity](docs/CreateIdentity.md)
|
133
|
+
- [OryHydraClient::CreateRecoveryLink](docs/CreateRecoveryLink.md)
|
120
134
|
- [OryHydraClient::ErrorContainer](docs/ErrorContainer.md)
|
121
|
-
- [OryHydraClient::Form](docs/Form.md)
|
122
135
|
- [OryHydraClient::FormField](docs/FormField.md)
|
123
136
|
- [OryHydraClient::GenericError](docs/GenericError.md)
|
124
137
|
- [OryHydraClient::GenericErrorPayload](docs/GenericErrorPayload.md)
|
125
138
|
- [OryHydraClient::HealthNotReadyStatus](docs/HealthNotReadyStatus.md)
|
126
139
|
- [OryHydraClient::HealthStatus](docs/HealthStatus.md)
|
127
140
|
- [OryHydraClient::Identity](docs/Identity.md)
|
128
|
-
- [OryHydraClient::
|
129
|
-
- [OryHydraClient::
|
130
|
-
- [OryHydraClient::
|
131
|
-
- [OryHydraClient::
|
132
|
-
- [OryHydraClient::
|
133
|
-
- [OryHydraClient::
|
134
|
-
- [OryHydraClient::
|
141
|
+
- [OryHydraClient::LoginFlow](docs/LoginFlow.md)
|
142
|
+
- [OryHydraClient::LoginFlowMethod](docs/LoginFlowMethod.md)
|
143
|
+
- [OryHydraClient::LoginFlowMethodConfig](docs/LoginFlowMethodConfig.md)
|
144
|
+
- [OryHydraClient::LoginViaApiResponse](docs/LoginViaApiResponse.md)
|
145
|
+
- [OryHydraClient::Message](docs/Message.md)
|
146
|
+
- [OryHydraClient::RecoveryAddress](docs/RecoveryAddress.md)
|
147
|
+
- [OryHydraClient::RecoveryFlow](docs/RecoveryFlow.md)
|
148
|
+
- [OryHydraClient::RecoveryFlowMethod](docs/RecoveryFlowMethod.md)
|
149
|
+
- [OryHydraClient::RecoveryFlowMethodConfig](docs/RecoveryFlowMethodConfig.md)
|
150
|
+
- [OryHydraClient::RecoveryLink](docs/RecoveryLink.md)
|
151
|
+
- [OryHydraClient::RegistrationFlow](docs/RegistrationFlow.md)
|
152
|
+
- [OryHydraClient::RegistrationFlowMethod](docs/RegistrationFlowMethod.md)
|
153
|
+
- [OryHydraClient::RegistrationFlowMethodConfig](docs/RegistrationFlowMethodConfig.md)
|
154
|
+
- [OryHydraClient::RegistrationViaApiResponse](docs/RegistrationViaApiResponse.md)
|
155
|
+
- [OryHydraClient::RevokeSession](docs/RevokeSession.md)
|
135
156
|
- [OryHydraClient::Session](docs/Session.md)
|
136
|
-
- [OryHydraClient::
|
137
|
-
- [OryHydraClient::
|
157
|
+
- [OryHydraClient::SettingsFlow](docs/SettingsFlow.md)
|
158
|
+
- [OryHydraClient::SettingsFlowMethod](docs/SettingsFlowMethod.md)
|
159
|
+
- [OryHydraClient::SettingsFlowMethodConfig](docs/SettingsFlowMethodConfig.md)
|
160
|
+
- [OryHydraClient::SettingsViaApiResponse](docs/SettingsViaApiResponse.md)
|
161
|
+
- [OryHydraClient::UpdateIdentity](docs/UpdateIdentity.md)
|
138
162
|
- [OryHydraClient::VerifiableAddress](docs/VerifiableAddress.md)
|
139
|
-
- [OryHydraClient::
|
163
|
+
- [OryHydraClient::VerificationFlow](docs/VerificationFlow.md)
|
164
|
+
- [OryHydraClient::VerificationFlowMethod](docs/VerificationFlowMethod.md)
|
165
|
+
- [OryHydraClient::VerificationFlowMethodConfig](docs/VerificationFlowMethodConfig.md)
|
140
166
|
- [OryHydraClient::Version](docs/Version.md)
|
141
167
|
|
142
168
|
|
143
169
|
## Documentation for Authorization
|
144
170
|
|
145
|
-
|
171
|
+
|
172
|
+
### sessionToken
|
173
|
+
|
174
|
+
|
175
|
+
- **Type**: API key
|
176
|
+
- **API key parameter name**: X-Session-Token
|
177
|
+
- **Location**: HTTP header
|
146
178
|
|
data/docs/AdminApi.md
CHANGED
@@ -4,25 +4,28 @@ All URIs are relative to *http://localhost*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**create_identity**](AdminApi.md#create_identity) | **POST** /identities | Create an
|
8
|
-
[**
|
9
|
-
[**
|
7
|
+
[**create_identity**](AdminApi.md#create_identity) | **POST** /identities | Create an Identity
|
8
|
+
[**create_recovery_link**](AdminApi.md#create_recovery_link) | **POST** /recovery/link | Create a Recovery Link
|
9
|
+
[**delete_identity**](AdminApi.md#delete_identity) | **DELETE** /identities/{id} | Delete an Identity
|
10
|
+
[**get_identity**](AdminApi.md#get_identity) | **GET** /identities/{id} | Get an Identity
|
10
11
|
[**get_schema**](AdminApi.md#get_schema) | **GET** /schemas/{id} |
|
11
|
-
[**
|
12
|
-
[**
|
13
|
-
[**
|
14
|
-
[**
|
15
|
-
[**
|
16
|
-
[**
|
17
|
-
[**
|
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
|
18
21
|
|
19
22
|
|
20
23
|
|
21
24
|
## create_identity
|
22
25
|
|
23
|
-
> Identity create_identity(
|
26
|
+
> Identity create_identity(opts)
|
24
27
|
|
25
|
-
Create an
|
28
|
+
Create an Identity
|
26
29
|
|
27
30
|
This endpoint creates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future. Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
28
31
|
|
@@ -33,11 +36,13 @@ This endpoint creates an identity. It is NOT possible to set an identity's crede
|
|
33
36
|
require 'ory-kratos-client'
|
34
37
|
|
35
38
|
api_instance = OryHydraClient::AdminApi.new
|
36
|
-
|
39
|
+
opts = {
|
40
|
+
body: OryHydraClient::CreateIdentity.new # CreateIdentity |
|
41
|
+
}
|
37
42
|
|
38
43
|
begin
|
39
|
-
#Create an
|
40
|
-
result = api_instance.create_identity(
|
44
|
+
#Create an Identity
|
45
|
+
result = api_instance.create_identity(opts)
|
41
46
|
p result
|
42
47
|
rescue OryHydraClient::ApiError => e
|
43
48
|
puts "Exception when calling AdminApi->create_identity: #{e}"
|
@@ -49,7 +54,7 @@ end
|
|
49
54
|
|
50
55
|
Name | Type | Description | Notes
|
51
56
|
------------- | ------------- | ------------- | -------------
|
52
|
-
**body** | [**
|
57
|
+
**body** | [**CreateIdentity**](CreateIdentity.md)| | [optional]
|
53
58
|
|
54
59
|
### Return type
|
55
60
|
|
@@ -65,13 +70,62 @@ No authorization required
|
|
65
70
|
- **Accept**: application/json
|
66
71
|
|
67
72
|
|
73
|
+
## create_recovery_link
|
74
|
+
|
75
|
+
> RecoveryLink create_recovery_link(opts)
|
76
|
+
|
77
|
+
Create a Recovery Link
|
78
|
+
|
79
|
+
This endpoint creates a recovery link which should be given to the user in order for them to recover (or activate) their account.
|
80
|
+
|
81
|
+
### Example
|
82
|
+
|
83
|
+
```ruby
|
84
|
+
# load the gem
|
85
|
+
require 'ory-kratos-client'
|
86
|
+
|
87
|
+
api_instance = OryHydraClient::AdminApi.new
|
88
|
+
opts = {
|
89
|
+
body: OryHydraClient::CreateRecoveryLink.new # CreateRecoveryLink |
|
90
|
+
}
|
91
|
+
|
92
|
+
begin
|
93
|
+
#Create a Recovery Link
|
94
|
+
result = api_instance.create_recovery_link(opts)
|
95
|
+
p result
|
96
|
+
rescue OryHydraClient::ApiError => e
|
97
|
+
puts "Exception when calling AdminApi->create_recovery_link: #{e}"
|
98
|
+
end
|
99
|
+
```
|
100
|
+
|
101
|
+
### Parameters
|
102
|
+
|
103
|
+
|
104
|
+
Name | Type | Description | Notes
|
105
|
+
------------- | ------------- | ------------- | -------------
|
106
|
+
**body** | [**CreateRecoveryLink**](CreateRecoveryLink.md)| | [optional]
|
107
|
+
|
108
|
+
### Return type
|
109
|
+
|
110
|
+
[**RecoveryLink**](RecoveryLink.md)
|
111
|
+
|
112
|
+
### Authorization
|
113
|
+
|
114
|
+
No authorization required
|
115
|
+
|
116
|
+
### HTTP request headers
|
117
|
+
|
118
|
+
- **Content-Type**: application/json
|
119
|
+
- **Accept**: application/json
|
120
|
+
|
121
|
+
|
68
122
|
## delete_identity
|
69
123
|
|
70
124
|
> delete_identity(id)
|
71
125
|
|
72
|
-
Delete an
|
126
|
+
Delete an Identity
|
73
127
|
|
74
|
-
|
128
|
+
Calling this endpoint irrecoverably and permanently deletes the identity given its ID. This action can not be undone. This endpoint returns 204 when the identity was deleted or when the identity was not found, in which case it is assumed that is has been deleted already. Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
75
129
|
|
76
130
|
### Example
|
77
131
|
|
@@ -83,7 +137,7 @@ api_instance = OryHydraClient::AdminApi.new
|
|
83
137
|
id = 'id_example' # String | ID is the identity's ID.
|
84
138
|
|
85
139
|
begin
|
86
|
-
#Delete an
|
140
|
+
#Delete an Identity
|
87
141
|
api_instance.delete_identity(id)
|
88
142
|
rescue OryHydraClient::ApiError => e
|
89
143
|
puts "Exception when calling AdminApi->delete_identity: #{e}"
|
@@ -115,7 +169,7 @@ No authorization required
|
|
115
169
|
|
116
170
|
> Identity get_identity(id)
|
117
171
|
|
118
|
-
Get an
|
172
|
+
Get an Identity
|
119
173
|
|
120
174
|
Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
121
175
|
|
@@ -129,7 +183,7 @@ api_instance = OryHydraClient::AdminApi.new
|
|
129
183
|
id = 'id_example' # String | ID must be set to the ID of identity you want to get
|
130
184
|
|
131
185
|
begin
|
132
|
-
#Get an
|
186
|
+
#Get an Identity
|
133
187
|
result = api_instance.get_identity(id)
|
134
188
|
p result
|
135
189
|
rescue OryHydraClient::ApiError => e
|
@@ -164,7 +218,7 @@ No authorization required
|
|
164
218
|
|
165
219
|
|
166
220
|
|
167
|
-
Get a
|
221
|
+
Get a Traits Schema Definition
|
168
222
|
|
169
223
|
### Example
|
170
224
|
|
@@ -204,13 +258,13 @@ No authorization required
|
|
204
258
|
- **Accept**: application/json
|
205
259
|
|
206
260
|
|
207
|
-
##
|
261
|
+
## get_self_service_error
|
208
262
|
|
209
|
-
>
|
263
|
+
> ErrorContainer get_self_service_error(error)
|
210
264
|
|
211
|
-
Get
|
265
|
+
Get User-Facing Self-Service Errors
|
212
266
|
|
213
|
-
This endpoint returns
|
267
|
+
This endpoint returns the error associated with a user-facing self service errors. This endpoint supports stub values to help you implement the error UI: `?error=stub:500` - returns a stub 500 (Internal Server Error) error. More information can be found at [ORY Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
|
214
268
|
|
215
269
|
### Example
|
216
270
|
|
@@ -219,14 +273,14 @@ This endpoint returns a login request's context with, for example, error details
|
|
219
273
|
require 'ory-kratos-client'
|
220
274
|
|
221
275
|
api_instance = OryHydraClient::AdminApi.new
|
222
|
-
|
276
|
+
error = 'error_example' # String | Error is the container's ID
|
223
277
|
|
224
278
|
begin
|
225
|
-
#Get
|
226
|
-
result = api_instance.
|
279
|
+
#Get User-Facing Self-Service Errors
|
280
|
+
result = api_instance.get_self_service_error(error)
|
227
281
|
p result
|
228
282
|
rescue OryHydraClient::ApiError => e
|
229
|
-
puts "Exception when calling AdminApi->
|
283
|
+
puts "Exception when calling AdminApi->get_self_service_error: #{e}"
|
230
284
|
end
|
231
285
|
```
|
232
286
|
|
@@ -235,11 +289,11 @@ end
|
|
235
289
|
|
236
290
|
Name | Type | Description | Notes
|
237
291
|
------------- | ------------- | ------------- | -------------
|
238
|
-
**
|
292
|
+
**error** | **String**| Error is the container's ID |
|
239
293
|
|
240
294
|
### Return type
|
241
295
|
|
242
|
-
[**
|
296
|
+
[**ErrorContainer**](ErrorContainer.md)
|
243
297
|
|
244
298
|
### Authorization
|
245
299
|
|
@@ -251,13 +305,13 @@ No authorization required
|
|
251
305
|
- **Accept**: application/json
|
252
306
|
|
253
307
|
|
254
|
-
##
|
308
|
+
## get_self_service_login_flow
|
255
309
|
|
256
|
-
>
|
310
|
+
> LoginFlow get_self_service_login_flow(id)
|
257
311
|
|
258
|
-
Get
|
312
|
+
Get Login Flow
|
259
313
|
|
260
|
-
This endpoint returns a
|
314
|
+
This endpoint returns a login flow's context with, for example, error details and other information. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
261
315
|
|
262
316
|
### Example
|
263
317
|
|
@@ -266,14 +320,14 @@ This endpoint returns a registration request's context with, for example, error
|
|
266
320
|
require 'ory-kratos-client'
|
267
321
|
|
268
322
|
api_instance = OryHydraClient::AdminApi.new
|
269
|
-
|
323
|
+
id = 'id_example' # String | The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`).
|
270
324
|
|
271
325
|
begin
|
272
|
-
#Get
|
273
|
-
result = api_instance.
|
326
|
+
#Get Login Flow
|
327
|
+
result = api_instance.get_self_service_login_flow(id)
|
274
328
|
p result
|
275
329
|
rescue OryHydraClient::ApiError => e
|
276
|
-
puts "Exception when calling AdminApi->
|
330
|
+
puts "Exception when calling AdminApi->get_self_service_login_flow: #{e}"
|
277
331
|
end
|
278
332
|
```
|
279
333
|
|
@@ -282,11 +336,11 @@ end
|
|
282
336
|
|
283
337
|
Name | Type | Description | Notes
|
284
338
|
------------- | ------------- | ------------- | -------------
|
285
|
-
**
|
339
|
+
**id** | **String**| The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`). |
|
286
340
|
|
287
341
|
### Return type
|
288
342
|
|
289
|
-
[**
|
343
|
+
[**LoginFlow**](LoginFlow.md)
|
290
344
|
|
291
345
|
### Authorization
|
292
346
|
|
@@ -298,13 +352,13 @@ No authorization required
|
|
298
352
|
- **Accept**: application/json
|
299
353
|
|
300
354
|
|
301
|
-
##
|
355
|
+
## get_self_service_recovery_flow
|
302
356
|
|
303
|
-
>
|
357
|
+
> RecoveryFlow get_self_service_recovery_flow(id)
|
304
358
|
|
305
|
-
Get
|
359
|
+
Get information about a recovery flow
|
306
360
|
|
307
|
-
|
361
|
+
This endpoint returns a recovery flow's context with, for example, error details and other information. More information can be found at [ORY Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
|
308
362
|
|
309
363
|
### Example
|
310
364
|
|
@@ -313,14 +367,14 @@ When accessing this endpoint through ORY Kratos' Public API, ensure that cookies
|
|
313
367
|
require 'ory-kratos-client'
|
314
368
|
|
315
369
|
api_instance = OryHydraClient::AdminApi.new
|
316
|
-
|
370
|
+
id = 'id_example' # String | The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`).
|
317
371
|
|
318
372
|
begin
|
319
|
-
#Get
|
320
|
-
result = api_instance.
|
373
|
+
#Get information about a recovery flow
|
374
|
+
result = api_instance.get_self_service_recovery_flow(id)
|
321
375
|
p result
|
322
376
|
rescue OryHydraClient::ApiError => e
|
323
|
-
puts "Exception when calling AdminApi->
|
377
|
+
puts "Exception when calling AdminApi->get_self_service_recovery_flow: #{e}"
|
324
378
|
end
|
325
379
|
```
|
326
380
|
|
@@ -329,11 +383,11 @@ end
|
|
329
383
|
|
330
384
|
Name | Type | Description | Notes
|
331
385
|
------------- | ------------- | ------------- | -------------
|
332
|
-
**
|
386
|
+
**id** | **String**| The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`). |
|
333
387
|
|
334
388
|
### Return type
|
335
389
|
|
336
|
-
[**
|
390
|
+
[**RecoveryFlow**](RecoveryFlow.md)
|
337
391
|
|
338
392
|
### Authorization
|
339
393
|
|
@@ -345,13 +399,13 @@ No authorization required
|
|
345
399
|
- **Accept**: application/json
|
346
400
|
|
347
401
|
|
348
|
-
##
|
402
|
+
## get_self_service_registration_flow
|
349
403
|
|
350
|
-
>
|
404
|
+
> RegistrationFlow get_self_service_registration_flow(id)
|
351
405
|
|
352
|
-
Get
|
406
|
+
Get Registration Flow
|
353
407
|
|
354
|
-
This endpoint returns
|
408
|
+
This endpoint returns a registration flow's context with, for example, error details and other information. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
355
409
|
|
356
410
|
### Example
|
357
411
|
|
@@ -360,16 +414,14 @@ This endpoint returns the error associated with a user-facing self service error
|
|
360
414
|
require 'ory-kratos-client'
|
361
415
|
|
362
416
|
api_instance = OryHydraClient::AdminApi.new
|
363
|
-
|
364
|
-
error: 'error_example' # String |
|
365
|
-
}
|
417
|
+
id = 'id_example' # String | The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`).
|
366
418
|
|
367
419
|
begin
|
368
|
-
#Get
|
369
|
-
result = api_instance.
|
420
|
+
#Get Registration Flow
|
421
|
+
result = api_instance.get_self_service_registration_flow(id)
|
370
422
|
p result
|
371
423
|
rescue OryHydraClient::ApiError => e
|
372
|
-
puts "Exception when calling AdminApi->
|
424
|
+
puts "Exception when calling AdminApi->get_self_service_registration_flow: #{e}"
|
373
425
|
end
|
374
426
|
```
|
375
427
|
|
@@ -378,11 +430,11 @@ end
|
|
378
430
|
|
379
431
|
Name | Type | Description | Notes
|
380
432
|
------------- | ------------- | ------------- | -------------
|
381
|
-
**
|
433
|
+
**id** | **String**| The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`). |
|
382
434
|
|
383
435
|
### Return type
|
384
436
|
|
385
|
-
[**
|
437
|
+
[**RegistrationFlow**](RegistrationFlow.md)
|
386
438
|
|
387
439
|
### Authorization
|
388
440
|
|
@@ -394,13 +446,67 @@ No authorization required
|
|
394
446
|
- **Accept**: application/json
|
395
447
|
|
396
448
|
|
397
|
-
##
|
449
|
+
## get_self_service_settings_flow
|
450
|
+
|
451
|
+
> SettingsFlow get_self_service_settings_flow(id)
|
452
|
+
|
453
|
+
Get Settings Flow
|
454
|
+
|
455
|
+
When accessing this endpoint through ORY Kratos' Public API you must ensure that either the ORY Kratos Session Cookie or the ORY Kratos Session Token are set. The public endpoint does not return 404 status codes but instead 403 or 500 to improve data privacy. You can access this endpoint without credentials when using ORY Kratos' Admin API. More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
456
|
+
|
457
|
+
### Example
|
458
|
+
|
459
|
+
```ruby
|
460
|
+
# load the gem
|
461
|
+
require 'ory-kratos-client'
|
462
|
+
# setup authorization
|
463
|
+
OryHydraClient.configure do |config|
|
464
|
+
# Configure API key authorization: sessionToken
|
465
|
+
config.api_key['X-Session-Token'] = 'YOUR API KEY'
|
466
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
467
|
+
#config.api_key_prefix['X-Session-Token'] = 'Bearer'
|
468
|
+
end
|
469
|
+
|
470
|
+
api_instance = OryHydraClient::AdminApi.new
|
471
|
+
id = 'id_example' # String | ID is the Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`).
|
472
|
+
|
473
|
+
begin
|
474
|
+
#Get Settings Flow
|
475
|
+
result = api_instance.get_self_service_settings_flow(id)
|
476
|
+
p result
|
477
|
+
rescue OryHydraClient::ApiError => e
|
478
|
+
puts "Exception when calling AdminApi->get_self_service_settings_flow: #{e}"
|
479
|
+
end
|
480
|
+
```
|
481
|
+
|
482
|
+
### Parameters
|
483
|
+
|
484
|
+
|
485
|
+
Name | Type | Description | Notes
|
486
|
+
------------- | ------------- | ------------- | -------------
|
487
|
+
**id** | **String**| ID is the Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`). |
|
488
|
+
|
489
|
+
### Return type
|
490
|
+
|
491
|
+
[**SettingsFlow**](SettingsFlow.md)
|
492
|
+
|
493
|
+
### Authorization
|
494
|
+
|
495
|
+
[sessionToken](../README.md#sessionToken)
|
496
|
+
|
497
|
+
### HTTP request headers
|
498
|
+
|
499
|
+
- **Content-Type**: Not defined
|
500
|
+
- **Accept**: application/json
|
501
|
+
|
502
|
+
|
503
|
+
## get_self_service_verification_flow
|
398
504
|
|
399
|
-
>
|
505
|
+
> VerificationFlow get_self_service_verification_flow(id)
|
400
506
|
|
401
|
-
Get
|
507
|
+
Get Verification Flow
|
402
508
|
|
403
|
-
|
509
|
+
This endpoint returns a verification flow's context with, for example, error details and other information. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
|
404
510
|
|
405
511
|
### Example
|
406
512
|
|
@@ -409,14 +515,14 @@ When accessing this endpoint through ORY Kratos' Public API, ensure that cookies
|
|
409
515
|
require 'ory-kratos-client'
|
410
516
|
|
411
517
|
api_instance = OryHydraClient::AdminApi.new
|
412
|
-
|
518
|
+
id = 'id_example' # String | The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`).
|
413
519
|
|
414
520
|
begin
|
415
|
-
#Get
|
416
|
-
result = api_instance.
|
521
|
+
#Get Verification Flow
|
522
|
+
result = api_instance.get_self_service_verification_flow(id)
|
417
523
|
p result
|
418
524
|
rescue OryHydraClient::ApiError => e
|
419
|
-
puts "Exception when calling AdminApi->
|
525
|
+
puts "Exception when calling AdminApi->get_self_service_verification_flow: #{e}"
|
420
526
|
end
|
421
527
|
```
|
422
528
|
|
@@ -425,11 +531,11 @@ end
|
|
425
531
|
|
426
532
|
Name | Type | Description | Notes
|
427
533
|
------------- | ------------- | ------------- | -------------
|
428
|
-
**
|
534
|
+
**id** | **String**| The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`). |
|
429
535
|
|
430
536
|
### Return type
|
431
537
|
|
432
|
-
[**
|
538
|
+
[**VerificationFlow**](VerificationFlow.md)
|
433
539
|
|
434
540
|
### Authorization
|
435
541
|
|
@@ -443,11 +549,11 @@ No authorization required
|
|
443
549
|
|
444
550
|
## list_identities
|
445
551
|
|
446
|
-
> Array<Identity> list_identities
|
552
|
+
> Array<Identity> list_identities(opts)
|
447
553
|
|
448
|
-
List
|
554
|
+
List Identities
|
449
555
|
|
450
|
-
|
556
|
+
Lists all identities. Does not support search at the moment. Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
451
557
|
|
452
558
|
### Example
|
453
559
|
|
@@ -456,10 +562,14 @@ This endpoint returns a login request's context with, for example, error details
|
|
456
562
|
require 'ory-kratos-client'
|
457
563
|
|
458
564
|
api_instance = OryHydraClient::AdminApi.new
|
565
|
+
opts = {
|
566
|
+
per_page: 100, # Integer | Items per Page This is the number of items per page.
|
567
|
+
page: 0 # Integer | Pagination Page
|
568
|
+
}
|
459
569
|
|
460
570
|
begin
|
461
|
-
#List
|
462
|
-
result = api_instance.list_identities
|
571
|
+
#List Identities
|
572
|
+
result = api_instance.list_identities(opts)
|
463
573
|
p result
|
464
574
|
rescue OryHydraClient::ApiError => e
|
465
575
|
puts "Exception when calling AdminApi->list_identities: #{e}"
|
@@ -468,7 +578,11 @@ end
|
|
468
578
|
|
469
579
|
### Parameters
|
470
580
|
|
471
|
-
|
581
|
+
|
582
|
+
Name | Type | Description | Notes
|
583
|
+
------------- | ------------- | ------------- | -------------
|
584
|
+
**per_page** | **Integer**| Items per Page This is the number of items per page. | [optional] [default to 100]
|
585
|
+
**page** | **Integer**| Pagination Page | [optional] [default to 0]
|
472
586
|
|
473
587
|
### Return type
|
474
588
|
|
@@ -484,11 +598,53 @@ No authorization required
|
|
484
598
|
- **Accept**: application/json
|
485
599
|
|
486
600
|
|
601
|
+
## prometheus
|
602
|
+
|
603
|
+
> prometheus
|
604
|
+
|
605
|
+
Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
|
606
|
+
|
607
|
+
``` metadata: annotations: prometheus.io/port: \"4434\" prometheus.io/path: \"/metrics/prometheus\" ```
|
608
|
+
|
609
|
+
### Example
|
610
|
+
|
611
|
+
```ruby
|
612
|
+
# load the gem
|
613
|
+
require 'ory-kratos-client'
|
614
|
+
|
615
|
+
api_instance = OryHydraClient::AdminApi.new
|
616
|
+
|
617
|
+
begin
|
618
|
+
#Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
|
619
|
+
api_instance.prometheus
|
620
|
+
rescue OryHydraClient::ApiError => e
|
621
|
+
puts "Exception when calling AdminApi->prometheus: #{e}"
|
622
|
+
end
|
623
|
+
```
|
624
|
+
|
625
|
+
### Parameters
|
626
|
+
|
627
|
+
This endpoint does not need any parameter.
|
628
|
+
|
629
|
+
### Return type
|
630
|
+
|
631
|
+
nil (empty response body)
|
632
|
+
|
633
|
+
### Authorization
|
634
|
+
|
635
|
+
No authorization required
|
636
|
+
|
637
|
+
### HTTP request headers
|
638
|
+
|
639
|
+
- **Content-Type**: Not defined
|
640
|
+
- **Accept**: Not defined
|
641
|
+
|
642
|
+
|
487
643
|
## update_identity
|
488
644
|
|
489
|
-
> Identity update_identity(id,
|
645
|
+
> Identity update_identity(id, opts)
|
490
646
|
|
491
|
-
Update an
|
647
|
+
Update an Identity
|
492
648
|
|
493
649
|
This endpoint updates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future. The full identity payload (except credentials) is expected. This endpoint does not support patching. Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
494
650
|
|
@@ -500,11 +656,13 @@ require 'ory-kratos-client'
|
|
500
656
|
|
501
657
|
api_instance = OryHydraClient::AdminApi.new
|
502
658
|
id = 'id_example' # String | ID must be set to the ID of identity you want to update
|
503
|
-
|
659
|
+
opts = {
|
660
|
+
body: OryHydraClient::UpdateIdentity.new # UpdateIdentity |
|
661
|
+
}
|
504
662
|
|
505
663
|
begin
|
506
|
-
#Update an
|
507
|
-
result = api_instance.update_identity(id,
|
664
|
+
#Update an Identity
|
665
|
+
result = api_instance.update_identity(id, opts)
|
508
666
|
p result
|
509
667
|
rescue OryHydraClient::ApiError => e
|
510
668
|
puts "Exception when calling AdminApi->update_identity: #{e}"
|
@@ -517,7 +675,7 @@ end
|
|
517
675
|
Name | Type | Description | Notes
|
518
676
|
------------- | ------------- | ------------- | -------------
|
519
677
|
**id** | **String**| ID must be set to the ID of identity you want to update |
|
520
|
-
**body** | [**
|
678
|
+
**body** | [**UpdateIdentity**](UpdateIdentity.md)| | [optional]
|
521
679
|
|
522
680
|
### Return type
|
523
681
|
|