Community

Open Source

Playground

Permify Docs

API References

Support

Read Attributes

`Any` contains an arbitrary serialized protocol buffer message along with a
URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form
of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

    Foo foo = ...;
    Any any;
    any.PackFrom(foo);
    ...
    if (any.UnpackTo(&foo)) {
      ...
    }

Example 2: Pack and unpack a message in Java.

    Foo foo = ...;
    Any any = Any.pack(foo);
    ...
    if (any.is(Foo.class)) {
      foo = any.unpack(Foo.class);
    }
    // or ...
    if (any.isSameTypeAs(Foo.getDefaultInstance())) {
      foo = any.unpack(Foo.getDefaultInstance());
    }

 Example 3: Pack and unpack a message in Python.

    foo = Foo(...)
    any = Any()
    any.Pack(foo)
    ...
    if any.Is(Foo.DESCRIPTOR):
      any.Unpack(foo)
      ...

 Example 4: Pack and unpack a message in Go

     foo := &pb.Foo{...}
     any, err := anypb.New(foo)
     if err != nil {
       ...
     }
     ...
     foo := &pb.Foo{}
     if err := any.UnmarshalTo(foo); err != nil {
       ...
     }

The pack methods provided by protobuf library will by default use
'type.googleapis.com/full.type.name' as the type URL and the unpack
methods only use the fully qualified type name after the last '/'
in the type URL, for example "foo.bar.com/x/y.z" will yield type
name "y.z".

JSON
====
The JSON representation of an `Any` value uses the regular
representation of the deserialized, embedded message, with an
additional field `@type` which contains the type URL. Example:

    package google.profile;
    message Person {
      string first_name = 1;
      string last_name = 2;
    }

    {
      "@type": "type.googleapis.com/google.profile.Person",
      "firstName": <string>,
      "lastName": <string>
    }

If the embedded message type is well-known and has a custom JSON
representation, that representation will be embedded adding a field
`value` which holds the custom JSON in addition to the `@type`
field. Example (for message [google.protobuf.Duration][]):

    {
      "@type": "type.googleapis.com/google.protobuf.Duration",
      "value": "1.212s"
    }

A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
`path/google.protobuf.Duration`). The name should be in a canonical form
(e.g., leading "." is not accepted).

In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme `http`, `https`, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:

* If no scheme is provided, `https` is assumed.
* An HTTP GET on the URL must yield a [google.protobuf.Type][]
  value in binary format, or produce an error.
* Applications are allowed to cache lookup results based on the
  URL, or have them precompiled into a binary to avoid any
  lookup. Therefore, binary compatibility needs to be preserved
  on changes to types. (Use versioned type names to manage
  breaking changes.)

Note: this functionality is not currently available in the official
protobuf release, and it is not used for type URLs beginning with
type.googleapis.com. As of May 2023, there are no widely used type server
implementations and no plans to implement one.

Schemes other than `http`, `https` (or the empty scheme) might be
used with implementation specific semantics.

Attribute represents an attribute of an entity with a specific type and value.

Name of the attribute

AttributeFilter is used to filter attributes based on the entity and attribute names.

Names of the attributes to be filtered

AttributeReadRequestMetadata defines the structure for the metadata of an attribute read request.
It includes the snap_token associated with a particular state of the database.

The snap token to avoid stale cache, see more details on [Snap Tokens](../../operations/snap-tokens)

Entity represents an entity with a type and an identifier.

EntityFilter is used to filter entities based on the type and ids.

List of entity IDs

Type of the entity

AttributeReadRequest defines the structure of a request for reading attributes.
It includes the tenant_id, metadata, attribute filter, page size for pagination, and a continuous token for multi-page results.

AttributeReadResponse defines the structure of the response to an attribute read request.
It includes the attributes retrieved and a continuous token for handling result pagination.

read attributes

Start building scalable and fine-grained authorization systems in mere minutes.

Explore Permify

Authorization As A Service

Authorization As A Service | Permify

Permify FAQs

Quickstart

Modeling Authorization

Storing Data & Schema

Interacting With The API

Testing & Validation

Introduction

User Groups

Healthcare System

Document Management

Social Network

Fintech & Banking

Organization Tool

Global Roles

Resource Specific Roles

Custom Roles

Public or Private Resources

Text & Object Based Conditions

Numerical Conditions

Organization Hierarchies

Inherited/Nested Permissions

Recursive Relationships

Configuration

Deployment

Deploy on AWS ECS, ECR & EC2

Install with Brew

Run using Docker

Deploy on Fly.io

Deploy on Google Compute Engine

Deploying Permify with Helm Charts

Deploy on Kubernetes Cluster

Data Bundles

Cache Mechanisms

Contextual Permissions

Observability

Consistency (Snap Tokens)

Data Synchronization

OpenTelemetry

Jaeger

SigNoz

Zipkin

Role Based Access Control (RBAC)

Relationship Based Access Control (ReBAC)

Attribute Based Access Control (ABAC)

Multi Tenancy

LLM Authorization

Upgrade Guide from v1.0 to v1.1

Example section for showcasing API endpoints

Write Schema

List Schema

Partial Schema Update

Read Schema

Write Authorization Data

Read Relationships

Run Bundle

Delete Data

Check Access Control

Expand API

Subject Filtering

Lookup Entity (Data Filtering)

Lookup Entity (Streaming)

Subject Permission List

List Tenants

Create Tenant

Delete Tenant

Write Bundle

Read Bundle

Delete Bundle

Watch API

API Documentation

Schema Service

Data Service

Permission Service

Tenancy Service

Bundle Service

Watch Service

Read Attributes

Path Parameters

Body

Response