26.2.0 • Published 5 months ago

@ory/keto-client

Licence

Apache-2.0

Version

26.2.0

Deps

Size

455 kB

Vulns

Weekly

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

Language level

Module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

To build and compile the typescript sources to javascript use:

npm install
npm run build

First build the package then run npm publish

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @ory/keto-client@v26.2.0 --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
MetadataApi	getVersion	GET /version	Return Running Software Version.
MetadataApi	isAlive	GET /health/alive	Check HTTP Server Status
MetadataApi	isReady	GET /health/ready	Check HTTP Server and Database Status
PermissionApi	batchCheckPermission	POST /relation-tuples/batch/check	Batch check permissions
PermissionApi	checkPermission	GET /relation-tuples/check/openapi	Check a permission
PermissionApi	checkPermissionOrError	GET /relation-tuples/check	Check a permission
PermissionApi	expandPermissions	GET /relation-tuples/expand	Expand a Relationship into permissions.
PermissionApi	postCheckPermission	POST /relation-tuples/check/openapi	Check a permission
PermissionApi	postCheckPermissionOrError	POST /relation-tuples/check	Check a permission
RelationshipApi	checkOplSyntax	POST /opl/syntax/check	Check the syntax of an OPL file
RelationshipApi	createRelationship	PUT /admin/relation-tuples	Create a Relationship
RelationshipApi	deleteRelationships	DELETE /admin/relation-tuples	Delete Relationships
RelationshipApi	getRelationships	GET /relation-tuples	Query relationships
RelationshipApi	listRelationshipNamespaces	GET /namespaces	Query namespaces
RelationshipApi	patchRelationships	PATCH /admin/relation-tuples	Patch Multiple Relationships

Keywords