Skip to main content

Britive Python SDK

Python client for the Britive API.

The SDK provides Python methods for Britive APIs. It generally passes values to the API for validation, but some methods combine related API operations or normalize responses for Python callers.

This package supports Python versions >= 3.11.

Installation

pip install britive

Install cloud federation dependencies as needed:

pip install "britive[aws]"
pip install "britive[azure]"
pip install "britive[gcp]"

To install the current source from GitHub instead of PyPI, run:

pip install "git+https://github.com/britive/python-sdk.git"

Documentation

Method docstrings describe parameters, return values, and API-specific behavior.

Official API documentation can be found here: Britive API Documentation.

Authentication

The SDK accepts Britive API tokens, temporary bearer tokens, and workload federation tokens. Provide an API or bearer token in one of these ways:

  1. Passed directly into the class constructor.
  2. Injected as an environment variable into the execution context where this package is being run.

The environment variable name is BRITIVE_API_TOKEN.

To source a workload federation token, pass token_federation_provider to the Britive constructor. Supported providers include AWS, Azure managed identities, Bitbucket Pipelines, GCP, GitHub Actions, GitLab, and Spacelift.

Every token authenticates against a specific Britive tenant. Provide the tenant in one of these ways:

  1. Passed directly into the Britive class constructor.
  2. Injected as an environment variable into the execution context where this package is being run.

The environment variable name is BRITIVE_TENANT.

In order to obtain the tenant name, reference the Britive URL used to log into the UI. If the URL is https://example.britive-app.com then the tenant name will be example.

Temporary bearer tokens

An authenticated client with securityadmin.temptoken.create permission can create a temporary bearer token:

from britive.britive import Britive

client = Britive()
temporary = client.security.temp_tokens.create(duration_seconds=900)

# Revoke it when no longer needed. Pass the token value, not a token ID.
client.security.temp_tokens.revoke(token=temporary['accessToken'])

Revocation authenticates DELETE /api/auth with the supplied temporary token. It does not change the client's normal credentials. Temporary-token listing and metadata retrieval are not supported yet; list and get raise NotImplementedError. Keep token values secret. The SDK does not persist them.

Pagination

The SDK automatically follows recognized paginated list responses. Methods documented as returning an API summary dictionary preserve that summary instead:

  • my_devices.list returns one page with records under data. Use page and size to select a page.
  • Managed-tag list methods return records under data. Omit page and size for all matches, or provide both for one page. Sorting is applied when paging.
  • my_resources.list_resource_templates preserves the API's templates summary and optional paging details.

Assumptions

  • The caller has access to an active Britive tenant.
  • The caller has a token for a user, service identity, or workload.
  • No assumptions are made about the operating system or file system.
  • The SDK does not persist responses unless a method accepts and receives an output file, such as audit_logs.logs.download_csv(output_file=...).

Resource Coverage

The SDK includes clients for these main Britive areas:

  • Access Broker
  • API tokens
  • Application management, including applications, profiles, accounts, permissions, and scans
  • Audit logs and audit log webhooks
  • Global settings, including notification mediums, firewall settings, and ITSM
  • Identity management, including users, service identities, AI identities, tags, and identity providers
  • My Access, My Approvals, My Requests, My Resources, and My Secrets
  • My Devices and My Managed Tags
  • Reports
  • Secrets Manager
  • Security, including SAML, security policies, active sessions, and step-up authentication
  • System roles, policies, permissions, consumers, and actions
  • Workflows, notifications, and tasks

Proxies

The SDK uses Python requests to communicate with the Britive API. Configure an HTTP proxy through environment variables supported by requests.

  • HTTP proxies will be set via environment variables.
    • HTTP_PROXY
    • HTTPS_PROXY
    • NO_PROXY
    • http_proxy
    • https_proxy
    • no_proxy

Standard HTTP proxy URLs should be utilized.

Examples:

  • Unauthenticated Proxy: http://internalproxy.domain.com:8080
  • Authenticated Proxy: http://user:pass@internalproxy.domain.com:8080

Custom TLS Certificates

Configure custom TLS certificates through environment variables supported by requests.

  • Certificate bundles can be set via environment variables.
    • REQUESTS_CA_BUNDLE
    • CURL_CA_BUNDLE (used as a fallback)
    • PYBRITIVE_CA_BUNDLE (specific to the Britive Python SDK)

The values of these environment variables must be a path to a directory of certificates or a specific certificate.

Example: /path/to/certfile

Platform Examples

Linux/macOS

export REQUESTS_CA_BUNDLE="/usr/local/corp-proxy/cacert.pem"

Windows

PowerShell
$env:REQUESTS_CA_BUNDLE = "C:\Users\User\AppData\Local\corp-proxy\cacert.pem"
Command Prompt
set "REQUESTS_CA_BUNDLE=C:\Users\User\AppData\Local\corp-proxy\cacert.pem"

Examples

Importing

This should be the only class that is required for import.

from britive.britive import Britive

Optionally, the various exceptions that this package raises can be imported as well, e.g.

from britive import exceptions

Then specific exception(s) could be referenced as demonstrated below:

try:
    something()
except exceptions.TokenMissingError:
    handle()

List All Users

from britive.britive import Britive
import json

britive = Britive()  # source needed data from environment variables

print(json.dumps(britive.identity_management.users.list(), indent=2, default=str))

Provide Needed Authentication Information in the Script

from britive.britive import Britive
import json

britive = Britive(tenant='example', token='...') # source token and tenant locally (not from environment variables)

print(json.dumps(britive.identity_management.users.list(), indent=2, default=str))

Create API Token for a Service Identity

from britive.britive import Britive
import json

britive = Britive()  # source needed data from environment variables

print(json.dumps(
    britive.identity_management.service_identity_tokens.create(service_identity_id='abc123'),
    indent=2,
    default=str,
))

Run a Report (JSON and CSV output)

from britive.britive import Britive
import json

britive = Britive()  # source needed data from environment variables

print(json.dumps(britive.reports.run(report_id='abc123'), indent=2, default=str))

with open('file.csv', 'w') as f:
    f.write(britive.reports.run(report_id='abc123', csv=True))

Create an application profile policy

The commands below will create a policy on a profile that allows user@domain.com to check out the profile but only if approver@domain.com approves that request within 10 minutes.

from britive.britive import Britive

b = Britive()

policy = b.application_management.profiles.policies.build(
    name='example',
    users=['user@domain.com'],
    approval_notification_medium='Email',
    approver_users=['approver@domain.com'],
    time_to_approve=10
)

b.application_management.profiles.policies.create(profile_id='...', policy=policy)

Metadata

Release files for britive 4.8.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for britive 4.8.0
File Size Uploaded Provenance Actions
britive-4.8.0.tar.gz 103.1 kB Without provenance Details for britive-4.8.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for britive 4.8.0
File Interpreter ABI Platform Actions
britive-4.8.0-py3-none-any.whl Python 3 none any Details for britive-4.8.0-py3-none-any.whl

Total release size: 247.1 kB

Release files / britive-4.8.0.tar.gz

Download URL britive-4.8.0.tar.gz
Size 103.1 kB
Tags Source
SHA-256 checksum
How to use checksums
37508dba4378c6213cf772bb01b242578aa0f85a96c0f6e6cfa18669531c4946
BLAKE2b-256 checksum
How to use checksums
763feca163c5ec41c185d6e6f8731ebd16517b651c056dff9e3a5c1b47291d25
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Release files / britive-4.8.0-py3-none-any.whl

Download URL britive-4.8.0-py3-none-any.whl
Size 144.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fbb60089a47cf755f876ad78ae29db696a414572023c12156727befe53cdebf2
BLAKE2b-256 checksum
How to use checksums
3b6492bd300fe9884bfaff1436714a741b147121de4ee87d7ee830ebbe7c3321
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Security for britive 4.8.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

4.8.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page