| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
| Name | Name | Last commit date | ||
|---|---|---|---|---|
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:
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install permify-javascript --saveFinally, you need to build the module:
npm run buildTo 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 installNext, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:
npm linkTo 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 buildIf 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 --saveThe 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.jsThen include bundle.js in the HTML pages.
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
}
}
]
}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);
});
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 |
Authentication schemes defined for the API:
| Back | FazBrowse Home | New Git URL |