Skip to main content

Versatile Data Kit plugin library provides support for authentication.

Project description

vdk-control-api-auth

vdk-control-api-auth is a plugin library that implements authentication utilities used by vdk-control-cli and other plugins.

Usage

This is a library plugin, not a runnable plugin, and it is intended to be used as a dependency for other plugins, which need to authenticate users.

To use the library within a plugin or another Versatile Data Kit component, just import the Authentication class, and create an instance of it. The different authentication flows require different parameters to be specified.

Once everything is done, in order to authenticate, call .authenticate() on the Authentication instance.

Example Usage:

from vdk.plugin.control_api_auth.authentication import Authentication

auth = Authentication(
    token="<oauth-api-token>",
    authorization_url="https://some-authorization-endpoint",
    auth_type="api-token",
)

auth.authenticate()   # authenticate

auth.read_access_token()   # fetch the cached access token

Build and testing

In order to build and test a plugin go to the plugin directory and use ../build-plugin.sh script to build it

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

vdk-control-api-auth-0.1.824443273.tar.gz (14.4 kB view details)

Uploaded Source

File details

Details for the file vdk-control-api-auth-0.1.824443273.tar.gz.

File metadata

File hashes

Hashes for vdk-control-api-auth-0.1.824443273.tar.gz
Algorithm Hash digest
SHA256 dc3e402426819105c6a7c70a347d4e161fd76d8e3ff1d5f3c0d9a6c9dd721b8a
MD5 b22de1606da33ae08cb95db940dad923
BLAKE2b-256 b85e420e295efec39fe54e0d89415086ee1157317215a948ce3aa5fa5e424a18

See more details on using hashes here.

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