zrok/sdk/python/sdk/zrok

zrok_sdk

zrok client access

This Python package is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

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

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import zrok_api
from zrok_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'

# create an instance of the API class
api_instance = zrok_api.AccountApi(zrok_api.ApiClient(configuration))
body = zrok_api.ChangePasswordBody() # ChangePasswordBody |  (optional)

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

# create an instance of the API class
api_instance = zrok_api.AccountApi(zrok_api.ApiClient(configuration))
body = zrok_api.InviteBody() # InviteBody |  (optional)

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

# create an instance of the API class
api_instance = zrok_api.AccountApi(zrok_api.ApiClient(configuration))
body = zrok_api.LoginBody() # LoginBody |  (optional)

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

# Configure API key authorization: key
configuration = zrok_api.Configuration()
configuration.api_key['x-token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-token'] = 'Bearer'

# create an instance of the API class
api_instance = zrok_api.AccountApi(zrok_api.ApiClient(configuration))
body = zrok_api.RegenerateAccountTokenBody() # RegenerateAccountTokenBody |  (optional)

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

# create an instance of the API class
api_instance = zrok_api.AccountApi(zrok_api.ApiClient(configuration))
body = zrok_api.RegisterBody() # RegisterBody |  (optional)

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

# create an instance of the API class
api_instance = zrok_api.AccountApi(zrok_api.ApiClient(configuration))
body = zrok_api.ResetPasswordBody() # ResetPasswordBody |  (optional)

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

# create an instance of the API class
api_instance = zrok_api.AccountApi(zrok_api.ApiClient(configuration))
body = zrok_api.ResetPasswordRequestBody() # ResetPasswordRequestBody |  (optional)

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

# create an instance of the API class
api_instance = zrok_api.AccountApi(zrok_api.ApiClient(configuration))
body = zrok_api.VerifyBody() # VerifyBody |  (optional)

try:
    api_response = api_instance.verify(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->verify: %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

• AccessBody
• AccessBody1
• AccountBody
• AuthUser
• ChangePasswordBody
• ClientVersionCheckBody
• Configuration
• DisableBody
• EnableBody
• Environment
• EnvironmentAndResources
• Environments
• ErrorMessage
• Frontend
• FrontendBody
• FrontendBody1
• FrontendBody2
• Frontends
• GrantsBody
• IdentityBody
• InlineResponse200
• InlineResponse2001
• InlineResponse2002
• InlineResponse2003
• InlineResponse2003Members
• InlineResponse2004
• InlineResponse2004Organizations
• InlineResponse2005
• InlineResponse2005Memberships
• InlineResponse2006
• InlineResponse2007
• InlineResponse201
• InlineResponse2011
• InlineResponse2012
• InlineResponse2013
• InviteBody
• LoginBody
• Metrics
• MetricsSample
• OrganizationAddBody
• OrganizationBody
• OrganizationBody1
• OrganizationListBody
• OrganizationRemoveBody
• Overview
• Principal
• RegenerateAccountTokenBody
• RegisterBody
• ResetPasswordBody
• ResetPasswordRequestBody
• Share
• ShareBody
• ShareRequest
• ShareResponse
• Shares
• SparkData
• SparkDataSample
• SparklinesBody
• TokenGenerateBody
• UnaccessBody
• UnshareBody
• VerifyBody
• Version

Documentation For Authorization

key

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

Author