Skip to content

Permify/permify-javascript

BranchesTags

Repository files navigation

permify-javascript

PermifyClient - JavaScript client for permify-javascript Permify is an open source authorization service for creating fine-grained and scalable authorization systems. This SDK is automatically generated by the OpenAPI Generator project:

  • API version: v1.6.8
  • Package version: 0.11.0
  • Generator version: 7.13.0
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://github.com/Permify/permify/issues

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install permify-javascript --save

Finally, you need to build the module:

npm run build
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your permify-javascript from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var PermifyClient = require('permify-javascript');


var api = new PermifyClient.BundleApi()
var 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.
var body = new PermifyClient.BundleDeleteBody(); // {BundleDeleteBody} 
api.bundleDelete(tenantId, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
PermifyClient.BundleApi bundleDelete POST /v1/tenants/{tenant_id}/bundle/delete delete bundle
PermifyClient.BundleApi bundleRead POST /v1/tenants/{tenant_id}/bundle/read read bundle
PermifyClient.BundleApi bundleWrite POST /v1/tenants/{tenant_id}/bundle/write write bundle
PermifyClient.DataApi bundleRun POST /v1/tenants/{tenant_id}/data/run-bundle run bundle
PermifyClient.DataApi dataAttributesRead POST /v1/tenants/{tenant_id}/data/attributes/read read attributes
PermifyClient.DataApi dataDelete POST /v1/tenants/{tenant_id}/data/delete delete data
PermifyClient.DataApi dataRelationshipsRead POST /v1/tenants/{tenant_id}/data/relationships/read read relationships
PermifyClient.DataApi dataWrite POST /v1/tenants/{tenant_id}/data/write write data
PermifyClient.DataApi relationshipsDelete POST /v1/tenants/{tenant_id}/relationships/delete delete relationships
PermifyClient.DataApi relationshipsWrite POST /v1/tenants/{tenant_id}/relationships/write write relationships
PermifyClient.PermissionApi permissionsBulkCheck POST /v1/tenants/{tenant_id}/permissions/bulk-check bulk check api
PermifyClient.PermissionApi permissionsCheck POST /v1/tenants/{tenant_id}/permissions/check check api
PermifyClient.PermissionApi permissionsExpand POST /v1/tenants/{tenant_id}/permissions/expand expand api
PermifyClient.PermissionApi permissionsLookupEntity POST /v1/tenants/{tenant_id}/permissions/lookup-entity lookup entity
PermifyClient.PermissionApi permissionsLookupEntityStream POST /v1/tenants/{tenant_id}/permissions/lookup-entity-stream lookup entity stream
PermifyClient.PermissionApi permissionsLookupSubject POST /v1/tenants/{tenant_id}/permissions/lookup-subject lookup-subject
PermifyClient.PermissionApi permissionsSubjectPermission POST /v1/tenants/{tenant_id}/permissions/subject-permission subject permission
PermifyClient.SchemaApi schemasList POST /v1/tenants/{tenant_id}/schemas/list list schema
PermifyClient.SchemaApi schemasPartialWrite PATCH /v1/tenants/{tenant_id}/schemas/partial-write partially update your authorization model
PermifyClient.SchemaApi schemasRead POST /v1/tenants/{tenant_id}/schemas/read read schema
PermifyClient.SchemaApi schemasWrite POST /v1/tenants/{tenant_id}/schemas/write write schema
PermifyClient.TenancyApi tenantsCreate POST /v1/tenants/create create tenant
PermifyClient.TenancyApi tenantsDelete DELETE /v1/tenants/{id} delete tenant
PermifyClient.TenancyApi tenantsList POST /v1/tenants/list list tenants
PermifyClient.WatchApi watchWatch POST /v1/tenants/{tenant_id}/watch watch changes

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

ApiKeyAuth

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

About

Permify Javascript Client

Resources

Readme

License

Apache-2.0 license
Activity
Custom properties

Stars

7 stars

Watchers

0 watching

Forks

1 fork
Report repository

Releases 1

v0.12.0 Latest
Apr 16, 2026

Packages

 
 
 

Contributors

Languages