permify_async.DataApi

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

bundle_run

BundleRunResponse bundle_run(tenant_id, body)

run bundle

Example

import permify_async
from permify_async.models.bundle_run_response import BundleRunResponse
from permify_async.models.run_bundle_body import RunBundleBody
from permify_async.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_async.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
async with permify_async.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = permify_async.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_async.RunBundleBody() # RunBundleBody | 

    try:
        # run bundle
        api_response = await 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)

Parameters

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

Return type

BundleRunResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

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]

data_attributes_read

AttributeReadResponse data_attributes_read(tenant_id, body)

read attributes

Example

import permify_async
from permify_async.models.attribute_read_response import AttributeReadResponse
from permify_async.models.read_attributes_body import ReadAttributesBody
from permify_async.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_async.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
async with permify_async.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = permify_async.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_async.ReadAttributesBody() # ReadAttributesBody | 

    try:
        # read attributes
        api_response = await 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)

Parameters

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

Return type

AttributeReadResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

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]

data_delete

DataDeleteResponse data_delete(tenant_id, body)

delete data

Example

import permify_async
from permify_async.models.data_delete_body import DataDeleteBody
from permify_async.models.data_delete_response import DataDeleteResponse
from permify_async.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_async.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
async with permify_async.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = permify_async.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_async.DataDeleteBody() # DataDeleteBody | 

    try:
        # delete data
        api_response = await 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)

Parameters

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

Return type

DataDeleteResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

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]

data_relationships_read

RelationshipReadResponse data_relationships_read(tenant_id, body)

read relationships

Example

import permify_async
from permify_async.models.read_relationships_body import ReadRelationshipsBody
from permify_async.models.relationship_read_response import RelationshipReadResponse
from permify_async.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_async.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
async with permify_async.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = permify_async.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_async.ReadRelationshipsBody() # ReadRelationshipsBody | 

    try:
        # read relationships
        api_response = await 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)

Parameters

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

Return type

RelationshipReadResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

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]

data_write

DataWriteResponse data_write(tenant_id, body)

write data

Example

import permify_async
from permify_async.models.data_write_body import DataWriteBody
from permify_async.models.data_write_response import DataWriteResponse
from permify_async.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_async.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
async with permify_async.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = permify_async.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_async.DataWriteBody() # DataWriteBody | 

    try:
        # write data
        api_response = await 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)

Parameters

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

Return type

DataWriteResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

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]

relationships_delete

RelationshipDeleteResponse relationships_delete(tenant_id, body)

delete relationships

Example

import permify_async
from permify_async.models.delete_relationships_body import DeleteRelationshipsBody
from permify_async.models.relationship_delete_response import RelationshipDeleteResponse
from permify_async.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_async.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
async with permify_async.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = permify_async.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_async.DeleteRelationshipsBody() # DeleteRelationshipsBody | 

    try:
        # delete relationships
        api_response = await 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)

Parameters

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

Return type

RelationshipDeleteResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

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]

relationships_write

RelationshipWriteResponse relationships_write(tenant_id, body)

write relationships

Example

import permify_async
from permify_async.models.relationship_write_response import RelationshipWriteResponse
from permify_async.models.write_relationships_body import WriteRelationshipsBody
from permify_async.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_async.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
async with permify_async.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = permify_async.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_async.WriteRelationshipsBody() # WriteRelationshipsBody | 

    try:
        # write relationships
        api_response = await 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)

Parameters

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

Return type

RelationshipWriteResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

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]

FilesExpand file tree

DataApi.md

Latest commit

History

DataApi.md

File metadata and controls

permify_async.DataApi

bundle_run

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

data_attributes_read

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

data_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

data_relationships_read

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

data_write

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

relationships_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

relationships_write

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details