Authzed Python Client

PyPI License Build Status Mailing List Discord Server Twitter

This repository houses the Python client library for Authzed.

Authzed is a database and service that stores, computes, and validates your application's permissions.

Developers create a schema that models their permissions requirements and use a client library, such as this one, to apply the schema to the database, insert data into the database, and query the data to efficiently check permissions in their applications.

Supported client API versions:

  • v1 - Core SpiceDB API for permissions checks, schema management, and relationship operations
  • materialize/v0 - Materialize API for building materialized permission views

You can find more info on each API on the Authzed API reference documentation. Additionally, Protobuf API documentation can be found on the Buf Registry Authzed API repository.

See CONTRIBUTING.md for instructions on how to contribute and perform common tasks like building the project and running tests.

Getting Started

We highly recommend following the Protecting Your First App guide to learn the latest best practice to integrate an application with Authzed.

If you're interested in examples of a specific version of the API, they can be found in their respective folders in the examples directory.

Basic Usage

Installation

This project is packaged as the wheel authzed on the Python Package Index.

If you are using pip, the command to install the library is:

pip install authzed

Initializing a client

With the exception of gRPC utility functions found in grpcutil, everything required to connect and make API calls is located in a module respective to API version.

In order to successfully connect, you will have to provide a Bearer Token with your own API Token from the Authzed dashboard in place of t_your_token_here_1234567deadbeef in the following example:

from authzed.api.v1 import Client
from grpcutil import bearer_token_credentials


client = Client(
    "grpc.authzed.com:443",
    bearer_token_credentials("t_your_token_here_1234567deadbeef"),
)

Performing an API call

from authzed.api.v1 import (
    CheckPermissionRequest,
    CheckPermissionResponse,
    ObjectReference,
    SubjectReference,
)


post_one = ObjectReference(object_type="blog/post", object_id="1")
emilia = SubjectReference(object=ObjectReference(
    object_type="blog/user",
    object_id="emilia",
))

# Is Emilia in the set of users that can read post #1?
resp = client.CheckPermission(CheckPermissionRequest(
    resource=post_one,
    permission="reader",
    subject=emilia,
))
assert resp.permissionship == CheckPermissionResponse.PERMISSIONSHIP_HAS_PERMISSION

Insecure Client Usage

When running in a context like docker compose, because of Docker's virtual networking, the gRPC client sees the SpiceDB container as "remote." It has built-in safeguards to prevent calling a remote client in an insecure manner, such as using client credentials without TLS.

However, this is a pain when setting up a development or testing environment, so we provide the InsecureClient as a convenience:

from authzed.api.v1 import InsecureClient

client = InsecureClient(
    "spicedb:50051",
    "my super secret token"
)

Materialize API

The authzed-py supports Authzed Materialize API. The Materialize API allows you to build and maintain materialized views of your permissions data in your own systems for high-performance lookups.

Learn more in the Materialize API Quickstart Guide that can be found the examples directory.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (1.25.0)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for authzed from gravatar.com authzed

Credits

Author: Authzed

License expression

Apache-2.0
View SPDX License List

Requires

Python <4, >=3.10

Classifiers

Report project as malware

Download files

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

Source Distribution

authzed-1.24.2.tar.gz (147.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

authzed-1.24.2-py3-none-any.whl (189.9 kB view details)

Uploaded Python 3

File details

Details for the file authzed-1.24.2.tar.gz.

File metadata

  • Download URL: authzed-1.24.2.tar.gz
  • Upload date:
  • Size: 147.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for authzed-1.24.2.tar.gz
Algorithm Hash digest
SHA256 f7fa7239e6a37d3bdd5990c55fd74a3372813df1477a89992d137b2d4dd5f347
MD5 e576c677a851428b74ceecd684417ad1
BLAKE2b-256 f67ab413d665c9d3695c5b87fd97a814c38d93c828e6c3ba8c691c3bfe7dd3aa

See more details on using hashes here.

Provenance

The following attestation bundles were made for authzed-1.24.2.tar.gz:

Publisher: publish-to-pypi.yml on authzed/authzed-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file authzed-1.24.2-py3-none-any.whl.

File metadata

  • Download URL: authzed-1.24.2-py3-none-any.whl
  • Upload date:
  • Size: 189.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for authzed-1.24.2-py3-none-any.whl
Algorithm Hash digest
SHA256 387bf9daeccfae7c8c04b7bc14573e71563e44366e3251f8cf35aac57a4bff34
MD5 d57a7d83be4c21db5eaeaad9cbdc3f0d
BLAKE2b-256 6a163e6fda5461046461df09180b885703db9c9ff5c572749135fd62998dd62e

See more details on using hashes here.

Provenance

The following attestation bundles were made for authzed-1.24.2-py3-none-any.whl:

Publisher: publish-to-pypi.yml on authzed/authzed-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

1.25.0

2 files

1.24.4

2 files

1.24.3

2 files

This release

1.24.2 This release

2 files

1.24.1

2 files

1.24.0

2 files

1.23.0

2 files

Pre-release

1.22.2rc2

2 files

Pre-release

1.22.2rc1

2 files

1.22.1

2 files

1.22.0

2 files

1.21.2

2 files

1.21.1

2 files

1.21.0

2 files

1.20.0

2 files

Pre-release

1.2.0b1

2 files

1.1.0

2 files

1.0.0

2 files

0.19.0

2 files

0.18.3

2 files

0.18.2

2 files

0.18.1

2 files

0.17.0

2 files

0.16.0

2 files

0.15.0

2 files

0.14.2

2 files

0.14.1

2 files

0.14.0

2 files

0.13.0

2 files

0.12.0

2 files

0.11.0

2 files

0.10.0

2 files

0.9.0

2 files

0.8.0

2 files

0.7.1

2 files

0.7.0

2 files

0.6.0

2 files

0.5.1

2 files

0.5.0

2 files

0.4.2

2 files

0.4.1

2 files

0.3.1

2 files

0.3.0

2 files

0.2.0

2 files

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