keynetra-client 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6726f396d1c490c843b50c0da08446d605a0e48a43d30b28784f1cba2627cb26
+  data.tar.gz: 73b0505539cda9eb48a6827924495d349b536f58fd7ebeabf23ce3bd9f7ceb25
+SHA512:
+  metadata.gz: 6b4f37ad87c1143ee1ee573a18e7c1a0660dd73275a63931ca7cf948e8d7eacd7e3059a0fe45f900895b64d391cf32991c3cd4caadc99d04abb3e9f1b95432c2
+  data.tar.gz: b54d6d02b91439ac8768b75c1530156d7c81bf7d9f2961b409758cda06a0fa911fb293a13926056d54d717de61f54ed59b316e26f4f90d1cf40b0e89664f83d3

data/Gemfile

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

data/README.md

@@ -0,0 +1,49 @@
+# keynetra-client
+
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Version](https://img.shields.io/badge/version-0.1.1-green.svg)]()
+[![Documentation](https://img.shields.io/badge/docs-latest-brightgreen.svg)](https://docs.keynetra.com/sdks/ruby)
+
+Official Ruby Client SDK for the [KeyNetra](https://keynetra.com) authorization platform. 🛡️
+
+KeyNetra provides high-performance, distributed authorization as a service. This SDK allows your Ruby applications to integrate seamlessly with KeyNetra for access control and policy management.
+
+## ✨ Features
+
+- **🚀 Unified Client**: Simple entry point for all API operations.
+- **🛡️ Type Safety**: Full type definitions for requests and responses.
+- **🔑 Security**: Built-in support for API Key and Bearer token authentication.
+- **⚡ Performance**: Optimized for low-latency authorization checks.
+
+## 📦 Installation
+
+```bash
+gem install keynetra-client
+```
+
+## 🚀 Quick Start
+
+```ruby
+require 'keynetra-client'
+
+client = KeyNetra::KeyNetraClient.new(
+    "http://localhost:8080",
+    "YOUR_API_KEY"
+)
+
+# Perform an access check
+decision = client.access_api.check_access(...)
+```
+
+
+
+## 📚 Documentation
+
+For full API documentation, please visit the [KeyNetra Documentation Portal](https://docs.keynetra.com/sdks/ruby).
+
+## 🤝 Support
+
+- **Source**: [https://github.com/keynetra/keynetra-client-ruby](https://github.com/keynetra/keynetra-client-ruby)
+- **Issues**: [GitHub Issues](https://github.com/keynetra/keynetra-client-ruby/issues)
+- **License**: Apache-2.0
+

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/ACLCreate.md

@@ -0,0 +1,28 @@
+# KeyNetra::ACLCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subject_type** | **String** |  |  |
+| **subject_id** | **String** |  |  |
+| **resource_type** | **String** |  |  |
+| **resource_id** | **String** |  |  |
+| **action** | **String** |  |  |
+| **effect** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::ACLCreate.new(
+  subject_type: null,
+  subject_id: null,
+  resource_type: null,
+  resource_id: null,
+  action: null,
+  effect: null
+)
+```
+

data/docs/ACLOut.md

@@ -0,0 +1,34 @@
+# KeyNetra::ACLOut
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subject_type** | **String** |  |  |
+| **subject_id** | **String** |  |  |
+| **resource_type** | **String** |  |  |
+| **resource_id** | **String** |  |  |
+| **action** | **String** |  |  |
+| **effect** | **String** |  |  |
+| **id** | **Integer** |  |  |
+| **tenant_id** | **Integer** |  |  |
+| **created_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::ACLOut.new(
+  subject_type: null,
+  subject_id: null,
+  resource_type: null,
+  resource_id: null,
+  action: null,
+  effect: null,
+  id: null,
+  tenant_id: null,
+  created_at: null
+)
+```
+

data/docs/AccessApi.md

@@ -0,0 +1,234 @@
+# KeyNetra::AccessApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**check_access_batch_check_access_batch_post**](AccessApi.md#check_access_batch_check_access_batch_post) | **POST** /check-access-batch | Check Access Batch |
+| [**check_access_check_access_post**](AccessApi.md#check_access_check_access_post) | **POST** /check-access | Check Access |
+| [**simulate_simulate_post**](AccessApi.md#simulate_simulate_post) | **POST** /simulate | Simulate |
+
+
+## check_access_batch_check_access_batch_post
+
+> <SuccessResponseBatchAccessResponse> check_access_batch_check_access_batch_post(batch_access_request, opts)
+
+Check Access Batch
+
+### Examples
+
+```ruby
+require 'time'
+require 'keynetra-client'
+# setup authorization
+KeyNetra.configure do |config|
+  # Configure API key authorization: APIKeyHeader
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+
+  # Configure Bearer authorization: HTTPBearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = KeyNetra::AccessApi.new
+batch_access_request = KeyNetra::BatchAccessRequest.new({items: [KeyNetra::BatchAccessItem.new({action: 'action_example'})]}) # BatchAccessRequest | 
+opts = {
+  policy_set: 'policy_set_example' # String | 
+}
+
+begin
+  # Check Access Batch
+  result = api_instance.check_access_batch_check_access_batch_post(batch_access_request, opts)
+  p result
+rescue KeyNetra::ApiError => e
+  puts "Error when calling AccessApi->check_access_batch_check_access_batch_post: #{e}"
+end
+```
+
+#### Using the check_access_batch_check_access_batch_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponseBatchAccessResponse>, Integer, Hash)> check_access_batch_check_access_batch_post_with_http_info(batch_access_request, opts)
+
+```ruby
+begin
+  # Check Access Batch
+  data, status_code, headers = api_instance.check_access_batch_check_access_batch_post_with_http_info(batch_access_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponseBatchAccessResponse>
+rescue KeyNetra::ApiError => e
+  puts "Error when calling AccessApi->check_access_batch_check_access_batch_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **batch_access_request** | [**BatchAccessRequest**](BatchAccessRequest.md) |  |  |
+| **policy_set** | **String** |  | [optional][default to &#39;active&#39;] |
+
+### Return type
+
+[**SuccessResponseBatchAccessResponse**](SuccessResponseBatchAccessResponse.md)
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## check_access_check_access_post
+
+> <SuccessResponseAccessDecisionResponse> check_access_check_access_post(access_request, opts)
+
+Check Access
+
+### Examples
+
+```ruby
+require 'time'
+require 'keynetra-client'
+# setup authorization
+KeyNetra.configure do |config|
+  # Configure API key authorization: APIKeyHeader
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+
+  # Configure Bearer authorization: HTTPBearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = KeyNetra::AccessApi.new
+access_request = KeyNetra::AccessRequest.new({action: 'action_example'}) # AccessRequest | 
+opts = {
+  policy_set: 'policy_set_example' # String | 
+}
+
+begin
+  # Check Access
+  result = api_instance.check_access_check_access_post(access_request, opts)
+  p result
+rescue KeyNetra::ApiError => e
+  puts "Error when calling AccessApi->check_access_check_access_post: #{e}"
+end
+```
+
+#### Using the check_access_check_access_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponseAccessDecisionResponse>, Integer, Hash)> check_access_check_access_post_with_http_info(access_request, opts)
+
+```ruby
+begin
+  # Check Access
+  data, status_code, headers = api_instance.check_access_check_access_post_with_http_info(access_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponseAccessDecisionResponse>
+rescue KeyNetra::ApiError => e
+  puts "Error when calling AccessApi->check_access_check_access_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_request** | [**AccessRequest**](AccessRequest.md) |  |  |
+| **policy_set** | **String** |  | [optional][default to &#39;active&#39;] |
+
+### Return type
+
+[**SuccessResponseAccessDecisionResponse**](SuccessResponseAccessDecisionResponse.md)
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## simulate_simulate_post
+
+> <SuccessResponseSimulationResponse> simulate_simulate_post(access_request)
+
+Simulate
+
+### Examples
+
+```ruby
+require 'time'
+require 'keynetra-client'
+# setup authorization
+KeyNetra.configure do |config|
+  # Configure API key authorization: APIKeyHeader
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+
+  # Configure Bearer authorization: HTTPBearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = KeyNetra::AccessApi.new
+access_request = KeyNetra::AccessRequest.new({action: 'action_example'}) # AccessRequest | 
+
+begin
+  # Simulate
+  result = api_instance.simulate_simulate_post(access_request)
+  p result
+rescue KeyNetra::ApiError => e
+  puts "Error when calling AccessApi->simulate_simulate_post: #{e}"
+end
+```
+
+#### Using the simulate_simulate_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponseSimulationResponse>, Integer, Hash)> simulate_simulate_post_with_http_info(access_request)
+
+```ruby
+begin
+  # Simulate
+  data, status_code, headers = api_instance.simulate_simulate_post_with_http_info(access_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponseSimulationResponse>
+rescue KeyNetra::ApiError => e
+  puts "Error when calling AccessApi->simulate_simulate_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_request** | [**AccessRequest**](AccessRequest.md) |  |  |
+
+### Return type
+
+[**SuccessResponseSimulationResponse**](SuccessResponseSimulationResponse.md)
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/AccessDecisionResponse.md

@@ -0,0 +1,30 @@
+# KeyNetra::AccessDecisionResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **allowed** | **Boolean** |  |  |
+| **decision** | **String** |  |  |
+| **matched_policies** | **Array<String>** |  | [optional] |
+| **reason** | **String** |  | [optional] |
+| **policy_id** | **String** |  | [optional] |
+| **explain_trace** | **Array<Hash<String, Object>>** |  | [optional] |
+| **revision** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::AccessDecisionResponse.new(
+  allowed: null,
+  decision: null,
+  matched_policies: null,
+  reason: null,
+  policy_id: null,
+  explain_trace: null,
+  revision: null
+)
+```
+

data/docs/AccessRequest.md

@@ -0,0 +1,28 @@
+# KeyNetra::AccessRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user** | **Hash<String, Object>** |  | [optional] |
+| **action** | **String** |  |  |
+| **resource** | **Hash<String, Object>** |  | [optional] |
+| **context** | **Hash<String, Object>** |  | [optional] |
+| **consistency** | **String** |  | [optional][default to 'eventual'] |
+| **revision** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::AccessRequest.new(
+  user: null,
+  action: null,
+  resource: null,
+  context: null,
+  consistency: null,
+  revision: null
+)
+```
+

data/docs/AdminLoginRequest.md

@@ -0,0 +1,20 @@
+# KeyNetra::AdminLoginRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **username** | **String** |  |  |
+| **password** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::AdminLoginRequest.new(
+  username: null,
+  password: null
+)
+```
+

data/docs/AdminLoginResponse.md

@@ -0,0 +1,26 @@
+# KeyNetra::AdminLoginResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_token** | **String** |  |  |
+| **token_type** | **String** |  | [optional][default to 'bearer'] |
+| **expires_in** | **Integer** |  |  |
+| **role** | **String** |  | [optional][default to 'admin'] |
+| **tenant_key** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::AdminLoginResponse.new(
+  access_token: null,
+  token_type: null,
+  expires_in: null,
+  role: null,
+  tenant_key: null
+)
+```
+

data/docs/AuditRecordOut.md

@@ -0,0 +1,42 @@
+# KeyNetra::AuditRecordOut
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+| **principal_type** | **String** |  |  |
+| **principal_id** | **String** |  |  |
+| **correlation_id** | **String** |  | [optional] |
+| **user** | **Hash<String, Object>** |  |  |
+| **action** | **String** |  |  |
+| **resource** | **Hash<String, Object>** |  |  |
+| **decision** | **String** |  |  |
+| **matched_policies** | **Array<Object>** |  |  |
+| **reason** | **String** |  | [optional] |
+| **evaluated_rules** | **Array<Object>** |  |  |
+| **failed_conditions** | **Array<Object>** |  |  |
+| **created_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::AuditRecordOut.new(
+  id: null,
+  principal_type: null,
+  principal_id: null,
+  correlation_id: null,
+  user: null,
+  action: null,
+  resource: null,
+  decision: null,
+  matched_policies: null,
+  reason: null,
+  evaluated_rules: null,
+  failed_conditions: null,
+  created_at: null
+)
+```
+

data/docs/AuthApi.md

@@ -0,0 +1,133 @@
+# KeyNetra::AuthApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**admin_login_admin_login_post**](AuthApi.md#admin_login_admin_login_post) | **POST** /admin/login | Admin Login |
+| [**admin_login_admin_login_post_0**](AuthApi.md#admin_login_admin_login_post_0) | **POST** /admin/login | Admin Login |
+
+
+## admin_login_admin_login_post
+
+> <SuccessResponseAdminLoginResponse> admin_login_admin_login_post(admin_login_request)
+
+Admin Login
+
+### Examples
+
+```ruby
+require 'time'
+require 'keynetra-client'
+
+api_instance = KeyNetra::AuthApi.new
+admin_login_request = KeyNetra::AdminLoginRequest.new({username: 'username_example', password: 'password_example'}) # AdminLoginRequest | 
+
+begin
+  # Admin Login
+  result = api_instance.admin_login_admin_login_post(admin_login_request)
+  p result
+rescue KeyNetra::ApiError => e
+  puts "Error when calling AuthApi->admin_login_admin_login_post: #{e}"
+end
+```
+
+#### Using the admin_login_admin_login_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponseAdminLoginResponse>, Integer, Hash)> admin_login_admin_login_post_with_http_info(admin_login_request)
+
+```ruby
+begin
+  # Admin Login
+  data, status_code, headers = api_instance.admin_login_admin_login_post_with_http_info(admin_login_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponseAdminLoginResponse>
+rescue KeyNetra::ApiError => e
+  puts "Error when calling AuthApi->admin_login_admin_login_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **admin_login_request** | [**AdminLoginRequest**](AdminLoginRequest.md) |  |  |
+
+### Return type
+
+[**SuccessResponseAdminLoginResponse**](SuccessResponseAdminLoginResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## admin_login_admin_login_post_0
+
+> <SuccessResponseAdminLoginResponse> admin_login_admin_login_post_0(admin_login_request)
+
+Admin Login
+
+### Examples
+
+```ruby
+require 'time'
+require 'keynetra-client'
+
+api_instance = KeyNetra::AuthApi.new
+admin_login_request = KeyNetra::AdminLoginRequest.new({username: 'username_example', password: 'password_example'}) # AdminLoginRequest | 
+
+begin
+  # Admin Login
+  result = api_instance.admin_login_admin_login_post_0(admin_login_request)
+  p result
+rescue KeyNetra::ApiError => e
+  puts "Error when calling AuthApi->admin_login_admin_login_post_0: #{e}"
+end
+```
+
+#### Using the admin_login_admin_login_post_0_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponseAdminLoginResponse>, Integer, Hash)> admin_login_admin_login_post_0_with_http_info(admin_login_request)
+
+```ruby
+begin
+  # Admin Login
+  data, status_code, headers = api_instance.admin_login_admin_login_post_0_with_http_info(admin_login_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponseAdminLoginResponse>
+rescue KeyNetra::ApiError => e
+  puts "Error when calling AuthApi->admin_login_admin_login_post_0_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **admin_login_request** | [**AdminLoginRequest**](AdminLoginRequest.md) |  |  |
+
+### Return type
+
+[**SuccessResponseAdminLoginResponse**](SuccessResponseAdminLoginResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/AuthModelCreate.md

@@ -0,0 +1,18 @@
+# KeyNetra::AuthModelCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **schema** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'keynetra-client'
+
+instance = KeyNetra::AuthModelCreate.new(
+  schema: null
+)
+```
+