permify-ruby

Permify - the Ruby gem for the Permify API

Permify is an open source authorization service for creating fine-grained and scalable authorization systems.

This SDK is automatically generated by the OpenAPI Generator project:

• API version: v1.5.4
• Package version: v1.5.4
• Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://github.com/Permify/permify/issues

Installation

Build a gem

To build the Ruby code into a gem:

gem build permify-ruby.gemspec

Then either install the gem locally:

gem install ./permify-ruby-v1.5.4.gem

(for development, run gem install --dev ./permify-ruby-v1.5.4.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'permify-ruby', '~> v1.5.4'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'permify-ruby', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'permify-ruby'

api_instance = Permify::BundleApi.new
tenant_id = 'tenant_id_example' # String | Identifier of the tenant, if you are not using multi-tenancy (have only one tenant) use pre-inserted tenant <code>t1</code> for this field. Required, and must match the pattern \\“[a-zA-Z0-9-,]+\\“, max 64 bytes.
body = Permify::BundleDeleteBody.new # BundleDeleteBody | 

begin
  #delete bundle
  result = api_instance.bundle_delete(tenant_id, body)
  p result
rescue Permify::ApiError => e
  puts "Exception when calling BundleApi->bundle_delete: #{e}"
end

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
Permify::BundleApi	bundle_delete	POST /v1/tenants/{tenant_id}/bundle/delete	delete bundle
Permify::BundleApi	bundle_read	POST /v1/tenants/{tenant_id}/bundle/read	read bundle
Permify::BundleApi	bundle_write	POST /v1/tenants/{tenant_id}/bundle/write	write bundle
Permify::DataApi	bundle_run	POST /v1/tenants/{tenant_id}/data/run-bundle	run bundle
Permify::DataApi	data_attributes_read	POST /v1/tenants/{tenant_id}/data/attributes/read	read attributes
Permify::DataApi	data_delete	POST /v1/tenants/{tenant_id}/data/delete	delete data
Permify::DataApi	data_relationships_read	POST /v1/tenants/{tenant_id}/data/relationships/read	read relationships
Permify::DataApi	data_write	POST /v1/tenants/{tenant_id}/data/write	write data
Permify::DataApi	relationships_delete	POST /v1/tenants/{tenant_id}/relationships/delete	delete relationships
Permify::DataApi	relationships_write	POST /v1/tenants/{tenant_id}/relationships/write	write relationships
Permify::PermissionApi	permissions_bulk_check	POST /v1/tenants/{tenant_id}/permissions/bulk-check	bulk check api
Permify::PermissionApi	permissions_check	POST /v1/tenants/{tenant_id}/permissions/check	check api
Permify::PermissionApi	permissions_expand	POST /v1/tenants/{tenant_id}/permissions/expand	expand api
Permify::PermissionApi	permissions_lookup_entity	POST /v1/tenants/{tenant_id}/permissions/lookup-entity	lookup entity
Permify::PermissionApi	permissions_lookup_entity_stream	POST /v1/tenants/{tenant_id}/permissions/lookup-entity-stream	lookup entity stream
Permify::PermissionApi	permissions_lookup_subject	POST /v1/tenants/{tenant_id}/permissions/lookup-subject	lookup-subject
Permify::PermissionApi	permissions_subject_permission	POST /v1/tenants/{tenant_id}/permissions/subject-permission	subject permission
Permify::SchemaApi	schemas_list	POST /v1/tenants/{tenant_id}/schemas/list	list schema
Permify::SchemaApi	schemas_partial_write	PATCH /v1/tenants/{tenant_id}/schemas/partial-write	partially update your authorization model
Permify::SchemaApi	schemas_read	POST /v1/tenants/{tenant_id}/schemas/read	read schema
Permify::SchemaApi	schemas_write	POST /v1/tenants/{tenant_id}/schemas/write	write schema
Permify::TenancyApi	tenants_create	POST /v1/tenants/create	create tenant
Permify::TenancyApi	tenants_delete	DELETE /v1/tenants/{id}	delete tenant
Permify::TenancyApi	tenants_list	POST /v1/tenants/list	list tenants
Permify::WatchApi	watch_watch	POST /v1/tenants/{tenant_id}/watch	watch changes

Documentation for Models

• Permify::AbstractType
• Permify::Any
• Permify::Argument
• Permify::Attribute
• Permify::AttributeDefinition
• Permify::AttributeFilter
• Permify::AttributeReadRequestMetadata
• Permify::AttributeReadResponse
• Permify::AttributeType
• Permify::BulkCheckBody
• Permify::BundleDeleteBody
• Permify::BundleDeleteResponse
• Permify::BundleReadBody
• Permify::BundleReadResponse
• Permify::BundleRunResponse
• Permify::BundleWriteBody
• Permify::BundleWriteResponse
• Permify::CheckBody
• Permify::CheckResult
• Permify::CheckedExpr
• Permify::Child
• Permify::Component
• Permify::Comprehension
• Permify::ComputedAttribute
• Permify::ComputedUserSet
• Permify::Constant
• Permify::Context
• Permify::CreateList
• Permify::CreateStruct
• Permify::DataBundle
• Permify::DataChange
• Permify::DataChangeOperation
• Permify::DataChanges
• Permify::DataDeleteBody
• Permify::DataDeleteResponse
• Permify::DataWriteBody
• Permify::DataWriteRequestMetadata
• Permify::DataWriteResponse
• Permify::DeleteRelationshipsBody
• Permify::Entity
• Permify::EntityDefinition
• Permify::EntityDefinitionReference
• Permify::EntityFilter
• Permify::Entry
• Permify::ExpandLeaf
• Permify::ExpandTreeNode
• Permify::ExpandTreeNodeOperation
• Permify::Expr
• Permify::ExprCall
• Permify::Extension
• Permify::FunctionType
• Permify::Ident
• Permify::Leaf
• Permify::ListType
• Permify::LookupEntityBody
• Permify::LookupEntityStreamBody
• Permify::LookupSubjectBody
• Permify::MapType
• Permify::PartialWriteBody
• Permify::Partials
• Permify::PermissionBulkCheckRequestItem
• Permify::PermissionBulkCheckResponse
• Permify::PermissionCheckRequestMetadata
• Permify::PermissionCheckResponse
• Permify::PermissionCheckResponseMetadata
• Permify::PermissionDefinition
• Permify::PermissionExpandBody
• Permify::PermissionExpandRequestMetadata
• Permify::PermissionExpandResponse
• Permify::PermissionLookupEntityRequestMetadata
• Permify::PermissionLookupEntityResponse
• Permify::PermissionLookupEntityStreamResponse
• Permify::PermissionLookupSubjectRequestMetadata
• Permify::PermissionLookupSubjectResponse
• Permify::PermissionSubjectPermissionRequestMetadata
• Permify::PermissionSubjectPermissionResponse
• Permify::PrimitiveType
• Permify::ReadAttributesBody
• Permify::ReadRelationshipsBody
• Permify::RelationDefinition
• Permify::RelationReference
• Permify::RelationshipDeleteResponse
• Permify::RelationshipReadRequestMetadata
• Permify::RelationshipReadResponse
• Permify::RelationshipWriteRequestMetadata
• Permify::RelationshipWriteResponse
• Permify::Rewrite
• Permify::RewriteOperation
• Permify::RuleDefinition
• Permify::RunBundleBody
• Permify::SchemaDefinition
• Permify::SchemaDefinitionReference
• Permify::SchemaList
• Permify::SchemaListBody
• Permify::SchemaListResponse
• Permify::SchemaPartialWriteRequestMetadata
• Permify::SchemaPartialWriteResponse
• Permify::SchemaReadBody
• Permify::SchemaReadRequestMetadata
• Permify::SchemaReadResponse
• Permify::SchemaWriteBody
• Permify::SchemaWriteResponse
• Permify::Select
• Permify::SourceInfo
• Permify::Status
• Permify::StreamResultOfPermissionLookupEntityStreamResponse
• Permify::StreamResultOfWatchResponse
• Permify::StringArrayValue
• Permify::Subject
• Permify::SubjectFilter
• Permify::SubjectPermissionBody
• Permify::Subjects
• Permify::Tenant
• Permify::TenantCreateRequest
• Permify::TenantCreateResponse
• Permify::TenantDeleteResponse
• Permify::TenantListRequest
• Permify::TenantListResponse
• Permify::Tuple
• Permify::TupleFilter
• Permify::TupleSet
• Permify::TupleToUserSet
• Permify::V1Call
• Permify::V1Expand
• Permify::V1Operation
• Permify::V1alpha1Reference
• Permify::V1alpha1Type
• Permify::Values
• Permify::Version
• Permify::WatchBody
• Permify::WatchResponse
• Permify::WellKnownType
• Permify::WriteRelationshipsBody

Documentation for Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header