ory-kratos-client 0.0.3.alpha2

data/docs/LoginRequest.md

@@ -0,0 +1,27 @@
+# OryHydraClient::LoginRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active** | **String** | and so on. | [optional] 
+**expires_at** | **DateTime** | ExpiresAt is the time (UTC) when the request expires. If the user still wishes to log in, a new request has to be initiated. | [optional] 
+**id** | **String** |  | [optional] 
+**issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. | [optional] 
+**methods** | [**Hash<String, LoginRequestMethod>**](LoginRequestMethod.md) | Methods contains context for all enabled login methods. If a login request has been processed, but for example the password is incorrect, this will contain error messages. | [optional] 
+**request_url** | **String** | RequestURL is the initial URL that was requested from ORY Kratos. It can be used to forward information contained in the URL's path or query for example. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::LoginRequest.new(active: null,
+                                 expires_at: null,
+                                 id: null,
+                                 issued_at: null,
+                                 methods: null,
+                                 request_url: null)
+```
+
+

data/docs/LoginRequestMethod.md

@@ -0,0 +1,19 @@
+# OryHydraClient::LoginRequestMethod
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**config** | [**LoginRequestMethodConfig**](LoginRequestMethodConfig.md) |  | [optional] 
+**method** | **String** | and so on. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::LoginRequestMethod.new(config: null,
+                                 method: null)
+```
+
+

data/docs/LoginRequestMethodConfig.md

@@ -0,0 +1,16 @@
+# OryHydraClient::LoginRequestMethodConfig
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::LoginRequestMethodConfig.new()
+```
+
+

data/docs/OidcStrategyCredentialsConfig.md

@@ -0,0 +1,19 @@
+# OryHydraClient::OidcStrategyCredentialsConfig
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**provider** | **String** |  | [optional] 
+**subject** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::OidcStrategyCredentialsConfig.new(provider: null,
+                                 subject: null)
+```
+
+

data/docs/OidcStrategyRequestMethod.md

@@ -0,0 +1,25 @@
+# OryHydraClient::OidcStrategyRequestMethod
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | **String** | Action should be used as the form action URL (<form action=\"{{ .Action }}\" method=\"post\">). | [optional] 
+**errors** | [**Array<Error>**](Error.md) | Errors contains all form errors. These will be duplicates of the individual field errors. | [optional] 
+**fields** | [**Hash<String, FormField>**](FormField.md) | Fields contains multiple fields asdfasdf | [optional] 
+**method** | **String** | Method is the form method (e.g. POST) | [optional] 
+**providers** | [**Array<FormField>**](FormField.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::OidcStrategyRequestMethod.new(action: null,
+                                 errors: null,
+                                 fields: null,
+                                 method: null,
+                                 providers: null)
+```
+
+

data/docs/ProfileManagementRequest.md

@@ -0,0 +1,29 @@
+# OryHydraClient::ProfileManagementRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**expires_at** | **DateTime** | ExpiresAt is the time (UTC) when the request expires. If the user still wishes to update the profile, a new request has to be initiated. | [optional] 
+**form** | [**Form**](Form.md) |  | [optional] 
+**id** | **String** |  | [optional] 
+**identity** | [**Identity**](Identity.md) |  | [optional] 
+**issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. | [optional] 
+**request_url** | **String** | RequestURL is the initial URL that was requested from ORY Kratos. It can be used to forward information contained in the URL's path or query for example. | [optional] 
+**update_successful** | **Boolean** | UpdateSuccessful, if true, indicates that the profile has been updated successfully with the provided data. Done will stay true when repeatedly checking. If set to true, done will revert back to false only when a request with invalid (e.g. \"please use a valid phone number\") data was sent. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::ProfileManagementRequest.new(expires_at: null,
+                                 form: null,
+                                 id: null,
+                                 identity: null,
+                                 issued_at: null,
+                                 request_url: null,
+                                 update_successful: null)
+```
+
+

data/docs/PublicApi.md

@@ -0,0 +1,419 @@
+# OryHydraClient::PublicApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**complete_self_service_browser_profile_management_flow**](PublicApi.md#complete_self_service_browser_profile_management_flow) | **POST** /self-service/browser/flows/profile/update | Complete the browser-based profile management flows
+[**get_self_service_browser_login_request**](PublicApi.md#get_self_service_browser_login_request) | **GET** /self-service/browser/flows/requests/login | Get the request context of browser-based login user flows
+[**get_self_service_browser_profile_management_request**](PublicApi.md#get_self_service_browser_profile_management_request) | **GET** /self-service/browser/flows/requests/profile | Get the request context of browser-based profile management flows
+[**get_self_service_browser_registration_request**](PublicApi.md#get_self_service_browser_registration_request) | **GET** /self-service/browser/flows/requests/registration | Get the request context of browser-based registration user flows
+[**initialize_self_service_browser_login_flow**](PublicApi.md#initialize_self_service_browser_login_flow) | **GET** /self-service/browser/flows/login | Initialize browser-based login user flow
+[**initialize_self_service_browser_logout_flow**](PublicApi.md#initialize_self_service_browser_logout_flow) | **GET** /self-service/browser/flows/logout | Initialize Browser-Based Logout User Flow
+[**initialize_self_service_browser_registration_flow**](PublicApi.md#initialize_self_service_browser_registration_flow) | **GET** /self-service/browser/flows/registration | Initialize browser-based registration user flow
+[**initialize_self_service_profile_management_flow**](PublicApi.md#initialize_self_service_profile_management_flow) | **GET** /self-service/browser/flows/profile | Initialize browser-based profile management flow
+[**whoami**](PublicApi.md#whoami) | **GET** /sessions/whoami | Check who the current HTTP session belongs to
+
+
+
+## complete_self_service_browser_profile_management_flow
+
+> complete_self_service_browser_profile_management_flow(body, opts)
+
+Complete the browser-based profile management flows
+
+This endpoint completes a browser-based profile management flow. This is usually achieved by POSTing data to this endpoint.  If the provided profile data is valid against the Identity's Traits JSON Schema, the data will be updated and the browser redirected to `url.profile_ui` for further steps.  > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...) and HTML Forms.  More information can be found at [ORY Kratos Profile Management Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-profile-management).
+
+### Example
+
+```ruby
+# load the gem
+require 'ory-kratos-client'
+
+api_instance = OryHydraClient::PublicApi.new
+body = OryHydraClient::CompleteSelfServiceBrowserProfileManagementFlowPayload.new # CompleteSelfServiceBrowserProfileManagementFlowPayload | 
+opts = {
+  request: 'request_example' # String | Request is the request ID.  type: string
+}
+
+begin
+  #Complete the browser-based profile management flows
+  api_instance.complete_self_service_browser_profile_management_flow(body, opts)
+rescue OryHydraClient::ApiError => e
+  puts "Exception when calling PublicApi->complete_self_service_browser_profile_management_flow: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**CompleteSelfServiceBrowserProfileManagementFlowPayload**](CompleteSelfServiceBrowserProfileManagementFlowPayload.md)|  | 
+ **request** | **String**| Request is the request ID.  type: string | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## get_self_service_browser_login_request
+
+> LoginRequest get_self_service_browser_login_request(request)
+
+Get the request context of browser-based login user flows
+
+This endpoint returns a login request's context with, for example, error details and other information.  When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks.  More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
+
+### Example
+
+```ruby
+# load the gem
+require 'ory-kratos-client'
+
+api_instance = OryHydraClient::PublicApi.new
+request = 'request_example' # String | Request is the Login Request ID  The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/login?request=abcde`).
+
+begin
+  #Get the request context of browser-based login user flows
+  result = api_instance.get_self_service_browser_login_request(request)
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Exception when calling PublicApi->get_self_service_browser_login_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | **String**| Request is the Login Request ID  The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/login?request=abcde`). | 
+
+### Return type
+
+[**LoginRequest**](LoginRequest.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_self_service_browser_profile_management_request
+
+> ProfileManagementRequest get_self_service_browser_profile_management_request(request)
+
+Get the request context of browser-based profile management flows
+
+When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500.  More information can be found at [ORY Kratos Profile Management Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-profile-management).
+
+### Example
+
+```ruby
+# load the gem
+require 'ory-kratos-client'
+
+api_instance = OryHydraClient::PublicApi.new
+request = 'request_example' # String | Request is the Login Request ID  The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/login?request=abcde`).
+
+begin
+  #Get the request context of browser-based profile management flows
+  result = api_instance.get_self_service_browser_profile_management_request(request)
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Exception when calling PublicApi->get_self_service_browser_profile_management_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | **String**| Request is the Login Request ID  The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/login?request=abcde`). | 
+
+### Return type
+
+[**ProfileManagementRequest**](ProfileManagementRequest.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_self_service_browser_registration_request
+
+> RegistrationRequest get_self_service_browser_registration_request(request)
+
+Get the request context of browser-based registration user flows
+
+This endpoint returns a registration request's context with, for example, error details and other information.  When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks.  More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
+
+### Example
+
+```ruby
+# load the gem
+require 'ory-kratos-client'
+
+api_instance = OryHydraClient::PublicApi.new
+request = 'request_example' # String | Request is the Registration Request ID  The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/registration?request=abcde`).
+
+begin
+  #Get the request context of browser-based registration user flows
+  result = api_instance.get_self_service_browser_registration_request(request)
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Exception when calling PublicApi->get_self_service_browser_registration_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | **String**| Request is the Registration Request ID  The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/registration?request=abcde`). | 
+
+### Return type
+
+[**RegistrationRequest**](RegistrationRequest.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## initialize_self_service_browser_login_flow
+
+> initialize_self_service_browser_login_flow
+
+Initialize browser-based login user flow
+
+This endpoint initializes a browser-based user login flow. Once initialized, the browser will be redirected to `urls.login_ui` with the request ID set as a query parameter. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url`.  > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...).  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).
+
+### Example
+
+```ruby
+# load the gem
+require 'ory-kratos-client'
+
+api_instance = OryHydraClient::PublicApi.new
+
+begin
+  #Initialize browser-based login user flow
+  api_instance.initialize_self_service_browser_login_flow
+rescue OryHydraClient::ApiError => e
+  puts "Exception when calling PublicApi->initialize_self_service_browser_login_flow: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## initialize_self_service_browser_logout_flow
+
+> initialize_self_service_browser_logout_flow
+
+Initialize Browser-Based Logout User Flow
+
+This endpoint initializes a logout flow.  > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...).  On successful logout, the browser will be redirected (HTTP 302 Found) to `urls.default_return_to`.  More information can be found at [ORY Kratos User Logout Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-logout).
+
+### Example
+
+```ruby
+# load the gem
+require 'ory-kratos-client'
+
+api_instance = OryHydraClient::PublicApi.new
+
+begin
+  #Initialize Browser-Based Logout User Flow
+  api_instance.initialize_self_service_browser_logout_flow
+rescue OryHydraClient::ApiError => e
+  puts "Exception when calling PublicApi->initialize_self_service_browser_logout_flow: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## initialize_self_service_browser_registration_flow
+
+> initialize_self_service_browser_registration_flow
+
+Initialize browser-based registration user flow
+
+This endpoint initializes a browser-based user registration flow. Once initialized, the browser will be redirected to `urls.registration_ui` with the request ID set as a query parameter. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url`.  > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...).  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).
+
+### Example
+
+```ruby
+# load the gem
+require 'ory-kratos-client'
+
+api_instance = OryHydraClient::PublicApi.new
+
+begin
+  #Initialize browser-based registration user flow
+  api_instance.initialize_self_service_browser_registration_flow
+rescue OryHydraClient::ApiError => e
+  puts "Exception when calling PublicApi->initialize_self_service_browser_registration_flow: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## initialize_self_service_profile_management_flow
+
+> initialize_self_service_profile_management_flow
+
+Initialize browser-based profile management flow
+
+This endpoint initializes a browser-based profile management flow. Once initialized, the browser will be redirected to `urls.profile_ui` with the request ID set as a query parameter. If no valid user session exists, a login flow will be initialized.  > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...).  More information can be found at [ORY Kratos Profile Management Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-profile-management).
+
+### Example
+
+```ruby
+# load the gem
+require 'ory-kratos-client'
+
+api_instance = OryHydraClient::PublicApi.new
+
+begin
+  #Initialize browser-based profile management flow
+  api_instance.initialize_self_service_profile_management_flow
+rescue OryHydraClient::ApiError => e
+  puts "Exception when calling PublicApi->initialize_self_service_profile_management_flow: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## whoami
+
+> Session whoami
+
+Check who the current HTTP session belongs to
+
+Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated. Returns a session object or 401 if the credentials are invalid or no credentials were sent.  This endpoint is useful for reverse proxies and API Gateways.
+
+### Example
+
+```ruby
+# load the gem
+require 'ory-kratos-client'
+
+api_instance = OryHydraClient::PublicApi.new
+
+begin
+  #Check who the current HTTP session belongs to
+  result = api_instance.whoami
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Exception when calling PublicApi->whoami: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Session**](Session.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+