Rust API client for openapi

January 31, 2024 · View on GitHub

A high performance and flexible authorization/permission engine built for developers and inspired by Google Zanzibar.

For more information, please visit https://openfga.dev

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

API version: 0.1
Package version: 0.1
Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named openapi and add the following to Cargo.toml under [dependencies]:

openapi = { path = "./openapi" }

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AssertionsApi	read_assertions	GET /stores/{store_id}/assertions/{authorization_model_id}	Read assertions for an authorization model ID
AssertionsApi	write_assertions	PUT /stores/{store_id}/assertions/{authorization_model_id}	Upsert assertions for an authorization model ID
AuthorizationModelsApi	read_authorization_model	GET /stores/{store_id}/authorization-models/{id}	Return a particular version of an authorization model
AuthorizationModelsApi	read_authorization_models	GET /stores/{store_id}/authorization-models	Return all the authorization models for a particular store
AuthorizationModelsApi	write_authorization_model	POST /stores/{store_id}/authorization-models	Create a new authorization model
RelationshipQueriesApi	check	POST /stores/{store_id}/check	Check whether a user is authorized to access an object
RelationshipQueriesApi	expand	POST /stores/{store_id}/expand	Expand all relationships in userset tree format, and following userset rewrite rules. Useful to reason about and debug a certain relationship
RelationshipQueriesApi	list_objects	POST /stores/{store_id}/list-objects	List all objects of the given type that the user has a relation with
RelationshipQueriesApi	streamed_list_objects	POST /stores/{store_id}/streamed-list-objects	[EXPERIMENTAL] Stream all objects of the given type that the user has a relation with
RelationshipTuplesApi	read	POST /stores/{store_id}/read	Get tuples from the store that matches a query, without following userset rewrite rules
RelationshipTuplesApi	read_changes	GET /stores/{store_id}/changes	Return a list of all the tuple changes
RelationshipTuplesApi	write	POST /stores/{store_id}/write	Add or delete tuples from the store
StoresApi	create_store	POST /stores	Create a store
StoresApi	delete_store	DELETE /stores/{store_id}	Delete a store
StoresApi	get_store	GET /stores/{store_id}	Get a store
StoresApi	list_stores	GET /stores	List all stores

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

community@openfga.dev