Authzed
Authzed endpoints from AuthZed
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Authzed endpoints from AuthZed
Endpoints 27
Experimental
- POSTEXPERIMENTAL: CountRelationships returns the count of relationships for *pre-registered* filter.
/v1/experimental/countrelationships - POSTEXPERIMENTAL: RegisterRelationshipCounter registers a new filter for counting relationships. A filter must be registered before
a count can be requested.
/v1/experimental/registerrelationshipcounter - POSTEXPERIMENTAL: UnregisterRelationshipCounter unregisters an existing filter for counting relationships.
/v1/experimental/unregisterrelationshipcounter
Deprecated
- POSTDEPRECATED: Promoted to DiffSchema in the stable API.
/v1/experimental/diffschema - POSTDEPRECATED: Promoted to CheckBulkPermission in the stable API.
/v1/experimental/permissions/bulkcheckpermission - POSTDEPRECATED: Promoted to ComputablePermissions in the stable API.
/v1/experimental/permissions/computable - POSTDEPRECATED: Promoted to DependentRelations in the stable API.
/v1/experimental/permissions/dependent - POSTDEPRECATED: Promoted to ReflectSchema in the stable API.
/v1/experimental/reflectschema - POSTDEPRECATED: Promoted to ExportBulkRelationships in the stable API.
/v1/experimental/relationships/bulkexport - POSTDEPRECATED: Promoted to ImportBulkRelationships in the stable API.
/v1/experimental/relationships/bulkimport
Permissions
- POSTCheckPermission determines for a given resource whether a subject computes
to having a permission or is a direct member of a particular relation.
/v1/permissions/check - POSTCheckBulkPermissions evaluates the given list of permission checks
and returns the list of results.
/v1/permissions/checkbulk - POSTExpandPermissionTree reveals the graph structure for a resource's
permission or relation. This RPC does not recurse infinitely deep and may
require multiple calls to fully unnest a deeply nested graph.
/v1/permissions/expand - POSTLookupResources returns all the resources of a given type that a subject
can access whether via a computed permission or relation membership.
/v1/permissions/resourcesResults are streamed and not guaranteed to be unique: the same resource may be returned more than once (for example via caveated/conditional results, or when… - POSTLookupSubjects returns all the subjects of a given type that
have access whether via a computed permission or relation membership.
/v1/permissions/subjectsResults are streamed and not guaranteed to be unique: the same subject may be returned more than once, possibly with differing permissionship. Callers that… - POSTDeleteRelationships atomically bulk deletes all relationships matching the
provided filter. If no relationships match, none will be deleted and the
operation will succeed. An optional set of preconditions can be provided that must
be satisfied for the operation to commit.
/v1/relationships/delete - POSTExportBulkRelationships is the fastest path available to exporting
relationships from the server. It is resumable, and will return results
in an order determined by the server.
/v1/relationships/exportbulk - POSTImportBulkRelationships is a faster path to writing a large number of
relationships at once. It is both batched and streaming. For maximum
performance, the caller should attempt to write relationships in as close
to relationship sort order as possible: (resource.object_type,
resource.object_id, relation, subject.object.object_type,
subject.object.object_id, subject.optional_relation). All relationships
written are done so under a single transaction.
/v1/relationships/importbulk - POSTReadRelationships reads a set of the relationships matching one or more
filters.
/v1/relationships/read - POSTWriteRelationships atomically writes and/or deletes a set of specified
relationships. An optional set of preconditions can be provided that must
be satisfied for the operation to commit.
/v1/relationships/write
Schema
- POSTDiffSchema returns the difference between the specified schema and the current
schema stored in SpiceDB.
/v1/schema/diffschema - POSTComputablePermissions returns the set of permissions that compute based off a relation
in the current schema. For example, if the schema has a relation `viewer` and a permission
`view` defined as `permission view = viewer + editor`, then the
computable permissions for the relation `viewer` will include `view`.
/v1/schema/permissions/computable - POSTDependentRelations returns the set of relations and permissions that used
to compute a permission, recursively, in the current schema. It is the
inverse of the ComputablePermissions API.
/v1/schema/permissions/dependent - POSTRead returns the current Object Definitions for a Permissions System.
/v1/schema/readErrors include: INVALID_ARGUMENT: a provided value has failed to semantically validate NOT_FOUND: no schema has been defined - POSTReflectSchema reflects the current schema stored in SpiceDB, returning a structural
form of the schema for use by client tooling.
/v1/schema/reflectschema - POSTWrite overwrites the current Object Definitions for a Permissions System.
/v1/schema/write
Watch
- POSTWatch returns a stream of events that occurred in the datastore in ascending timestamp order.
The events can be relationship updates, schema updates, or checkpoints.
/v1/watch
API details
- Authentication
- An API key in the Authorization header
- Operations
- 27 operations on 27 pathsPOST 27
- Main resources
- Permissions 10Deprecated 7Schema 6Experimental 3Watch 1
- Response formats
application/json- Description format
- Swagger 2.0, API version
1.0 - Links
- Documentation · OpenAPI document · Support
- Listed from
- AuthZed (SpiceDB)'s published OpenAPI description (authzed/api) (Apache-2.0)
How to test the Authzed in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Authzed collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “EXPERIMENTAL: CountRelationships returns the count of relationships for *pre-registered* filter.” (POST /v1/experimental/countrelationships), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Authzed?
Authzed endpoints from AuthZed It is listed under Identity & security and has 27 endpoints.
Who publishes the Authzed?
It is listed from AuthZed's public API description (an OpenAPI document), not published by AuthZed on Swastik Codes. Anyone who controls authzed.com can claim the profile by adding a DNS TXT record.
How do I authenticate with the Authzed?
With an API key in the Authorization header.
How many endpoints does the Authzed have?
27 operations on 27 paths (27 POST). The largest groups are Permissions, Deprecated, Schema, Experimental.
Is forking the Authzed free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.