All URIs are relative to http://localhost
Method | HTTP request | Description |
---|---|---|
bundle_run | POST /v1/tenants/{tenant_id}/data/run-bundle | run bundle |
data_attributes_read | POST /v1/tenants/{tenant_id}/data/attributes/read | read attributes |
data_delete | POST /v1/tenants/{tenant_id}/data/delete | delete data |
data_relationships_read | POST /v1/tenants/{tenant_id}/data/relationships/read | read relationships |
data_write | POST /v1/tenants/{tenant_id}/data/write | write data |
relationships_delete | POST /v1/tenants/{tenant_id}/relationships/delete | delete relationships |
relationships_write | POST /v1/tenants/{tenant_id}/relationships/write | write relationships |
BundleRunResponse bundle_run(tenant_id, body)
run bundle
import permify
from permify.models.bundle_run_response import BundleRunResponse
from permify.models.run_bundle_body import RunBundleBody
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.DataApi(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.RunBundleBody() # RunBundleBody |
try:
# run bundle
api_response = api_instance.bundle_run(tenant_id, body)
print("The response of DataApi->bundle_run:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DataApi->bundle_run: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
tenant_id | 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 | RunBundleBody |
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | A successful response. | - |
0 | An unexpected error response. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AttributeReadResponse data_attributes_read(tenant_id, body)
read attributes
import permify
from permify.models.attribute_read_response import AttributeReadResponse
from permify.models.read_attributes_body import ReadAttributesBody
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.DataApi(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.ReadAttributesBody() # ReadAttributesBody |
try:
# read attributes
api_response = api_instance.data_attributes_read(tenant_id, body)
print("The response of DataApi->data_attributes_read:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DataApi->data_attributes_read: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
tenant_id | 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 | ReadAttributesBody |
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | A successful response. | - |
0 | An unexpected error response. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DataDeleteResponse data_delete(tenant_id, body)
delete data
import permify
from permify.models.data_delete_body import DataDeleteBody
from permify.models.data_delete_response import DataDeleteResponse
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.DataApi(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.DataDeleteBody() # DataDeleteBody |
try:
# delete data
api_response = api_instance.data_delete(tenant_id, body)
print("The response of DataApi->data_delete:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DataApi->data_delete: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
tenant_id | 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 | DataDeleteBody |
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | A successful response. | - |
0 | An unexpected error response. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RelationshipReadResponse data_relationships_read(tenant_id, body)
read relationships
import permify
from permify.models.read_relationships_body import ReadRelationshipsBody
from permify.models.relationship_read_response import RelationshipReadResponse
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.DataApi(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.ReadRelationshipsBody() # ReadRelationshipsBody |
try:
# read relationships
api_response = api_instance.data_relationships_read(tenant_id, body)
print("The response of DataApi->data_relationships_read:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DataApi->data_relationships_read: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
tenant_id | 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 | ReadRelationshipsBody |
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | A successful response. | - |
0 | An unexpected error response. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DataWriteResponse data_write(tenant_id, body)
write data
import permify
from permify.models.data_write_body import DataWriteBody
from permify.models.data_write_response import DataWriteResponse
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.DataApi(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.DataWriteBody() # DataWriteBody |
try:
# write data
api_response = api_instance.data_write(tenant_id, body)
print("The response of DataApi->data_write:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DataApi->data_write: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
tenant_id | 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 | DataWriteBody |
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | A successful response. | - |
0 | An unexpected error response. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RelationshipDeleteResponse relationships_delete(tenant_id, body)
delete relationships
import permify
from permify.models.delete_relationships_body import DeleteRelationshipsBody
from permify.models.relationship_delete_response import RelationshipDeleteResponse
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.DataApi(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.DeleteRelationshipsBody() # DeleteRelationshipsBody |
try:
# delete relationships
api_response = api_instance.relationships_delete(tenant_id, body)
print("The response of DataApi->relationships_delete:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DataApi->relationships_delete: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
tenant_id | 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 | DeleteRelationshipsBody |
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | A successful response. | - |
0 | An unexpected error response. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RelationshipWriteResponse relationships_write(tenant_id, body)
write relationships
import permify
from permify.models.relationship_write_response import RelationshipWriteResponse
from permify.models.write_relationships_body import WriteRelationshipsBody
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.DataApi(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.WriteRelationshipsBody() # WriteRelationshipsBody |
try:
# write relationships
api_response = api_instance.relationships_write(tenant_id, body)
print("The response of DataApi->relationships_write:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DataApi->relationships_write: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
tenant_id | 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 | WriteRelationshipsBody |
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | A successful response. | - |
0 | An unexpected error response. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]