Skip to content

Latest commit

 

History

History
221 lines (148 loc) · 7.45 KB

BundleApi.md

File metadata and controls

221 lines (148 loc) · 7.45 KB
Raw

permify.BundleApi

All URIs are relative to http://localhost

Method HTTP request Description
bundle_delete POST /v1/tenants/{tenant_id}/bundle/delete delete bundle
bundle_read POST /v1/tenants/{tenant_id}/bundle/read read bundle
bundle_write POST /v1/tenants/{tenant_id}/bundle/write write bundle

bundle_delete

BundleDeleteResponse bundle_delete(tenant_id, body)

delete bundle

Example

import permify
from permify.models.bundle_delete_body import BundleDeleteBody
from permify.models.bundle_delete_response import BundleDeleteResponse
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.BundleDeleteBody() # BundleDeleteBody | 

    try:
        # delete bundle
        api_response = api_instance.bundle_delete(tenant_id, body)
        print("The response of BundleApi->bundle_delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BundleApi->bundle_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 BundleDeleteBody

Return type

BundleDeleteResponse

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]

bundle_read

BundleReadResponse bundle_read(tenant_id, body)

read bundle

Example

import permify
from permify.models.bundle_read_body import BundleReadBody
from permify.models.bundle_read_response import BundleReadResponse
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.BundleReadBody() # BundleReadBody | 

    try:
        # read bundle
        api_response = api_instance.bundle_read(tenant_id, body)
        print("The response of BundleApi->bundle_read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BundleApi->bundle_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 BundleReadBody

Return type

BundleReadResponse

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]

bundle_write

BundleWriteResponse bundle_write(tenant_id, body)

write bundle

Example

import permify
from permify.models.bundle_write_body import BundleWriteBody
from permify.models.bundle_write_response import BundleWriteResponse
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.BundleWriteBody() # BundleWriteBody | 

    try:
        # write bundle
        api_response = api_instance.bundle_write(tenant_id, body)
        print("The response of BundleApi->bundle_write:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BundleApi->bundle_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 BundleWriteBody

Return type

BundleWriteResponse

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]