- Community
- Open Source
- Introduction
- POSTWrite Authorization Data
- POSTRead Relationships
- POSTRead Attributes
- POSTRun Bundle
- POSTDelete Data
- POSTCheck Access Control
- POSTExpand API
- POSTSubject Filtering
- POSTLookup Entity (Data Filtering)
- POSTLookup Entity (Streaming)
- POSTSubject Permission List
- POSTWatch API
API Documentation
Data Service
Permission Service
Watch Service
Expand API
Identifier of the tenant, if you are not using multi-tenancy (have only one tenant) use pre-inserted tenant <code>t1</code> for this field. Required, and must match the pattern \“[a-zA-Z0-9-,]+\“, max 64 bytes.
PermissionExpandRequest is the request message for the Expand method in the Permission service.
PermissionExpandRequestMetadata metadata for the PermissionExpandRequest.
Version of the schema.
The snap token to avoid stale cache, see more details on Snap Tokens.
Entity represents an entity with a type and an identifier.
Name of the permission to be expanded, not required, must start with a letter and can include alphanumeric and underscore, max 64 bytes.
Context encapsulates the information related to a single operation, including the tuples involved and the associated attributes.
A repeated field of tuples involved in the operation.
A repeated field of attributes associated with the operation.
Additional data associated with the context.
Additional arguments associated with this request.
cr, err: = client.Permission.Expand(context.Background(), &v1.PermissionExpandRequest{
TenantId: "t1",
Metadata: &v1.PermissionExpandRequestMetadata{
SnapToken: "",
SchemaVersion: "",
},
Entity: &v1.Entity{
Type: "repository",
Id: "1",
},
Permission: "push",
}){
"tree": {
"entity": {
"type": "<string>",
"id": "<string>"
},
"permission": "<string>",
"arguments": [
{
"computedAttribute": {
"name": "<string>"
},
"contextAttribute": {
"name": "<string>"
}
}
],
"expand": {
"operation": "OPERATION_UNSPECIFIED",
"children": [
{
"entity": {
"type": "<string>",
"id": "<string>"
},
"permission": "<string>",
"arguments": [
{
"computedAttribute": {
"name": "<string>"
},
"contextAttribute": {
"name": "<string>"
}
}
],
"expand": {
"operation": "OPERATION_UNSPECIFIED",
"children": [
{
"entity": {
"type": "<string>",
"id": "<string>"
},
"permission": "<string>",
"arguments": [
{
"computedAttribute": {
"name": "<string>"
},
"contextAttribute": {
"name": "<string>"
}
}
],
"expand": {
"operation": "OPERATION_UNSPECIFIED",
"children": [
{
"entity": {
"type": "<string>",
"id": "<string>"
},
"permission": "<string>",
"arguments": [
{
"computedAttribute": {
"name": "<string>"
},
"contextAttribute": {
"name": "<string>"
}
}
],
"expand": {
"operation": "OPERATION_UNSPECIFIED",
"children": [
{
"entity": {
"type": "<string>",
"id": "<string>"
},
"permission": "<string>",
"arguments": [
{
"computedAttribute": {
"name": "<string>"
},
"contextAttribute": {
"name": "<string>"
}
}
],
"expand": {
"operation": "OPERATION_UNSPECIFIED",
"children": [
{
"entity": {
"type": "<string>",
"id": "<string>"
},
"permission": "<string>",
"arguments": [
{
"computedAttribute": {
"name": "<string>"
},
"contextAttribute": {
"name": "<string>"
}
}
],
"expand": {
"operation": "OPERATION_UNSPECIFIED",
"children": [
"<any>"
]
},
"leaf": {
"subjects": {
"subjects": [
{
"type": "<string>",
"id": "<string>",
"relation": "<string>"
}
]
},
"values": {
"values": {}
},
"value": "<any>"
}
}
]
},
"leaf": {
"subjects": {
"subjects": [
{
"type": "<string>",
"id": "<string>",
"relation": "<string>"
}
]
},
"values": {
"values": {}
},
"value": {
"@type": "<string>"
}
}
}
]
},
"leaf": {
"subjects": {
"subjects": [
{
"type": "<string>",
"id": "<string>",
"relation": "<string>"
}
]
},
"values": {
"values": {}
},
"value": {
"@type": "<string>"
}
}
}
]
},
"leaf": {
"subjects": {
"subjects": [
{
"type": "<string>",
"id": "<string>",
"relation": "<string>"
}
]
},
"values": {
"values": {}
},
"value": {
"@type": "<string>"
}
}
}
]
},
"leaf": {
"subjects": {
"subjects": [
{
"type": "<string>",
"id": "<string>",
"relation": "<string>"
}
]
},
"values": {
"values": {}
},
"value": {
"@type": "<string>"
}
}
}
]
},
"leaf": {
"subjects": {
"subjects": [
{
"type": "<string>",
"id": "<string>",
"relation": "<string>"
}
]
},
"values": {
"values": {}
},
"value": {
"@type": "<string>"
}
}
}
}Retrieve all subjects (users and user sets) that have a relationship or attribute with given entity and permission
Expand API response is represented by a user set tree, whose leaf nodes are user IDs or user sets pointing to other ⟨object#relation⟩ pairs.
Expand is designed for reasoning the complete set of users that have access to their objects, which allows our users to build efficient search indices for access-controlled content.
It is not designed to use as a check access. Expand request has a high latency which can cause a performance issues when its used as access check.
Path Parameters
Identifier of the tenant, if you are not using multi-tenancy (have only one tenant) use pre-inserted tenant <code>t1</code> for this field. Required, and must match the pattern \“[a-zA-Z0-9-,]+\“, max 64 bytes.
Body
PermissionExpandRequestMetadata metadata for the PermissionExpandRequest.
Version of the schema.
The snap token to avoid stale cache, see more details on Snap Tokens.
Entity represents an entity with a type and an identifier.
Name of the permission to be expanded, not required, must start with a letter and can include alphanumeric and underscore, max 64 bytes.
Context encapsulates the information related to a single operation, including the tuples involved and the associated attributes.
A repeated field of tuples involved in the operation.
Entity represents an entity with a type and an identifier.
Subject represents an entity subject with a type, an identifier, and a relation.
A repeated field of attributes associated with the operation.
Entity represents an entity with a type and an identifier.
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);
}
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,
httpsis 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.
Schemes other than http, https (or the empty scheme) might be
used with implementation specific semantics.
Additional data associated with the context.
Additional arguments associated with this request.
ComputedAttribute defines a computed attribute which includes its name.
ContextAttribute defines a context attribute which includes its name.
Response
Expand is used to define a hierarchical structure for permissions. It has an entity, permission, and arguments. The node can be either another hierarchical structure or a set of subjects.
Entity represents an entity with a type and an identifier.
permission is the permission applied to the entity.
arguments are the additional information or context used to evaluate permissions.
ComputedAttribute defines a computed attribute which includes its name.
ContextAttribute defines a context attribute which includes its name.
ExpandTreeNode represents a node in an expansion tree with a specific operation and its children.
Operation is an enum representing the type of operation to be applied on the tree node.
OPERATION_UNSPECIFIED, OPERATION_UNION, OPERATION_INTERSECTION, OPERATION_EXCLUSION Entity represents an entity with a type and an identifier.
permission is the permission applied to the entity.
arguments are the additional information or context used to evaluate permissions.
ComputedAttribute defines a computed attribute which includes its name.
ContextAttribute defines a context attribute which includes its name.
ExpandTreeNode represents a node in an expansion tree with a specific operation and its children.
Operation is an enum representing the type of operation to be applied on the tree node.
OPERATION_UNSPECIFIED, OPERATION_UNION, OPERATION_INTERSECTION, OPERATION_EXCLUSION Entity represents an entity with a type and an identifier.
permission is the permission applied to the entity.
arguments are the additional information or context used to evaluate permissions.
ComputedAttribute defines a computed attribute which includes its name.
ContextAttribute defines a context attribute which includes its name.
ExpandTreeNode represents a node in an expansion tree with a specific operation and its children.
Operation is an enum representing the type of operation to be applied on the tree node.
OPERATION_UNSPECIFIED, OPERATION_UNION, OPERATION_INTERSECTION, OPERATION_EXCLUSION Entity represents an entity with a type and an identifier.
permission is the permission applied to the entity.
arguments are the additional information or context used to evaluate permissions.
ComputedAttribute defines a computed attribute which includes its name.
ContextAttribute defines a context attribute which includes its name.
ExpandTreeNode represents a node in an expansion tree with a specific operation and its children.
Operation is an enum representing the type of operation to be applied on the tree node.
OPERATION_UNSPECIFIED, OPERATION_UNION, OPERATION_INTERSECTION, OPERATION_EXCLUSION Entity represents an entity with a type and an identifier.
permission is the permission applied to the entity.
arguments are the additional information or context used to evaluate permissions.
ComputedAttribute defines a computed attribute which includes its name.
ContextAttribute defines a context attribute which includes its name.
ExpandTreeNode represents a node in an expansion tree with a specific operation and its children.
Operation is an enum representing the type of operation to be applied on the tree node.
OPERATION_UNSPECIFIED, OPERATION_UNION, OPERATION_INTERSECTION, OPERATION_EXCLUSION Entity represents an entity with a type and an identifier.
permission is the permission applied to the entity.
arguments are the additional information or context used to evaluate permissions.
ComputedAttribute defines a computed attribute which includes its name.
ContextAttribute defines a context attribute which includes its name.
ExpandTreeNode represents a node in an expansion tree with a specific operation and its children.
Operation is an enum representing the type of operation to be applied on the tree node.
OPERATION_UNSPECIFIED, OPERATION_UNION, OPERATION_INTERSECTION, OPERATION_EXCLUSION ExpandLeaf is the leaf node of an Expand tree and can be either a set of Subjects or a set of Values.
Subjects holds a repeated field of Subject type.
A list of subjects.
ExpandLeaf is the leaf node of an Expand tree and can be either a set of Subjects or a set of Values.
Subjects holds a repeated field of Subject type.
A list of subjects.
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);
}
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,
httpsis 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.
Schemes other than http, https (or the empty scheme) might be
used with implementation specific semantics.
ExpandLeaf is the leaf node of an Expand tree and can be either a set of Subjects or a set of Values.
Subjects holds a repeated field of Subject type.
A list of subjects.
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);
}
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,
httpsis 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.
Schemes other than http, https (or the empty scheme) might be
used with implementation specific semantics.
ExpandLeaf is the leaf node of an Expand tree and can be either a set of Subjects or a set of Values.
Subjects holds a repeated field of Subject type.
A list of subjects.
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);
}
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,
httpsis 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.
Schemes other than http, https (or the empty scheme) might be
used with implementation specific semantics.
ExpandLeaf is the leaf node of an Expand tree and can be either a set of Subjects or a set of Values.
Subjects holds a repeated field of Subject type.
A list of subjects.
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);
}
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,
httpsis 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.
Schemes other than http, https (or the empty scheme) might be
used with implementation specific semantics.
ExpandLeaf is the leaf node of an Expand tree and can be either a set of Subjects or a set of Values.
Subjects holds a repeated field of Subject type.
A list of subjects.
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);
}
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,
httpsis 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.
Schemes other than http, https (or the empty scheme) might be
used with implementation specific semantics.
cr, err: = client.Permission.Expand(context.Background(), &v1.PermissionExpandRequest{
TenantId: "t1",
Metadata: &v1.PermissionExpandRequestMetadata{
SnapToken: "",
SchemaVersion: "",
},
Entity: &v1.Entity{
Type: "repository",
Id: "1",
},
Permission: "push",
}){
"tree": {
"entity": {
"type": "<string>",
"id": "<string>"
},
"permission": "<string>",
"arguments": [
{
"computedAttribute": {
"name": "<string>"
},
"contextAttribute": {
"name": "<string>"
}
}
],
"expand": {
"operation": "OPERATION_UNSPECIFIED",
"children": [
{
"entity": {
"type": "<string>",
"id": "<string>"
},
"permission": "<string>",
"arguments": [
{
"computedAttribute": {
"name": "<string>"
},
"contextAttribute": {
"name": "<string>"
}
}
],
"expand": {
"operation": "OPERATION_UNSPECIFIED",
"children": [
{
"entity": {
"type": "<string>",
"id": "<string>"
},
"permission": "<string>",
"arguments": [
{
"computedAttribute": {
"name": "<string>"
},
"contextAttribute": {
"name": "<string>"
}
}
],
"expand": {
"operation": "OPERATION_UNSPECIFIED",
"children": [
{
"entity": {
"type": "<string>",
"id": "<string>"
},
"permission": "<string>",
"arguments": [
{
"computedAttribute": {
"name": "<string>"
},
"contextAttribute": {
"name": "<string>"
}
}
],
"expand": {
"operation": "OPERATION_UNSPECIFIED",
"children": [
{
"entity": {
"type": "<string>",
"id": "<string>"
},
"permission": "<string>",
"arguments": [
{
"computedAttribute": {
"name": "<string>"
},
"contextAttribute": {
"name": "<string>"
}
}
],
"expand": {
"operation": "OPERATION_UNSPECIFIED",
"children": [
{
"entity": {
"type": "<string>",
"id": "<string>"
},
"permission": "<string>",
"arguments": [
{
"computedAttribute": {
"name": "<string>"
},
"contextAttribute": {
"name": "<string>"
}
}
],
"expand": {
"operation": "OPERATION_UNSPECIFIED",
"children": [
"<any>"
]
},
"leaf": {
"subjects": {
"subjects": [
{
"type": "<string>",
"id": "<string>",
"relation": "<string>"
}
]
},
"values": {
"values": {}
},
"value": "<any>"
}
}
]
},
"leaf": {
"subjects": {
"subjects": [
{
"type": "<string>",
"id": "<string>",
"relation": "<string>"
}
]
},
"values": {
"values": {}
},
"value": {
"@type": "<string>"
}
}
}
]
},
"leaf": {
"subjects": {
"subjects": [
{
"type": "<string>",
"id": "<string>",
"relation": "<string>"
}
]
},
"values": {
"values": {}
},
"value": {
"@type": "<string>"
}
}
}
]
},
"leaf": {
"subjects": {
"subjects": [
{
"type": "<string>",
"id": "<string>",
"relation": "<string>"
}
]
},
"values": {
"values": {}
},
"value": {
"@type": "<string>"
}
}
}
]
},
"leaf": {
"subjects": {
"subjects": [
{
"type": "<string>",
"id": "<string>",
"relation": "<string>"
}
]
},
"values": {
"values": {}
},
"value": {
"@type": "<string>"
}
}
}
]
},
"leaf": {
"subjects": {
"subjects": [
{
"type": "<string>",
"id": "<string>",
"relation": "<string>"
}
]
},
"values": {
"values": {}
},
"value": {
"@type": "<string>"
}
}
}
}