service-aware-frontend/pkgs/clan-cli/tests/openapi_client/docs/ClientsApi.md

openapi_client.ClientsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
get_clients_by_did	GET /api/v1/{entity_did}/clients	Get Clients By Did

get_clients_by_did

List[Service] get_clients_by_did(entity_did, skip=skip, limit=limit)

Get Clients By Did

Example

import time
import os
import openapi_client
from openapi_client.models.service import Service
from openapi_client.rest import ApiException
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 = openapi_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.ClientsApi(api_client)
    entity_did = 'entity_did_example' # str |
    skip = 0 # int |  (optional) (default to 0)
    limit = 100 # int |  (optional) (default to 100)

    try:
        # Get Clients By Did
        api_response = api_instance.get_clients_by_did(entity_did, skip=skip, limit=limit)
        print("The response of ClientsApi->get_clients_by_did:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ClientsApi->get_clients_by_did: %s\n" % e)

Parameters

Name	Type	Description	Notes
entity_did	str
skip	int		[optional] [default to 0]
limit	int		[optional] [default to 100]

Return type

List[Service]

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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