Package org.apache.syncope.ext.openfga.client.api

Class StoresApi

java.lang.Object

org.apache.syncope.ext.openfga.client.api.StoresApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-03-07T14:52:32.408381154+01:00[Europe/Rome]",
           comments="Generator version: 7.12.0")
public class StoresApi
extends Object

Constructor Summary

Constructors

Constructor	Description
StoresApi()
StoresApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
CreateStoreResponse	createStore(CreateStoreRequest body)	Create a store Create a unique OpenFGA store which will be used to store authorization models and relationship tuples.
ApiResponse<CreateStoreResponse>	createStoreWithHttpInfo(CreateStoreRequest body)	Create a store Create a unique OpenFGA store which will be used to store authorization models and relationship tuples.
void	deleteStore(String storeId)	Delete a store Delete an OpenFGA store.
ApiResponse<Void>	deleteStoreWithHttpInfo(String storeId)	Delete a store Delete an OpenFGA store.
protected ApiException	getApiException(String operationId, HttpResponse<InputStream> response)
GetStoreResponse	getStore(String storeId)	Get a store Returns an OpenFGA store by its identifier
ApiResponse<GetStoreResponse>	getStoreWithHttpInfo(String storeId)	Get a store Returns an OpenFGA store by its identifier
ListStoresResponse	listStores(Integer pageSize, String continuationToken, String name)	List all stores Returns a paginated list of OpenFGA stores and a continuation token to get additional stores.
ApiResponse<ListStoresResponse>	listStoresWithHttpInfo(Integer pageSize, String continuationToken, String name)	List all stores Returns a paginated list of OpenFGA stores and a continuation token to get additional stores.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StoresApi

public StoresApi()

StoresApi

public StoresApi(ApiClient apiClient)

Method Details

getApiException

protected ApiException getApiException(String operationId,
 HttpResponse<InputStream> response)
                                throws IOException

Throws:

IOException

createStore

public CreateStoreResponse createStore(CreateStoreRequest body)
                                throws ApiException

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

Parameters:

body - (required)

Returns:

CreateStoreResponse

Throws:

ApiException - if fails to make API call

createStoreWithHttpInfo

public ApiResponse<CreateStoreResponse> createStoreWithHttpInfo(CreateStoreRequest body)
                                                         throws ApiException

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

Parameters:

body - (required)

Returns:

ApiResponse<CreateStoreResponse>

Throws:

ApiException - if fails to make API call

deleteStore

public void deleteStore(String storeId)
                 throws ApiException

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

Parameters:

storeId - (required)

Throws:

ApiException - if fails to make API call

deleteStoreWithHttpInfo

public ApiResponse<Void> deleteStoreWithHttpInfo(String storeId)
                                          throws ApiException

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

Parameters:

storeId - (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

getStore

public GetStoreResponse getStore(String storeId)
                          throws ApiException

Get a store Returns an OpenFGA store by its identifier

Parameters:

storeId - (required)

Returns:

GetStoreResponse

Throws:

ApiException - if fails to make API call

getStoreWithHttpInfo

public ApiResponse<GetStoreResponse> getStoreWithHttpInfo(String storeId)
                                                   throws ApiException

Get a store Returns an OpenFGA store by its identifier

Parameters:

storeId - (required)

Returns:

ApiResponse<GetStoreResponse>

Throws:

ApiException - if fails to make API call

listStores

public ListStoresResponse listStores(Integer pageSize,
 String continuationToken,
 String name)
                              throws ApiException

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:

pageSize - (optional)

continuationToken - (optional)

name - The name parameter instructs the API to only include results that match that name.Multiple results may be returned. Only exact matches will be returned; substring matches and regexes will not be evaluated (optional)

Returns:

ListStoresResponse

Throws:

ApiException - if fails to make API call

listStoresWithHttpInfo

public ApiResponse<ListStoresResponse> listStoresWithHttpInfo(Integer pageSize,
 String continuationToken,
 String name)
                                                       throws ApiException

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:

pageSize - (optional)

continuationToken - (optional)

name - The name parameter instructs the API to only include results that match that name.Multiple results may be returned. Only exact matches will be returned; substring matches and regexes will not be evaluated (optional)

Returns:

ApiResponse<ListStoresResponse>

Throws:

ApiException - if fails to make API call