ory_keto_client.ReadApi

All URIs are relative to http://localhost

Method	HTTP request	Description
get_check	GET /relation-tuples/check/openapi	Check a relation tuple
get_check_mirror_status	GET /relation-tuples/check	Check a relation tuple
get_expand	GET /relation-tuples/expand	Expand a Relation Tuple
get_relation_tuples	GET /relation-tuples	Query relation tuples
post_check	POST /relation-tuples/check/openapi	Check a relation tuple
post_check_mirror_status	POST /relation-tuples/check	Check a relation tuple

get_check

GetCheckResponse get_check()

Check a relation tuple

To learn how relation tuples and the check works, head over to the documentation.

Example

import time
import ory_keto_client
from ory_keto_client.api import read_api
from ory_keto_client.model.generic_error import GenericError
from ory_keto_client.model.get_check_response import GetCheckResponse
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = ory_keto_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with ory_keto_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = read_api.ReadApi(api_client)
    namespace = "namespace_example" # str | Namespace of the Relation Tuple (optional)
    object = "object_example" # str | Object of the Relation Tuple (optional)
    relation = "relation_example" # str | Relation of the Relation Tuple (optional)
    subject_id = "subject_id_example" # str | SubjectID of the Relation Tuple (optional)
    subject_set_namespace = "subject_set.namespace_example" # str | Namespace of the Subject Set (optional)
    subject_set_object = "subject_set.object_example" # str | Object of the Subject Set (optional)
    subject_set_relation = "subject_set.relation_example" # str | Relation of the Subject Set (optional)
    max_depth = 1 # int |  (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Check a relation tuple
        api_response = api_instance.get_check(namespace=namespace, object=object, relation=relation, subject_id=subject_id, subject_set_namespace=subject_set_namespace, subject_set_object=subject_set_object, subject_set_relation=subject_set_relation, max_depth=max_depth)
        pprint(api_response)
    except ory_keto_client.ApiException as e:
        print("Exception when calling ReadApi->get_check: %s\n" % e)

Parameters

Name	Type	Description	Notes
namespace	str	Namespace of the Relation Tuple	[optional]
object	str	Object of the Relation Tuple	[optional]
relation	str	Relation of the Relation Tuple	[optional]
subject_id	str	SubjectID of the Relation Tuple	[optional]
subject_set_namespace	str	Namespace of the Subject Set	[optional]
subject_set_object	str	Object of the Subject Set	[optional]
subject_set_relation	str	Relation of the Subject Set	[optional]
max_depth	int		[optional]

Return type

GetCheckResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	getCheckResponse	-
400	genericError	-
500	genericError	-

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

get_check_mirror_status

GetCheckResponse get_check_mirror_status()

Check a relation tuple

To learn how relation tuples and the check works, head over to the documentation.

Example

import time
import ory_keto_client
from ory_keto_client.api import read_api
from ory_keto_client.model.generic_error import GenericError
from ory_keto_client.model.get_check_response import GetCheckResponse
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = ory_keto_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with ory_keto_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = read_api.ReadApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # Check a relation tuple
        api_response = api_instance.get_check_mirror_status()
        pprint(api_response)
    except ory_keto_client.ApiException as e:
        print("Exception when calling ReadApi->get_check_mirror_status: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

GetCheckResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	getCheckResponse	-
400	genericError	-
403	getCheckResponse	-
500	genericError	-

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

get_expand

ExpandTree get_expand(namespace, object, relation)

Expand a Relation Tuple

Use this endpoint to expand a relation tuple.

Example

import time
import ory_keto_client
from ory_keto_client.api import read_api
from ory_keto_client.model.expand_tree import ExpandTree
from ory_keto_client.model.generic_error import GenericError
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = ory_keto_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with ory_keto_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = read_api.ReadApi(api_client)
    namespace = "namespace_example" # str | Namespace of the Subject Set
    object = "object_example" # str | Object of the Subject Set
    relation = "relation_example" # str | Relation of the Subject Set
    max_depth = 1 # int |  (optional)

    # example passing only required values which don't have defaults set
    try:
        # Expand a Relation Tuple
        api_response = api_instance.get_expand(namespace, object, relation)
        pprint(api_response)
    except ory_keto_client.ApiException as e:
        print("Exception when calling ReadApi->get_expand: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Expand a Relation Tuple
        api_response = api_instance.get_expand(namespace, object, relation, max_depth=max_depth)
        pprint(api_response)
    except ory_keto_client.ApiException as e:
        print("Exception when calling ReadApi->get_expand: %s\n" % e)

Parameters

Name	Type	Description	Notes
namespace	str	Namespace of the Subject Set
object	str	Object of the Subject Set
relation	str	Relation of the Subject Set
max_depth	int		[optional]

Return type

ExpandTree

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	expandTree	-
400	genericError	-
404	genericError	-
500	genericError	-

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

get_relation_tuples

GetRelationTuplesResponse get_relation_tuples()

Query relation tuples

Get all relation tuples that match the query. Only the namespace field is required.

Example

import time
import ory_keto_client
from ory_keto_client.api import read_api
from ory_keto_client.model.generic_error import GenericError
from ory_keto_client.model.get_relation_tuples_response import GetRelationTuplesResponse
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = ory_keto_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with ory_keto_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = read_api.ReadApi(api_client)
    page_token = "page_token_example" # str |  (optional)
    page_size = 1 # int |  (optional)
    namespace = "namespace_example" # str | Namespace of the Relation Tuple (optional)
    object = "object_example" # str | Object of the Relation Tuple (optional)
    relation = "relation_example" # str | Relation of the Relation Tuple (optional)
    subject_id = "subject_id_example" # str | SubjectID of the Relation Tuple (optional)
    subject_set_namespace = "subject_set.namespace_example" # str | Namespace of the Subject Set (optional)
    subject_set_object = "subject_set.object_example" # str | Object of the Subject Set (optional)
    subject_set_relation = "subject_set.relation_example" # str | Relation of the Subject Set (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Query relation tuples
        api_response = api_instance.get_relation_tuples(page_token=page_token, page_size=page_size, namespace=namespace, object=object, relation=relation, subject_id=subject_id, subject_set_namespace=subject_set_namespace, subject_set_object=subject_set_object, subject_set_relation=subject_set_relation)
        pprint(api_response)
    except ory_keto_client.ApiException as e:
        print("Exception when calling ReadApi->get_relation_tuples: %s\n" % e)

Parameters

Name	Type	Description	Notes
page_token	str		[optional]
page_size	int		[optional]
namespace	str	Namespace of the Relation Tuple	[optional]
object	str	Object of the Relation Tuple	[optional]
relation	str	Relation of the Relation Tuple	[optional]
subject_id	str	SubjectID of the Relation Tuple	[optional]
subject_set_namespace	str	Namespace of the Subject Set	[optional]
subject_set_object	str	Object of the Subject Set	[optional]
subject_set_relation	str	Relation of the Subject Set	[optional]

Return type

GetRelationTuplesResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	getRelationTuplesResponse	-
404	genericError	-
500	genericError	-

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

post_check

GetCheckResponse post_check()

Check a relation tuple

To learn how relation tuples and the check works, head over to the documentation.

Example

import time
import ory_keto_client
from ory_keto_client.api import read_api
from ory_keto_client.model.generic_error import GenericError
from ory_keto_client.model.get_check_response import GetCheckResponse
from ory_keto_client.model.relation_query import RelationQuery
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = ory_keto_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with ory_keto_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = read_api.ReadApi(api_client)
    max_depth = 1 # int |  (optional)
    relation_query = RelationQuery(
        namespace="namespace_example",
        object="object_example",
        relation="relation_example",
        subject_id="subject_id_example",
        subject_set=SubjectSet(
            namespace="namespace_example",
            object="object_example",
            relation="relation_example",
        ),
    ) # RelationQuery |  (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Check a relation tuple
        api_response = api_instance.post_check(max_depth=max_depth, relation_query=relation_query)
        pprint(api_response)
    except ory_keto_client.ApiException as e:
        print("Exception when calling ReadApi->post_check: %s\n" % e)

Parameters

Name	Type	Description	Notes
max_depth	int		[optional]
relation_query	RelationQuery		[optional]

Return type

GetCheckResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	getCheckResponse	-
400	genericError	-
500	genericError	-

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

post_check_mirror_status

GetCheckResponse post_check_mirror_status()

Check a relation tuple

To learn how relation tuples and the check works, head over to the documentation.

Example

import time
import ory_keto_client
from ory_keto_client.api import read_api
from ory_keto_client.model.generic_error import GenericError
from ory_keto_client.model.get_check_response import GetCheckResponse
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = ory_keto_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with ory_keto_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = read_api.ReadApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # Check a relation tuple
        api_response = api_instance.post_check_mirror_status()
        pprint(api_response)
    except ory_keto_client.ApiException as e:
        print("Exception when calling ReadApi->post_check_mirror_status: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

GetCheckResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	getCheckResponse	-
400	genericError	-
403	getCheckResponse	-
500	genericError	-

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

Files

ReadApi.md

Latest commit

History

ReadApi.md

File metadata and controls

ory_keto_client.ReadApi

get_check

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_check_mirror_status

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_expand

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_relation_tuples

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

post_check

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

post_check_mirror_status

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details