@ory/keto-client
v26.2.0
Published
OpenAPI client for @ory/keto-client
Downloads
11,401
Readme
@ory/[email protected]
This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:
Environment
- Node.js
- Webpack
- Browserify
Language level
- ES5 - you must have a Promises/A+ library installed
- ES6
Module system
- CommonJS
- ES6 module system
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)
Building
To build and compile the typescript sources to javascript use:
npm install
npm run buildPublishing
First build the package then run npm publish
Consuming
navigate to the folder of your consuming project and run one of the following commands.
published:
npm install @ory/[email protected] --saveunPublished (not recommended):
npm install PATH_TO_GENERATED_PACKAGE --saveDocumentation for API Endpoints
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
Documentation For Models
- BatchCheckPermissionBody
- BatchCheckPermissionResult
- CheckOplSyntaxResult
- CheckPermissionResult
- CheckPermissionResultWithError
- CreateRelationshipBody
- ErrorGeneric
- ExpandedPermissionTree
- GenericError
- GetVersion200Response
- HealthNotReadyStatus
- HealthStatus
- IsAlive200Response
- IsReady503Response
- Namespace
- ParseError
- PostCheckPermissionBody
- PostCheckPermissionOrErrorBody
- RelationQuery
- Relationship
- RelationshipNamespaces
- RelationshipPatch
- Relationships
- SourcePosition
- SubjectSet
- Version
Documentation For Authorization
Endpoints do not require authorization.
