ory_keto_client 0.8.0-alpha.2 copy "ory_keto_client: ^0.8.0-alpha.2" to clipboard
ory_keto_client: ^0.8.0-alpha.2 copied to clipboard

outdated

OpenAPI API client

ory_keto_client #

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.8.0-alpha.2
  • Build package: org.openapitools.codegen.languages.DartDioClientCodegen

Requirements #

Dart 2.7.0 or later OR Flutter 1.12 or later

Installation & Usage #

Github #

If this Dart package is published to Github, please include the following in pubspec.yaml

name: ory_keto_client
version: 0.8.0-alpha.2
description: OpenAPI API client
dependencies:
  ory_keto_client:
    git: https://github.com/ory/sdk.git
      version: 'any'

Local #

To use the package in 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/api.dart';


final api = MetadataApi();

try {
    final response = await api.getVersion();
    print(response);
} catch (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
ReadApi getCheck GET /check Check a relation tuple
ReadApi getExpand GET /expand Expand a Relation Tuple
ReadApi getRelationTuples GET /relation-tuples Query relation tuples
ReadApi postCheck POST /check Check a relation tuple
WriteApi createRelationTuple PUT /relation-tuples Create a Relation Tuple
WriteApi deleteRelationTuples DELETE /relation-tuples Delete Relation Tuples
WriteApi patchRelationTuples PATCH /relation-tuples Patch Multiple Relation Tuples

Documentation For Models #

Documentation For Authorization #

All endpoints do not require authorization.

Author #

hi@ory.sh