Skip to content

Latest commit

 

History

History
375 lines (271 loc) · 13.4 KB

SessionApi.md

File metadata and controls

375 lines (271 loc) · 13.4 KB
Raw

openziti_edge_client.SessionApi

All URIs are relative to https://demo.ziti.dev/edge/client/v1

Method HTTP request Description
create_session POST /sessions Create a session resource
delete_session DELETE /sessions/{id} Delete a session
detail_session GET /sessions/{id} Retrieves a single session
list_sessions GET /sessions List sessions

create_session

SessionCreateEnvelope create_session(session)

Create a session resource

Create a session resource.

Example

  • Api Key Authentication (ztSession):
  • OAuth Authentication (oauth2):
import time
import openziti_edge_client
from openziti_edge_client.api import session_api
from openziti_edge_client.model.api_error_envelope import ApiErrorEnvelope
from openziti_edge_client.model.session_create_envelope import SessionCreateEnvelope
from openziti_edge_client.model.session_create import SessionCreate
from pprint import pprint
# Defining the host is optional and defaults to https://demo.ziti.dev/edge/client/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openziti_edge_client.Configuration(
    host = "https://demo.ziti.dev/edge/client/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ztSession
configuration.api_key['ztSession'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ztSession'] = 'Bearer'

# Configure OAuth2 access token for authorization: oauth2
configuration = openziti_edge_client.Configuration(
    host = "https://demo.ziti.dev/edge/client/v1"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with openziti_edge_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = session_api.SessionApi(api_client)
    session = SessionCreate(
        service_id="service_id_example",
        tags=Tags(None),
        type=DialBind("Dial"),
    ) # SessionCreate | A session to create

    # example passing only required values which don't have defaults set
    try:
        # Create a session resource
        api_response = api_instance.create_session(session)
        pprint(api_response)
    except openziti_edge_client.ApiException as e:
        print("Exception when calling SessionApi->create_session: %s\n" % e)

Parameters

Name Type Description Notes
session SessionCreate A session to create

Return type

SessionCreateEnvelope

Authorization

ztSession, oauth2

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 The create request was successful and the resource has been added at the following location -
400 The supplied request contains invalid fields or could not be parsed (json and non-json bodies). The error's code, message, and cause fields can be inspected for further information -
401 The currently supplied session does not have the correct access rights to request this resource -

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

delete_session

Empty delete_session(id)

Delete a session

Delete a session by id.

Example

  • Api Key Authentication (ztSession):
  • OAuth Authentication (oauth2):
import time
import openziti_edge_client
from openziti_edge_client.api import session_api
from openziti_edge_client.model.api_error_envelope import ApiErrorEnvelope
from openziti_edge_client.model.empty import Empty
from pprint import pprint
# Defining the host is optional and defaults to https://demo.ziti.dev/edge/client/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openziti_edge_client.Configuration(
    host = "https://demo.ziti.dev/edge/client/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ztSession
configuration.api_key['ztSession'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ztSession'] = 'Bearer'

# Configure OAuth2 access token for authorization: oauth2
configuration = openziti_edge_client.Configuration(
    host = "https://demo.ziti.dev/edge/client/v1"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with openziti_edge_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = session_api.SessionApi(api_client)
    id = "id_example" # str | The id of the requested resource

    # example passing only required values which don't have defaults set
    try:
        # Delete a session
        api_response = api_instance.delete_session(id)
        pprint(api_response)
    except openziti_edge_client.ApiException as e:
        print("Exception when calling SessionApi->delete_session: %s\n" % e)

Parameters

Name Type Description Notes
id str The id of the requested resource

Return type

Empty

Authorization

ztSession, oauth2

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 The delete request was successful and the resource has been removed -
400 The supplied request contains invalid fields or could not be parsed (json and non-json bodies). The error's code, message, and cause fields can be inspected for further information -
401 The currently supplied session does not have the correct access rights to request this resource -
409 The resource requested to be removed/altered cannot be as it is referenced by another object. -

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

detail_session

DetailSessionEnvelope detail_session(id)

Retrieves a single session

Retrieves a single session by id.

Example

  • Api Key Authentication (ztSession):
  • OAuth Authentication (oauth2):
import time
import openziti_edge_client
from openziti_edge_client.api import session_api
from openziti_edge_client.model.api_error_envelope import ApiErrorEnvelope
from openziti_edge_client.model.detail_session_envelope import DetailSessionEnvelope
from pprint import pprint
# Defining the host is optional and defaults to https://demo.ziti.dev/edge/client/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openziti_edge_client.Configuration(
    host = "https://demo.ziti.dev/edge/client/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ztSession
configuration.api_key['ztSession'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ztSession'] = 'Bearer'

# Configure OAuth2 access token for authorization: oauth2
configuration = openziti_edge_client.Configuration(
    host = "https://demo.ziti.dev/edge/client/v1"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with openziti_edge_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = session_api.SessionApi(api_client)
    id = "id_example" # str | The id of the requested resource

    # example passing only required values which don't have defaults set
    try:
        # Retrieves a single session
        api_response = api_instance.detail_session(id)
        pprint(api_response)
    except openziti_edge_client.ApiException as e:
        print("Exception when calling SessionApi->detail_session: %s\n" % e)

Parameters

Name Type Description Notes
id str The id of the requested resource

Return type

DetailSessionEnvelope

Authorization

ztSession, oauth2

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A single session -
401 The currently supplied session does not have the correct access rights to request this resource -
404 The requested resource does not exist -

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

list_sessions

ListSessionsEnvelope list_sessions()

List sessions

Retrieves a list of active sessions resources; supports filtering, sorting, and pagination. Sessions are tied to an API session and are moved when an API session times out or logs out. Active sessions (i.e. Ziti SDK connected to an edge router) will keep the session and API session marked as active.

Example

  • Api Key Authentication (ztSession):
  • OAuth Authentication (oauth2):
import time
import openziti_edge_client
from openziti_edge_client.api import session_api
from openziti_edge_client.model.api_error_envelope import ApiErrorEnvelope
from openziti_edge_client.model.list_sessions_envelope import ListSessionsEnvelope
from pprint import pprint
# Defining the host is optional and defaults to https://demo.ziti.dev/edge/client/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openziti_edge_client.Configuration(
    host = "https://demo.ziti.dev/edge/client/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ztSession
configuration.api_key['ztSession'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ztSession'] = 'Bearer'

# Configure OAuth2 access token for authorization: oauth2
configuration = openziti_edge_client.Configuration(
    host = "https://demo.ziti.dev/edge/client/v1"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with openziti_edge_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = session_api.SessionApi(api_client)
    limit = 1 # int |  (optional)
    offset = 1 # int |  (optional)
    filter = "filter_example" # str |  (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # List sessions
        api_response = api_instance.list_sessions(limit=limit, offset=offset, filter=filter)
        pprint(api_response)
    except openziti_edge_client.ApiException as e:
        print("Exception when calling SessionApi->list_sessions: %s\n" % e)

Parameters

Name Type Description Notes
limit int [optional]
offset int [optional]
filter str [optional]

Return type

ListSessionsEnvelope

Authorization

ztSession, oauth2

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A list of sessions -
400 The supplied request contains invalid fields or could not be parsed (json and non-json bodies). The error's code, message, and cause fields can be inspected for further information -
401 The currently supplied session does not have the correct access rights to request this resource -

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