ory-client 0.0.1.alpha7 → 0.0.1.alpha8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +10 -11
- data/docs/DefaultApi.md +57 -55
- data/docs/LoginViaApiResponse.md +1 -1
- data/docs/RegistrationViaApiResponse.md +1 -1
- data/docs/UiNodeInputAttributes.md +1 -1
- data/lib/ory-client/api/default_api.rb +52 -52
- data/lib/ory-client/api_client.rb +1 -1
- data/lib/ory-client/api_error.rb +1 -1
- data/lib/ory-client/configuration.rb +1 -1
- data/lib/ory-client/models/authenticate_ok_body.rb +1 -1
- data/lib/ory-client/models/container_change_response_item.rb +1 -1
- data/lib/ory-client/models/container_create_created_body.rb +1 -1
- data/lib/ory-client/models/container_top_ok_body.rb +1 -1
- data/lib/ory-client/models/container_update_ok_body.rb +1 -1
- data/lib/ory-client/models/container_wait_ok_body.rb +1 -1
- data/lib/ory-client/models/container_wait_ok_body_error.rb +1 -1
- data/lib/ory-client/models/create_identity.rb +1 -1
- data/lib/ory-client/models/create_recovery_link.rb +1 -1
- data/lib/ory-client/models/error_response.rb +1 -1
- data/lib/ory-client/models/generic_error.rb +1 -1
- data/lib/ory-client/models/graph_driver_data.rb +1 -1
- data/lib/ory-client/models/health_not_ready_status.rb +1 -1
- data/lib/ory-client/models/health_status.rb +1 -1
- data/lib/ory-client/models/id_response.rb +1 -1
- data/lib/ory-client/models/identity.rb +1 -1
- data/lib/ory-client/models/identity_credentials.rb +1 -1
- data/lib/ory-client/models/image_delete_response_item.rb +1 -1
- data/lib/ory-client/models/image_summary.rb +1 -1
- data/lib/ory-client/models/inline_response200.rb +1 -1
- data/lib/ory-client/models/inline_response2001.rb +1 -1
- data/lib/ory-client/models/inline_response503.rb +1 -1
- data/lib/ory-client/models/json_error.rb +1 -1
- data/lib/ory-client/models/login_flow.rb +1 -1
- data/lib/ory-client/models/login_via_api_response.rb +1 -6
- data/lib/ory-client/models/meta.rb +1 -1
- data/lib/ory-client/models/plugin.rb +1 -1
- data/lib/ory-client/models/plugin_config.rb +1 -1
- data/lib/ory-client/models/plugin_config_args.rb +1 -1
- data/lib/ory-client/models/plugin_config_interface.rb +1 -1
- data/lib/ory-client/models/plugin_config_linux.rb +1 -1
- data/lib/ory-client/models/plugin_config_network.rb +1 -1
- data/lib/ory-client/models/plugin_config_rootfs.rb +1 -1
- data/lib/ory-client/models/plugin_config_user.rb +1 -1
- data/lib/ory-client/models/plugin_device.rb +1 -1
- data/lib/ory-client/models/plugin_env.rb +1 -1
- data/lib/ory-client/models/plugin_interface_type.rb +1 -1
- data/lib/ory-client/models/plugin_mount.rb +1 -1
- data/lib/ory-client/models/plugin_settings.rb +1 -1
- data/lib/ory-client/models/port.rb +1 -1
- data/lib/ory-client/models/recovery_address.rb +1 -1
- data/lib/ory-client/models/recovery_flow.rb +1 -1
- data/lib/ory-client/models/recovery_link.rb +1 -1
- data/lib/ory-client/models/registration_flow.rb +1 -1
- data/lib/ory-client/models/registration_via_api_response.rb +1 -6
- data/lib/ory-client/models/revoke_session.rb +1 -1
- data/lib/ory-client/models/self_service_error_container.rb +1 -1
- data/lib/ory-client/models/service_update_response.rb +1 -1
- data/lib/ory-client/models/session.rb +1 -1
- data/lib/ory-client/models/settings_flow.rb +1 -1
- data/lib/ory-client/models/settings_profile_form_config.rb +1 -1
- data/lib/ory-client/models/settings_via_api_response.rb +1 -1
- data/lib/ory-client/models/submit_self_service_browser_settings_oidc_flow_payload.rb +1 -1
- data/lib/ory-client/models/submit_self_service_login_flow.rb +1 -1
- data/lib/ory-client/models/submit_self_service_login_flow_with_password_method.rb +1 -1
- data/lib/ory-client/models/submit_self_service_recovery_flow_with_link_method.rb +1 -1
- data/lib/ory-client/models/submit_self_service_registration_flow.rb +1 -1
- data/lib/ory-client/models/submit_self_service_registration_flow_with_password_method.rb +1 -1
- data/lib/ory-client/models/submit_self_service_settings_flow.rb +1 -1
- data/lib/ory-client/models/submit_self_service_settings_flow_with_password_method.rb +1 -1
- data/lib/ory-client/models/submit_self_service_settings_flow_with_profile_method.rb +1 -1
- data/lib/ory-client/models/submit_self_service_verification_flow_with_link_method.rb +1 -1
- data/lib/ory-client/models/ui_container.rb +1 -1
- data/lib/ory-client/models/ui_node.rb +1 -1
- data/lib/ory-client/models/ui_node_anchor_attributes.rb +1 -1
- data/lib/ory-client/models/ui_node_attributes.rb +1 -1
- data/lib/ory-client/models/ui_node_image_attributes.rb +1 -1
- data/lib/ory-client/models/ui_node_input_attributes.rb +4 -2
- data/lib/ory-client/models/ui_node_text_attributes.rb +1 -1
- data/lib/ory-client/models/ui_text.rb +1 -1
- data/lib/ory-client/models/update_identity.rb +1 -1
- data/lib/ory-client/models/verifiable_identity_address.rb +1 -1
- data/lib/ory-client/models/verification_flow.rb +1 -1
- data/lib/ory-client/models/version.rb +1 -1
- data/lib/ory-client/models/volume.rb +1 -1
- data/lib/ory-client/models/volume_usage_data.rb +1 -1
- data/lib/ory-client/version.rb +2 -2
- data/lib/ory-client.rb +1 -2
- data/ory-client.gemspec +1 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 59c333603bd1a13b6596b5ed4494d6ba7a1929063fd28492c72e5f783637ca39
|
|
4
|
+
data.tar.gz: fd1d180908e9e8d7c90d1de71ac1b712f13345ba6c7eb62b98fcc85380a113fc
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 22af1bab5be93aa4175efdcd99e215e624c05538be13a2d7f4bc223bf47256aa8fe1ffbc50d609c295d53df37af4feff80bd51d4bf764757c5ad88cb483289f4
|
|
7
|
+
data.tar.gz: f29520a6b60d312f156fc8710c7c5eb414607d5e3ce8691e9b3c572eecbc26cb6c6c74c40a9ba7286e02f82e07ad82166ec8cc574af75d27f2c892051e1c471d
|
data/README.md
CHANGED
|
@@ -8,8 +8,8 @@ with a valid Personal Access Token. Public APIs are mostly used in browsers.
|
|
|
8
8
|
|
|
9
9
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
10
10
|
|
|
11
|
-
- API version: v0.0.1-alpha.
|
|
12
|
-
- Package version: v0.0.1-alpha.
|
|
11
|
+
- API version: v0.0.1-alpha.8
|
|
12
|
+
- Package version: v0.0.1-alpha.8
|
|
13
13
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
14
14
|
|
|
15
15
|
## Installation
|
|
@@ -25,16 +25,16 @@ gem build ory-client.gemspec
|
|
|
25
25
|
Then either install the gem locally:
|
|
26
26
|
|
|
27
27
|
```shell
|
|
28
|
-
gem install ./ory-client-v0.0.1-alpha.
|
|
28
|
+
gem install ./ory-client-v0.0.1-alpha.8.gem
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
(for development, run `gem install --dev ./ory-client-v0.0.1-alpha.
|
|
31
|
+
(for development, run `gem install --dev ./ory-client-v0.0.1-alpha.8.gem` to install the development dependencies)
|
|
32
32
|
|
|
33
33
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
34
34
|
|
|
35
35
|
Finally add this to the Gemfile:
|
|
36
36
|
|
|
37
|
-
gem 'ory-client', '~> v0.0.1-alpha.
|
|
37
|
+
gem 'ory-client', '~> v0.0.1-alpha.8'
|
|
38
38
|
|
|
39
39
|
### Install from Git
|
|
40
40
|
|
|
@@ -105,12 +105,12 @@ Class | Method | HTTP request | Description
|
|
|
105
105
|
*OryHydraClient::DefaultApi* | [**get_self_service_verification_flow_admin**](docs/DefaultApi.md#get_self_service_verification_flow_admin) | **GET** /api/kratos/admin/self-service/verification/flows | Get Verification Flow
|
|
106
106
|
*OryHydraClient::DefaultApi* | [**get_version_admin**](docs/DefaultApi.md#get_version_admin) | **GET** /api/kratos/admin/version | Return Running Software Version.
|
|
107
107
|
*OryHydraClient::DefaultApi* | [**initialize_self_service_browser_logout_flow**](docs/DefaultApi.md#initialize_self_service_browser_logout_flow) | **GET** /api/kratos/public/self-service/browser/flows/logout | Initialize Browser-Based Logout User Flow
|
|
108
|
-
*OryHydraClient::DefaultApi* | [**initialize_self_service_login_for_browsers**](docs/DefaultApi.md#initialize_self_service_login_for_browsers) | **GET** /api/kratos/public/self-service/login/browser | Initialize Login Flow for
|
|
109
|
-
*OryHydraClient::DefaultApi* | [**
|
|
108
|
+
*OryHydraClient::DefaultApi* | [**initialize_self_service_login_for_browsers**](docs/DefaultApi.md#initialize_self_service_login_for_browsers) | **GET** /api/kratos/public/self-service/login/browser | Initialize Login Flow for Browsers
|
|
109
|
+
*OryHydraClient::DefaultApi* | [**initialize_self_service_login_without_browser**](docs/DefaultApi.md#initialize_self_service_login_without_browser) | **GET** /api/kratos/public/self-service/login/api | Initialize Login Flow for APIs, Services, Apps, ...
|
|
110
110
|
*OryHydraClient::DefaultApi* | [**initialize_self_service_recovery_for_browsers**](docs/DefaultApi.md#initialize_self_service_recovery_for_browsers) | **GET** /api/kratos/public/self-service/recovery/browser | Initialize Recovery Flow for Browser Clients
|
|
111
111
|
*OryHydraClient::DefaultApi* | [**initialize_self_service_recovery_for_native_apps**](docs/DefaultApi.md#initialize_self_service_recovery_for_native_apps) | **GET** /api/kratos/public/self-service/recovery/api | Initialize Recovery Flow for Native Apps and API clients
|
|
112
|
-
*OryHydraClient::DefaultApi* | [**initialize_self_service_registration_for_browsers**](docs/DefaultApi.md#initialize_self_service_registration_for_browsers) | **GET** /api/kratos/public/self-service/registration/browser | Initialize Registration Flow for
|
|
113
|
-
*OryHydraClient::DefaultApi* | [**
|
|
112
|
+
*OryHydraClient::DefaultApi* | [**initialize_self_service_registration_for_browsers**](docs/DefaultApi.md#initialize_self_service_registration_for_browsers) | **GET** /api/kratos/public/self-service/registration/browser | Initialize Registration Flow for Browsers
|
|
113
|
+
*OryHydraClient::DefaultApi* | [**initialize_self_service_registration_without_browser**](docs/DefaultApi.md#initialize_self_service_registration_without_browser) | **GET** /api/kratos/public/self-service/registration/api | Initialize Registration Flow for APIs, Services, Apps, ...
|
|
114
114
|
*OryHydraClient::DefaultApi* | [**initialize_self_service_settings_for_browsers**](docs/DefaultApi.md#initialize_self_service_settings_for_browsers) | **GET** /api/kratos/public/self-service/settings/browser | Initialize Settings Flow for Browsers
|
|
115
115
|
*OryHydraClient::DefaultApi* | [**initialize_self_service_settings_for_native_apps**](docs/DefaultApi.md#initialize_self_service_settings_for_native_apps) | **GET** /api/kratos/public/self-service/settings/api | Initialize Settings Flow for Native Apps and API clients
|
|
116
116
|
*OryHydraClient::DefaultApi* | [**initialize_self_service_verification_for_browsers**](docs/DefaultApi.md#initialize_self_service_verification_for_browsers) | **GET** /api/kratos/public/self-service/verification/browser | Initialize Verification Flow for Browser Clients
|
|
@@ -125,7 +125,7 @@ Class | Method | HTTP request | Description
|
|
|
125
125
|
*OryHydraClient::DefaultApi* | [**submit_self_service_recovery_flow_with_link_method**](docs/DefaultApi.md#submit_self_service_recovery_flow_with_link_method) | **POST** /api/kratos/public/self-service/recovery/methods/link | Complete Recovery Flow with Link Method
|
|
126
126
|
*OryHydraClient::DefaultApi* | [**submit_self_service_registration_flow**](docs/DefaultApi.md#submit_self_service_registration_flow) | **POST** /api/kratos/public/self-service/registration | Submit a Registration Flow
|
|
127
127
|
*OryHydraClient::DefaultApi* | [**submit_self_service_settings_flow**](docs/DefaultApi.md#submit_self_service_settings_flow) | **POST** /api/kratos/public/self-service/settings | Complete Settings Flow
|
|
128
|
-
*OryHydraClient::DefaultApi* | [**submit_self_service_verification_flow**](docs/DefaultApi.md#submit_self_service_verification_flow) | **POST** /api/kratos/public/self-service/verification | Complete Verification Flow
|
|
128
|
+
*OryHydraClient::DefaultApi* | [**submit_self_service_verification_flow**](docs/DefaultApi.md#submit_self_service_verification_flow) | **POST** /api/kratos/public/self-service/verification/flows | Complete Verification Flow
|
|
129
129
|
*OryHydraClient::DefaultApi* | [**to_session**](docs/DefaultApi.md#to_session) | **GET** /api/kratos/public/sessions/whoami | Check Who the Current HTTP Session Belongs To
|
|
130
130
|
*OryHydraClient::DefaultApi* | [**update_identity_admin**](docs/DefaultApi.md#update_identity_admin) | **PUT** /api/kratos/admin/identities/{id} | Update an Identity
|
|
131
131
|
|
|
@@ -200,7 +200,6 @@ Class | Method | HTTP request | Description
|
|
|
200
200
|
- [OryHydraClient::UiNodeAttributes](docs/UiNodeAttributes.md)
|
|
201
201
|
- [OryHydraClient::UiNodeImageAttributes](docs/UiNodeImageAttributes.md)
|
|
202
202
|
- [OryHydraClient::UiNodeInputAttributes](docs/UiNodeInputAttributes.md)
|
|
203
|
-
- [OryHydraClient::UiNodeInputAttributesValue](docs/UiNodeInputAttributesValue.md)
|
|
204
203
|
- [OryHydraClient::UiNodeTextAttributes](docs/UiNodeTextAttributes.md)
|
|
205
204
|
- [OryHydraClient::UiText](docs/UiText.md)
|
|
206
205
|
- [OryHydraClient::UpdateIdentity](docs/UpdateIdentity.md)
|
data/docs/DefaultApi.md
CHANGED
|
@@ -24,12 +24,12 @@ All URIs are relative to *https://playground.projects.oryapis.com*
|
|
|
24
24
|
| [**get_self_service_verification_flow_admin**](DefaultApi.md#get_self_service_verification_flow_admin) | **GET** /api/kratos/admin/self-service/verification/flows | Get Verification Flow |
|
|
25
25
|
| [**get_version_admin**](DefaultApi.md#get_version_admin) | **GET** /api/kratos/admin/version | Return Running Software Version. |
|
|
26
26
|
| [**initialize_self_service_browser_logout_flow**](DefaultApi.md#initialize_self_service_browser_logout_flow) | **GET** /api/kratos/public/self-service/browser/flows/logout | Initialize Browser-Based Logout User Flow |
|
|
27
|
-
| [**initialize_self_service_login_for_browsers**](DefaultApi.md#initialize_self_service_login_for_browsers) | **GET** /api/kratos/public/self-service/login/browser | Initialize Login Flow for
|
|
28
|
-
| [**
|
|
27
|
+
| [**initialize_self_service_login_for_browsers**](DefaultApi.md#initialize_self_service_login_for_browsers) | **GET** /api/kratos/public/self-service/login/browser | Initialize Login Flow for Browsers |
|
|
28
|
+
| [**initialize_self_service_login_without_browser**](DefaultApi.md#initialize_self_service_login_without_browser) | **GET** /api/kratos/public/self-service/login/api | Initialize Login Flow for APIs, Services, Apps, ... |
|
|
29
29
|
| [**initialize_self_service_recovery_for_browsers**](DefaultApi.md#initialize_self_service_recovery_for_browsers) | **GET** /api/kratos/public/self-service/recovery/browser | Initialize Recovery Flow for Browser Clients |
|
|
30
30
|
| [**initialize_self_service_recovery_for_native_apps**](DefaultApi.md#initialize_self_service_recovery_for_native_apps) | **GET** /api/kratos/public/self-service/recovery/api | Initialize Recovery Flow for Native Apps and API clients |
|
|
31
|
-
| [**initialize_self_service_registration_for_browsers**](DefaultApi.md#initialize_self_service_registration_for_browsers) | **GET** /api/kratos/public/self-service/registration/browser | Initialize Registration Flow for
|
|
32
|
-
| [**
|
|
31
|
+
| [**initialize_self_service_registration_for_browsers**](DefaultApi.md#initialize_self_service_registration_for_browsers) | **GET** /api/kratos/public/self-service/registration/browser | Initialize Registration Flow for Browsers |
|
|
32
|
+
| [**initialize_self_service_registration_without_browser**](DefaultApi.md#initialize_self_service_registration_without_browser) | **GET** /api/kratos/public/self-service/registration/api | Initialize Registration Flow for APIs, Services, Apps, ... |
|
|
33
33
|
| [**initialize_self_service_settings_for_browsers**](DefaultApi.md#initialize_self_service_settings_for_browsers) | **GET** /api/kratos/public/self-service/settings/browser | Initialize Settings Flow for Browsers |
|
|
34
34
|
| [**initialize_self_service_settings_for_native_apps**](DefaultApi.md#initialize_self_service_settings_for_native_apps) | **GET** /api/kratos/public/self-service/settings/api | Initialize Settings Flow for Native Apps and API clients |
|
|
35
35
|
| [**initialize_self_service_verification_for_browsers**](DefaultApi.md#initialize_self_service_verification_for_browsers) | **GET** /api/kratos/public/self-service/verification/browser | Initialize Verification Flow for Browser Clients |
|
|
@@ -44,7 +44,7 @@ All URIs are relative to *https://playground.projects.oryapis.com*
|
|
|
44
44
|
| [**submit_self_service_recovery_flow_with_link_method**](DefaultApi.md#submit_self_service_recovery_flow_with_link_method) | **POST** /api/kratos/public/self-service/recovery/methods/link | Complete Recovery Flow with Link Method |
|
|
45
45
|
| [**submit_self_service_registration_flow**](DefaultApi.md#submit_self_service_registration_flow) | **POST** /api/kratos/public/self-service/registration | Submit a Registration Flow |
|
|
46
46
|
| [**submit_self_service_settings_flow**](DefaultApi.md#submit_self_service_settings_flow) | **POST** /api/kratos/public/self-service/settings | Complete Settings Flow |
|
|
47
|
-
| [**submit_self_service_verification_flow**](DefaultApi.md#submit_self_service_verification_flow) | **POST** /api/kratos/public/self-service/verification | Complete Verification Flow |
|
|
47
|
+
| [**submit_self_service_verification_flow**](DefaultApi.md#submit_self_service_verification_flow) | **POST** /api/kratos/public/self-service/verification/flows | Complete Verification Flow |
|
|
48
48
|
| [**to_session**](DefaultApi.md#to_session) | **GET** /api/kratos/public/sessions/whoami | Check Who the Current HTTP Session Belongs To |
|
|
49
49
|
| [**update_identity_admin**](DefaultApi.md#update_identity_admin) | **PUT** /api/kratos/admin/identities/{id} | Update an Identity |
|
|
50
50
|
|
|
@@ -600,7 +600,7 @@ end
|
|
|
600
600
|
|
|
601
601
|
Get Login Flow
|
|
602
602
|
|
|
603
|
-
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).
|
|
603
|
+
This endpoint returns a login flow's context with, for example, error details and other information. :::info This endpoint is EXPERIMENTAL and subject to potential breaking changes in the future. ::: 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).
|
|
604
604
|
|
|
605
605
|
### Examples
|
|
606
606
|
|
|
@@ -664,7 +664,7 @@ No authorization required
|
|
|
664
664
|
|
|
665
665
|
Get Login Flow
|
|
666
666
|
|
|
667
|
-
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).
|
|
667
|
+
This endpoint returns a login flow's context with, for example, error details and other information. :::info This endpoint is EXPERIMENTAL and subject to potential breaking changes in the future. ::: 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).
|
|
668
668
|
|
|
669
669
|
### Examples
|
|
670
670
|
|
|
@@ -866,7 +866,7 @@ end
|
|
|
866
866
|
|
|
867
867
|
Get Registration Flow
|
|
868
868
|
|
|
869
|
-
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).
|
|
869
|
+
This endpoint returns a registration flow's context with, for example, error details and other information. :::info This endpoint is EXPERIMENTAL and subject to potential breaking changes in the future. ::: 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).
|
|
870
870
|
|
|
871
871
|
### Examples
|
|
872
872
|
|
|
@@ -930,7 +930,7 @@ No authorization required
|
|
|
930
930
|
|
|
931
931
|
Get Registration Flow
|
|
932
932
|
|
|
933
|
-
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).
|
|
933
|
+
This endpoint returns a registration flow's context with, for example, error details and other information. :::info This endpoint is EXPERIMENTAL and subject to potential breaking changes in the future. ::: 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).
|
|
934
934
|
|
|
935
935
|
### Examples
|
|
936
936
|
|
|
@@ -1400,11 +1400,11 @@ No authorization required
|
|
|
1400
1400
|
|
|
1401
1401
|
## initialize_self_service_login_for_browsers
|
|
1402
1402
|
|
|
1403
|
-
> initialize_self_service_login_for_browsers(opts)
|
|
1403
|
+
> <LoginFlow> initialize_self_service_login_for_browsers(opts)
|
|
1404
1404
|
|
|
1405
|
-
Initialize Login Flow for
|
|
1405
|
+
Initialize Login Flow for Browsers
|
|
1406
1406
|
|
|
1407
|
-
This endpoint initializes a browser-based user login flow.
|
|
1407
|
+
This endpoint initializes a browser-based user login flow. This endpoint will set the appropriate cookies and anti-CSRF measures required for browser-based flows. :::info This endpoint is EXPERIMENTAL and subject to potential breaking changes in the future. ::: If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.login.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url` unless the query parameter `?refresh=true` was set. If this endpoint is called via an AJAX request, the response contains the login flow without a redirect. This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. 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).
|
|
1408
1408
|
|
|
1409
1409
|
### Examples
|
|
1410
1410
|
|
|
@@ -1418,8 +1418,9 @@ opts = {
|
|
|
1418
1418
|
}
|
|
1419
1419
|
|
|
1420
1420
|
begin
|
|
1421
|
-
# Initialize Login Flow for
|
|
1422
|
-
api_instance.initialize_self_service_login_for_browsers(opts)
|
|
1421
|
+
# Initialize Login Flow for Browsers
|
|
1422
|
+
result = api_instance.initialize_self_service_login_for_browsers(opts)
|
|
1423
|
+
p result
|
|
1423
1424
|
rescue OryHydraClient::ApiError => e
|
|
1424
1425
|
puts "Error when calling DefaultApi->initialize_self_service_login_for_browsers: #{e}"
|
|
1425
1426
|
end
|
|
@@ -1427,17 +1428,17 @@ end
|
|
|
1427
1428
|
|
|
1428
1429
|
#### Using the initialize_self_service_login_for_browsers_with_http_info variant
|
|
1429
1430
|
|
|
1430
|
-
This returns an Array which contains the response data
|
|
1431
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1431
1432
|
|
|
1432
|
-
> <Array(
|
|
1433
|
+
> <Array(<LoginFlow>, Integer, Hash)> initialize_self_service_login_for_browsers_with_http_info(opts)
|
|
1433
1434
|
|
|
1434
1435
|
```ruby
|
|
1435
1436
|
begin
|
|
1436
|
-
# Initialize Login Flow for
|
|
1437
|
+
# Initialize Login Flow for Browsers
|
|
1437
1438
|
data, status_code, headers = api_instance.initialize_self_service_login_for_browsers_with_http_info(opts)
|
|
1438
1439
|
p status_code # => 2xx
|
|
1439
1440
|
p headers # => { ... }
|
|
1440
|
-
p data # =>
|
|
1441
|
+
p data # => <LoginFlow>
|
|
1441
1442
|
rescue OryHydraClient::ApiError => e
|
|
1442
1443
|
puts "Error when calling DefaultApi->initialize_self_service_login_for_browsers_with_http_info: #{e}"
|
|
1443
1444
|
end
|
|
@@ -1451,7 +1452,7 @@ end
|
|
|
1451
1452
|
|
|
1452
1453
|
### Return type
|
|
1453
1454
|
|
|
1454
|
-
|
|
1455
|
+
[**LoginFlow**](LoginFlow.md)
|
|
1455
1456
|
|
|
1456
1457
|
### Authorization
|
|
1457
1458
|
|
|
@@ -1463,13 +1464,13 @@ No authorization required
|
|
|
1463
1464
|
- **Accept**: application/json
|
|
1464
1465
|
|
|
1465
1466
|
|
|
1466
|
-
##
|
|
1467
|
+
## initialize_self_service_login_without_browser
|
|
1467
1468
|
|
|
1468
|
-
> <LoginFlow>
|
|
1469
|
+
> <LoginFlow> initialize_self_service_login_without_browser(opts)
|
|
1469
1470
|
|
|
1470
|
-
Initialize Login Flow for
|
|
1471
|
+
Initialize Login Flow for APIs, Services, Apps, ...
|
|
1471
1472
|
|
|
1472
|
-
This endpoint initiates a login flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing login flow call `/self-service/login/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks, including CSRF login attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: 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).
|
|
1473
|
+
This endpoint initiates a login flow for API clients that do not use a browser, such as mobile devices, smart TVs, and so on. :::info This endpoint is EXPERIMENTAL and subject to potential breaking changes in the future. ::: If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing login flow call `/self-service/login/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks, including CSRF login attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: 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).
|
|
1473
1474
|
|
|
1474
1475
|
### Examples
|
|
1475
1476
|
|
|
@@ -1483,29 +1484,29 @@ opts = {
|
|
|
1483
1484
|
}
|
|
1484
1485
|
|
|
1485
1486
|
begin
|
|
1486
|
-
# Initialize Login Flow for
|
|
1487
|
-
result = api_instance.
|
|
1487
|
+
# Initialize Login Flow for APIs, Services, Apps, ...
|
|
1488
|
+
result = api_instance.initialize_self_service_login_without_browser(opts)
|
|
1488
1489
|
p result
|
|
1489
1490
|
rescue OryHydraClient::ApiError => e
|
|
1490
|
-
puts "Error when calling DefaultApi->
|
|
1491
|
+
puts "Error when calling DefaultApi->initialize_self_service_login_without_browser: #{e}"
|
|
1491
1492
|
end
|
|
1492
1493
|
```
|
|
1493
1494
|
|
|
1494
|
-
#### Using the
|
|
1495
|
+
#### Using the initialize_self_service_login_without_browser_with_http_info variant
|
|
1495
1496
|
|
|
1496
1497
|
This returns an Array which contains the response data, status code and headers.
|
|
1497
1498
|
|
|
1498
|
-
> <Array(<LoginFlow>, Integer, Hash)>
|
|
1499
|
+
> <Array(<LoginFlow>, Integer, Hash)> initialize_self_service_login_without_browser_with_http_info(opts)
|
|
1499
1500
|
|
|
1500
1501
|
```ruby
|
|
1501
1502
|
begin
|
|
1502
|
-
# Initialize Login Flow for
|
|
1503
|
-
data, status_code, headers = api_instance.
|
|
1503
|
+
# Initialize Login Flow for APIs, Services, Apps, ...
|
|
1504
|
+
data, status_code, headers = api_instance.initialize_self_service_login_without_browser_with_http_info(opts)
|
|
1504
1505
|
p status_code # => 2xx
|
|
1505
1506
|
p headers # => { ... }
|
|
1506
1507
|
p data # => <LoginFlow>
|
|
1507
1508
|
rescue OryHydraClient::ApiError => e
|
|
1508
|
-
puts "Error when calling DefaultApi->
|
|
1509
|
+
puts "Error when calling DefaultApi->initialize_self_service_login_without_browser_with_http_info: #{e}"
|
|
1509
1510
|
end
|
|
1510
1511
|
```
|
|
1511
1512
|
|
|
@@ -1652,11 +1653,11 @@ No authorization required
|
|
|
1652
1653
|
|
|
1653
1654
|
## initialize_self_service_registration_for_browsers
|
|
1654
1655
|
|
|
1655
|
-
> initialize_self_service_registration_for_browsers
|
|
1656
|
+
> <RegistrationFlow> initialize_self_service_registration_for_browsers
|
|
1656
1657
|
|
|
1657
|
-
Initialize Registration Flow for
|
|
1658
|
+
Initialize Registration Flow for Browsers
|
|
1658
1659
|
|
|
1659
|
-
This endpoint initializes a browser-based user registration flow.
|
|
1660
|
+
This endpoint initializes a browser-based user registration flow. This endpoint will set the appropriate cookies and anti-CSRF measures required for browser-based flows. :::info This endpoint is EXPERIMENTAL and subject to potential breaking changes in the future. ::: If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.registration.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url`. If this endpoint is called via an AJAX request, the response contains the registration flow without a redirect. This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. 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).
|
|
1660
1661
|
|
|
1661
1662
|
### Examples
|
|
1662
1663
|
|
|
@@ -1667,8 +1668,9 @@ require 'ory-client'
|
|
|
1667
1668
|
api_instance = OryHydraClient::DefaultApi.new
|
|
1668
1669
|
|
|
1669
1670
|
begin
|
|
1670
|
-
# Initialize Registration Flow for
|
|
1671
|
-
api_instance.initialize_self_service_registration_for_browsers
|
|
1671
|
+
# Initialize Registration Flow for Browsers
|
|
1672
|
+
result = api_instance.initialize_self_service_registration_for_browsers
|
|
1673
|
+
p result
|
|
1672
1674
|
rescue OryHydraClient::ApiError => e
|
|
1673
1675
|
puts "Error when calling DefaultApi->initialize_self_service_registration_for_browsers: #{e}"
|
|
1674
1676
|
end
|
|
@@ -1676,17 +1678,17 @@ end
|
|
|
1676
1678
|
|
|
1677
1679
|
#### Using the initialize_self_service_registration_for_browsers_with_http_info variant
|
|
1678
1680
|
|
|
1679
|
-
This returns an Array which contains the response data
|
|
1681
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1680
1682
|
|
|
1681
|
-
> <Array(
|
|
1683
|
+
> <Array(<RegistrationFlow>, Integer, Hash)> initialize_self_service_registration_for_browsers_with_http_info
|
|
1682
1684
|
|
|
1683
1685
|
```ruby
|
|
1684
1686
|
begin
|
|
1685
|
-
# Initialize Registration Flow for
|
|
1687
|
+
# Initialize Registration Flow for Browsers
|
|
1686
1688
|
data, status_code, headers = api_instance.initialize_self_service_registration_for_browsers_with_http_info
|
|
1687
1689
|
p status_code # => 2xx
|
|
1688
1690
|
p headers # => { ... }
|
|
1689
|
-
p data # =>
|
|
1691
|
+
p data # => <RegistrationFlow>
|
|
1690
1692
|
rescue OryHydraClient::ApiError => e
|
|
1691
1693
|
puts "Error when calling DefaultApi->initialize_self_service_registration_for_browsers_with_http_info: #{e}"
|
|
1692
1694
|
end
|
|
@@ -1698,7 +1700,7 @@ This endpoint does not need any parameter.
|
|
|
1698
1700
|
|
|
1699
1701
|
### Return type
|
|
1700
1702
|
|
|
1701
|
-
|
|
1703
|
+
[**RegistrationFlow**](RegistrationFlow.md)
|
|
1702
1704
|
|
|
1703
1705
|
### Authorization
|
|
1704
1706
|
|
|
@@ -1710,13 +1712,13 @@ No authorization required
|
|
|
1710
1712
|
- **Accept**: application/json
|
|
1711
1713
|
|
|
1712
1714
|
|
|
1713
|
-
##
|
|
1715
|
+
## initialize_self_service_registration_without_browser
|
|
1714
1716
|
|
|
1715
|
-
> <RegistrationFlow>
|
|
1717
|
+
> <RegistrationFlow> initialize_self_service_registration_without_browser
|
|
1716
1718
|
|
|
1717
|
-
Initialize Registration Flow for
|
|
1719
|
+
Initialize Registration Flow for APIs, Services, Apps, ...
|
|
1718
1720
|
|
|
1719
|
-
This endpoint initiates a registration flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing registration flow call `/self-service/registration/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: 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).
|
|
1721
|
+
This endpoint initiates a registration flow for API clients such as mobile devices, smart TVs, and so on. :::info This endpoint is EXPERIMENTAL and subject to potential breaking changes in the future. ::: If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing registration flow call `/self-service/registration/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: 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).
|
|
1720
1722
|
|
|
1721
1723
|
### Examples
|
|
1722
1724
|
|
|
@@ -1727,29 +1729,29 @@ require 'ory-client'
|
|
|
1727
1729
|
api_instance = OryHydraClient::DefaultApi.new
|
|
1728
1730
|
|
|
1729
1731
|
begin
|
|
1730
|
-
# Initialize Registration Flow for
|
|
1731
|
-
result = api_instance.
|
|
1732
|
+
# Initialize Registration Flow for APIs, Services, Apps, ...
|
|
1733
|
+
result = api_instance.initialize_self_service_registration_without_browser
|
|
1732
1734
|
p result
|
|
1733
1735
|
rescue OryHydraClient::ApiError => e
|
|
1734
|
-
puts "Error when calling DefaultApi->
|
|
1736
|
+
puts "Error when calling DefaultApi->initialize_self_service_registration_without_browser: #{e}"
|
|
1735
1737
|
end
|
|
1736
1738
|
```
|
|
1737
1739
|
|
|
1738
|
-
#### Using the
|
|
1740
|
+
#### Using the initialize_self_service_registration_without_browser_with_http_info variant
|
|
1739
1741
|
|
|
1740
1742
|
This returns an Array which contains the response data, status code and headers.
|
|
1741
1743
|
|
|
1742
|
-
> <Array(<RegistrationFlow>, Integer, Hash)>
|
|
1744
|
+
> <Array(<RegistrationFlow>, Integer, Hash)> initialize_self_service_registration_without_browser_with_http_info
|
|
1743
1745
|
|
|
1744
1746
|
```ruby
|
|
1745
1747
|
begin
|
|
1746
|
-
# Initialize Registration Flow for
|
|
1747
|
-
data, status_code, headers = api_instance.
|
|
1748
|
+
# Initialize Registration Flow for APIs, Services, Apps, ...
|
|
1749
|
+
data, status_code, headers = api_instance.initialize_self_service_registration_without_browser_with_http_info
|
|
1748
1750
|
p status_code # => 2xx
|
|
1749
1751
|
p headers # => { ... }
|
|
1750
1752
|
p data # => <RegistrationFlow>
|
|
1751
1753
|
rescue OryHydraClient::ApiError => e
|
|
1752
|
-
puts "Error when calling DefaultApi->
|
|
1754
|
+
puts "Error when calling DefaultApi->initialize_self_service_registration_without_browser_with_http_info: #{e}"
|
|
1753
1755
|
end
|
|
1754
1756
|
```
|
|
1755
1757
|
|
|
@@ -2367,7 +2369,7 @@ No authorization required
|
|
|
2367
2369
|
|
|
2368
2370
|
Submit a Login Flow
|
|
2369
2371
|
|
|
2370
|
-
Use this endpoint to complete a login flow. This endpoint behaves differently for API and browser flows. API flows expect `application/json` to be sent in the body and responds with HTTP 200 and a application/json body with the session token on success; HTTP 302 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. Browser flows expect `application/x-www-form-urlencoded` to be sent in the body and
|
|
2372
|
+
:::info This endpoint is EXPERIMENTAL and subject to potential breaking changes in the future. ::: Use this endpoint to complete a login flow. This endpoint behaves differently for API and browser flows. API flows expect `application/json` to be sent in the body and responds with HTTP 200 and a application/json body with the session token on success; HTTP 302 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. Browser flows expect a Content-Type of `application/x-www-form-urlencoded` or `application/json` to be sent in the body and respond with a HTTP 302 redirect to the post/after login URL or the `return_to` value if it was set and if the login succeeded; a HTTP 302 redirect to the login UI URL with the flow ID containing the validation errors otherwise. Browser flows with an accept header of `application/json` will not redirect but instead respond with HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success; HTTP 302 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. 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).
|
|
2371
2373
|
|
|
2372
2374
|
### Examples
|
|
2373
2375
|
|
|
@@ -2571,7 +2573,7 @@ No authorization required
|
|
|
2571
2573
|
|
|
2572
2574
|
Submit a Registration Flow
|
|
2573
2575
|
|
|
2574
|
-
Use this endpoint to complete a registration flow by sending an identity's traits and password. This endpoint behaves differently for API and browser flows. API flows expect `application/json` to be sent in the body and respond with HTTP 200 and a application/json body with the created identity success - if the session hook is configured the `session` and `session_token` will also be included; HTTP 302 redirect to a fresh registration flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. Browser flows expect `application/x-www-form-urlencoded` to be sent in the body and
|
|
2576
|
+
:::info This endpoint is EXPERIMENTAL and subject to potential breaking changes in the future. ::: Use this endpoint to complete a registration flow by sending an identity's traits and password. This endpoint behaves differently for API and browser flows. API flows expect `application/json` to be sent in the body and respond with HTTP 200 and a application/json body with the created identity success - if the session hook is configured the `session` and `session_token` will also be included; HTTP 302 redirect to a fresh registration flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. Browser flows expect a Content-Type of `application/x-www-form-urlencoded` or `application/json` to be sent in the body and respond with a HTTP 302 redirect to the post/after registration URL or the `return_to` value if it was set and if the registration succeeded; a HTTP 302 redirect to the registration UI URL with the flow ID containing the validation errors otherwise. Browser flows with an accept header of `application/json` will not redirect but instead respond with HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success; HTTP 302 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. 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).
|
|
2575
2577
|
|
|
2576
2578
|
### Examples
|
|
2577
2579
|
|
data/docs/LoginViaApiResponse.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **session** | [**Session**](Session.md) | | |
|
|
8
|
-
| **session_token** | **String** | The Session Token A session token is equivalent to a session cookie, but it can be sent in the HTTP Authorization Header: Authorization: bearer ${session-token} The session token is only issued for API flows, not for Browser flows! |
|
|
8
|
+
| **session_token** | **String** | The Session Token A session token is equivalent to a session cookie, but it can be sent in the HTTP Authorization Header: Authorization: bearer ${session-token} The session token is only issued for API flows, not for Browser flows! | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **identity** | [**Identity**](Identity.md) | | |
|
|
8
8
|
| **session** | [**Session**](Session.md) | | [optional] |
|
|
9
|
-
| **session_token** | **String** | The Session Token This field is only set when the session hook is configured as a post-registration hook. A session token is equivalent to a session cookie, but it can be sent in the HTTP Authorization Header: Authorization: bearer ${session-token} The session token is only issued for API flows, not for Browser flows! |
|
|
9
|
+
| **session_token** | **String** | The Session Token This field is only set when the session hook is configured as a post-registration hook. A session token is equivalent to a session cookie, but it can be sent in the HTTP Authorization Header: Authorization: bearer ${session-token} The session token is only issued for API flows, not for Browser flows! | [optional] |
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
| **pattern** | **String** | The input's pattern. | [optional] |
|
|
11
11
|
| **required** | **Boolean** | Mark this input field as required. | [optional] |
|
|
12
12
|
| **type** | **String** | | |
|
|
13
|
-
| **value** | [**
|
|
13
|
+
| **value** | [**AnyType**](.md) | The input's value. | [optional] |
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|