Skip to content

Latest commit

 

History

History
146 lines (94 loc) · 4.48 KB

BundleApi.md

File metadata and controls

146 lines (94 loc) · 4.48 KB

PermifyApi.BundleApi

All URIs are relative to http://localhost

Method HTTP request Description
bundleDelete POST /v1/tenants/{tenant_id}/bundle/delete delete bundle
bundleRead POST /v1/tenants/{tenant_id}/bundle/read read bundle
bundleWrite POST /v1/tenants/{tenant_id}/bundle/write write bundle

bundleDelete

BundleDeleteResponse bundleDelete(tenantId, body)

delete bundle

Example

import PermifyApi from 'permify_api';

let apiInstance = new PermifyApi.BundleApi();
let tenantId = "tenantId_example"; // String | 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.
let body = new PermifyApi.BundleDeleteBody(); // BundleDeleteBody | 
apiInstance.bundleDelete(tenantId, body, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
tenantId String 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

bundleRead

BundleReadResponse bundleRead(tenantId, body)

read bundle

Example

import PermifyApi from 'permify_api';

let apiInstance = new PermifyApi.BundleApi();
let tenantId = "tenantId_example"; // String | 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.
let body = new PermifyApi.BundleReadBody(); // BundleReadBody | 
apiInstance.bundleRead(tenantId, body, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
tenantId String 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

bundleWrite

BundleWriteResponse bundleWrite(tenantId, body)

write bundle

Example

import PermifyApi from 'permify_api';

let apiInstance = new PermifyApi.BundleApi();
let tenantId = "tenantId_example"; // String | 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.
let body = new PermifyApi.BundleWriteBody(); // BundleWriteBody | 
apiInstance.bundleWrite(tenantId, body, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
tenantId String 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