permify

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

This Python package is automatically generated by the OpenAPI Generator project:

• API version: v0.8.1
• Package version: 1.0.0
• Generator version: 7.6.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://github.com/Permify/permify/issues

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/permify/permify-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/permify/permify-python.git)

Then import the package:

import permify

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import permify

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import permify
from permify.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = permify.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with permify.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = permify.BundleApi(api_client)
    tenant_id = 'tenant_id_example' # str | 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.BundleDeleteRequest() # BundleDeleteRequest | 

    try:
        # delete bundle
        api_response = api_instance.bundle_delete(tenant_id, body)
        print("The response of BundleApi->bundle_delete:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling BundleApi->bundle_delete: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

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
• BundleDeleteRequest
• BundleDeleteResponse
• BundleReadRequest
• BundleReadResponse
• BundleRunRequest
• BundleRunResponse
• BundleWriteRequest
• BundleWriteResponse
• CheckResult
• CheckedExpr
• Child
• Comprehension
• ComputedAttribute
• ComputedUserSet
• Constant
• Context
• ContextAttribute
• CreateList
• CreateStruct
• DataAttributesReadRequest
• DataBundle
• DataChange
• DataChangeOperation
• DataChanges
• DataDeleteRequest
• DataDeleteResponse
• DataRelationshipsReadRequest
• DataWriteRequest
• DataWriteRequestMetadata
• DataWriteResponse
• Entity
• EntityDefinition
• EntityDefinitionReference
• EntityFilter
• Entry
• Expand
• ExpandLeaf
• ExpandTreeNode
• ExpandTreeNodeOperation
• Expr
• ExprCall
• FunctionType
• Ident
• ItContainsTheTenantIdToIdentifyTheTenantAndMetadataOfTheSchemaToBeEditedWithTheCorrespondingEditsToVariousEntities
• Leaf
• ListType
• MapType
• NullValue
• Partials
• PermissionCheckRequestMetadata
• PermissionCheckResponse
• PermissionCheckResponseMetadata
• PermissionDefinition
• PermissionExpandRequestMetadata
• PermissionExpandResponse
• PermissionLookupEntityRequestMetadata
• PermissionLookupEntityResponse
• PermissionLookupEntityStreamResponse
• PermissionLookupSubjectRequestMetadata
• PermissionLookupSubjectResponse
• PermissionSubjectPermissionRequestMetadata
• PermissionSubjectPermissionResponse
• PermissionsCheckRequest
• PermissionsExpandRequest
• PermissionsLookupEntityRequest
• PermissionsLookupSubjectRequest
• PermissionsSubjectPermissionRequest
• PrimitiveType
• RelationDefinition
• RelationReference
• RelationshipDeleteRequest
• RelationshipDeleteResponse
• RelationshipReadRequestMetadata
• RelationshipReadResponse
• RelationshipWriteRequestMetadata
• RelationshipWriteResponse
• RelationshipsWriteRequest
• Rewrite
• RewriteOperation
• RuleDefinition
• SchemaDefinition
• SchemaDefinitionReference
• SchemaList
• SchemaListResponse
• SchemaPartialWriteRequestMetadata
• SchemaPartialWriteResponse
• SchemaReadRequestMetadata
• SchemaReadResponse
• SchemaWriteResponse
• SchemasListRequest
• SchemasReadRequest
• SchemasWriteRequest
• Select
• SourceInfo
• Status
• StreamResultOfPermissionLookupEntityStreamResponse
• StreamResultOfWatchResponse
• Subject
• SubjectFilter
• Subjects
• Tenant
• TenantCreateRequest
• TenantCreateResponse
• TenantDeleteResponse
• TenantListRequest
• TenantListResponse
• Tuple
• TupleFilter
• TupleSet
• TupleToUserSet
• V1Call
• V1Operation
• V1alpha1Reference
• V1alpha1Type
• Values
• WatchResponse
• WatchWatchRequest
• WellKnownType

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

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

Author

hello@permify.co