mirror of
https://github.com/openziti/zrok.git
synced 2025-06-01 07:36:07 +02:00
Merge branch 'v1_0_0' of github.com:openziti/zrok into v1_0_0
This commit is contained in:
Michael Quigley
commit
64d1fe70e8
5
.flake8
5
.flake8
@ -1,6 +1,5 @@
|
||||
[flake8]
|
||||
max-line-length = 120
|
||||
exclude =
|
||||
./sdk/python/sdk/**,
|
||||
./build/**
|
||||
|
||||
sdk/python/src/zrok_api/*
|
||||
sdk/python/src/test/*
|
||||
|
||||
83
.github/workflows/build-wheels.yml
vendored
83
.github/workflows/build-wheels.yml
vendored
@ -1,4 +1,4 @@
|
||||
name: build wheels
|
||||
name: Publish Python Distributions
|
||||
|
||||
on:
|
||||
release:
|
||||
@ -23,83 +23,86 @@ jobs:
|
||||
exit 1
|
||||
fi
|
||||
|
||||
build_wheels:
|
||||
build_distributions:
|
||||
name: Building Python Distributions
|
||||
needs: enforce_stable_semver
|
||||
runs-on: ubuntu-24.04
|
||||
defaults:
|
||||
run:
|
||||
working-directory: sdk/python/sdk/zrok
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
spec:
|
||||
- { name: 'linux x86_64', runner: ubuntu-20.04, target: manylinux_2_27_x86_64 }
|
||||
- { name: 'macOS x86_64', runner: macos-13, target: macosx_10_14_x86_64 }
|
||||
- { name: 'Windows x86_64', runner: windows-2019, target: win_amd64 }
|
||||
name: building ${{ matrix.spec.name }}
|
||||
runs-on: ${{ matrix.spec.runner }}
|
||||
working-directory: sdk/python/src
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Setup Python
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: '3.x'
|
||||
python-version: '3.13'
|
||||
cache: 'pip'
|
||||
|
||||
- name: Install Python Tools
|
||||
run: python -m pip install -U pip setuptools
|
||||
|
||||
- name: Build distro
|
||||
- name: Build Python distributions
|
||||
env:
|
||||
ZROK_VERSION: ${{ github.event.release.tag_name }}
|
||||
ZROK_PY_NAME: ${{ vars.ZROK_PY_NAME || null }}
|
||||
shell: bash
|
||||
run: |
|
||||
python setup.py sdist
|
||||
|
||||
set -o pipefail
|
||||
set -o xtrace
|
||||
|
||||
# Install build requirements
|
||||
pip install --upgrade pip
|
||||
pip install -r build-requirements.txt
|
||||
|
||||
# Build source distribution and wheel
|
||||
python -m build
|
||||
|
||||
# List built distributions
|
||||
ls -lAR ./dist
|
||||
|
||||
- uses: actions/upload-artifact@v4
|
||||
if: startsWith(matrix.spec.name, 'linux')
|
||||
with:
|
||||
name: zrok_sdk_${{ matrix.spec.target }}
|
||||
path: ${{ github.workspace }}/sdk/python/sdk/zrok/dist/*
|
||||
name: zrok_sdk_distributions
|
||||
path: sdk/python/src/dist/*
|
||||
|
||||
publish-testpypi:
|
||||
runs-on: ubuntu-20.04
|
||||
needs: [ build_wheels ]
|
||||
publish_testpypi:
|
||||
name: Publish TestPyPI
|
||||
runs-on: ubuntu-24.04
|
||||
needs: [ build_distributions ]
|
||||
permissions:
|
||||
id-token: write
|
||||
id-token: write
|
||||
steps:
|
||||
- name: Download artifacts
|
||||
uses: actions/download-artifact@v4
|
||||
with:
|
||||
path: ./dist
|
||||
path: sdk/python/src/dist
|
||||
merge-multiple: true
|
||||
pattern: zrok_sdk_*
|
||||
pattern: zrok_sdk_distributions
|
||||
|
||||
- name: Publish wheels (TestPYPI)
|
||||
- name: Publish Distributions to TestPyPI
|
||||
uses: pypa/gh-action-pypi-publish@release/v1
|
||||
with:
|
||||
repository-url: https://test.pypi.org/legacy/
|
||||
packages-dir: dist
|
||||
packages-dir: sdk/python/src/dist
|
||||
skip-existing: true
|
||||
verbose: true
|
||||
|
||||
publish-pypi:
|
||||
runs-on: ubuntu-20.04
|
||||
needs: [ publish-testpypi ]
|
||||
publish_pypi:
|
||||
name: Publish PyPI
|
||||
runs-on: ubuntu-24.04
|
||||
needs: [ publish_testpypi ]
|
||||
permissions:
|
||||
id-token: write
|
||||
id-token: write
|
||||
steps:
|
||||
- name: Download artifacts
|
||||
uses: actions/download-artifact@v4
|
||||
with:
|
||||
path: ./dist
|
||||
path: sdk/python/src/dist
|
||||
merge-multiple: true
|
||||
pattern: zrok_sdk_*
|
||||
pattern: zrok_sdk_distributions
|
||||
|
||||
- name: Publish wheels (PyPI)
|
||||
- name: Publish Distributions to PyPI
|
||||
uses: pypa/gh-action-pypi-publish@release/v1
|
||||
with:
|
||||
packages-dir: dist
|
||||
packages-dir: sdk/python/src/dist
|
||||
verbose: true
|
||||
|
||||
66
.github/workflows/ci-build.yml
vendored
66
.github/workflows/ci-build.yml
vendored
@ -17,7 +17,7 @@ concurrency:
|
||||
jobs:
|
||||
ubuntu-build:
|
||||
name: Build Linux AMD64 CLI
|
||||
runs-on: ubuntu-20.04
|
||||
runs-on: ubuntu-24.04
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
@ -61,19 +61,6 @@ jobs:
|
||||
shell: bash
|
||||
run: go test -v ./...
|
||||
|
||||
- name: setup python
|
||||
uses: actions/setup-python@v3
|
||||
with:
|
||||
python-version: '3.10'
|
||||
|
||||
- name: python deps
|
||||
shell: bash
|
||||
run: python -m pip install -U pip flake8
|
||||
|
||||
- name: python lint
|
||||
shell: bash
|
||||
run: flake8 sdk/python/sdk/zrok
|
||||
|
||||
- name: solve GOBIN
|
||||
id: solve_go_bin
|
||||
shell: bash
|
||||
@ -88,12 +75,61 @@ jobs:
|
||||
path: ${{ steps.solve_go_bin.outputs.go_bin }}/zrok
|
||||
if-no-files-found: error
|
||||
|
||||
pytest:
|
||||
name: Test the Python SDK
|
||||
runs-on: ubuntu-24.04
|
||||
strategy:
|
||||
matrix:
|
||||
python-version: ["3.10", "3.11", "3.12", "3.13"]
|
||||
defaults:
|
||||
run:
|
||||
working-directory: sdk/python
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python ${{ matrix.python-version }}
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
|
||||
- name: Install dependencies
|
||||
shell: bash
|
||||
run: |
|
||||
|
||||
set -o pipefail
|
||||
set -o xtrace
|
||||
|
||||
python -m pip install --upgrade pip
|
||||
pip install -r src/requirements.txt
|
||||
pip install -r src/test-requirements.txt
|
||||
pip install -r src/build-requirements.txt
|
||||
pip install -e src/
|
||||
|
||||
- name: Test with pytest
|
||||
shell: bash
|
||||
run: |
|
||||
|
||||
set -o pipefail
|
||||
set -o xtrace
|
||||
|
||||
pytest --cov=zrok_api --verbose src/
|
||||
|
||||
- name: Lint the Python SDK
|
||||
shell: bash
|
||||
run: |
|
||||
|
||||
set -o pipefail
|
||||
set -o xtrace
|
||||
|
||||
flake8 .
|
||||
|
||||
# build a release candidate container image for branches named "main" or like "v*"
|
||||
rc-container-build:
|
||||
needs: ubuntu-build
|
||||
if: github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/heads/v')
|
||||
name: Build Release Candidate Container Image
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: ubuntu-24.04
|
||||
steps:
|
||||
- name: Set a container image tag from the branch name
|
||||
id: slug
|
||||
|
||||
38
.github/workflows/node-sdk.yml
vendored
38
.github/workflows/node-sdk.yml
vendored
@ -12,8 +12,6 @@ jobs:
|
||||
name: Require Stable Release Semver
|
||||
if: github.event.action == 'released'
|
||||
runs-on: ubuntu-24.04
|
||||
outputs:
|
||||
version: ${{ steps.parse.outputs.version }}
|
||||
steps:
|
||||
- name: Parse Release Version
|
||||
id: parse
|
||||
@ -32,18 +30,17 @@ jobs:
|
||||
if: always()
|
||||
name: Build for Node-${{ matrix.node_ver }} ${{ matrix.config.target }}/${{ matrix.config.arch }}
|
||||
runs-on: ${{ matrix.config.os }}
|
||||
|
||||
env:
|
||||
BUILD_NUMBER: ${{ github.run_number }}
|
||||
AWS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
|
||||
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
config:
|
||||
- { os: ubuntu-20.04, target: "linux", arch: "x64" }
|
||||
- { os: ubuntu-24.04, target: "linux", arch: "x64" }
|
||||
node_ver: [ 20 ]
|
||||
fail-fast: false
|
||||
|
||||
|
||||
steps:
|
||||
|
||||
- name: Node Version
|
||||
@ -55,20 +52,22 @@ jobs:
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
submodules: 'recursive'
|
||||
|
||||
- name: Get current zrok repo tag
|
||||
if: github.event.action == 'released'
|
||||
id: tag
|
||||
run: echo "TAG=$(git describe --tags --abbrev=0)" | tee -a $GITHUB_OUTPUT
|
||||
shell: bash
|
||||
run: echo "TAG=$(git describe --tags --always)" | tee -a $GITHUB_OUTPUT
|
||||
|
||||
- name: Update zrok NodeJS-SDK's package.json version based on current zrok repo git tag
|
||||
if: github.ref_type == 'tag'
|
||||
if: github.event.action == 'released'
|
||||
shell: bash
|
||||
run: |
|
||||
cd ${{ runner.workspace }}/${{ github.event.repository.name }}/sdk/nodejs/sdk
|
||||
cd sdk/nodejs/sdk
|
||||
npm version ${{ steps.tag.outputs.TAG }} --no-git-tag-version --allow-same-version
|
||||
|
||||
- name: Setup .npmrc
|
||||
if: github.ref_type == 'tag'
|
||||
if: github.event.action == 'released'
|
||||
# Setup .npmrc file to prepare for possible publish to npm
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
@ -76,17 +75,26 @@ jobs:
|
||||
registry-url: 'https://registry.npmjs.org'
|
||||
|
||||
- name: Build the zrok NodeJS-SDK
|
||||
shell: bash
|
||||
run: |
|
||||
cd ${{ runner.workspace }}/${{ github.event.repository.name }}/sdk/nodejs/sdk
|
||||
cd sdk/nodejs/sdk
|
||||
npm install
|
||||
npm run build
|
||||
env:
|
||||
BUILD_DATE: ${{ steps.date.outputs.date }}
|
||||
|
||||
- name: NPM Publish
|
||||
if: github.ref_type == 'tag'
|
||||
if: github.event.action == 'released'
|
||||
shell: bash
|
||||
run: |
|
||||
cd ${{ runner.workspace }}/${{ github.event.repository.name }}/sdk/nodejs/sdk
|
||||
npm publish --access public
|
||||
cd sdk/nodejs/sdk
|
||||
# Check if this is the official repository
|
||||
if [[ "${{ github.repository_owner }}" == "openziti" ]]; then
|
||||
echo "Publishing from official repository with @latest tag"
|
||||
npm publish --access public
|
||||
else
|
||||
echo "Publishing from fork/test repository with @canary tag"
|
||||
npm publish --access public --tag canary
|
||||
fi
|
||||
env:
|
||||
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||
|
||||
8
.gitignore
vendored
8
.gitignore
vendored
@ -16,8 +16,6 @@ node_modules/
|
||||
.docusaurus
|
||||
.cache-loader
|
||||
|
||||
sdk/python/sdk/build/
|
||||
|
||||
# Misc
|
||||
.DS_Store
|
||||
.env.local
|
||||
@ -37,3 +35,9 @@ yarn-error.log*
|
||||
.obsidian
|
||||
|
||||
sdk/nodejs/sdk/dist
|
||||
|
||||
# py module artifacts
|
||||
/sdk/python/src/**/*.egg-info/
|
||||
/sdk/python/src/**/__pycache__/
|
||||
/.coverage
|
||||
/sdk/python/src/dist/
|
||||
|
||||
@ -28,6 +28,8 @@ CHANGE: Deprecated the `passwords` configuration stanza. The zrok controller and
|
||||
|
||||
CHANGE: The protocol for determining valid client versions has been changed. Previously a zrok client would do a `GET` against the `/api/v1/version` endpoint and do a local version string comparison (as a normal precondition to any API call) to see if the controller version matched. The protocol has been amended so that any out-of-date client using the old protocol will receive a version string indicating that they need to uprade their client. New clients will do a `POST` against the `/api/v1/clientVersionCheck` endpoint, posting their client version, and the server will check for compatibility. Does not change the security posture in any significant way, but gives more flexibility on the server side for managing client compatibility. Provides a better, cleared out-of-date error message for old clients when accessing `v1.0.0`+ (https://github.com/openziti/zrok/issues/859)
|
||||
|
||||
CHANGE: The Python SDK is now generated by `openapi-generator` and requires a newer `urllib3` version 2.1.0. The published Python module, `zrok`, inherits the dependencies of the generated packages.
|
||||
|
||||
## v0.4.49
|
||||
|
||||
FIX: Release artifacts now include a reproducible source archive. The archive's download URL is now used by the Homebrew formula when building from source instead of the archive generated on-demand by GitHub (https://github.com/openziti/zrok/issues/858).
|
||||
|
||||
@ -2,37 +2,41 @@
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
command -v swagger >/dev/null 2>&1 || {
|
||||
command -v swagger &>/dev/null || {
|
||||
echo >&2 "command 'swagger' not installed. see: https://github.com/go-swagger/go-swagger for installation"
|
||||
exit 1
|
||||
}
|
||||
|
||||
command -v swagger-codegen 2>&1 || {
|
||||
command -v swagger-codegen &>/dev/null || {
|
||||
echo >&2 "command 'swagger-codegen' not installed. see: https://github.com/swagger-api/swagger-codegen for installation"
|
||||
exit 1
|
||||
}
|
||||
|
||||
command -v openapi-generator-cli 2>&1 || {
|
||||
command -v openapi-generator-cli &>/dev/null || {
|
||||
echo >&2 "command 'openapi-generator-cli' not installed. see: https://www.npmjs.com/package/@openapitools/openapi-generator-cli for installation"
|
||||
exit 1
|
||||
}
|
||||
|
||||
command -v realpath 2>&1 || {
|
||||
command -v realpath &>/dev/null || {
|
||||
echo >&2 "command 'realpath' not installed. see: https://www.npmjs.com/package/realpath for installation"
|
||||
exit 1
|
||||
}
|
||||
|
||||
scriptPath=$(realpath $0)
|
||||
scriptPath=$(realpath "$0")
|
||||
scriptDir=$(dirname "$scriptPath")
|
||||
|
||||
zrokDir=$(realpath "$scriptDir/..")
|
||||
|
||||
zrokSpec=$(realpath "$zrokDir/specs/zrok.yml")
|
||||
|
||||
pythonConfig=$(realpath "$zrokDir/bin/python_config.json")
|
||||
# anti-oops in case user runs this script from somewhere else
|
||||
if [[ "$(realpath "$zrokDir")" != "$(realpath "$(pwd)")" ]]
|
||||
then
|
||||
echo "ERROR: must be run from zrok root" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "...clean generate zrok server/client"
|
||||
rm -rf rest_*
|
||||
rm -rf ./rest_*
|
||||
|
||||
echo "...generating zrok server"
|
||||
swagger generate server -P rest_model_zrok.Principal -f "$zrokSpec" -s rest_server_zrok -t "$zrokDir" -m "rest_model_zrok" --exclude-main
|
||||
@ -42,7 +46,7 @@ swagger generate client -P rest_model_zrok.Principal -f "$zrokSpec" -c rest_clie
|
||||
|
||||
echo "...generating api console ts client"
|
||||
rm -rf ui/src/api
|
||||
openapi-generator-cli generate -i specs/zrok.yml -o ui/src/api -g typescript-fetch
|
||||
openapi-generator-cli generate -i "$zrokSpec" -o ui/src/api -g typescript-fetch
|
||||
|
||||
echo "...generating agent console ts client"
|
||||
rm -rf agent/agentUi/src/api
|
||||
@ -50,11 +54,12 @@ openapi-generator-cli generate -i agent/agentGrpc/agent.swagger.json -o agent/ag
|
||||
|
||||
echo "...generating nodejs sdk ts client"
|
||||
rm -rf sdk/nodejs/sdk/src/api
|
||||
openapi-generator-cli generate -i specs/zrok.yml -o sdk/nodejs/sdk/src/api -g typescript-fetch
|
||||
openapi-generator-cli generate -i "$zrokSpec" -o sdk/nodejs/sdk/src/api -g typescript-fetch
|
||||
|
||||
echo "...generating python sdk client"
|
||||
swagger-codegen generate -i specs/zrok.yml -o sdk/python/sdk/zrok -c $pythonConfig -l python
|
||||
pyMod="./sdk/python/src"
|
||||
rm -rf "$pyMod"/{zrok_api,docs,test,.gitignore,README.md,requirements.txt}
|
||||
openapi-generator-cli generate -i "$zrokSpec" -o "$pyMod" -g python \
|
||||
--package-name zrok_api --additional-properties projectName=zrok
|
||||
|
||||
git checkout rest_server_zrok/configure_zrok.go
|
||||
rm sdk/nodejs/sdk/src/zrok/api/git_push.sh
|
||||
rm sdk/python/sdk/zrok/git_push.sh
|
||||
|
||||
@ -1,4 +0,0 @@
|
||||
{
|
||||
"packageName":"zrok_api",
|
||||
"projectName":"zrok_sdk"
|
||||
}
|
||||
@ -29,11 +29,15 @@ fi
|
||||
(
|
||||
HOME=/tmp/builder
|
||||
# Navigate to the "ui" directory and run npm commands
|
||||
npm config set cache /mnt/.npm
|
||||
cd ./ui/
|
||||
mkdir -p $HOME
|
||||
npm install
|
||||
npm run build
|
||||
npm config set cache /mnt/.npm
|
||||
for UI in ./ui ./agent/agentUi
|
||||
do
|
||||
pushd ${UI}
|
||||
npm install
|
||||
npm run build
|
||||
popd
|
||||
done
|
||||
)
|
||||
|
||||
for ARCH in "${JOBS[@]}"; do
|
||||
|
||||
@ -1,3 +1,3 @@
|
||||
Flask==3.0.0
|
||||
waitress==2.1.2
|
||||
zrok
|
||||
zrok
|
||||
flask
|
||||
waitress
|
||||
|
||||
@ -1,3 +1,2 @@
|
||||
openziti==0.8.1
|
||||
requests==2.31.0
|
||||
zrok
|
||||
zrok
|
||||
requests
|
||||
|
||||
4
sdk/python/examples/proxy/requirements.txt
Normal file
4
sdk/python/examples/proxy/requirements.txt
Normal file
@ -0,0 +1,4 @@
|
||||
zrok
|
||||
flask
|
||||
requests
|
||||
waitress
|
||||
64
sdk/python/sdk/zrok/.gitignore
vendored
64
sdk/python/sdk/zrok/.gitignore
vendored
@ -1,64 +0,0 @@
|
||||
# Byte-compiled / optimized / DLL files
|
||||
__pycache__/
|
||||
*.py[cod]
|
||||
*$py.class
|
||||
|
||||
# C extensions
|
||||
*.so
|
||||
|
||||
# Distribution / packaging
|
||||
.Python
|
||||
env/
|
||||
build/
|
||||
develop-eggs/
|
||||
dist/
|
||||
downloads/
|
||||
eggs/
|
||||
.eggs/
|
||||
lib/
|
||||
lib64/
|
||||
parts/
|
||||
sdist/
|
||||
var/
|
||||
*.egg-info/
|
||||
.installed.cfg
|
||||
*.egg
|
||||
|
||||
# PyInstaller
|
||||
# Usually these files are written by a python script from a template
|
||||
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
||||
*.manifest
|
||||
*.spec
|
||||
|
||||
# Installer logs
|
||||
pip-log.txt
|
||||
pip-delete-this-directory.txt
|
||||
|
||||
# Unit test / coverage reports
|
||||
htmlcov/
|
||||
.tox/
|
||||
.coverage
|
||||
.coverage.*
|
||||
.cache
|
||||
nosetests.xml
|
||||
coverage.xml
|
||||
*,cover
|
||||
.hypothesis/
|
||||
venv/
|
||||
.python-version
|
||||
|
||||
# Translations
|
||||
*.mo
|
||||
*.pot
|
||||
|
||||
# Django stuff:
|
||||
*.log
|
||||
|
||||
# Sphinx documentation
|
||||
docs/_build/
|
||||
|
||||
# PyBuilder
|
||||
target/
|
||||
|
||||
#Ipython Notebook
|
||||
.ipynb_checkpoints
|
||||
@ -1,23 +0,0 @@
|
||||
# Swagger Codegen Ignore
|
||||
# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen
|
||||
|
||||
# Use this file to prevent files from being overwritten by the generator.
|
||||
# The patterns follow closely to .gitignore or .dockerignore.
|
||||
|
||||
# As an example, the C# client generator defines ApiClient.cs.
|
||||
# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
|
||||
#ApiClient.cs
|
||||
|
||||
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
|
||||
#foo/*/qux
|
||||
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
|
||||
|
||||
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
|
||||
#foo/**/qux
|
||||
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
|
||||
|
||||
# You can also negate patterns with an exclamation (!).
|
||||
# For example, you can ignore all files in a docs folder with the file extension .md:
|
||||
#docs/*.md
|
||||
# Then explicitly reverse the ignore rule for a single file:
|
||||
#!docs/README.md
|
||||
@ -1 +0,0 @@
|
||||
3.0.51
|
||||
@ -1,13 +0,0 @@
|
||||
# ref: https://docs.travis-ci.com/user/languages/python
|
||||
language: python
|
||||
python:
|
||||
- "3.2"
|
||||
- "3.3"
|
||||
- "3.4"
|
||||
- "3.5"
|
||||
#- "3.5-dev" # 3.5 development branch
|
||||
#- "nightly" # points to the latest development branch e.g. 3.6-dev
|
||||
# command to install dependencies
|
||||
install: "pip install -r requirements.txt"
|
||||
# command to run tests
|
||||
script: nosetests
|
||||
@ -1,274 +0,0 @@
|
||||
# zrok_sdk
|
||||
zrok client access
|
||||
|
||||
This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/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
|
||||
|
||||
```sh
|
||||
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:
|
||||
```python
|
||||
import zrok_api
|
||||
```
|
||||
|
||||
### Setuptools
|
||||
|
||||
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
|
||||
|
||||
```sh
|
||||
python setup.py install --user
|
||||
```
|
||||
(or `sudo python setup.py install` to install the package for all users)
|
||||
|
||||
Then import the package:
|
||||
```python
|
||||
import zrok_api
|
||||
```
|
||||
|
||||
## Getting Started
|
||||
|
||||
Please follow the [installation procedure](#installation--usage) and then run the following:
|
||||
|
||||
```python
|
||||
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**](docs/AccountApi.md#change_password) | **POST** /changePassword |
|
||||
*AccountApi* | [**invite**](docs/AccountApi.md#invite) | **POST** /invite |
|
||||
*AccountApi* | [**login**](docs/AccountApi.md#login) | **POST** /login |
|
||||
*AccountApi* | [**regenerate_account_token**](docs/AccountApi.md#regenerate_account_token) | **POST** /regenerateAccountToken |
|
||||
*AccountApi* | [**register**](docs/AccountApi.md#register) | **POST** /register |
|
||||
*AccountApi* | [**reset_password**](docs/AccountApi.md#reset_password) | **POST** /resetPassword |
|
||||
*AccountApi* | [**reset_password_request**](docs/AccountApi.md#reset_password_request) | **POST** /resetPasswordRequest |
|
||||
*AccountApi* | [**verify**](docs/AccountApi.md#verify) | **POST** /verify |
|
||||
*AdminApi* | [**add_organization_member**](docs/AdminApi.md#add_organization_member) | **POST** /organization/add |
|
||||
*AdminApi* | [**create_account**](docs/AdminApi.md#create_account) | **POST** /account |
|
||||
*AdminApi* | [**create_frontend**](docs/AdminApi.md#create_frontend) | **POST** /frontend |
|
||||
*AdminApi* | [**create_identity**](docs/AdminApi.md#create_identity) | **POST** /identity |
|
||||
*AdminApi* | [**create_organization**](docs/AdminApi.md#create_organization) | **POST** /organization |
|
||||
*AdminApi* | [**delete_frontend**](docs/AdminApi.md#delete_frontend) | **DELETE** /frontend |
|
||||
*AdminApi* | [**delete_organization**](docs/AdminApi.md#delete_organization) | **DELETE** /organization |
|
||||
*AdminApi* | [**grants**](docs/AdminApi.md#grants) | **POST** /grants |
|
||||
*AdminApi* | [**invite_token_generate**](docs/AdminApi.md#invite_token_generate) | **POST** /invite/token/generate |
|
||||
*AdminApi* | [**list_frontends**](docs/AdminApi.md#list_frontends) | **GET** /frontends |
|
||||
*AdminApi* | [**list_organization_members**](docs/AdminApi.md#list_organization_members) | **POST** /organization/list |
|
||||
*AdminApi* | [**list_organizations**](docs/AdminApi.md#list_organizations) | **GET** /organizations |
|
||||
*AdminApi* | [**remove_organization_member**](docs/AdminApi.md#remove_organization_member) | **POST** /organization/remove |
|
||||
*AdminApi* | [**update_frontend**](docs/AdminApi.md#update_frontend) | **PATCH** /frontend |
|
||||
*EnvironmentApi* | [**disable**](docs/EnvironmentApi.md#disable) | **POST** /disable |
|
||||
*EnvironmentApi* | [**enable**](docs/EnvironmentApi.md#enable) | **POST** /enable |
|
||||
*MetadataApi* | [**client_version_check**](docs/MetadataApi.md#client_version_check) | **POST** /clientVersionCheck |
|
||||
*MetadataApi* | [**configuration**](docs/MetadataApi.md#configuration) | **GET** /configuration |
|
||||
*MetadataApi* | [**get_account_detail**](docs/MetadataApi.md#get_account_detail) | **GET** /detail/account |
|
||||
*MetadataApi* | [**get_account_metrics**](docs/MetadataApi.md#get_account_metrics) | **GET** /metrics/account |
|
||||
*MetadataApi* | [**get_environment_detail**](docs/MetadataApi.md#get_environment_detail) | **GET** /detail/environment/{envZId} |
|
||||
*MetadataApi* | [**get_environment_metrics**](docs/MetadataApi.md#get_environment_metrics) | **GET** /metrics/environment/{envId} |
|
||||
*MetadataApi* | [**get_frontend_detail**](docs/MetadataApi.md#get_frontend_detail) | **GET** /detail/frontend/{frontendId} |
|
||||
*MetadataApi* | [**get_share_detail**](docs/MetadataApi.md#get_share_detail) | **GET** /detail/share/{shareToken} |
|
||||
*MetadataApi* | [**get_share_metrics**](docs/MetadataApi.md#get_share_metrics) | **GET** /metrics/share/{shareToken} |
|
||||
*MetadataApi* | [**get_sparklines**](docs/MetadataApi.md#get_sparklines) | **POST** /sparklines |
|
||||
*MetadataApi* | [**list_memberships**](docs/MetadataApi.md#list_memberships) | **GET** /memberships |
|
||||
*MetadataApi* | [**list_org_members**](docs/MetadataApi.md#list_org_members) | **GET** /members/{organizationToken} |
|
||||
*MetadataApi* | [**org_account_overview**](docs/MetadataApi.md#org_account_overview) | **GET** /overview/{organizationToken}/{accountEmail} |
|
||||
*MetadataApi* | [**overview**](docs/MetadataApi.md#overview) | **GET** /overview |
|
||||
*MetadataApi* | [**version**](docs/MetadataApi.md#version) | **GET** /version |
|
||||
*MetadataApi* | [**version_inventory**](docs/MetadataApi.md#version_inventory) | **GET** /versions |
|
||||
*ShareApi* | [**access**](docs/ShareApi.md#access) | **POST** /access |
|
||||
*ShareApi* | [**share**](docs/ShareApi.md#share) | **POST** /share |
|
||||
*ShareApi* | [**unaccess**](docs/ShareApi.md#unaccess) | **DELETE** /unaccess |
|
||||
*ShareApi* | [**unshare**](docs/ShareApi.md#unshare) | **DELETE** /unshare |
|
||||
*ShareApi* | [**update_access**](docs/ShareApi.md#update_access) | **PATCH** /access |
|
||||
*ShareApi* | [**update_share**](docs/ShareApi.md#update_share) | **PATCH** /share |
|
||||
|
||||
## Documentation For Models
|
||||
|
||||
- [AccessBody](docs/AccessBody.md)
|
||||
- [AccessBody1](docs/AccessBody1.md)
|
||||
- [AccountBody](docs/AccountBody.md)
|
||||
- [AuthUser](docs/AuthUser.md)
|
||||
- [ChangePasswordBody](docs/ChangePasswordBody.md)
|
||||
- [ClientVersionCheckBody](docs/ClientVersionCheckBody.md)
|
||||
- [Configuration](docs/Configuration.md)
|
||||
- [DisableBody](docs/DisableBody.md)
|
||||
- [EnableBody](docs/EnableBody.md)
|
||||
- [Environment](docs/Environment.md)
|
||||
- [EnvironmentAndResources](docs/EnvironmentAndResources.md)
|
||||
- [Environments](docs/Environments.md)
|
||||
- [ErrorMessage](docs/ErrorMessage.md)
|
||||
- [Frontend](docs/Frontend.md)
|
||||
- [FrontendBody](docs/FrontendBody.md)
|
||||
- [FrontendBody1](docs/FrontendBody1.md)
|
||||
- [FrontendBody2](docs/FrontendBody2.md)
|
||||
- [Frontends](docs/Frontends.md)
|
||||
- [GrantsBody](docs/GrantsBody.md)
|
||||
- [IdentityBody](docs/IdentityBody.md)
|
||||
- [InlineResponse200](docs/InlineResponse200.md)
|
||||
- [InlineResponse2001](docs/InlineResponse2001.md)
|
||||
- [InlineResponse2002](docs/InlineResponse2002.md)
|
||||
- [InlineResponse2003](docs/InlineResponse2003.md)
|
||||
- [InlineResponse2003Members](docs/InlineResponse2003Members.md)
|
||||
- [InlineResponse2004](docs/InlineResponse2004.md)
|
||||
- [InlineResponse2004Organizations](docs/InlineResponse2004Organizations.md)
|
||||
- [InlineResponse2005](docs/InlineResponse2005.md)
|
||||
- [InlineResponse2005Memberships](docs/InlineResponse2005Memberships.md)
|
||||
- [InlineResponse2006](docs/InlineResponse2006.md)
|
||||
- [InlineResponse2007](docs/InlineResponse2007.md)
|
||||
- [InlineResponse201](docs/InlineResponse201.md)
|
||||
- [InlineResponse2011](docs/InlineResponse2011.md)
|
||||
- [InlineResponse2012](docs/InlineResponse2012.md)
|
||||
- [InlineResponse2013](docs/InlineResponse2013.md)
|
||||
- [InviteBody](docs/InviteBody.md)
|
||||
- [LoginBody](docs/LoginBody.md)
|
||||
- [Metrics](docs/Metrics.md)
|
||||
- [MetricsSample](docs/MetricsSample.md)
|
||||
- [OrganizationAddBody](docs/OrganizationAddBody.md)
|
||||
- [OrganizationBody](docs/OrganizationBody.md)
|
||||
- [OrganizationBody1](docs/OrganizationBody1.md)
|
||||
- [OrganizationListBody](docs/OrganizationListBody.md)
|
||||
- [OrganizationRemoveBody](docs/OrganizationRemoveBody.md)
|
||||
- [Overview](docs/Overview.md)
|
||||
- [Principal](docs/Principal.md)
|
||||
- [RegenerateAccountTokenBody](docs/RegenerateAccountTokenBody.md)
|
||||
- [RegisterBody](docs/RegisterBody.md)
|
||||
- [ResetPasswordBody](docs/ResetPasswordBody.md)
|
||||
- [ResetPasswordRequestBody](docs/ResetPasswordRequestBody.md)
|
||||
- [Share](docs/Share.md)
|
||||
- [ShareBody](docs/ShareBody.md)
|
||||
- [ShareRequest](docs/ShareRequest.md)
|
||||
- [ShareResponse](docs/ShareResponse.md)
|
||||
- [Shares](docs/Shares.md)
|
||||
- [SparkData](docs/SparkData.md)
|
||||
- [SparkDataSample](docs/SparkDataSample.md)
|
||||
- [SparklinesBody](docs/SparklinesBody.md)
|
||||
- [TokenGenerateBody](docs/TokenGenerateBody.md)
|
||||
- [UnaccessBody](docs/UnaccessBody.md)
|
||||
- [UnshareBody](docs/UnshareBody.md)
|
||||
- [VerifyBody](docs/VerifyBody.md)
|
||||
- [Version](docs/Version.md)
|
||||
|
||||
## Documentation For Authorization
|
||||
|
||||
|
||||
## key
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: x-token
|
||||
- **Location**: HTTP header
|
||||
|
||||
|
||||
## Author
|
||||
|
||||
|
||||
@ -1,12 +0,0 @@
|
||||
# AccessBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**env_zid** | **str** | | [optional]
|
||||
**share_token** | **str** | | [optional]
|
||||
**bind_address** | **str** | | [optional]
|
||||
**description** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,11 +0,0 @@
|
||||
# AccessBody1
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**frontend_token** | **str** | | [optional]
|
||||
**bind_address** | **str** | | [optional]
|
||||
**description** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,383 +0,0 @@
|
||||
# zrok_api.AccountApi
|
||||
|
||||
All URIs are relative to */api/v1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**change_password**](AccountApi.md#change_password) | **POST** /changePassword |
|
||||
[**invite**](AccountApi.md#invite) | **POST** /invite |
|
||||
[**login**](AccountApi.md#login) | **POST** /login |
|
||||
[**regenerate_account_token**](AccountApi.md#regenerate_account_token) | **POST** /regenerateAccountToken |
|
||||
[**register**](AccountApi.md#register) | **POST** /register |
|
||||
[**reset_password**](AccountApi.md#reset_password) | **POST** /resetPassword |
|
||||
[**reset_password_request**](AccountApi.md#reset_password_request) | **POST** /resetPasswordRequest |
|
||||
[**verify**](AccountApi.md#verify) | **POST** /verify |
|
||||
|
||||
# **change_password**
|
||||
> change_password(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**ChangePasswordBody**](ChangePasswordBody.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **invite**
|
||||
> invite(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import zrok_api
|
||||
from zrok_api.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# create an instance of the API class
|
||||
api_instance = zrok_api.AccountApi()
|
||||
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)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**InviteBody**](InviteBody.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **login**
|
||||
> str login(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import zrok_api
|
||||
from zrok_api.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# create an instance of the API class
|
||||
api_instance = zrok_api.AccountApi()
|
||||
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)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**LoginBody**](LoginBody.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
**str**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **regenerate_account_token**
|
||||
> InlineResponse200 regenerate_account_token(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.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)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**RegenerateAccountTokenBody**](RegenerateAccountTokenBody.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse200**](InlineResponse200.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **register**
|
||||
> InlineResponse200 register(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import zrok_api
|
||||
from zrok_api.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# create an instance of the API class
|
||||
api_instance = zrok_api.AccountApi()
|
||||
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)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**RegisterBody**](RegisterBody.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse200**](InlineResponse200.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **reset_password**
|
||||
> reset_password(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import zrok_api
|
||||
from zrok_api.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# create an instance of the API class
|
||||
api_instance = zrok_api.AccountApi()
|
||||
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)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**ResetPasswordBody**](ResetPasswordBody.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **reset_password_request**
|
||||
> reset_password_request(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import zrok_api
|
||||
from zrok_api.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# create an instance of the API class
|
||||
api_instance = zrok_api.AccountApi()
|
||||
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)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**ResetPasswordRequestBody**](ResetPasswordRequestBody.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **verify**
|
||||
> InlineResponse2001 verify(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import zrok_api
|
||||
from zrok_api.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# create an instance of the API class
|
||||
api_instance = zrok_api.AccountApi()
|
||||
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)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**VerifyBody**](VerifyBody.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse2001**](InlineResponse2001.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,10 +0,0 @@
|
||||
# AccountBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**email** | **str** | | [optional]
|
||||
**password** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,720 +0,0 @@
|
||||
# zrok_api.AdminApi
|
||||
|
||||
All URIs are relative to */api/v1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**add_organization_member**](AdminApi.md#add_organization_member) | **POST** /organization/add |
|
||||
[**create_account**](AdminApi.md#create_account) | **POST** /account |
|
||||
[**create_frontend**](AdminApi.md#create_frontend) | **POST** /frontend |
|
||||
[**create_identity**](AdminApi.md#create_identity) | **POST** /identity |
|
||||
[**create_organization**](AdminApi.md#create_organization) | **POST** /organization |
|
||||
[**delete_frontend**](AdminApi.md#delete_frontend) | **DELETE** /frontend |
|
||||
[**delete_organization**](AdminApi.md#delete_organization) | **DELETE** /organization |
|
||||
[**grants**](AdminApi.md#grants) | **POST** /grants |
|
||||
[**invite_token_generate**](AdminApi.md#invite_token_generate) | **POST** /invite/token/generate |
|
||||
[**list_frontends**](AdminApi.md#list_frontends) | **GET** /frontends |
|
||||
[**list_organization_members**](AdminApi.md#list_organization_members) | **POST** /organization/list |
|
||||
[**list_organizations**](AdminApi.md#list_organizations) | **GET** /organizations |
|
||||
[**remove_organization_member**](AdminApi.md#remove_organization_member) | **POST** /organization/remove |
|
||||
[**update_frontend**](AdminApi.md#update_frontend) | **PATCH** /frontend |
|
||||
|
||||
# **add_organization_member**
|
||||
> add_organization_member(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.AdminApi(zrok_api.ApiClient(configuration))
|
||||
body = zrok_api.OrganizationAddBody() # OrganizationAddBody | (optional)
|
||||
|
||||
try:
|
||||
api_instance.add_organization_member(body=body)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AdminApi->add_organization_member: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**OrganizationAddBody**](OrganizationAddBody.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **create_account**
|
||||
> InlineResponse200 create_account(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.AdminApi(zrok_api.ApiClient(configuration))
|
||||
body = zrok_api.AccountBody() # AccountBody | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_account(body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AdminApi->create_account: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**AccountBody**](AccountBody.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse200**](InlineResponse200.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **create_frontend**
|
||||
> InlineResponse201 create_frontend(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.AdminApi(zrok_api.ApiClient(configuration))
|
||||
body = zrok_api.FrontendBody() # FrontendBody | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_frontend(body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AdminApi->create_frontend: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**FrontendBody**](FrontendBody.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse201**](InlineResponse201.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **create_identity**
|
||||
> InlineResponse2011 create_identity(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.AdminApi(zrok_api.ApiClient(configuration))
|
||||
body = zrok_api.IdentityBody() # IdentityBody | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_identity(body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AdminApi->create_identity: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**IdentityBody**](IdentityBody.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse2011**](InlineResponse2011.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **create_organization**
|
||||
> InlineResponse2012 create_organization(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.AdminApi(zrok_api.ApiClient(configuration))
|
||||
body = zrok_api.OrganizationBody() # OrganizationBody | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_organization(body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AdminApi->create_organization: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**OrganizationBody**](OrganizationBody.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse2012**](InlineResponse2012.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_frontend**
|
||||
> delete_frontend(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.AdminApi(zrok_api.ApiClient(configuration))
|
||||
body = zrok_api.FrontendBody1() # FrontendBody1 | (optional)
|
||||
|
||||
try:
|
||||
api_instance.delete_frontend(body=body)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AdminApi->delete_frontend: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**FrontendBody1**](FrontendBody1.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_organization**
|
||||
> delete_organization(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.AdminApi(zrok_api.ApiClient(configuration))
|
||||
body = zrok_api.OrganizationBody1() # OrganizationBody1 | (optional)
|
||||
|
||||
try:
|
||||
api_instance.delete_organization(body=body)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AdminApi->delete_organization: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**OrganizationBody1**](OrganizationBody1.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **grants**
|
||||
> grants(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.AdminApi(zrok_api.ApiClient(configuration))
|
||||
body = zrok_api.GrantsBody() # GrantsBody | (optional)
|
||||
|
||||
try:
|
||||
api_instance.grants(body=body)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AdminApi->grants: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**GrantsBody**](GrantsBody.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **invite_token_generate**
|
||||
> invite_token_generate(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.AdminApi(zrok_api.ApiClient(configuration))
|
||||
body = zrok_api.TokenGenerateBody() # TokenGenerateBody | (optional)
|
||||
|
||||
try:
|
||||
api_instance.invite_token_generate(body=body)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AdminApi->invite_token_generate: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**TokenGenerateBody**](TokenGenerateBody.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **list_frontends**
|
||||
> list[InlineResponse2002] list_frontends()
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.AdminApi(zrok_api.ApiClient(configuration))
|
||||
|
||||
try:
|
||||
api_response = api_instance.list_frontends()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AdminApi->list_frontends: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**list[InlineResponse2002]**](InlineResponse2002.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **list_organization_members**
|
||||
> InlineResponse2003 list_organization_members(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.AdminApi(zrok_api.ApiClient(configuration))
|
||||
body = zrok_api.OrganizationListBody() # OrganizationListBody | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.list_organization_members(body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AdminApi->list_organization_members: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**OrganizationListBody**](OrganizationListBody.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse2003**](InlineResponse2003.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **list_organizations**
|
||||
> InlineResponse2004 list_organizations()
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.AdminApi(zrok_api.ApiClient(configuration))
|
||||
|
||||
try:
|
||||
api_response = api_instance.list_organizations()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AdminApi->list_organizations: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse2004**](InlineResponse2004.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **remove_organization_member**
|
||||
> remove_organization_member(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.AdminApi(zrok_api.ApiClient(configuration))
|
||||
body = zrok_api.OrganizationRemoveBody() # OrganizationRemoveBody | (optional)
|
||||
|
||||
try:
|
||||
api_instance.remove_organization_member(body=body)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AdminApi->remove_organization_member: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**OrganizationRemoveBody**](OrganizationRemoveBody.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **update_frontend**
|
||||
> update_frontend(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.AdminApi(zrok_api.ApiClient(configuration))
|
||||
body = zrok_api.FrontendBody2() # FrontendBody2 | (optional)
|
||||
|
||||
try:
|
||||
api_instance.update_frontend(body=body)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AdminApi->update_frontend: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**FrontendBody2**](FrontendBody2.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,10 +0,0 @@
|
||||
# AuthUser
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**username** | **str** | | [optional]
|
||||
**password** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,11 +0,0 @@
|
||||
# ChangePasswordBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**email** | **str** | | [optional]
|
||||
**old_password** | **str** | | [optional]
|
||||
**new_password** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
# ClientVersionCheckBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**client_version** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,13 +0,0 @@
|
||||
# Configuration
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**version** | **str** | | [optional]
|
||||
**tou_link** | **str** | | [optional]
|
||||
**invites_open** | **bool** | | [optional]
|
||||
**requires_invite_token** | **bool** | | [optional]
|
||||
**invite_token_contact** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
# DisableBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**identity** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,10 +0,0 @@
|
||||
# EnableBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**description** | **str** | | [optional]
|
||||
**host** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,16 +0,0 @@
|
||||
# Environment
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**description** | **str** | | [optional]
|
||||
**host** | **str** | | [optional]
|
||||
**address** | **str** | | [optional]
|
||||
**z_id** | **str** | | [optional]
|
||||
**activity** | [**SparkData**](SparkData.md) | | [optional]
|
||||
**limited** | **bool** | | [optional]
|
||||
**created_at** | **int** | | [optional]
|
||||
**updated_at** | **int** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,11 +0,0 @@
|
||||
# EnvironmentAndResources
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**environment** | [**Environment**](Environment.md) | | [optional]
|
||||
**frontends** | [**Frontends**](Frontends.md) | | [optional]
|
||||
**shares** | [**Shares**](Shares.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,110 +0,0 @@
|
||||
# zrok_api.EnvironmentApi
|
||||
|
||||
All URIs are relative to */api/v1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**disable**](EnvironmentApi.md#disable) | **POST** /disable |
|
||||
[**enable**](EnvironmentApi.md#enable) | **POST** /enable |
|
||||
|
||||
# **disable**
|
||||
> disable(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.EnvironmentApi(zrok_api.ApiClient(configuration))
|
||||
body = zrok_api.DisableBody() # DisableBody | (optional)
|
||||
|
||||
try:
|
||||
api_instance.disable(body=body)
|
||||
except ApiException as e:
|
||||
print("Exception when calling EnvironmentApi->disable: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**DisableBody**](DisableBody.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **enable**
|
||||
> InlineResponse2011 enable(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.EnvironmentApi(zrok_api.ApiClient(configuration))
|
||||
body = zrok_api.EnableBody() # EnableBody | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.enable(body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling EnvironmentApi->enable: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**EnableBody**](EnableBody.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse2011**](InlineResponse2011.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,8 +0,0 @@
|
||||
# Environments
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,8 +0,0 @@
|
||||
# ErrorMessage
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,17 +0,0 @@
|
||||
# Frontend
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | | [optional]
|
||||
**frontend_token** | **str** | | [optional]
|
||||
**share_token** | **str** | | [optional]
|
||||
**backend_mode** | **str** | | [optional]
|
||||
**bind_address** | **str** | | [optional]
|
||||
**description** | **str** | | [optional]
|
||||
**z_id** | **str** | | [optional]
|
||||
**created_at** | **int** | | [optional]
|
||||
**updated_at** | **int** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,12 +0,0 @@
|
||||
# FrontendBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**z_id** | **str** | | [optional]
|
||||
**url_template** | **str** | | [optional]
|
||||
**public_name** | **str** | | [optional]
|
||||
**permission_mode** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
# FrontendBody1
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**frontend_token** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,11 +0,0 @@
|
||||
# FrontendBody2
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**frontend_token** | **str** | | [optional]
|
||||
**public_name** | **str** | | [optional]
|
||||
**url_template** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,8 +0,0 @@
|
||||
# Frontends
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
# GrantsBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**email** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
# IdentityBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
# InlineResponse200
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**account_token** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
# InlineResponse2001
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**email** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,14 +0,0 @@
|
||||
# InlineResponse2002
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**frontend_token** | **str** | | [optional]
|
||||
**z_id** | **str** | | [optional]
|
||||
**url_template** | **str** | | [optional]
|
||||
**public_name** | **str** | | [optional]
|
||||
**created_at** | **int** | | [optional]
|
||||
**updated_at** | **int** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
# InlineResponse2003
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**members** | [**list[InlineResponse2003Members]**](InlineResponse2003Members.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,10 +0,0 @@
|
||||
# InlineResponse2003Members
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**email** | **str** | | [optional]
|
||||
**admin** | **bool** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
# InlineResponse2004
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**organizations** | [**list[InlineResponse2004Organizations]**](InlineResponse2004Organizations.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,10 +0,0 @@
|
||||
# InlineResponse2004Members
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**email** | **str** | | [optional]
|
||||
**admin** | **bool** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,10 +0,0 @@
|
||||
# InlineResponse2004Organizations
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**organization_token** | **str** | | [optional]
|
||||
**description** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
# InlineResponse2005
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**memberships** | [**list[InlineResponse2005Memberships]**](InlineResponse2005Memberships.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,11 +0,0 @@
|
||||
# InlineResponse2005Memberships
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**organization_token** | **str** | | [optional]
|
||||
**description** | **str** | | [optional]
|
||||
**admin** | **bool** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,10 +0,0 @@
|
||||
# InlineResponse2005Organizations
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**token** | **str** | | [optional]
|
||||
**description** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
# InlineResponse2006
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**sparklines** | [**list[Metrics]**](Metrics.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,11 +0,0 @@
|
||||
# InlineResponse2006Memberships
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**organization_token** | **str** | | [optional]
|
||||
**description** | **str** | | [optional]
|
||||
**admin** | **bool** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
# InlineResponse2007
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**controller_version** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
# InlineResponse201
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**frontend_token** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,10 +0,0 @@
|
||||
# InlineResponse2011
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**identity** | **str** | | [optional]
|
||||
**cfg** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
# InlineResponse2012
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**organization_token** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,10 +0,0 @@
|
||||
# InlineResponse2013
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**frontend_token** | **str** | | [optional]
|
||||
**backend_mode** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
# InlineResponse400
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**message** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,10 +0,0 @@
|
||||
# InviteBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**email** | **str** | | [optional]
|
||||
**invite_token** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,10 +0,0 @@
|
||||
# LoginBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**email** | **str** | | [optional]
|
||||
**password** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,796 +0,0 @@
|
||||
# zrok_api.MetadataApi
|
||||
|
||||
All URIs are relative to */api/v1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**client_version_check**](MetadataApi.md#client_version_check) | **POST** /clientVersionCheck |
|
||||
[**configuration**](MetadataApi.md#configuration) | **GET** /configuration |
|
||||
[**get_account_detail**](MetadataApi.md#get_account_detail) | **GET** /detail/account |
|
||||
[**get_account_metrics**](MetadataApi.md#get_account_metrics) | **GET** /metrics/account |
|
||||
[**get_environment_detail**](MetadataApi.md#get_environment_detail) | **GET** /detail/environment/{envZId} |
|
||||
[**get_environment_metrics**](MetadataApi.md#get_environment_metrics) | **GET** /metrics/environment/{envId} |
|
||||
[**get_frontend_detail**](MetadataApi.md#get_frontend_detail) | **GET** /detail/frontend/{frontendId} |
|
||||
[**get_share_detail**](MetadataApi.md#get_share_detail) | **GET** /detail/share/{shareToken} |
|
||||
[**get_share_metrics**](MetadataApi.md#get_share_metrics) | **GET** /metrics/share/{shareToken} |
|
||||
[**get_sparklines**](MetadataApi.md#get_sparklines) | **POST** /sparklines |
|
||||
[**list_memberships**](MetadataApi.md#list_memberships) | **GET** /memberships |
|
||||
[**list_org_members**](MetadataApi.md#list_org_members) | **GET** /members/{organizationToken} |
|
||||
[**org_account_overview**](MetadataApi.md#org_account_overview) | **GET** /overview/{organizationToken}/{accountEmail} |
|
||||
[**overview**](MetadataApi.md#overview) | **GET** /overview |
|
||||
[**version**](MetadataApi.md#version) | **GET** /version |
|
||||
[**version_inventory**](MetadataApi.md#version_inventory) | **GET** /versions |
|
||||
|
||||
# **client_version_check**
|
||||
> client_version_check(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import zrok_api
|
||||
from zrok_api.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# create an instance of the API class
|
||||
api_instance = zrok_api.MetadataApi()
|
||||
body = zrok_api.ClientVersionCheckBody() # ClientVersionCheckBody | (optional)
|
||||
|
||||
try:
|
||||
api_instance.client_version_check(body=body)
|
||||
except ApiException as e:
|
||||
print("Exception when calling MetadataApi->client_version_check: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**ClientVersionCheckBody**](ClientVersionCheckBody.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **configuration**
|
||||
> Configuration configuration()
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import zrok_api
|
||||
from zrok_api.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# create an instance of the API class
|
||||
api_instance = zrok_api.MetadataApi()
|
||||
|
||||
try:
|
||||
api_response = api_instance.configuration()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling MetadataApi->configuration: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**Configuration**](Configuration.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_account_detail**
|
||||
> Environments get_account_detail()
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.MetadataApi(zrok_api.ApiClient(configuration))
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_account_detail()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling MetadataApi->get_account_detail: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**Environments**](Environments.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_account_metrics**
|
||||
> Metrics get_account_metrics(duration=duration)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.MetadataApi(zrok_api.ApiClient(configuration))
|
||||
duration = 'duration_example' # str | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_account_metrics(duration=duration)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling MetadataApi->get_account_metrics: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**duration** | **str**| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**Metrics**](Metrics.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_environment_detail**
|
||||
> EnvironmentAndResources get_environment_detail(env_zid)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.MetadataApi(zrok_api.ApiClient(configuration))
|
||||
env_zid = 'env_zid_example' # str |
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_environment_detail(env_zid)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling MetadataApi->get_environment_detail: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**env_zid** | **str**| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**EnvironmentAndResources**](EnvironmentAndResources.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_environment_metrics**
|
||||
> Metrics get_environment_metrics(env_id, duration=duration)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.MetadataApi(zrok_api.ApiClient(configuration))
|
||||
env_id = 'env_id_example' # str |
|
||||
duration = 'duration_example' # str | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_environment_metrics(env_id, duration=duration)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling MetadataApi->get_environment_metrics: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**env_id** | **str**| |
|
||||
**duration** | **str**| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**Metrics**](Metrics.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_frontend_detail**
|
||||
> Frontend get_frontend_detail(frontend_id)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.MetadataApi(zrok_api.ApiClient(configuration))
|
||||
frontend_id = 56 # int |
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_frontend_detail(frontend_id)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling MetadataApi->get_frontend_detail: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**frontend_id** | **int**| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Frontend**](Frontend.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_share_detail**
|
||||
> Share get_share_detail(share_token)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.MetadataApi(zrok_api.ApiClient(configuration))
|
||||
share_token = 'share_token_example' # str |
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_share_detail(share_token)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling MetadataApi->get_share_detail: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**share_token** | **str**| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Share**](Share.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_share_metrics**
|
||||
> Metrics get_share_metrics(share_token, duration=duration)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.MetadataApi(zrok_api.ApiClient(configuration))
|
||||
share_token = 'share_token_example' # str |
|
||||
duration = 'duration_example' # str | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_share_metrics(share_token, duration=duration)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling MetadataApi->get_share_metrics: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**share_token** | **str**| |
|
||||
**duration** | **str**| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**Metrics**](Metrics.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_sparklines**
|
||||
> InlineResponse2006 get_sparklines(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.MetadataApi(zrok_api.ApiClient(configuration))
|
||||
body = zrok_api.SparklinesBody() # SparklinesBody | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_sparklines(body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling MetadataApi->get_sparklines: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**SparklinesBody**](SparklinesBody.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse2006**](InlineResponse2006.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **list_memberships**
|
||||
> InlineResponse2005 list_memberships()
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.MetadataApi(zrok_api.ApiClient(configuration))
|
||||
|
||||
try:
|
||||
api_response = api_instance.list_memberships()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling MetadataApi->list_memberships: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse2005**](InlineResponse2005.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **list_org_members**
|
||||
> InlineResponse2003 list_org_members(organization_token)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.MetadataApi(zrok_api.ApiClient(configuration))
|
||||
organization_token = 'organization_token_example' # str |
|
||||
|
||||
try:
|
||||
api_response = api_instance.list_org_members(organization_token)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling MetadataApi->list_org_members: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**organization_token** | **str**| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse2003**](InlineResponse2003.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **org_account_overview**
|
||||
> Overview org_account_overview(organization_token, account_email)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.MetadataApi(zrok_api.ApiClient(configuration))
|
||||
organization_token = 'organization_token_example' # str |
|
||||
account_email = 'account_email_example' # str |
|
||||
|
||||
try:
|
||||
api_response = api_instance.org_account_overview(organization_token, account_email)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling MetadataApi->org_account_overview: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**organization_token** | **str**| |
|
||||
**account_email** | **str**| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Overview**](Overview.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **overview**
|
||||
> Overview overview()
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.MetadataApi(zrok_api.ApiClient(configuration))
|
||||
|
||||
try:
|
||||
api_response = api_instance.overview()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling MetadataApi->overview: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**Overview**](Overview.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **version**
|
||||
> Version version()
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import zrok_api
|
||||
from zrok_api.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# create an instance of the API class
|
||||
api_instance = zrok_api.MetadataApi()
|
||||
|
||||
try:
|
||||
api_response = api_instance.version()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling MetadataApi->version: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**Version**](Version.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **version_inventory**
|
||||
> InlineResponse2007 version_inventory()
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import zrok_api
|
||||
from zrok_api.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# create an instance of the API class
|
||||
api_instance = zrok_api.MetadataApi()
|
||||
|
||||
try:
|
||||
api_response = api_instance.version_inventory()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling MetadataApi->version_inventory: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse2007**](InlineResponse2007.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,12 +0,0 @@
|
||||
# Metrics
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**scope** | **str** | | [optional]
|
||||
**id** | **str** | | [optional]
|
||||
**period** | **float** | | [optional]
|
||||
**samples** | [**list[MetricsSample]**](MetricsSample.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,11 +0,0 @@
|
||||
# MetricsSample
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**rx** | **float** | | [optional]
|
||||
**tx** | **float** | | [optional]
|
||||
**timestamp** | **float** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,11 +0,0 @@
|
||||
# OrganizationAddBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**organization_token** | **str** | | [optional]
|
||||
**email** | **str** | | [optional]
|
||||
**admin** | **bool** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
# OrganizationBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**description** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
# OrganizationBody1
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**organization_token** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
# OrganizationListBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**organization_token** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,10 +0,0 @@
|
||||
# OrganizationRemoveBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**organization_token** | **str** | | [optional]
|
||||
**email** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,10 +0,0 @@
|
||||
# Overview
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**account_limited** | **bool** | | [optional]
|
||||
**environments** | [**list[EnvironmentAndResources]**](EnvironmentAndResources.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,13 +0,0 @@
|
||||
# Principal
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | | [optional]
|
||||
**email** | **str** | | [optional]
|
||||
**token** | **str** | | [optional]
|
||||
**limitless** | **bool** | | [optional]
|
||||
**admin** | **bool** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
# RegenerateAccountTokenBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**email_address** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
# RegenerateTokenBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**email_address** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,10 +0,0 @@
|
||||
# RegisterBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**register_token** | **str** | | [optional]
|
||||
**password** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,10 +0,0 @@
|
||||
# ResetPasswordBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**reset_token** | **str** | | [optional]
|
||||
**password** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
# ResetPasswordRequestBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**email_address** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,20 +0,0 @@
|
||||
# Share
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**share_token** | **str** | | [optional]
|
||||
**z_id** | **str** | | [optional]
|
||||
**share_mode** | **str** | | [optional]
|
||||
**backend_mode** | **str** | | [optional]
|
||||
**frontend_selection** | **str** | | [optional]
|
||||
**frontend_endpoint** | **str** | | [optional]
|
||||
**backend_proxy_endpoint** | **str** | | [optional]
|
||||
**reserved** | **bool** | | [optional]
|
||||
**activity** | [**SparkData**](SparkData.md) | | [optional]
|
||||
**limited** | **bool** | | [optional]
|
||||
**created_at** | **int** | | [optional]
|
||||
**updated_at** | **int** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,315 +0,0 @@
|
||||
# zrok_api.ShareApi
|
||||
|
||||
All URIs are relative to */api/v1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**access**](ShareApi.md#access) | **POST** /access |
|
||||
[**share**](ShareApi.md#share) | **POST** /share |
|
||||
[**unaccess**](ShareApi.md#unaccess) | **DELETE** /unaccess |
|
||||
[**unshare**](ShareApi.md#unshare) | **DELETE** /unshare |
|
||||
[**update_access**](ShareApi.md#update_access) | **PATCH** /access |
|
||||
[**update_share**](ShareApi.md#update_share) | **PATCH** /share |
|
||||
|
||||
# **access**
|
||||
> InlineResponse2013 access(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.ShareApi(zrok_api.ApiClient(configuration))
|
||||
body = zrok_api.AccessBody() # AccessBody | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.access(body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ShareApi->access: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**AccessBody**](AccessBody.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InlineResponse2013**](InlineResponse2013.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **share**
|
||||
> ShareResponse share(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.ShareApi(zrok_api.ApiClient(configuration))
|
||||
body = zrok_api.ShareRequest() # ShareRequest | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.share(body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ShareApi->share: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**ShareRequest**](ShareRequest.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ShareResponse**](ShareResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **unaccess**
|
||||
> unaccess(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.ShareApi(zrok_api.ApiClient(configuration))
|
||||
body = zrok_api.UnaccessBody() # UnaccessBody | (optional)
|
||||
|
||||
try:
|
||||
api_instance.unaccess(body=body)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ShareApi->unaccess: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**UnaccessBody**](UnaccessBody.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **unshare**
|
||||
> unshare(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.ShareApi(zrok_api.ApiClient(configuration))
|
||||
body = zrok_api.UnshareBody() # UnshareBody | (optional)
|
||||
|
||||
try:
|
||||
api_instance.unshare(body=body)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ShareApi->unshare: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**UnshareBody**](UnshareBody.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: application/zrok.v1+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **update_access**
|
||||
> update_access(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.ShareApi(zrok_api.ApiClient(configuration))
|
||||
body = zrok_api.AccessBody1() # AccessBody1 | (optional)
|
||||
|
||||
try:
|
||||
api_instance.update_access(body=body)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ShareApi->update_access: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**AccessBody1**](AccessBody1.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **update_share**
|
||||
> update_share(body=body)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```python
|
||||
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.ShareApi(zrok_api.ApiClient(configuration))
|
||||
body = zrok_api.ShareBody() # ShareBody | (optional)
|
||||
|
||||
try:
|
||||
api_instance.update_share(body=body)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ShareApi->update_share: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**ShareBody**](ShareBody.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[key](../README.md#key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/zrok.v1+json
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,12 +0,0 @@
|
||||
# ShareBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**share_token** | **str** | | [optional]
|
||||
**backend_proxy_endpoint** | **str** | | [optional]
|
||||
**add_access_grants** | **list[str]** | | [optional]
|
||||
**remove_access_grants** | **list[str]** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,22 +0,0 @@
|
||||
# ShareRequest
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**env_zid** | **str** | | [optional]
|
||||
**share_mode** | **str** | | [optional]
|
||||
**frontend_selection** | **list[str]** | | [optional]
|
||||
**backend_mode** | **str** | | [optional]
|
||||
**backend_proxy_endpoint** | **str** | | [optional]
|
||||
**auth_scheme** | **str** | | [optional]
|
||||
**auth_users** | [**list[AuthUser]**](AuthUser.md) | | [optional]
|
||||
**oauth_provider** | **str** | | [optional]
|
||||
**oauth_email_domains** | **list[str]** | | [optional]
|
||||
**oauth_authorization_check_interval** | **str** | | [optional]
|
||||
**reserved** | **bool** | | [optional]
|
||||
**permission_mode** | **str** | | [optional]
|
||||
**access_grants** | **list[str]** | | [optional]
|
||||
**unique_name** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,10 +0,0 @@
|
||||
# ShareResponse
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**frontend_proxy_endpoints** | **list[str]** | | [optional]
|
||||
**share_token** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,8 +0,0 @@
|
||||
# Shares
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,8 +0,0 @@
|
||||
# SparkData
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,10 +0,0 @@
|
||||
# SparkDataSample
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**rx** | **float** | | [optional]
|
||||
**tx** | **float** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,11 +0,0 @@
|
||||
# SparklinesBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**account** | **bool** | | [optional]
|
||||
**environments** | **list[str]** | | [optional]
|
||||
**shares** | **list[str]** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
# TokenGenerateBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**invite_tokens** | **list[str]** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,11 +0,0 @@
|
||||
# UnaccessBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**frontend_token** | **str** | | [optional]
|
||||
**env_zid** | **str** | | [optional]
|
||||
**share_token** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,11 +0,0 @@
|
||||
# UnshareBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**env_zid** | **str** | | [optional]
|
||||
**share_token** | **str** | | [optional]
|
||||
**reserved** | **bool** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
# VerifyBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**register_token** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,8 +0,0 @@
|
||||
# Version
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
# VersionBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**client_version** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
# VersionCheckBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**client_version** | **str** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@ -1,5 +0,0 @@
|
||||
certifi >= 14.05.14
|
||||
six >= 1.10
|
||||
python_dateutil >= 2.5.3
|
||||
setuptools >= 21.0.0
|
||||
urllib3 >= 1.15.1
|
||||
@ -1,39 +0,0 @@
|
||||
# coding: utf-8
|
||||
|
||||
"""
|
||||
zrok
|
||||
|
||||
zrok client access # noqa: E501
|
||||
|
||||
OpenAPI spec version: 1.0.0
|
||||
|
||||
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
||||
"""
|
||||
|
||||
from setuptools import setup, find_packages # noqa: H301
|
||||
|
||||
NAME = "zrok_sdk"
|
||||
VERSION = "1.0.0"
|
||||
# To install the library, run the following
|
||||
#
|
||||
# python setup.py install
|
||||
#
|
||||
# prerequisite: setuptools
|
||||
# http://pypi.python.org/pypi/setuptools
|
||||
|
||||
REQUIRES = ["urllib3 >= 1.15", "six >= 1.10", "certifi", "python-dateutil"]
|
||||
|
||||
setup(
|
||||
name=NAME,
|
||||
version=VERSION,
|
||||
description="zrok",
|
||||
author_email="",
|
||||
url="",
|
||||
keywords=["Swagger", "zrok"],
|
||||
install_requires=REQUIRES,
|
||||
packages=find_packages(),
|
||||
include_package_data=True,
|
||||
long_description="""\
|
||||
zrok client access # noqa: E501
|
||||
"""
|
||||
)
|
||||
@ -1,5 +0,0 @@
|
||||
coverage>=4.0.3
|
||||
nose>=1.3.7
|
||||
pluggy>=0.3.1
|
||||
py>=1.4.31
|
||||
randomize>=0.13
|
||||
@ -1 +0,0 @@
|
||||
# coding: utf-8
|
||||
@ -1,39 +0,0 @@
|
||||
# coding: utf-8
|
||||
|
||||
"""
|
||||
zrok
|
||||
|
||||
zrok client access # noqa: E501
|
||||
|
||||
OpenAPI spec version: 1.0.0
|
||||
|
||||
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
||||
"""
|
||||
|
||||
from __future__ import absolute_import
|
||||
|
||||
import unittest
|
||||
|
||||
import zrok_api
|
||||
from zrok_api.models.access_body import AccessBody # noqa: E501
|
||||
from zrok_api.rest import ApiException
|
||||
|
||||
|
||||
class TestAccessBody(unittest.TestCase):
|
||||
"""AccessBody unit test stubs"""
|
||||
|
||||
def setUp(self):
|
||||
pass
|
||||
|
||||
def tearDown(self):
|
||||
pass
|
||||
|
||||
def testAccessBody(self):
|
||||
"""Test AccessBody"""
|
||||
# FIXME: construct object with mandatory attributes with example values
|
||||
# model = zrok_api.models.access_body.AccessBody() # noqa: E501
|
||||
pass
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
unittest.main()
|
||||
@ -1,39 +0,0 @@
|
||||
# coding: utf-8
|
||||
|
||||
"""
|
||||
zrok
|
||||
|
||||
zrok client access # noqa: E501
|
||||
|
||||
OpenAPI spec version: 1.0.0
|
||||
|
||||
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
||||
"""
|
||||
|
||||
from __future__ import absolute_import
|
||||
|
||||
import unittest
|
||||
|
||||
import zrok_api
|
||||
from zrok_api.models.access_body1 import AccessBody1 # noqa: E501
|
||||
from zrok_api.rest import ApiException
|
||||
|
||||
|
||||
class TestAccessBody1(unittest.TestCase):
|
||||
"""AccessBody1 unit test stubs"""
|
||||
|
||||
def setUp(self):
|
||||
pass
|
||||
|
||||
def tearDown(self):
|
||||
pass
|
||||
|
||||
def testAccessBody1(self):
|
||||
"""Test AccessBody1"""
|
||||
# FIXME: construct object with mandatory attributes with example values
|
||||
# model = zrok_api.models.access_body1.AccessBody1() # noqa: E501
|
||||
pass
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
unittest.main()
|
||||
@ -1,81 +0,0 @@
|
||||
# coding: utf-8
|
||||
|
||||
"""
|
||||
zrok
|
||||
|
||||
zrok client access # noqa: E501
|
||||
|
||||
OpenAPI spec version: 1.0.0
|
||||
|
||||
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
||||
"""
|
||||
|
||||
from __future__ import absolute_import
|
||||
|
||||
import unittest
|
||||
|
||||
import zrok_api
|
||||
from zrok_api.api.account_api import AccountApi # noqa: E501
|
||||
from zrok_api.rest import ApiException
|
||||
|
||||
|
||||
class TestAccountApi(unittest.TestCase):
|
||||
"""AccountApi unit test stubs"""
|
||||
|
||||
def setUp(self):
|
||||
self.api = AccountApi() # noqa: E501
|
||||
|
||||
def tearDown(self):
|
||||
pass
|
||||
|
||||
def test_change_password(self):
|
||||
"""Test case for change_password
|
||||
|
||||
"""
|
||||
pass
|
||||
|
||||
def test_invite(self):
|
||||
"""Test case for invite
|
||||
|
||||
"""
|
||||
pass
|
||||
|
||||
def test_login(self):
|
||||
"""Test case for login
|
||||
|
||||
"""
|
||||
pass
|
||||
|
||||
def test_regenerate_token(self):
|
||||
"""Test case for regenerate_token
|
||||
|
||||
"""
|
||||
pass
|
||||
|
||||
def test_register(self):
|
||||
"""Test case for register
|
||||
|
||||
"""
|
||||
pass
|
||||
|
||||
def test_reset_password(self):
|
||||
"""Test case for reset_password
|
||||
|
||||
"""
|
||||
pass
|
||||
|
||||
def test_reset_password_request(self):
|
||||
"""Test case for reset_password_request
|
||||
|
||||
"""
|
||||
pass
|
||||
|
||||
def test_verify(self):
|
||||
"""Test case for verify
|
||||
|
||||
"""
|
||||
pass
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
unittest.main()
|
||||
@ -1,39 +0,0 @@
|
||||
# coding: utf-8
|
||||
|
||||
"""
|
||||
zrok
|
||||
|
||||
zrok client access # noqa: E501
|
||||
|
||||
OpenAPI spec version: 1.0.0
|
||||
|
||||
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
||||
"""
|
||||
|
||||
from __future__ import absolute_import
|
||||
|
||||
import unittest
|
||||
|
||||
import zrok_api
|
||||
from zrok_api.models.account_body import AccountBody # noqa: E501
|
||||
from zrok_api.rest import ApiException
|
||||
|
||||
|
||||
class TestAccountBody(unittest.TestCase):
|
||||
"""AccountBody unit test stubs"""
|
||||
|
||||
def setUp(self):
|
||||
pass
|
||||
|
||||
def tearDown(self):
|
||||
pass
|
||||
|
||||
def testAccountBody(self):
|
||||
"""Test AccountBody"""
|
||||
# FIXME: construct object with mandatory attributes with example values
|
||||
# model = zrok_api.models.account_body.AccountBody() # noqa: E501
|
||||
pass
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
unittest.main()
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user