Skip to content

Latest commit

 

History

History
133 lines (73 loc) · 3.56 KB

StoresApi.md

File metadata and controls

133 lines (73 loc) · 3.56 KB

\StoresApi

All URIs are relative to http://localhost

Method HTTP request Description
create_store POST /stores Create a store
delete_store DELETE /stores/{store_id} Delete a store
get_store GET /stores/{store_id} Get a store
list_stores GET /stores List all stores

create_store

crate::models::CreateStoreResponse create_store(body) Create a store

Create a unique OpenFGA store which will be used to store authorization models and relationship tuples.

Parameters

Name Type Description Required Notes
body CreateStoreRequest [required]

Return type

crate::models::CreateStoreResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_store

delete_store(store_id) Delete a store

Delete an OpenFGA store. This does not delete the data associated with the store, like tuples or authorization models.

Parameters

Name Type Description Required Notes
store_id String [required]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_store

crate::models::GetStoreResponse get_store(store_id) Get a store

Returns an OpenFGA store by its identifier

Parameters

Name Type Description Required Notes
store_id String [required]

Return type

crate::models::GetStoreResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_stores

crate::models::ListStoresResponse list_stores(page_size, continuation_token) List all stores

Returns a paginated list of OpenFGA stores and a continuation token to get additional stores. The continuation token will be empty if there are no more stores.

Parameters

Name Type Description Required Notes
page_size Option<i32>
continuation_token Option<String>

Return type

crate::models::ListStoresResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]