Skip to main content

HYPR SDK for Python

HYPR provides a robust set of REST APIs for administrative operations as well as for writing FIDO UAF and FIDO2 applications. This Python SDK wraps a subset of those REST APIs in a typical SDK pattern to allow coding Python scripts at a higher level than simply calling REST APIs via cURL or Postman.

If the REST API you want to use is not implemented in this SDK, you can request it from HYPR Support. You can also obtain the existing GitLab repo implementation from the same email address. Use it as a guide, to implement the Python models/functions, or contribute to it in GitLab.

Installation​

You can pip to install this Python package on your local machine using the wheel file in the /dist directory. This takes care of automatically installing the dependencies as well. It's best to install it into a virtual environment to avoid conflicts with your system installation of Python.

Create a Virtual Environment if You Don't Already Have One​

~ % python3 -m venv ./pyenv
~ % cd pyenv 
pyenv % source bin/activate
(pyenv) pyenv % which python
/Users/ghopper/pyenv/bin/python
(pyenv) pyenv % python --version
Python 3.10.0
(pyenv) pyenv % pip install --upgrade pip
Requirement already satisfied: pip in ./lib/python3.10/site-packages (21.2.3)
Collecting pip
  Using cached pip-24.0-py3-none-any.whl (2.1 MB)
Installing collected packages: pip
  Attempting uninstall: pip
    Found existing installation: pip 21.2.3
    Uninstalling pip-21.2.3:
      Successfully uninstalled pip-21.2.3
Successfully installed pip-24.0

Install the hypr-python-sdk Package in Your Virtual Environment​

Navigate to the /dist directory in this repo. Download the dist/hypr_python_sdk-0.1.0-py3-none-any.whl file to your local machine. Use pip install in the activated virtual environment you created above:

(pyenv) pyenv % pip install ~/Downloads/hypr_python_sdk-0.1.0-py3-none-any.whl 
Processing /Users/ghopper/Downloads/hypr_python_sdk-0.1.0-py3-none-any.whl
Collecting pytest<9.0.0,>=8.1.1 (from hypr-python-sdk==0.1.0)
  Downloading pytest-8.2.2-py3-none-any.whl.metadata (7.6 kB)
Requirement already satisfied: requests<3.0.0,>=2.28.1 in ./lib/python3.10/site-packages (from hypr-python-sdk==0.1.0) (2.31.0)
Collecting iniconfig (from pytest<9.0.0,>=8.1.1->hypr-python-sdk==0.1.0)
  Downloading iniconfig-2.0.0-py3-none-any.whl.metadata (2.6 kB)
Requirement already satisfied: packaging in ./lib/python3.10/site-packages (from pytest<9.0.0,>=8.1.1->hypr-python-sdk==0.1.0) (24.0)
Collecting pluggy<2.0,>=1.5 (from pytest<9.0.0,>=8.1.1->hypr-python-sdk==0.1.0)
  Downloading pluggy-1.5.0-py3-none-any.whl.metadata (4.8 kB)
Collecting exceptiongroup>=1.0.0rc8 (from pytest<9.0.0,>=8.1.1->hypr-python-sdk==0.1.0)
  Downloading exceptiongroup-1.2.1-py3-none-any.whl.metadata (6.6 kB)
Collecting tomli>=1 (from pytest<9.0.0,>=8.1.1->hypr-python-sdk==0.1.0)
  Downloading tomli-2.0.1-py3-none-any.whl.metadata (8.9 kB)
Requirement already satisfied: charset-normalizer<4,>=2 in ./lib/python3.10/site-packages (from requests<3.0.0,>=2.28.1->hypr-python-sdk==0.1.0) (3.3.2)
Requirement already satisfied: idna<4,>=2.5 in ./lib/python3.10/site-packages (from requests<3.0.0,>=2.28.1->hypr-python-sdk==0.1.0) (3.7)
Requirement already satisfied: urllib3<3,>=1.21.1 in ./lib/python3.10/site-packages (from requests<3.0.0,>=2.28.1->hypr-python-sdk==0.1.0) (2.2.1)
Requirement already satisfied: certifi>=2017.4.17 in ./lib/python3.10/site-packages (from requests<3.0.0,>=2.28.1->hypr-python-sdk==0.1.0) (2024.2.2)
Downloading pytest-8.2.2-py3-none-any.whl (339 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 339.9/339.9 kB 1.0 MB/s eta 0:00:00
Downloading exceptiongroup-1.2.1-py3-none-any.whl (16 kB)
Downloading pluggy-1.5.0-py3-none-any.whl (20 kB)
Downloading tomli-2.0.1-py3-none-any.whl (12 kB)
Downloading iniconfig-2.0.0-py3-none-any.whl (5.9 kB)
Installing collected packages: tomli, pluggy, iniconfig, exceptiongroup, pytest, hypr-python-sdk
Successfully installed exceptiongroup-1.2.1 hypr-python-sdk-0.1.0 iniconfig-2.0.0 pluggy-1.5.0 pytest-8.2.2 tomli-2.0.1

Your virtual environment is now ready to use the HYPR SDK for Python.

How to Use the HYPR SDK for Python​

Initiate the Client​

You'll need three pieces of information to create any script.

These three values will be used to initiate any script you write with the following code:

    from hypr_sdk.client import HYPRHttpClient
    from hypr_sdk.config import HYPRHttpClientConfig
    
    hypr_config = HYPRHttpClientConfig(base_url,  api_token, rp_app_id)
    hypr_client = HYPRHttpClient(hypr_config)

Calling the SDK Functions​

Once you have the hypr_client, you can pass it along with any other required parameters to the function of your choice.

For example

    from hypr_sdk.models.users import RPUserPageResponse
    from hypr_sdk.services.users import get_users

    # get users 
    response: RPUserPageResponse = get_users(hypr_client)
    print('HYPR Python SDK Internal Representation')
    print(response)
    print()
    print('HYPR Python SDK JSON Representation')
    print(response.to_json_serializable())

    print_response(response, title='get_users(hypr_client) retrieves one page of users')

Example Python Scripts​

The hypr-python-sdk GitLab repo houses an examples directory that contains fully realized scripts Python scripts as well as a simple example called basic_example.py. Go to the GitLab repo to download the examples to your machine.

Start with basic_example.py as a way to vet your Python environment. You will need to edit basic_example.py to add your values.

    base_url = 'https://<your tenant>'  # replace <your tenant> with the url of you HYPR tenant
    rp_app_id = '<rpAppId>'  # replace <rpAppId> with the application ID obtained from the HYPR Control Center (CC)
    api_token = '<token value>'  # replace <token value> with an api token created for the rp_app_id in CC

Assuming the script is located at ~/my_scripts/basic_example.py, you can run it in your virtual environment (called pyenv in this example) as follows:

% cd pyenv
pyenv % source bin/activate
(pyenv) pyenv % python ~/my_scripts/basic_example.py

References​

HYPR Passwordless API (REST) Documentation

Python Virtual Environments Tutorial