Write Bundle

rr, err := client.Bundle.Write(context.Background(), &v1.BundleWriteRequest{
    TenantId: "t1",
    Bundles: []*v1.DataBundle{
        {
            Name: "organization_created",
            Arguments: []string{
                "creatorID",
                "organizationID",
            },
            Operations: []*v1.Operation{
                {
                    RelationshipsWrite: []string{
                        "organization:{{.organizationID}}#admin@user:{{.creatorID}}",
                        "organization:{{.organizationID}}#manager@user:{{.creatorID}}",
                    },
                    AttributesWrite: []string{
                        "organization:{{.organizationID}}$public|boolean:false",
                    },
                },
            },
        },
    },
})

client.bundle.write({
    tenantId: "t1",
    bundles: [
        {
            name: "organization_created",
            arguments: [
                "creatorID",
                "organizationID",
            ],
            operations: [
                {
                    relationships_write: [
                        "organization:{{.organizationID}}#admin@user:{{.creatorID}}",
                        "organization:{{.organizationID}}#manager@user:{{.creatorID}}",
                    ],
                    attributes_write: [
                        "organization:{{.organizationID}}$public|boolean:false",
                    ]
                }
            ]
        }
    ]
}).then((response) => {
    // handle response
})

curl --location --request POST 'localhost:3476/v1/tenants/{tenant_id}/bundle/write' \
--header 'Content-Type: application/json' \
--data-raw '{
    "bundles": [
        {
            "name": "organization_created",
            "arguments": [
                "creatorID",
                "organizationID"
            ],
            "operations": [
                {
                    "relationships_write": [
                        "organization:{{.organizationID}}#admin@user:{{.creatorID}}",
                        "organization:{{.organizationID}}#manager@user:{{.creatorID}}"
                    ],
                    "attributes_write": [
                        "organization:{{.organizationID}}$public|boolean:false"
                    ]
                }
            ]
        }
    ]
}'

{
  "names": [
    "<string>"
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<string>"
    }
  ]
}

POST

tenants

{tenant_id}

bundle

write

rr, err := client.Bundle.Write(context.Background(), &v1.BundleWriteRequest{
    TenantId: "t1",
    Bundles: []*v1.DataBundle{
        {
            Name: "organization_created",
            Arguments: []string{
                "creatorID",
                "organizationID",
            },
            Operations: []*v1.Operation{
                {
                    RelationshipsWrite: []string{
                        "organization:{{.organizationID}}#admin@user:{{.creatorID}}",
                        "organization:{{.organizationID}}#manager@user:{{.creatorID}}",
                    },
                    AttributesWrite: []string{
                        "organization:{{.organizationID}}$public|boolean:false",
                    },
                },
            },
        },
    },
})

client.bundle.write({
    tenantId: "t1",
    bundles: [
        {
            name: "organization_created",
            arguments: [
                "creatorID",
                "organizationID",
            ],
            operations: [
                {
                    relationships_write: [
                        "organization:{{.organizationID}}#admin@user:{{.creatorID}}",
                        "organization:{{.organizationID}}#manager@user:{{.creatorID}}",
                    ],
                    attributes_write: [
                        "organization:{{.organizationID}}$public|boolean:false",
                    ]
                }
            ]
        }
    ]
}).then((response) => {
    // handle response
})

curl --location --request POST 'localhost:3476/v1/tenants/{tenant_id}/bundle/write' \
--header 'Content-Type: application/json' \
--data-raw '{
    "bundles": [
        {
            "name": "organization_created",
            "arguments": [
                "creatorID",
                "organizationID"
            ],
            "operations": [
                {
                    "relationships_write": [
                        "organization:{{.organizationID}}#admin@user:{{.creatorID}}",
                        "organization:{{.organizationID}}#manager@user:{{.creatorID}}"
                    ],
                    "attributes_write": [
                        "organization:{{.organizationID}}$public|boolean:false"
                    ]
                }
            ]
        }
    ]
}'

{
  "names": [
    "<string>"
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<string>"
    }
  ]
}

What is Data Bundles?

Ensuring that authorization data remains in sync with the business model is an important practice when using Permify. Prior to Data Bundles, it was the responsibility of the services (such as WriteData API) to structure how relations are created and deleted when actions occur on resources. With the Data Bundles, you be able to bundle and model the creation and deletion of relations and attributes when specific actions occur on resources in your applications. We believe this functionality will streamline managing authorization data as well as managing this in a central place increases visibility around certain actions/triggers that end up with data creation.

How Bundles Work

Let’s examine how Bundles operate with a basic example. Let’s say you want to model how data will be created when an organization is created in your application. For this purpose, you can utilize the WriteBundle API endpoint. This API enables users to define or update data bundles, each distinguished by a unique name. Here’s an example body for WriteBundle in this scenario:

"bundles": [
    {
        "name": "organization_created"
        "arguments": [
            "creatorID",
            "organizationID"
        ],
        "operations": [
            {
                "relationships_write": [
                    "organization:{{.organizationID}}#admin@user:{{.creatorID}}",
                    "organization:{{.organizationID}}#manager@user:{{.creatorID}}",
                ],
                "attributes_write": [
                    "organization:{{.organizationID}}$public|boolean:false",
                ],
            },
        ],
    },
],

Operations represent actions that can be performed on relationships and attributes, such as adding or deleting relationships when certain events occur. Let’s say user:564 creates an organization:789 in your application. According to your authorization logic, this will result in the creation of several authorization data, including relational tuples and attributes, respectively.

organization:789#admin@user:564
organization:789#manager@user:564
organization:789$public|boolean:false

Instead of using the WriteData endpoint, you can utilize RunBundle to create this data by simply providing specific identifiers. An example request of RunBundle for this scenario:

POST /bundle
BODY
{
   "name": "project_created",
   "arguments": {
       "creatorID": "564",
       "organizationID": "789",
    }
}

This will result in the creation of the following data in Permify:

organization:789#admin@user:564
organization:789#manager@user:564
organization:789$public|boolean:false

Endpoints

Write Bundles Request

The “Write Bundle” API is designed for handling data in a multi-tenant application environment. Its primary function is to write and delete data according to predefined structures. This API allows users to define or update data bundles, each distinguished by a unique name.

Path Parameters

tenant_id

string

required

Identifier of the tenant, if you are not using multi-tenancy (have only one tenant) use pre-inserted tenant t1 for this field. Required, and must match the pattern \“[a-zA-Z0-9-,]+\“, max 64 bytes.

Body

application/json

BundleWriteRequest is used to request the writing of a bundle. It contains the tenant_id to identify the tenant and the Bundles object.

bundles

object[]

Contains the bundle data to be written.

Show child attributes

Response

A successful response.

BundleWriteResponse is the response for a BundleWriteRequest. It includes a name which could be used as an identifier or acknowledgment.

names

string[]

Identifier or acknowledgment of the written bundle.

API Documentation

Schema Service

Data Service

Permission Service

Tenancy Service

Bundle Service

Watch Service

What is Data Bundles?

How Bundles Work

Endpoints

Write Bundles Request

Path Parameters

Body

Response

​What is Data Bundles?

​How Bundles Work

​Endpoints

​Write Bundles Request

Path Parameters

Body

Response

What is Data Bundles?

How Bundles Work

Endpoints

Write Bundles Request