ory-kratos-client 0.0.3.alpha2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d9583284f88c2316a1eda66d477cead9e4041da12b3249d5db8046e637b76171
+  data.tar.gz: 75d1e620ec93e5d6139d3c1fc670093bcabebbcf948235e727911e0c72be8d53
+SHA512:
+  metadata.gz: 1317f9ec4f01158e724a036edeed7ac977a6243ab1d2a61d4ebf098b820a46d08fb48fd8f1cf20a991a6d150b36e41d044aa77eb96ce47551c03d35169eb4d9f
+  data.tar.gz: 27f95f77813b08daaa540187fd83f5bc920915aaa633973ba37c2e8ecf6507e94314909580135b06fb2f1831e81495844176affe0630ad694a4bf496e74db928

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,128 @@
+# ory-kratos-client
+
+OryHydraClient - the Ruby gem for the Ory Kratos
+
+Welcome to the ORY Kratos HTTP API documentation!
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: latest
+- Package version: v0.0.3-alpha.2
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build ory-kratos-client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./ory-kratos-client-v0.0.3-alpha.2.gem
+```
+
+(for development, run `gem install --dev ./ory-kratos-client-v0.0.3-alpha.2.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'ory-kratos-client', '~> v0.0.3-alpha.2'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/ory/sdk, then add the following in the Gemfile:
+
+    gem 'ory-kratos-client', :git => 'https://github.com/ory/sdk.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'ory-kratos-client'
+
+api_instance = OryHydraClient::AdminApi.new
+body = OryHydraClient::Identity.new # Identity | 
+
+begin
+  #Create an identity
+  result = api_instance.create_identity(body)
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Exception when calling AdminApi->create_identity: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://localhost*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*OryHydraClient::AdminApi* | [**create_identity**](docs/AdminApi.md#create_identity) | **POST** /identities | Create an identity
+*OryHydraClient::AdminApi* | [**delete_identity**](docs/AdminApi.md#delete_identity) | **DELETE** /identities/{id} | Delete an identity
+*OryHydraClient::AdminApi* | [**get_identity**](docs/AdminApi.md#get_identity) | **GET** /identities/{id} | Get an identity
+*OryHydraClient::AdminApi* | [**get_self_service_browser_login_request**](docs/AdminApi.md#get_self_service_browser_login_request) | **GET** /self-service/browser/flows/requests/login | Get the request context of browser-based login user flows
+*OryHydraClient::AdminApi* | [**get_self_service_browser_profile_management_request**](docs/AdminApi.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
+*OryHydraClient::AdminApi* | [**get_self_service_browser_registration_request**](docs/AdminApi.md#get_self_service_browser_registration_request) | **GET** /self-service/browser/flows/requests/registration | Get the request context of browser-based registration user flows
+*OryHydraClient::AdminApi* | [**list_identities**](docs/AdminApi.md#list_identities) | **GET** /identities | List all identities in the system
+*OryHydraClient::AdminApi* | [**update_identity**](docs/AdminApi.md#update_identity) | **PUT** /identities/{id} | Update an identity
+*OryHydraClient::CommonApi* | [**get_self_service_browser_login_request**](docs/CommonApi.md#get_self_service_browser_login_request) | **GET** /self-service/browser/flows/requests/login | Get the request context of browser-based login user flows
+*OryHydraClient::CommonApi* | [**get_self_service_browser_profile_management_request**](docs/CommonApi.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
+*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
+*OryHydraClient::HealthApi* | [**is_instance_alive**](docs/HealthApi.md#is_instance_alive) | **GET** /health/alive | Check alive status
+*OryHydraClient::HealthApi* | [**is_instance_ready**](docs/HealthApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status
+*OryHydraClient::PublicApi* | [**complete_self_service_browser_profile_management_flow**](docs/PublicApi.md#complete_self_service_browser_profile_management_flow) | **POST** /self-service/browser/flows/profile/update | Complete the browser-based profile management flows
+*OryHydraClient::PublicApi* | [**get_self_service_browser_login_request**](docs/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
+*OryHydraClient::PublicApi* | [**get_self_service_browser_profile_management_request**](docs/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
+*OryHydraClient::PublicApi* | [**get_self_service_browser_registration_request**](docs/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
+*OryHydraClient::PublicApi* | [**initialize_self_service_browser_login_flow**](docs/PublicApi.md#initialize_self_service_browser_login_flow) | **GET** /self-service/browser/flows/login | Initialize browser-based login user flow
+*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
+*OryHydraClient::PublicApi* | [**initialize_self_service_browser_registration_flow**](docs/PublicApi.md#initialize_self_service_browser_registration_flow) | **GET** /self-service/browser/flows/registration | Initialize browser-based registration user flow
+*OryHydraClient::PublicApi* | [**initialize_self_service_profile_management_flow**](docs/PublicApi.md#initialize_self_service_profile_management_flow) | **GET** /self-service/browser/flows/profile | Initialize browser-based profile management flow
+*OryHydraClient::PublicApi* | [**whoami**](docs/PublicApi.md#whoami) | **GET** /sessions/whoami | Check who the current HTTP session belongs to
+*OryHydraClient::VersionApi* | [**get_version**](docs/VersionApi.md#get_version) | **GET** /version | Get service version
+
+
+## Documentation for Models
+
+ - [OryHydraClient::CompleteSelfServiceBrowserProfileManagementFlowPayload](docs/CompleteSelfServiceBrowserProfileManagementFlowPayload.md)
+ - [OryHydraClient::Error](docs/Error.md)
+ - [OryHydraClient::Form](docs/Form.md)
+ - [OryHydraClient::FormField](docs/FormField.md)
+ - [OryHydraClient::GenericError](docs/GenericError.md)
+ - [OryHydraClient::GenericErrorPayload](docs/GenericErrorPayload.md)
+ - [OryHydraClient::HealthNotReadyStatus](docs/HealthNotReadyStatus.md)
+ - [OryHydraClient::HealthStatus](docs/HealthStatus.md)
+ - [OryHydraClient::Identity](docs/Identity.md)
+ - [OryHydraClient::LoginRequest](docs/LoginRequest.md)
+ - [OryHydraClient::LoginRequestMethod](docs/LoginRequestMethod.md)
+ - [OryHydraClient::LoginRequestMethodConfig](docs/LoginRequestMethodConfig.md)
+ - [OryHydraClient::ProfileManagementRequest](docs/ProfileManagementRequest.md)
+ - [OryHydraClient::RegistrationRequest](docs/RegistrationRequest.md)
+ - [OryHydraClient::RegistrationRequestMethod](docs/RegistrationRequestMethod.md)
+ - [OryHydraClient::RegistrationRequestMethodConfig](docs/RegistrationRequestMethodConfig.md)
+ - [OryHydraClient::Session](docs/Session.md)
+ - [OryHydraClient::Version](docs/Version.md)
+
+
+## Documentation for Authorization
+
+ All endpoints do not require authorization.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AdminApi.md

@@ -0,0 +1,389 @@
+# OryHydraClient::AdminApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_identity**](AdminApi.md#create_identity) | **POST** /identities | Create an identity
+[**delete_identity**](AdminApi.md#delete_identity) | **DELETE** /identities/{id} | Delete an identity
+[**get_identity**](AdminApi.md#get_identity) | **GET** /identities/{id} | Get an identity
+[**get_self_service_browser_login_request**](AdminApi.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**](AdminApi.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**](AdminApi.md#get_self_service_browser_registration_request) | **GET** /self-service/browser/flows/requests/registration | Get the request context of browser-based registration user flows
+[**list_identities**](AdminApi.md#list_identities) | **GET** /identities | List all identities in the system
+[**update_identity**](AdminApi.md#update_identity) | **PUT** /identities/{id} | Update an identity
+
+
+
+## create_identity
+
+> Identity create_identity(body)
+
+Create an identity
+
+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).
+
+### Example
+
+```ruby
+# load the gem
+require 'ory-kratos-client'
+
+api_instance = OryHydraClient::AdminApi.new
+body = OryHydraClient::Identity.new # Identity | 
+
+begin
+  #Create an identity
+  result = api_instance.create_identity(body)
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Exception when calling AdminApi->create_identity: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**Identity**](Identity.md)|  | 
+
+### Return type
+
+[**Identity**](Identity.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_identity
+
+> delete_identity(id)
+
+Delete an identity
+
+This endpoint deletes an identity. This can not be undone.  Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
+
+### Example
+
+```ruby
+# load the gem
+require 'ory-kratos-client'
+
+api_instance = OryHydraClient::AdminApi.new
+id = 'id_example' # String | ID is the identity's ID.
+
+begin
+  #Delete an identity
+  api_instance.delete_identity(id)
+rescue OryHydraClient::ApiError => e
+  puts "Exception when calling AdminApi->delete_identity: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| ID is the identity's ID. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_identity
+
+> Identity get_identity(id)
+
+Get an identity
+
+Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
+
+### Example
+
+```ruby
+# load the gem
+require 'ory-kratos-client'
+
+api_instance = OryHydraClient::AdminApi.new
+id = 'id_example' # String | ID must be set to the ID of identity you want to get
+
+begin
+  #Get an identity
+  result = api_instance.get_identity(id)
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Exception when calling AdminApi->get_identity: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| ID must be set to the ID of identity you want to get | 
+
+### Return type
+
+[**Identity**](Identity.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **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::AdminApi.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 AdminApi->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::AdminApi.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 AdminApi->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::AdminApi.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 AdminApi->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
+
+
+## list_identities
+
+> Array<Identity> list_identities
+
+List all identities in the system
+
+This endpoint returns a login request's context with, for example, error details and other information.  Learn how identities work in [ORY Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
+
+### Example
+
+```ruby
+# load the gem
+require 'ory-kratos-client'
+
+api_instance = OryHydraClient::AdminApi.new
+
+begin
+  #List all identities in the system
+  result = api_instance.list_identities
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Exception when calling AdminApi->list_identities: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<Identity>**](Identity.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_identity
+
+> Identity update_identity(id, body)
+
+Update an identity
+
+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).
+
+### Example
+
+```ruby
+# load the gem
+require 'ory-kratos-client'
+
+api_instance = OryHydraClient::AdminApi.new
+id = 'id_example' # String | ID must be set to the ID of identity you want to update
+body = OryHydraClient::Identity.new # Identity | 
+
+begin
+  #Update an identity
+  result = api_instance.update_identity(id, body)
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Exception when calling AdminApi->update_identity: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| ID must be set to the ID of identity you want to update | 
+ **body** | [**Identity**](Identity.md)|  | 
+
+### Return type
+
+[**Identity**](Identity.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+