zi-api-auth-client


Namezi-api-auth-client JSON
Version 2.0.2 PyPI version JSON
download
home_pagehttps://github.com/Zoominfo/api-auth-python-client
SummaryA library that supports username-password and PKI authentication methods for enterprise-api
upload_time2024-11-20 16:57:22
maintainerNone
docs_urlNone
authorKrishna Teja Dinavahi
requires_pythonNone
licenseMIT
keywords zoominfo enterprise-api pki-auth
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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-----'''

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Zoominfo/api-auth-python-client",
    "name": "zi-api-auth-client",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "ZoomInfo enterprise-api pki-auth",
    "author": "Krishna Teja Dinavahi",
    "author_email": "krishnateja.dinavahi@zoominfo.com",
    "download_url": "https://files.pythonhosted.org/packages/ed/e4/757b7dd2fe0fa141fcb0fd73b0976281eccf7eabbcc190fa82b8c587d233/zi_api_auth_client-2.0.2.tar.gz",
    "platform": null,
    "description": "zi_api_auth_client\n==============================\n\nThis library supports 2 types of authentication methods. Both the methods return a JWT token which you can use to make\napi calls for enterprise-api on production.\n\nUsername and password authentication:\n============================================================\n\n**Usage:**\n\n1. import zi_api_auth_client\n\n2. jwt_token = zi_api_auth_client.user_name_pwd_authentication(\"your_user_name\", \"your_password\")\n\nPKI authentication:\n==============================\n\nThis type of authentication needs a private key and a client ID to generate the JWT token.\n\n**Usage:**\n\n1. import zi_api_auth_client\n\n2. Paste your private key:\n\n        key = '''\n\n        -----BEGIN PRIVATE KEY-----\n\n        Your private key goes here\n\n        -----END PRIVATE KEY-----'''\n\n3. jwt_token = zi_api_auth_client.pki_authentication(\"your_user_name\", \"your_client_id\", key)\n\n**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.**\n\n**Correct way:**\n\nThe following is the right way to paste your private key.\n\n\n    '''\n\n    -----BEGIN PRIVATE KEY-----\n\n    Your private key goes here\n\n    -----END PRIVATE KEY-----'''\n\n**Wrong way:**\n\nPasting 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.\n\n\n       '''\n\n            -----BEGIN PRIVATE KEY-----\n\n            Your private key goes here\n\n            -----END PRIVATE KEY-----'''\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A library that supports username-password and PKI authentication methods for enterprise-api",
    "version": "2.0.2",
    "project_urls": {
        "Homepage": "https://github.com/Zoominfo/api-auth-python-client"
    },
    "split_keywords": [
        "zoominfo",
        "enterprise-api",
        "pki-auth"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9c23c53efb755d531c7b126fc65cda1eec2c39b3bc7fc408c956007b84f00e4b",
                "md5": "4da96855184be3d2cced56f1fe3a1b4f",
                "sha256": "8426ee7c68620dcbae3a809860da909acd93f9b793fa0a67116c6fd5424cd9cf"
            },
            "downloads": -1,
            "filename": "zi_api_auth_client-2.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4da96855184be3d2cced56f1fe3a1b4f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 4400,
            "upload_time": "2024-11-20T16:57:21",
            "upload_time_iso_8601": "2024-11-20T16:57:21.622021Z",
            "url": "https://files.pythonhosted.org/packages/9c/23/c53efb755d531c7b126fc65cda1eec2c39b3bc7fc408c956007b84f00e4b/zi_api_auth_client-2.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ede4757b7dd2fe0fa141fcb0fd73b0976281eccf7eabbcc190fa82b8c587d233",
                "md5": "36d8bc20cc111616f70b8b247d36dfb8",
                "sha256": "352a0194b4f2bf87e42524f8cb0754ef2b0110937495dd728d9e76586d732666"
            },
            "downloads": -1,
            "filename": "zi_api_auth_client-2.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "36d8bc20cc111616f70b8b247d36dfb8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 3702,
            "upload_time": "2024-11-20T16:57:22",
            "upload_time_iso_8601": "2024-11-20T16:57:22.653221Z",
            "url": "https://files.pythonhosted.org/packages/ed/e4/757b7dd2fe0fa141fcb0fd73b0976281eccf7eabbcc190fa82b8c587d233/zi_api_auth_client-2.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-20 16:57:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Zoominfo",
    "github_project": "api-auth-python-client",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "zi-api-auth-client"
}
        
Elapsed time: 1.48285s