permify-java

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

This Java package is automatically generated by the OpenAPI Generator project.

Requirements.

• Java
• Gradle or Maven

Installation

To include the SDK in your project, add the following to your build.gradle file:

dependencies {
    implementation 'co.permify:permify:{version}'
}

or add the following dependency to your pom.xml file:

<dependency>
  <groupId>co.permify</groupId>
  <artifactId>permify</artifactId>
  <version>{version}</version>
</dependency>

Navigate to the root directory of the project and run the following commands to build and install the SDK:

mvn clean install

Running the Application

After successfully building the project, you can run the application using the following command:

java -jar target/your-artifact-name-0.0.1.jar

Replace your-artifact-name-0.0.1.jar with the actual name of the jar file generated after the build.

Samples

For more detailed examples, please refer to the samples folder.

Documentation for API Endpoints

All URIs are relative to http://localhost:3476

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

Documentation For Models

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

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

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

Author

[email protected]