extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2025-06-04 00:55:39 +02:00
Code Issues Packages Projects Releases Wiki Activity
zrok/sdk/python/src
History

README.md

zrok

zrok client access

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Generator version: 7.12.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.8+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import zrok_api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import zrok_api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:


import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = zrok_api.Configuration(
    host = "/api/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: key
configuration.api_key['key'] = os.environ["API_KEY"]

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


# Enter a context with an instance of the API client
with zrok_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = zrok_api.AccountApi(api_client)
    body = zrok_api.ChangePasswordRequest() # ChangePasswordRequest |  (optional)

    try:
        api_instance.change_password(body=body)
    except ApiException as e:
        print("Exception when calling AccountApi->change_password: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to /api/v1

Class Method HTTP request Description
AccountApi change_password POST /changePassword
AccountApi invite POST /invite
AccountApi login POST /login
AccountApi regenerate_account_token POST /regenerateAccountToken
AccountApi register POST /register
AccountApi reset_password POST /resetPassword
AccountApi reset_password_request POST /resetPasswordRequest
AccountApi verify POST /verify
AdminApi add_organization_member POST /organization/add
AdminApi create_account POST /account
AdminApi create_frontend POST /frontend
AdminApi create_identity POST /identity
AdminApi create_organization POST /organization
AdminApi delete_frontend DELETE /frontend
AdminApi delete_organization DELETE /organization
AdminApi grants POST /grants
AdminApi invite_token_generate POST /invite/token/generate
AdminApi list_frontends GET /frontends
AdminApi list_organization_members POST /organization/list
AdminApi list_organizations GET /organizations
AdminApi remove_organization_member POST /organization/remove
AdminApi update_frontend PATCH /frontend
EnvironmentApi disable POST /disable
EnvironmentApi enable POST /enable
MetadataApi client_version_check POST /clientVersionCheck
MetadataApi configuration GET /configuration
MetadataApi get_account_detail GET /detail/account
MetadataApi get_account_metrics GET /metrics/account
MetadataApi get_environment_detail GET /detail/environment/{envZId}
MetadataApi get_environment_metrics GET /metrics/environment/{envId}
MetadataApi get_frontend_detail GET /detail/frontend/{frontendId}
MetadataApi get_share_detail GET /detail/share/{shareToken}
MetadataApi get_share_metrics GET /metrics/share/{shareToken}
MetadataApi get_sparklines POST /sparklines
MetadataApi list_memberships GET /memberships
MetadataApi list_org_members GET /members/{organizationToken}
MetadataApi org_account_overview GET /overview/{organizationToken}/{accountEmail}
MetadataApi overview GET /overview
MetadataApi version GET /version
MetadataApi version_inventory GET /versions
ShareApi access POST /access
ShareApi share POST /share
ShareApi unaccess DELETE /unaccess
ShareApi unshare DELETE /unshare
ShareApi update_access PATCH /access
ShareApi update_share PATCH /share

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

key

  • Type: API key
  • API key parameter name: x-token
  • Location: HTTP header

Author