Skip to main content

A library that supports username-password and PKI authentication methods for enterprise-api

Project description

zi_api_auth_client

This library supports 2 types of authentication methods. Both the methods return a JWT token which you can use to make api calls for enterprise-api on production.

Username and password authentication:

Usage:

  1. import zi_api_auth_client

  2. jwt_token = zi_api_auth_client.user_name_pwd_authentication(“your_user_name”, “your_password”)

PKI authentication:

This type of authentication needs a private key and a client ID to generate the JWT token.

Usage:

  1. import zi_api_auth_client

  2. Paste your private key:

    key = ‘’’

    —–BEGIN PRIVATE KEY—–

    Your private key goes here

    —–END PRIVATE KEY—–‘’’

  3. jwt_token = zi_api_auth_client.pki_authentication(“your_user_name”, “your_client_id”, key)

Note: If you get the error “ValueError: Could not deserialize key data.” when doing PKI authentication, make sure that your private key is properly formatted. Paste the private key as a multi-line string in python.

Correct way:

The following is the right way to paste your private key.

‘’’

—–BEGIN PRIVATE KEY—–

Your private key goes here

—–END PRIVATE KEY—–‘’’

Wrong way:

Pasting the private key as follows would throw the error “ValueError: Could not deserialize key data.” because there are extra spaces on each line in the key.

‘’’

—–BEGIN PRIVATE KEY—–

Your private key goes here

—–END PRIVATE KEY—–‘’’

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zi_api_auth_client-2.0.1.tar.gz (3.7 kB view hashes)

Uploaded Source

Built Distribution

zi_api_auth_client-2.0.1-py3-none-any.whl (4.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page