ory_keto_client 0.11.0-alpha.0
ory_keto_client: ^0.11.0-alpha.0 copied to clipboard
OpenAPI API client
ory_keto_client (EXPERIMENTAL) #
Documentation for all of Ory Keto's REST APIs. gRPC is documented separately.
This Dart package is automatically generated by the OpenAPI Generator project:
- API version: v0.11.0-alpha.0
- Build package: org.openapitools.codegen.languages.DartDioClientCodegen
Requirements #
- Dart 2.12.0 or later OR Flutter 1.26.0 or later
- Dio 4.0.0+
Installation & Usage #
pub.dev #
To use the package from pub.dev, please include the following in pubspec.yaml
dependencies:
ory_keto_client: 0.11.0-alpha.0
Github #
If this Dart package is published to Github, please include the following in pubspec.yaml
dependencies:
ory_keto_client:
git:
url: https://github.com/ory/sdk.git
#ref: main
Local development #
To use the package from your local drive, please include the following in pubspec.yaml
dependencies:
ory_keto_client:
path: /path/to/ory_keto_client
Getting Started #
Please follow the installation procedure and then run the following:
import 'package:ory_keto_client/ory_keto_client.dart';
final api = OryKetoClient().getMetadataApi();
try {
final response = await api.getVersion();
print(response);
} catch on DioError (e) {
print("Exception when calling MetadataApi->getVersion: $e\n");
}
Documentation 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 | 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 #
- CheckOplSyntaxResult
- CheckPermissionResult
- CreateRelationshipBody
- ErrorGeneric
- ExpandedPermissionTree
- GenericError
- GetVersion200Response
- HealthNotReadyStatus
- HealthStatus
- IsAlive200Response
- IsReady503Response
- Namespace
- ParseError
- PostCheckPermissionBody
- PostCheckPermissionOrErrorBody
- RelationQuery
- Relationship
- RelationshipNamespaces
- RelationshipPatch
- Relationships
- SourcePosition
- SubjectSet
- Version
Documentation For Authorization #
All endpoints do not require authorization.