Package: conjur-client
conjur-api-python3Python3-based API SDK forConjur OSS. The repo
also includes a self-contained CLI tool (conjur-cli) that wraps the API
in a simple executable script/binary.Status: AlphaWarning: Naming and APIs are still subject to breaking changes!Installing the codeUsing conjur-api-python3 with Conjur OSSAre you using this project withConjur OSS? Then westronglyrecommend choosing the version of this project to use from the latestConjur OSS
suite release.
Conjur maintainers perform additional testing on the suite release versions to ensure
compatibility. When possible, upgrade your Conjur version to match thelatest suite release;
when using integrations, choose the latest suite release that matches your Conjur version. For any
questions, please contact us onDiscourse.From PyPI$ pip3 install conjur-clientFrom source$ pip3 install .Note: On some machines, you have to usepipinstead ofpip3but in most cases,
you will want to usepip3if it's available for your platform.UsageCLICLI can either be used with the included executable script:conjur-cli--insecure-lhttps://myserver-aorgname-uadmin-psecret\variablegetfoo/barOr through the installed module:python-mconjur--insecure-lhttps://myserver-aorgname-uadmin-psecretlistAPIMost usage is done by creating a Client instance and then invoking the API on it:With login ID and password#!/usr/bin/env python3fromconjurimportClientclient=Client(url='https://conjur.myorg.com',account='default',login_id='admin',password='mypassword',ca_bundle='/path/to/my/ca/bundle')print("Setting variable...")client.set('conjur/my/variable','new value')print("Fetching variable...")new_value=client.get('conjur/my/variable')print("Variable value is:",new_value.decode('utf-8'))With login Id and API keyWrite the code same as in the first example but create the client with the following arguments:client=Client(url='https://conjur.myorg.com',account='default',login_id='admin',api_key='myapikey',ca_bundle='/path/to/my/ca/bundle')With.netrcand.conjurrcsettingsWrite the code same as in the first example but create the client with the following arguments:client=Client()Currently supported client methods:get(variable_id)Gets a variable value based on its ID. Variable is binary data
that should be decoded to your system's encoding (e.g.get(variable_id).decode('utf-8').get_many(variable_id[,variable_id...])Gets multiple variable values based on their IDs. Variables are
returned in a dictionary that maps the variable name to its value.set(variable_id, value)Sets a variable to a specific value based on its ID.Note: Policy to create the variable must have been already loaded
otherwise you will get a 404 error during invocation.apply_policy_file(policy_name, policy_file)Applies a file-based YAML to a named policy. This method only
supports additive changes. Result is a dictionary object constructed
from the returned JSON data.replace_policy_file(policy_name, policy_file)Replaces a named policy with one from the provided file. This is
usually a destructive invocation. Result is a dictionary object
constructed from the returned JSON data.delete_policy_file(policy_name, policy_file)Modifies an existing Conjur policy. Data may be explicitly
deleted using the !delete, !revoke, and !deny statements. Unlike
"replace" mode, no data is ever implicitly deleted. Result is a
dictionary object constructed from the returned JSON data.list()Returns a Python list of all the available resources for the current
account.whoami()Note: This method requires Conjur v1.9+Returns a Python dictionary of information about the client making an
API request (such as its ip address, user, account,
token expiration date etc.).ContributingWe store instructions for development and guidelines for how to build and test this
project in theCONTRIBUTING.md- please refer to that document
if you would like to contribute.LicenseThis project islicensed under Apache License v2.0